@dallaylaen/ski-interpreter 2.6.3 → 2.8.0

package/CHANGELOG.md

@@ -5,6 +5,50 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.8.0] - 2026-04-23
+
+### BREAKING CHANGES
+
+- `parse()` no longer auto-inlines aliases unless they are redefined; known aliases are preserved by name.
+- `toposort()` signature changed to use options object instead of positional parameters.
+
+### Added
+
+- `Expr.declare()` — emits a complete, round-trippable declaration of an expression including its dependencies.
+- `parse(..., { canonize: true })` — calculates properties of intermediate aliases during parsing.
+- `annotate()` — public rename of the semi-official `_setup()` method, with added documentation.
+- Quest UI: "reveal solution" button added.
+- Quest UI: raw user input is now saved when a quest is solved.
+- CLI (`bin/ski.js`): outputs full declarations instead of bare expressions.
+
+### Changed
+
+- `toJSON()` now outputs back-parsable declaration instead of just string.
+- `toposort` moved into `expr.ts`.
+- `extras.ts` delegates to `Expr.declare()` instead of re-implementing the logic.
+- Internal type `{ ... }` renamed to `Record<string, Named>` for clarity.
+
+### Fixed
+
+- `Expr.toLambda` was incorrectly preparing term (#24).
+
+## [2.7.0] - 2026-04-03
+
+### BREAKING CHANGES
+
+- Remove `SKI.schemas`.
+
+### Added
+
+- `SKI.extras.checkFormatOptions` that returns { value: FormatOptions } 
+or { error: object } for validating format options.
+- Rendered documentation at https://dallaylaen.github.io/ski-interpreter/man
+
+### Changed
+- Way better core documentation
+- Removed [zod](https://www.npmjs.com/package/zod) dependency
+for good, seems like overkill here.
+
 ## [2.6.3] - 2026-03-30
 
 ### Added

package/README.md

@@ -124,6 +124,8 @@ will start a node shell with the `SKI` class available as a global variable.
 
 # Usage
 
+See the [complete API reference](https://dallaylaen.github.io/ski-interpreter/man/) for gory details.
+
 ## A minimal example
 
 ```javascript

package/bin/ski.js

@@ -8,6 +8,7 @@ const { Quest } = SKI;
 const { version } = require('../package.json');
 
 const runOptions = {};
+/** @type FormatOptions */
 let format = {};
 let verbose = false;
 
@@ -165,20 +166,17 @@ function processLine (source, ski, onErr) {
     return; // nothing to see here
 
   try {
-    const expr = ski.parse(source);
+    const expr = ski.parse(source, { canonize: true });
+    if (expr instanceof SKI.classes.Alias)
+      ski.add(expr);
     const t0 = new Date();
-    const isAlias = expr instanceof SKI.classes.Alias;
-    const aliasName = isAlias ? expr.name : null;
 
     for (const state of expr.walk(runOptions)) {
-      if (state.final)
+      if (state.final) {
         console.log(`// ${state.steps} step(s) in ${new Date() - t0}ms`);
-
-      if (verbose || state.final)
-        console.log(state.expr.format(format));
-
-      if (state.final && isAlias && aliasName)
-        ski.add(aliasName, state.expr);
+        console.log(state.expr.declare({ ...format, inventory: ski.getTerms() }));
+      } else if (verbose)
+        console.log(state.expr.format(format) + ';');
     }
   } catch (err) {
     onErr(err);
@@ -389,7 +387,10 @@ function handleCommand (input, ski) {
 }
 
 function setFormat (options) {
-  format = SKI.schemas.FormatOptions.parse(JSON.parse(options));
+  const maybe = SKI.extras.checkFormatOptions(JSON.parse(options));
+  if (!maybe.value)
+    throw new Error('Invalid format options: ' + JSON.stringify(maybe.error));
+  format = maybe.value;
 }
 
 function toInt (comment) {