visaljs 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Visal In
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
+# visaljs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An ahead-of-time JavaScript to C compiler: `visaljs build` turns a JavaScript program (ES modules,
+CommonJS, `node_modules`) into a native binary.
+
+```sh
+npm install -g visaljs
+visaljs build app.js -o app
+./app
+```
+
+Needs Node 22 or later and a C compiler (`cc`, `gcc` or `clang`). Linux and macOS for now; on Windows, run it under WSL.
+The C runtime is built on first use and cached in `~/.cache/visaljs`.
+
+`visaljs build` reports each step as it goes:
+
+```
+ ✓ 🔍 Detected GCC 13.3.0  10ms
+ ✓ 📦 Rolled 6 modules into a single file (63.7 kB)  37ms
+ ✓ 🌳 Parsed 1,988 lines of JavaScript  60ms
+ ✓ 🧩 Compiled 1 regular expression  6ms
+ ✓ 🔧 Converted 272 functions to IR and optimized them  46ms
+ ✓ 📝 Emitted 21,951 lines of C code (1.2 MB)  39ms
+ ✓ 📚 Runtime libraries ready (cached ⚡)  39ms
+ ✓ 🔨 Compiled the binary (-O2, stripped)  6.57s
+
+ 🎉 Built srv in 6.85s: 1.2 MB, fits on a floppy disk 💾
+```
+
+```
+usage: visaljs build <entry.js> [options]
+
+options:
+  -o <file>          output binary
+  --emit-c <dir>     stop after C emission
+  --dump-ast         print the syntax tree and stop
+  --dump-ir          print the IR and stop
+  --debug            build without optimization (-O0), keeping symbols and debug info
+  --embed-source     embed the source text: Function.prototype.toString returns it
+  --all-builtins     install every built-in, not only those the program names
+  --no-bundle        skip the bundler: the input is one ES module (a bundle)
+  --script           compile as a classic script (sloppy mode, no bundler)
+  -q, --quiet        don't report each step of the build
+  --version          print the version
+  --help             print this help
+```