@dallaylaen/ski-interpreter 2.3.2 → 2.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dallaylaen/ski-interpreter",
-  "version": "2.3.2",
+  "version": "2.4.0",
   "description": "Simple Kombinator Interpreter - a combinatory logic & lambda calculus parser and interpreter. Supports SKI, BCKW, Church numerals, and setting up assertions ('quests') involving all of the above.",
   "keywords": [
     "combinatory logic",
@@ -11,26 +11,26 @@
   ],
   "type": "commonjs",
   "main": "lib/ski-interpreter.cjs.js",
+  "types": "lib/types/index.d.ts",
   "module": "lib/ski-interpreter.esm.js",
   "exports": {
     "import": "./lib/ski-interpreter.esm.js",
     "require": "./lib/ski-interpreter.cjs.js"
   },
-  "types": "types/index.d.ts",
   "bin": {
     "ski": "bin/ski.js"
   },
   "scripts": {
-    "lint": "npx eslint --ext .js,.ts src test index.js bin",
-    "types": "npx -p typescript tsc index.js --declaration --allowJs --emitDeclarationOnly --outDir types",
-    "test": "npx nyc mocha --recursive test",
-    "build-web": "npx esbuild --bundle --minify --sourcemap --format=iife ./index.js --outfile=docs/build/js/ski-interpreter.min.js",
-    "build-cjs": "npx esbuild --bundle --sourcemap --format=cjs ./index.js --outfile=lib/ski-interpreter.cjs.js",
-    "build-esm": "npx esbuild --bundle --sourcemap --format=esm ./index.js --outfile=lib/ski-interpreter.esm.js",
+    "lint": "npx eslint --ext .js,.ts src test bin",
+    "tsc": "npx tsc",
+    "test": "npm run tsc; npx nyc mocha --recursive test",
+    "build-web": "npx esbuild --bundle --minify --sourcemap --format=iife ./src/index.ts --outfile=docs/build/js/ski-interpreter.min.js",
+    "build-cjs": "npx esbuild --bundle --sourcemap --format=cjs ./src/index.ts --outfile=lib/ski-interpreter.cjs.js",
+    "build-esm": "npx esbuild --bundle --sourcemap --format=esm ./src/index.ts --outfile=lib/ski-interpreter.esm.js",
     "build-site": "npx esbuild --bundle --minify --sourcemap ./site-src/index.js --outfile=docs/build/js/util.min.js",
     "build-quest": "npx esbuild --bundle --minify --sourcemap --format=iife ./site-src/index-quest.js --outfile=docs/build/js/ski-quest.min.js",
-    "build-all": "npm run build-cjs && npm run build-esm && npm run build-web && npm run build-quest",
-    "build": "npm run lint && npm run types && npm run test && npm run build-all",
+    "build-all": "npm run build-cjs && npm run build-esm && npm run build-web && npm run build-site && npm run build-quest",
+    "build": "npm run lint && npm run tsc && npm run test && npm run build-all",
     "prepack": "npm run build && cp docs/build/js/ski-* lib/"
   },
   "files": [
@@ -38,8 +38,7 @@
     "README.md",
     "LICENSE",
     "CHANGELOG.md",
-    "lib",
-    "types"
+    "lib"
   ],
   "repository": {
     "type": "git",
@@ -52,6 +51,8 @@
   },
   "homepage": "https://dallaylaen.github.io/ski-interpreter/index.html",
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
+    "@typescript-eslint/parser": "^8.56.1",
     "chai": "^4.3.7",
     "esbuild": "^0.25.10",
     "eslint": "^8.57.0",

package/types/index.d.ts

@@ -1,3 +0,0 @@
-import { SKI } from "./src/parser";
-import { Quest } from "./src/quest";
-export { SKI, Quest };

package/types/src/quest.d.ts

@@ -1,257 +0,0 @@
-export type CaseResult = {
-    pass: boolean;
-    reason?: string;
-    steps: number;
-    start: typeof import("./expr").Expr;
-    found: typeof import("./expr").Expr;
-    expected: typeof import("./expr").Expr;
-    note?: string;
-    args: typeof import("./expr").Expr[];
-    case: Case;
-};
-export type Capability = {
-    linear?: boolean;
-    affine?: boolean;
-    normal?: boolean;
-    proper?: boolean;
-    discard?: boolean;
-    duplicate?: boolean;
-    arity?: number;
-};
-export type InputSpec = string | {
-    name: string;
-    fancy?: string;
-    allow?: string;
-    numbers?: boolean;
-    lambdas?: boolean;
-};
-export type QuestResult = {
-    pass: boolean;
-    details: CaseResult[];
-    expr?: typeof import("./expr").Expr;
-    input: typeof import("./expr").Expr[] | string[];
-    exception?: Error;
-    steps: number;
-    weight?: number;
-};
-export type SelfCheck = {
-    accepted?: string[][];
-    rejected?: string[][];
-};
-/**
- * @typedef {{
- *   pass: boolean,
- *   reason?: string,
- *   steps: number,
- *   start: Expr,
- *   found: Expr,
- *   expected: Expr,
- *   note?: string,
- *   args: Expr[],
- *   case: Case
- * }} CaseResult
- */
-/**
- * @typedef {{
- *   linear?: boolean,
- *   affine?: boolean,
- *   normal?: boolean,
- *   proper?: boolean,
- *   discard?: boolean,
- *   duplicate?: boolean,
- *   arity?: number,
- * }} Capability
- */
-/**
- * @typedef {
- *   [string, string]
- *   | [{max?: number}, string, string]
- *   | [{caps: Capability, max?: number}, string]
- * } TestCase
- */
-/**
- * @typedef {string | {name: string, fancy?: string, allow?: string, numbers?: boolean, lambdas?: boolean}} InputSpec
- */
-/**
- * @typedef {{
- *   pass: boolean,
- *   details: CaseResult[],
- *   expr?: Expr,
- *   input: Expr[]|string[],
- *   exception?: Error,
- *   steps: number,
- *   weight?: number
- * }} QuestResult
- */
-/**
- * @typedef {{
- *    input: InputSpec | InputSpec[],
- *    cases: TestCase[],
- *
- *    // the rest is optional
- *
- *    allow?: string,
- *    numbers?: boolean,
- *    env?: string[],
- *    engine?: SKI,
- *    engineFull?: SKI,
- *
- *    // metadata, also any fields not listed here will go to quest.meta.???
- *    id?: string|number,
- *    name?: string,
- *    intro?: string|string[], // multiple strings will be concatenated with spaces
- * }} QuestSpec
- */
-/**
- * @typedef {{ accepted?: string[][], rejected?: string[][] }} SelfCheck
- */
-export class Quest {
-    /**
-     * @description A combinator problem with a set of test cases for the proposed solution.
-     * @param {QuestSpec} options
-     * @example const quest = new Quest({
-     *    input: 'identity',
-     *    cases: [
-     *      ['identity x', 'x'],
-     *    ],
-     *    allow: 'SK',
-     *    intro: 'Find a combinator that behaves like the identity function.',
-     * });
-     * quest.check('S K K'); // { pass: true, details: [...], ... }
-     * quest.check('K S');   // { pass: false, details: [...], ... }
-     * quest.check('K x');   // fail! internal variable x is not equal to free variable x,
-     *                       //     despite having the same name.
-     * quest.check('I');     // fail! I not in the allowed list.
-     */
-    constructor(options: QuestSpec);
-    engine: any;
-    engineFull: any;
-    restrict: {
-        allow: QuestSpec;
-        numbers: any;
-        lambdas: any;
-    };
-    env: {};
-    input: any[];
-    envFull: {};
-    cases: any[];
-    name: any;
-    intro: any;
-    id: any;
-    meta: QuestSpec;
-    /**
-     *   Display allowed terms based on what engine thinks of this.env + this.restrict.allow
-     *   @return {string}
-     */
-    allowed(): string;
-    addInput(term: any): void;
-    /**
-     *
-     * @param {{} | string} opt
-     * @param {string} terms
-     * @return {Quest}
-     */
-    add(opt: {} | string, ...terms: string): Quest;
-    /**
-     * @description Statefully parse a list of strings into expressions or fancy aliases thereof.
-     * @param {string[]} input
-     * @return {{terms: Expr[], weight: number}}
-     */
-    prepare(...input: string[]): {
-        terms: typeof import("./expr").Expr[];
-        weight: number;
-    };
-    /**
-     *
-     * @param {string} input
-     * @return {QuestResult}
-     */
-    check(...input: string): QuestResult;
-    verify(options: any): {
-        date: string;
-    };
-    /**
-     * @desc Verify that solutions that are expected to pass/fail do so.
-     * @param {SelfCheck|{[key: string]: SelfCheck}} dataset
-     * @return {{shouldPass: {input: string[], result: QuestResult}[], shouldFail: {input: string[], result: QuestResult}[]} | null}
-     */
-    verifySolutions(dataset: SelfCheck | {
-        [key: string]: SelfCheck;
-    }): {
-        shouldPass: {
-            input: string[];
-            result: QuestResult;
-        }[];
-        shouldFail: {
-            input: string[];
-            result: QuestResult;
-        }[];
-    } | null;
-    verifyMeta(options?: {}): {
-        date: string;
-    };
-    /**
-       *
-       * @return {TestCase[]}
-       */
-    show(): TestCase[];
-}
-export namespace Quest {
-    export { Group };
-    export { Case };
-}
-declare class Case {
-    /**
-     * @param {FreeVar[]} input
-     * @param {{
-     *   max?: number,
-     *   note?: string,
-     *   env?: {[key:string]: Expr},
-     *   engine: SKI
-     * }} options
-     */
-    constructor(input: typeof import("./expr").FreeVar[], options: {
-        max?: number;
-        note?: string;
-        env?: {
-            [key: string]: typeof import("./expr").Expr;
-        };
-        engine: SKI;
-    });
-    max: number;
-    note: string;
-    env: {
-        [key: string]: typeof import("./expr").Expr;
-    };
-    input: typeof import("./expr").FreeVar[];
-    engine: SKI;
-    parse(src: any): Subst;
-    /**
-     * @param {Expr} expr
-     * @return {CaseResult}
-     */
-    check(...expr: typeof import("./expr").Expr): CaseResult;
-}
-declare class Group {
-    constructor(options: any);
-    name: any;
-    intro: string;
-    id: any;
-    content: any;
-    verify(options: any): {
-        content: any;
-    };
-}
-import { SKI } from "./parser";
-declare class Subst {
-    /**
-     * @descr A placeholder object with exactly n free variables to be substituted later.
-     * @param {Expr} expr
-     * @param {FreeVar[]} env
-     */
-    constructor(expr: typeof import("./expr").Expr, env: typeof import("./expr").FreeVar[]);
-    expr: typeof import("./expr").Expr;
-    env: typeof import("./expr").FreeVar[];
-    apply(list: any): typeof import("./expr").Expr;
-}
-export {};