@hyperscale0/hsx 1.0.0-beta.1 → 1.0.0

package/docs/llms.txt

@@ -0,0 +1,45 @@
+<!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
+
+# HSX documentation
+
+> Repository guide and generated compiler reference for HSX 1.0.0.
+
+## Guide
+
+[Your first program](guide/01-first-program.md): Hand-written chapter with compiler-checked programs.
+[Money](guide/02-money.md): Hand-written chapter with compiler-checked programs.
+[Instruments](guide/03-instruments.md): Hand-written chapter with compiler-checked programs.
+[Lifecycles](guide/04-lifecycles.md): Hand-written chapter with compiler-checked programs.
+[Fees and splits](guide/05-fees-and-splits.md): Hand-written chapter with compiler-checked programs.
+[Schedules](guide/06-schedules.md): Hand-written chapter with compiler-checked programs.
+[Composition](guide/07-composition.md): Hand-written chapter with compiler-checked programs.
+[Writing a module](guide/08-writing-a-module.md): Hand-written chapter with compiler-checked programs.
+[Cost](guide/09-cost.md): Hand-written chapter with compiler-checked programs.
+[Diagnostics](guide/10-diagnostics.md): Hand-written chapter with compiler-checked programs.
+
+## Reference
+
+[Grammar](reference/grammar.md): Lexer, clause, and module vocabulary.
+[Types](reference/types.md): HSX type kinds.
+[Diagnostics](reference/diagnostics.md): Stable HSX diagnostic codes and fixes.
+[CLI](reference/cli.md): Generated command usage.
+[UDL output](reference/udl-output.md): Compile artifacts and canonical output.
+[advance](reference/std/advance.md): Standard-library module.
+[cancellable_booking](reference/std/cancellable_booking.md): Standard-library module.
+[captured_payment](reference/std/captured_payment.md): Standard-library module.
+[conditional_disbursement](reference/std/conditional_disbursement.md): Standard-library module.
+[credit_facility](reference/std/credit_facility.md): Standard-library module.
+[held_payment](reference/std/held_payment.md): Standard-library module.
+[instant_transfer](reference/std/instant_transfer.md): Standard-library module.
+[metered](reference/std/metered.md): Standard-library module.
+[pooled_split](reference/std/pooled_split.md): Standard-library module.
+[premium_forward](reference/std/premium_forward.md): Standard-library module.
+[reconciled_payout](reference/std/reconciled_payout.md): Standard-library module.
+[recurring_collection](reference/std/recurring_collection.md): Standard-library module.
+[rotating_pool](reference/std/rotating_pool.md): Standard-library module.
+[scheduled](reference/std/scheduled.md): Standard-library module.
+[security_deposit](reference/std/security_deposit.md): Standard-library module.
+[settlement_batch](reference/std/settlement_batch.md): Standard-library module.
+[swap](reference/std/swap.md): Standard-library module.
+[threshold_pool](reference/std/threshold_pool.md): Standard-library module.
+[weighted_distribution](reference/std/weighted_distribution.md): Standard-library module.

package/docs/playground.md

@@ -0,0 +1,54 @@
+# Browser playground
+
+The HSX playground is a static browser application for authoring, editing,
+and inspecting HSX programs without a server. It runs the compiler directly
+in the browser client.
+
+## What it provides
+
+- Source editor with line numbers and debounced compilation (200 ms).
+- Verdict badge showing `valid`, `warning`, or `invalid`.
+- Diagnostics panel with stage, code, line and column coordinates, message,
+  and suggested fix. Clicking any diagnostic focuses the editor and highlights
+  the exact source span.
+- Tabbed output pane showing the lowered canonical UDL document as formatted
+  JSON and the UDL cost manifest.
+- Built-in example selector containing the full corpus of test programs and
+  standard-library settlements.
+- Pure client execution with no Node runtime dependencies.
+
+## Build the playground
+
+Generate the examples manifest, bundle the browser assets, and copy static
+files to `open/hsx/playground/dist/`:
+
+```bash
+bun run --cwd open/hsx playground:build
+```
+
+Verify that the generated static bundle contains no Node specifiers or URL
+resolution calls:
+
+```bash
+bun run --cwd open/hsx playground:check
+```
+
+## Serve locally
+
+The deliverable is the static directory under `open/hsx/playground/dist/`.
+Hosting infrastructure is owner-owed. To run the playground locally, serve
+the output directory with any local static file server.
+
+Using Bun:
+
+```bash
+bunx serve open/hsx/playground/dist
+```
+
+Using Python:
+
+```bash
+python3 -m http.server -d open/hsx/playground/dist 8000
+```
+
+Open `http://localhost:8000` in a browser.

package/docs/reference/cli.md

@@ -0,0 +1,35 @@
+<!-- Generated by scripts/docs/build.ts for HSX 1.0.0. Do not edit. -->
+
+# CLI
+
+```text
+hsx 1.0.0, the HSX compiler
+
+Usage:
+  hsx check <file.hsx> [--strict]
+  hsx build <file.hsx> [--out <file.json>] [--strict]
+  hsx cost <file.hsx> [--json] [--out <file.json>] [--strict]
+  hsx explain <HSX####>
+  hsx format <file.hsx>
+  hsx lsp
+  hsx --version
+  hsx --help
+
+Commands:
+  check   Compile and report diagnostics. Prints nothing when the program is clean.
+  build   Compile and write canonical UDL as JSON.
+  cost    Compile and print the version-pinned cost manifest as a table or JSON.
+  explain Print one diagnostic title, fix, and source example.
+  format  Print the source in the one canonical HSX style.
+  lsp     Run the language server over stdin and stdout.
+
+Options:
+  --json        Print the cost manifest as JSON instead of a table.
+  --out <file>  Write build or cost JSON to this path instead of stdout.
+  --strict      Treat warning-severity diagnostics as failures.
+
+Exit codes:
+  0  the program compiled (verdict valid, or warning without --strict)
+  1  the program was refused (verdict invalid, or warning with --strict)
+  2  the command line or the input file could not be used
+```