@jigs.design/compiler 0.3.5 → 0.3.7

package/dist/compile.d.ts

@@ -182,6 +182,28 @@ export interface CompileResult {
    */
   tags: ReadonlySet<string>;
 }
+/** The language's own tags: no component or define may take these names. */
+export declare const RESERVED_TAGS: ReadonlySet<string>;
+/** What `extendLibrary` built, and what it found in each jig. */
+export interface ExtendedLibrary {
+  /**
+   * Each jig's diagnostics, by name, numbered by its own source. A name
+   * here but not in `library` was dropped.
+   */
+  diagnostics: ReadonlyMap<string, ReadonlyArray<Diagnostic$1>>;
+  /** `base`, then each jig that entered, in order. */
+  library: Library;
+}
+/**
+ * `base` extended by `jigs`, in order, leniently: a jig may use `base`
+ * and the jigs before it. Never throws. A jig enters when its source has
+ * exactly one `<define>`, of its name, whose name is not already in the
+ * library, and none of its findings leave code that cannot run (an
+ * `undefined_reference`, an `invalid_statement`, an `unclosed` tag). A
+ * jig with other findings, such as an unknown component or prop, enters
+ * with what still compiles, and its diagnostics say what was removed.
+ */
+export declare function extendLibrary(base: Library, jigs: ReadonlyArray<Jig>, catalog: CompileCatalog): ExtendedLibrary;
 /**
  * Compiles `jigs` against `catalog`, in order: a jig may use the ones
  * before it. Throws when a jig has any diagnostic. Cached per catalog and

package/dist/compile.js

@@ -7,6 +7,7 @@ import { parseJigs } from "./parse.js";
 import { isValidValue } from "./spec.js";
 import { blockHoists } from "./block-hoist.js";
 //#region src/compile.ts
+/** The language's own tags: no component or define may take these names. */
 const RESERVED_TAGS = /* @__PURE__ */ new Set([
 	"define",
 	"each",
@@ -896,6 +897,61 @@ function buildLibrary(list, components) {
 	}
 	return built;
 }
+/** Findings that leave a define whose code cannot run: it is dropped. */
+const UNRUNNABLE = /* @__PURE__ */ new Set([
+	"invalid_statement",
+	"unclosed",
+	"undefined_reference"
+]);
+/**
+* `base` extended by `jigs`, in order, leniently: a jig may use `base`
+* and the jigs before it. Never throws. A jig enters when its source has
+* exactly one `<define>`, of its name, whose name is not already in the
+* library, and none of its findings leave code that cannot run (an
+* `undefined_reference`, an `invalid_statement`, an `unclosed` tag). A
+* jig with other findings, such as an unknown component or prop, enters
+* with what still compiles, and its diagnostics say what was removed.
+*/
+function extendLibrary(base, jigs, catalog) {
+	const built = new Map(base);
+	const diagnostics = /* @__PURE__ */ new Map();
+	const seen = /* @__PURE__ */ new Set();
+	const refuse = (jig, found, message) => {
+		diagnostics.set(jig.name, [...found, {
+			code: "invalid_define",
+			message,
+			severity: "error",
+			span: { line: 1 }
+		}]);
+	};
+	for (const jig of jigs) {
+		if (seen.has(jig.name)) continue;
+		seen.add(jig.name);
+		if (built.has(jig.name)) {
+			refuse(jig, [], `<${jig.name}> is already in the library; this one was dropped`);
+			continue;
+		}
+		const result = compileDocument(jig.source, built, catalog);
+		const found = result.findings.map((finding) => toDiagnostic(jig.source, finding));
+		const def = result.defines[0];
+		if (result.defines.length !== 1 || def?.name !== jig.name) {
+			refuse(jig, found, `The source must be one <define name="${jig.name}">; it was dropped`);
+			continue;
+		}
+		diagnostics.set(jig.name, found);
+		if (result.findings.some((finding) => finding.severity === "error" && UNRUNNABLE.has(finding.code))) continue;
+		built.set(def.name, {
+			...def,
+			origin: "library",
+			procedures: result.procedures,
+			tags: result.tags
+		});
+	}
+	return {
+		diagnostics,
+		library: built
+	};
+}
 /**
 * Compiles `jigs` against `catalog`, in order: a jig may use the ones
 * before it. Throws when a jig has any diagnostic. Cached per catalog and
@@ -983,4 +1039,4 @@ function compileJigs(source, options) {
 	} : finding));
 }
 //#endregion
-export { compileJigs, compileLibrary };
+export { RESERVED_TAGS, compileJigs, compileLibrary, extendLibrary };

package/dist/index.d.ts

@@ -2,11 +2,11 @@ import { columnAt, lineAt, rangeIn, spanIn } from "./offsets.js";
 import { JigsNode, Statement } from "./ast.js";
 import { CompileCatalog, ComponentSpec, PropSpec } from "./spec.js";
 import { ProgramOutput } from "./codegen.js";
-import { CompileOptions, CompileResult, CompiledDefine, Diagnostic, Jig, Library, Program, RenderNode, compileJigs, compileLibrary } from "./compile.js";
+import { CompileOptions, CompileResult, CompiledDefine, Diagnostic, ExtendedLibrary, Jig, Library, Program, RESERVED_TAGS, RenderNode, compileJigs, compileLibrary, extendLibrary } from "./compile.js";
 import { DataFields, DataRead, ELEMENT, ProcedureUse } from "./check-code.js";
 import { Hoisted, hoistDeclarations } from "./hoist.js";
 import { parseJigs } from "./parse.js";
 import { nearest } from "./suggest.js";
-import { jigSignature } from "./signature.js";
+import { SignatureOptions, jigSignature } from "./signature.js";
 import { Edit, EditFailure, EditFailureReason, SEARCH_MARKER, applyEdits, editBreakage, isEditReply, parseEdits } from "./patch.js";
-export { type CompileCatalog, type CompileOptions, type CompileResult, type CompiledDefine, type ComponentSpec, type DataFields, type DataRead, type Diagnostic, ELEMENT, type Edit, type EditFailure, type EditFailureReason, type Hoisted, type Jig, type JigsNode, type Library, type ProcedureUse, type Program, type ProgramOutput, type PropSpec, type RenderNode, SEARCH_MARKER, type Statement, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, hoistDeclarations, isEditReply, jigSignature, lineAt, nearest, parseEdits, parseJigs, rangeIn, spanIn };
+export { type CompileCatalog, type CompileOptions, type CompileResult, type CompiledDefine, type ComponentSpec, type DataFields, type DataRead, type Diagnostic, ELEMENT, type Edit, type EditFailure, type EditFailureReason, type ExtendedLibrary, type Hoisted, type Jig, type JigsNode, type Library, type ProcedureUse, type Program, type ProgramOutput, type PropSpec, RESERVED_TAGS, type RenderNode, SEARCH_MARKER, type SignatureOptions, type Statement, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, extendLibrary, hoistDeclarations, isEditReply, jigSignature, lineAt, nearest, parseEdits, parseJigs, rangeIn, spanIn };

package/dist/index.js

@@ -3,7 +3,7 @@ import { nearest } from "./suggest.js";
 import { ELEMENT } from "./check-code.js";
 import { parseJigs } from "./parse.js";
 import { hoistDeclarations } from "./hoist.js";
-import { compileJigs, compileLibrary } from "./compile.js";
+import { RESERVED_TAGS, compileJigs, compileLibrary, extendLibrary } from "./compile.js";
 import { jigSignature } from "./signature.js";
 import { SEARCH_MARKER, applyEdits, editBreakage, isEditReply, parseEdits } from "./patch.js";
-export { ELEMENT, SEARCH_MARKER, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, hoistDeclarations, isEditReply, jigSignature, lineAt, nearest, parseEdits, parseJigs, rangeIn, spanIn };
+export { ELEMENT, RESERVED_TAGS, SEARCH_MARKER, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, extendLibrary, hoistDeclarations, isEditReply, jigSignature, lineAt, nearest, parseEdits, parseJigs, rangeIn, spanIn };

package/dist/signature.d.ts

@@ -1,5 +1,17 @@
 import { Jig } from "./compile.js";
 //#region src/signature.d.ts
-/** `<statCard label value delta={0} note="">…</statCard>` when the define has a slot. */
-export declare function jigSignature(jig: Jig): string;
+export interface SignatureOptions {
+  /**
+   * Print a default that is an expression, such as an array of sample
+   * rows, as `prop={…}` rather than as written, so the signature stays one
+   * line and bounded by its prop names and scalar defaults. Default false.
+   */
+  elideExpressions?: boolean;
+}
+/**
+ * `<statCard label value delta={0} note="">…</statCard>` when the define
+ * has a slot. A string default prints as JSON, so it is one line; an
+ * expression default prints as written unless `elideExpressions`.
+ */
+export declare function jigSignature(jig: Jig, options?: SignatureOptions): string;
 //#endregion

package/dist/signature.js

@@ -1,9 +1,11 @@
 import { parseJigs } from "./parse.js";
 //#region src/signature.ts
-function formatAttr(prop) {
+/** What stands in for an expression default when the signature elides them. */
+const ELIDED = "{…}";
+function formatAttr(prop, elideExpressions) {
 	if (prop.shorthand === true) return prop.name;
 	if (prop.value.kind === "literal") return typeof prop.value.value === "string" ? `${prop.name}=${JSON.stringify(prop.value.value)}` : `${prop.name}={${JSON.stringify(prop.value.value)}}`;
-	return `${prop.name}={${prop.value.code}}`;
+	return elideExpressions ? `${prop.name}=${ELIDED}` : `${prop.name}={${prop.value.code}}`;
 }
 /** A `<slot/>` anywhere in the define's body, ignoring nested defines. */
 function hasSlot(nodes) {
@@ -13,11 +15,16 @@ function hasSlot(nodes) {
 	}
 	return false;
 }
-/** `<statCard label value delta={0} note="">…</statCard>` when the define has a slot. */
-function jigSignature(jig) {
+/**
+* `<statCard label value delta={0} note="">…</statCard>` when the define
+* has a slot. A string default prints as JSON, so it is one line; an
+* expression default prints as written unless `elideExpressions`.
+*/
+function jigSignature(jig, options) {
+	const elide = options?.elideExpressions === true;
 	const define = parseJigs(jig.source).children.find((node) => node.type === "element" && node.name === "define");
 	if (define === void 0) return `<${jig.name}>`;
-	const attrs = define.props.filter((prop) => prop.name !== "name").map((prop) => formatAttr(prop));
+	const attrs = define.props.filter((prop) => prop.name !== "name").map((prop) => formatAttr(prop, elide));
 	const open = attrs.length === 0 ? `<${jig.name}>` : `<${jig.name} ${attrs.join(" ")}>`;
 	return hasSlot(define.children) ? `${open}…</${jig.name}>` : open;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jigs.design/compiler",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "The Jigs compiler: parser, checker against a catalog, code generator, jig libraries, and the edit helpers. It evolves in place, behind the server API.",
   "license": "MIT",
   "repository": {
@@ -26,6 +26,6 @@
   },
   "dependencies": {
     "acorn": "8.19.0",
-    "@jigs.design/protocol": "0.3.5"
+    "@jigs.design/protocol": "0.3.7"
   }
 }