danvics/ProzillaOS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactor: Changed internal package naming

Browse source
This commit is contained in:
Prozilla 2024-07-09 18:23:31 +02:00
parent 308a42976e
commit 4f03c486d7
No known key found for this signature in database
GPG key ID: 5858DFE71CAF31EE
6 changed files with 34 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -19,7 +19,7 @@ ProzillaOS is a web-based operating system inspired by Ubuntu Linux and Windows.
## Packages ## 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. 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 - [`@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. 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/demo`](./packages/demo/): Demo site
- [`prozilla-os-docs`](./packages/docs/): Documentation site - [`@prozilla-os/docs`](./packages/docs/): Documentation site
## Scripts ## Scripts
@ -59,8 +59,9 @@ ProzillaOS uses the package manager [pnpm](https://pnpm.io/) to run scripts.
| <pre>pnpm&nbsp;run&nbsp;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&nbsp;run&nbsp;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&nbsp;run&nbsp;build</pre> | Build every package in sequential order. | <pre>pnpm&nbsp;run&nbsp;build</pre> | Build every package in sequential order.
| <pre>pnpm&nbsp;run&nbsp;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&nbsp;run&nbsp;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&nbsp;run&nbsp;publish</pre> | Publish the `dist` directory to GitHub pages.
### Libraries ### External packages
| Script | Description | | Script | Description |
| --- | --- | | --- | --- |
@ -71,18 +72,18 @@ ProzillaOS uses the package manager [pnpm](https://pnpm.io/) to run scripts.
> [!TIP] > [!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). > 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 | | Script | Linked package script |
| --- | --- | | --- | --- |
| <pre>pnpm&nbsp;run&nbsp;site:start</pre> | [`pnpm run start`](./packages/demo/README.md#scripts) | <pre>pnpm&nbsp;run&nbsp;demo:start</pre> | [`pnpm run start`](./packages/demo/README.md#scripts)
| <pre>pnpm&nbsp;run&nbsp;site:build</pre> | [`pnpm run build`](./packages/demo/README.md#scripts) | <pre>pnpm&nbsp;run&nbsp;demo:build</pre> | [`pnpm run build`](./packages/demo/README.md#scripts)
| <pre>pnpm&nbsp;run&nbsp;site:preview</pre> | [`pnpm run preview`](./packages/demo/README.md#scripts) | <pre>pnpm&nbsp;run&nbsp;demo:preview</pre> | [`pnpm run preview`](./packages/demo/README.md#scripts)
| <pre>pnpm&nbsp;run&nbsp;site:stage</pre> | [`pnpm run stage`](./packages/demo/README.md#scripts) | <pre>pnpm&nbsp;run&nbsp;demo:stage</pre> | [`pnpm run stage`](./packages/demo/README.md#scripts)
| <pre>pnpm&nbsp;run&nbsp;site:deploy</pre> | [`pnpm run deploy`](./packages/demo/README.md#scripts) | <pre>pnpm&nbsp;run&nbsp;demo:deploy</pre> | [`pnpm run deploy`](./packages/demo/README.md#scripts)
| <pre>pnpm&nbsp;run&nbsp;site:fetch</pre> | [`pnpm run fetch`](./packages/demo/README.md#scripts) | <pre>pnpm&nbsp;run&nbsp;demo:fetch</pre> | [`pnpm run fetch`](./packages/demo/README.md#scripts)
### Package: `prozilla-os-docs` ### Internal package: `@prozilla-os/docs`
| Script | Linked package script | | Script | Linked package script |
| --- | --- | | --- | --- |

32
package.json
View file

@ -1,5 +1,5 @@
{ {
"name": "prozilla-os-monorepo", "name": "@prozilla-os/monorepo",
"private": true, "private": true,
"author": { "author": {
"name": "Prozilla", "name": "Prozilla",
@ -10,24 +10,24 @@
"type": "module", "type": "module",
"scripts": { "scripts": {
"preinstall": "npx only-allow pnpm", "preinstall": "npx only-allow pnpm",
"start": "pnpm run site:start", "start": "pnpm run demo:start",
"prebuild": "rimraf dist", "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", "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", "publish": "pnpm vite-node packages/demo/scripts/deploy",
"site:start": "pnpm --filter prozilla-os-demo run start", "demo:start": "pnpm --filter @prozilla-os/demo run start",
"site:build": "pnpm --filter prozilla-os-demo run build", "demo:build": "pnpm --filter @prozilla-os/demo run build",
"site:preview": "pnpm --filter prozilla-os-demo run preview", "demo:preview": "pnpm --filter @prozilla-os/demo run preview",
"site:stage": "pnpm --filter prozilla-os-demo run stage", "demo:stage": "pnpm --filter @prozilla-os/demo run stage",
"site:deploy": "pnpm --filter prozilla-os-demo run deploy", "demo:deploy": "pnpm --filter @prozilla-os/demo run deploy",
"site:fetch": "pnpm --filter prozilla-os-demo run fetch", "demo:fetch": "pnpm --filter @prozilla-os/demo run fetch",
"docs:start": "pnpm --filter prozilla-os-docs run start", "docs:start": "pnpm --filter @prozilla-os/docs run start",
"docs:build": "pnpm --filter prozilla-os-docs run build", "docs:build": "pnpm --filter @prozilla-os/docs run build",
"docs:stage": "pnpm --filter prozilla-os-docs run stage", "docs:stage": "pnpm --filter @prozilla-os/docs run stage",
"docs:preview": "pnpm --filter prozilla-os-docs run preview", "docs:preview": "pnpm --filter @prozilla-os/docs run preview",
"docs:generate": "pnpm --filter prozilla-os-docs run generate", "docs:generate": "pnpm --filter @prozilla-os/docs run generate",
"packages:build": "pnpm -r --sequential --filter @prozilla-os/* --filter prozilla-os build", "packages:build": "pnpm -r --sequential --filter prozilla-os... build",
"packages:update": "npx changeset && pnpm changeset version", "packages:update": "npx changeset && pnpm changeset version",
"packages:release": "pnpm changeset publish" "packages:release": "pnpm changeset publish"
}, },

2
packages/demo/README.md
View file

@ -15,7 +15,7 @@
**🔗 [os.prozilla.dev](https://os.prozilla.dev/)** **🔗 [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 ## Scripts

2
packages/demo/package.json
View file

@ -1,5 +1,5 @@
{ {
"name": "prozilla-os-demo", "name": "@prozilla-os/demo",
"private": true, "private": true,
"author": { "author": {
"name": "Prozilla", "name": "Prozilla",

2
packages/docs/README.md
View file

@ -15,7 +15,7 @@
**🔗 [os.prozilla.dev/docs](https://os.prozilla.dev/docs)** **🔗 [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 ## Scripts

2
packages/docs/package.json
View file

@ -1,5 +1,5 @@
{ {
"name": "prozilla-os-docs", "name": "@prozilla-os/docs",
"private": true, "private": true,
"author": { "author": {
"name": "Prozilla", "name": "Prozilla",