@ecmaos/kernel 0.2.4 → 0.2.6

package/README.md

@@ -63,10 +63,12 @@ The goal is to create a kernel and supporting apps that tie together modern web
 
 - `Apps`
   - These are full applications that are developed specifically to work with ecmaOS
+  - Refer to the full list of [official published apps on npm](https://www.npmjs.com/org/ecmaos-apps)
+  - See the [./APPS.md](./APPS.md) file for a list of community apps; submit a PR to add your app!
   - An app is an npm package, in which the bin file has a shebang line of `#!ecmaos:bin:app:myappname`
   - Its default export (or exported `main` function) will be called with the `ProcessEntryParams` object
-  - They can be installed from the terminal using the `install` command, e.g. `# install @ecmaos-apps/boilerplate`
-  - Run the installed app: `# /usr/bin/boilerplate arg1 arg2` *(absolute path not required)*
+  - They can be installed from the terminal using the `install` command, e.g. `# install @ecmaos-apps/code`
+  - Run the installed app (bins are linked to `/usr/bin`): `# code /root/hello.js`
   - During development, it can be useful to run a [Verdaccio](https://github.com/verdaccio/verdaccio) server to test local packages
   - To publish to Verdaccio, run `# npm publish --registry http://localhost:4873` in your app's development environment
   - Then to install from your local registry, run `# install @myscope/mypackage --registry http://localhost:4873`
@@ -77,15 +79,13 @@ The goal is to create a kernel and supporting apps that tie together modern web
   - The main idea is that data and custom code can be loaded into it from the OS for WASM-native performance, as well as providing various utilities
   - Confusingly, the Kernel loads the BIOS — not the other way around
 
-- `Core`
-  - Core modules provide the system's essential functionality; this includes the kernel itself
-  - Other core modules include BIOS, Jaffa, Metal, SWAPI, as well as the main `@ecmaos/types` package
-
 - `Commands`
   - Commands are small utilities that aren't quite full Apps, provided by the shell
   - Some builtin commands that exist now will be moved into separate apps over time
 
 - `Devices`
+  - Refer to the full list of [official devices on npm](https://www.npmjs.com/org/ecmaos-devices)
+  - See the [./DEVICES.md](./DEVICES.md) file for a list of community devices; submit a PR to add your device!
   - Devices get loaded on boot, e.g. `/dev/bluetooth`, `/dev/random`, `/dev/battery`, etc.
   - A device can support being "run" by a user, e.g. `# /dev/battery status`
   - Devices may also be directly read/written using `fs` methods, and will behave accordingly (or have no effect if not supported)
@@ -128,10 +128,12 @@ The goal is to create a kernel and supporting apps that tie together modern web
   - Authenticated and encrypted connections with JWK/JWE/JOSE
 
 - `Modules`
+  - Refer to the full list of [official modules on npm](https://www.npmjs.com/org/ecmaos-modules)
+  - See the [./MODULES.md](./MODULES.md) file for a list of community modules; submit a PR to add your module!
   - Modules are dynamically loaded into the kernel at boot and can be enabled or disabled
   - They are specified during build via the `VITE_KERNEL_MODULES` environment variable
-    - e.g. `VITE_KERNEL_MODULES=@ecmaos-modules/sample@0.1.2,@your/package@1.2.3`
-  - Versions must be exact and are mandatory - you cannot use NPM version specifiers
+    - e.g. `VITE_KERNEL_MODULES=@ecmaos-modules/boilerplate@0.1.0,@your/package@1.2.3`
+  - Versions must be pinned and are mandatory - you cannot use NPM version specifiers
   - They can provide additional functionality, devices, commands, etc.
   - They offer a [common interface](./core/types/modules.ts) for interacting with the kernel
   - Generally they should be written in [AssemblyScript](https://www.assemblyscript.org), but this isn't required
@@ -155,6 +157,20 @@ The goal is to create a kernel and supporting apps that tie together modern web
 - `Utils`
   - Utilities and configuration used during development
 
+## Important Files and Directories
+
+- `/bin/`: Built-in commands
+- `/bios/`: The BIOS filesystem
+- `/boot/init`: A script that runs on boot
+- `/dev/`: All devices are here
+- `/etc/packages`: A list of installed packages to load on boot
+- `/home/`: Contains user home directories
+- `/proc/`: A directory containing various dynamic system information
+- `/root/`: The home directory for the root user
+- `/usr/bin/`: Executable packages get linked here
+- `/usr/lib/`: All installed packages are here
+- `/var/log/kernel.log`: The kernel log
+
 ## Command Examples
 
 ```sh
@@ -221,6 +237,22 @@ cat /dev/zero --bytes 10 > /dev/null
 
 Note: many device implementations are incomplete, but provide a solid starting point
 
+## Code Execution Example
+
+```sh
+echo "window.alert('Hello, world!')" > /root/hello.js
+load /root/hello.js
+```
+
+## App Development
+
+The `apps` directory in the repository contains a number of examples of how to develop apps, but there are many approaches you could take.
+
+- `@ecmaos-apps/boilerplate`: A minimal boilerplate app for developing new apps
+- `@ecmaos-apps/code`: A simple code editor app using [Monaco](https://microsoft.github.io/monaco-editor/); serves as a good reference for more complex apps
+
+Basically, your app's [bin](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#bin) file has a `main` (or default) function export that is passed the kernel reference and can use it to interact with the system as needed. A shebang line of `#!ecmaos:bin:app:myappname` is required at the top of the bin file to identify it as an app.
+
 ## Early Days
 
 The kernel is currently in active development. It is not considered stable and the structure and API are very likely to change in unexpected and possibly unannounced ways until version 1.0.0. Use cautiously and at your own risk.
@@ -230,8 +262,9 @@ Things to keep in mind:
 - Things have changed a lot since the tests were written, so they need to be updated and fixed
 - The kernel is designed to be run in an environment with a DOM (i.e. a browser)
 - Many features are only available on Chromium-based browsers, and many more behind feature flags
+- There will be a lot of technical challenges to overcome, and many things will first be implemented in a non-optimal way
 - Command interfaces won't match what you might be used to from a traditional Linux environment; not all commands and options are supported. Over time, Linuxish commands will be fleshed out and made to behave in a more familiar way.
-- Globbing doesn't work in the terminal yet
+- Globbing doesn't work in the terminal yet, [but is supported at the filesystem level](https://zenfs.dev/core/functions/fs.promises.glob.html)
 
 ## Development
 
@@ -247,9 +280,9 @@ git clone https://github.com/ecmaos/ecmaos.git
 cd ecmaos && pnpm install
 
 # Run the dev server
-pnpm run dev
+pnpm run dev:kernel
 
-# Run the docs server
+# Run the docs server (optional)
 pnpm run dev:docs
 
 # Build
@@ -263,7 +296,9 @@ pnpm run test:bench
 pnpm run test:ui
 
 # Generate modules
+turbo gen app # generate a new app template
 turbo gen device # generate a new device template
+turbo gen module # generate a new module template
 ```
 
 Also see [turbo.json](./turbo.json) and [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

package/dist/.vite/manifest.json

@@ -1,18 +1,18 @@
 {
-  "_browser-CoSyrw7Q.js": {
-    "file": "browser-CoSyrw7Q.js",
+  "_browser-C0q0NWWv.js": {
+    "file": "browser-C0q0NWWv.js",
     "name": "browser",
     "isDynamicEntry": true,
     "imports": [
-      "_empty-DAF3BgdH.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
-  "_empty-DAF3BgdH.js": {
-    "file": "empty-DAF3BgdH.js",
+  "_empty-BMkCc_7L.js": {
+    "file": "empty-BMkCc_7L.js",
     "name": "empty",
     "dynamicImports": [
-      "_topbar.min-CYYqkupv.js",
-      "_browser-CoSyrw7Q.js",
+      "_topbar.min-xBbuiIjv.js",
+      "_browser-C0q0NWWv.js",
       "src/tree/lib/commands/install.ts",
       "node_modules/.pnpm/figlet@1.8.0/node_modules/figlet/importable-fonts/Poison.js"
     ]
@@ -21,12 +21,12 @@
     "file": "kernel.css",
     "src": "_kernel.css"
   },
-  "_topbar.min-CYYqkupv.js": {
-    "file": "topbar.min-CYYqkupv.js",
+  "_topbar.min-xBbuiIjv.js": {
+    "file": "topbar.min-xBbuiIjv.js",
     "name": "topbar.min",
     "isDynamicEntry": true,
     "imports": [
-      "_empty-DAF3BgdH.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
   "node_modules/.pnpm/figlet@1.8.0/node_modules/figlet/importable-fonts/Poison.js": {
@@ -41,16 +41,16 @@
     "src": "src/tree/kernel.ts",
     "isEntry": true,
     "imports": [
-      "_empty-DAF3BgdH.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
   "src/tree/lib/commands/install.ts": {
-    "file": "install--B0gJ8Dk.js",
+    "file": "install-C64fBUI2.js",
     "name": "install",
     "src": "src/tree/lib/commands/install.ts",
     "isDynamicEntry": true,
     "imports": [
-      "_empty-DAF3BgdH.js"
+      "_empty-BMkCc_7L.js"
     ]
   },
   "src/ui.ts": {
@@ -59,7 +59,7 @@
     "src": "src/ui.ts",
     "isEntry": true,
     "imports": [
-      "_empty-DAF3BgdH.js"
+      "_empty-BMkCc_7L.js"
     ]
   }
 }

package/dist/{browser-CoSyrw7Q.js → browser-C0q0NWWv.js}

@@ -1,4 +1,4 @@
-import { g as getDefaultExportFromCjs } from "./empty-DAF3BgdH.js";
+import { g as getDefaultExportFromCjs } from "./empty-BMkCc_7L.js";
 var browser$2;
 var hasRequiredBrowser;
 function requireBrowser() {
@@ -20,4 +20,4 @@ const browser$1 = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePro
 export {
   browser$1 as b
 };
-//# sourceMappingURL=browser-CoSyrw7Q.js.map
+//# sourceMappingURL=browser-C0q0NWWv.js.map

package/dist/{browser-CoSyrw7Q.js.map → browser-C0q0NWWv.js.map}

@@ -1 +1 @@
-{"version":3,"file":"browser-CoSyrw7Q.js","sources":["../node_modules/.pnpm/ws@8.18.0/node_modules/ws/browser.js"],"sourcesContent":["'use strict';\n\nmodule.exports = function () {\n  throw new Error(\n    'ws does not work in the browser. Browser clients must use the native ' +\n      'WebSocket object'\n  );\n};\n"],"names":["browser"],"mappings":";;;;;;AAEAA,cAAiB,WAAY;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IAED;AAAA,EACF;;;;;;;;;","x_google_ignoreList":[0]}
+{"version":3,"file":"browser-C0q0NWWv.js","sources":["../node_modules/.pnpm/ws@8.18.0/node_modules/ws/browser.js"],"sourcesContent":["'use strict';\n\nmodule.exports = function () {\n  throw new Error(\n    'ws does not work in the browser. Browser clients must use the native ' +\n      'WebSocket object'\n  );\n};\n"],"names":["browser"],"mappings":";;;;;;AAEAA,cAAiB,WAAY;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IAED;AAAA,EACF;;;;;;;;;","x_google_ignoreList":[0]}