Refactor: Changed internal package naming
This commit is contained in:
Prozilla
parent
308a42976e
commit
4f03c486d7
6 changed files with 34 additions and 33 deletions
27
README.md
27
README.md
|
|
@ -19,7 +19,7 @@ ProzillaOS is a web-based operating system inspired by Ubuntu Linux and Windows.
|
|||
|
||||
## Packages
|
||||
|
||||
### Libraries
|
||||
### Libraries (external)
|
||||
|
||||
These libraries are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`. Each library has a `src/main.ts` entry file and is published to the npm registry.
|
||||
|
||||
|
|
@ -41,12 +41,12 @@ These libraries are different modules of ProzillaOS that can be installed separa
|
|||
|
||||
- [`@prozilla-os/logic-sim`][logic-sim]: Logic simulator app
|
||||
|
||||
### Sites
|
||||
### Sites (internal)
|
||||
|
||||
These packages contains the source code of parts of the ProzillaOS website. They are published to GitHub pages.
|
||||
|
||||
- [`prozilla-os-demo`](./packages/demo/): Demo site
|
||||
- [`prozilla-os-docs`](./packages/docs/): Documentation site
|
||||
- [`@prozilla-os/demo`](./packages/demo/): Demo site
|
||||
- [`@prozilla-os/docs`](./packages/docs/): Documentation site
|
||||
|
||||
## Scripts
|
||||
|
||||
|
|
@ -59,8 +59,9 @@ ProzillaOS uses the package manager [pnpm](https://pnpm.io/) to run scripts.
|
|||
| <pre>pnpm run start</pre> | Run [`pnpm run site:start`](#package-prozilla-os-demo). VSCode is configured to run this script whenever the project is opened.
|
||||
| <pre>pnpm run build</pre> | Build every package in sequential order.
|
||||
| <pre>pnpm run deploy</pre> | Clear the `dist` directory, build and stage each package that comprises the website, then deploy to GitHub pages. This should then trigger a GitHub Action that deploys the build to production.
|
||||
| <pre>pnpm run publish</pre> | Publish the `dist` directory to GitHub pages.
|
||||
|
||||
### Libraries
|
||||
### External packages
|
||||
|
||||
| Script | Description |
|
||||
| --- | --- |
|
||||
|
|
@ -71,18 +72,18 @@ ProzillaOS uses the package manager [pnpm](https://pnpm.io/) to run scripts.
|
|||
> [!TIP]
|
||||
> Use `pnpm --filter <package_selector> build` to build a sepecific subset of packages or a single package and output to respective `dist` directory/directories. For more information about selecting/filtering specific packages, read [pnpm's documentation on filtering](https://pnpm.io/filtering).
|
||||
|
||||
### Package: `prozilla-os-demo`
|
||||
### Internal package: `@prozilla-os/demo`
|
||||
|
||||
| Script | Linked package script |
|
||||
| --- | --- |
|
||||
| <pre>pnpm run site:start</pre> | [`pnpm run start`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run site:build</pre> | [`pnpm run build`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run site:preview</pre> | [`pnpm run preview`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run site:stage</pre> | [`pnpm run stage`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run site:deploy</pre> | [`pnpm run deploy`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run site:fetch</pre> | [`pnpm run fetch`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run demo:start</pre> | [`pnpm run start`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run demo:build</pre> | [`pnpm run build`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run demo:preview</pre> | [`pnpm run preview`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run demo:stage</pre> | [`pnpm run stage`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run demo:deploy</pre> | [`pnpm run deploy`](./packages/demo/README.md#scripts)
|
||||
| <pre>pnpm run demo:fetch</pre> | [`pnpm run fetch`](./packages/demo/README.md#scripts)
|
||||
|
||||
### Package: `prozilla-os-docs`
|
||||
### Internal package: `@prozilla-os/docs`
|
||||
|
||||
| Script | Linked package script |
|
||||
| --- | --- |
|
||||
|
|
|
|||
32
package.json
32
package.json
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "prozilla-os-monorepo",
|
||||
"name": "@prozilla-os/monorepo",
|
||||
"private": true,
|
||||
"author": {
|
||||
"name": "Prozilla",
|
||||
|
|
@ -10,24 +10,24 @@
|
|||
"type": "module",
|
||||
"scripts": {
|
||||
"preinstall": "npx only-allow pnpm",
|
||||
"start": "pnpm run site:start",
|
||||
"start": "pnpm run demo:start",
|
||||
"prebuild": "rimraf dist",
|
||||
"build": "pnpm run packages:build && pnpm run docs:build && pnpm run site:build",
|
||||
"build": "pnpm run packages:build && pnpm run docs:build && pnpm run demo:build",
|
||||
"predeploy": "rimraf dist",
|
||||
"deploy": "pnpm run docs:build && pnpm run docs:stage && pnpm run site:deploy",
|
||||
"deploy": "pnpm run docs:build && pnpm run docs:stage && pnpm run demo:deploy",
|
||||
"publish": "pnpm vite-node packages/demo/scripts/deploy",
|
||||
"site:start": "pnpm --filter prozilla-os-demo run start",
|
||||
"site:build": "pnpm --filter prozilla-os-demo run build",
|
||||
"site:preview": "pnpm --filter prozilla-os-demo run preview",
|
||||
"site:stage": "pnpm --filter prozilla-os-demo run stage",
|
||||
"site:deploy": "pnpm --filter prozilla-os-demo run deploy",
|
||||
"site:fetch": "pnpm --filter prozilla-os-demo run fetch",
|
||||
"docs:start": "pnpm --filter prozilla-os-docs run start",
|
||||
"docs:build": "pnpm --filter prozilla-os-docs run build",
|
||||
"docs:stage": "pnpm --filter prozilla-os-docs run stage",
|
||||
"docs:preview": "pnpm --filter prozilla-os-docs run preview",
|
||||
"docs:generate": "pnpm --filter prozilla-os-docs run generate",
|
||||
"packages:build": "pnpm -r --sequential --filter @prozilla-os/* --filter prozilla-os build",
|
||||
"demo:start": "pnpm --filter @prozilla-os/demo run start",
|
||||
"demo:build": "pnpm --filter @prozilla-os/demo run build",
|
||||
"demo:preview": "pnpm --filter @prozilla-os/demo run preview",
|
||||
"demo:stage": "pnpm --filter @prozilla-os/demo run stage",
|
||||
"demo:deploy": "pnpm --filter @prozilla-os/demo run deploy",
|
||||
"demo:fetch": "pnpm --filter @prozilla-os/demo run fetch",
|
||||
"docs:start": "pnpm --filter @prozilla-os/docs run start",
|
||||
"docs:build": "pnpm --filter @prozilla-os/docs run build",
|
||||
"docs:stage": "pnpm --filter @prozilla-os/docs run stage",
|
||||
"docs:preview": "pnpm --filter @prozilla-os/docs run preview",
|
||||
"docs:generate": "pnpm --filter @prozilla-os/docs run generate",
|
||||
"packages:build": "pnpm -r --sequential --filter prozilla-os... build",
|
||||
"packages:update": "npx changeset && pnpm changeset version",
|
||||
"packages:release": "pnpm changeset publish"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
|
||||
**🔗 [os.prozilla.dev](https://os.prozilla.dev/)**
|
||||
|
||||
`prozilla-os-demo` is a React Vite website that demonstrates the features of ProzillaOS.
|
||||
`@prozilla-os/demo` is a React Vite website that demonstrates the features of ProzillaOS.
|
||||
|
||||
## Scripts
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "prozilla-os-demo",
|
||||
"name": "@prozilla-os/demo",
|
||||
"private": true,
|
||||
"author": {
|
||||
"name": "Prozilla",
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
|
||||
**🔗 [os.prozilla.dev/docs](https://os.prozilla.dev/docs)**
|
||||
|
||||
`prozilla-os-docs` is a VitePress website that contains the documentation for ProzillaOS.
|
||||
`@prozilla-os/docs` is a VitePress website that contains the documentation for ProzillaOS.
|
||||
|
||||
## Scripts
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "prozilla-os-docs",
|
||||
"name": "@prozilla-os/docs",
|
||||
"private": true,
|
||||
"author": {
|
||||
"name": "Prozilla",
|
||||
|
|
|
|||
Loading…
Reference in a new issue