@jigs.design/compiler 0.3.6 → 0.3.7

package/dist/index.d.ts

@@ -7,6 +7,6 @@ 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 ExtendedLibrary, type Hoisted, type Jig, type JigsNode, type Library, type ProcedureUse, type Program, type ProgramOutput, type PropSpec, RESERVED_TAGS, type RenderNode, SEARCH_MARKER, type Statement, applyEdits, columnAt, compileJigs, compileLibrary, editBreakage, extendLibrary, 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/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.6",
+  "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.6"
+    "@jigs.design/protocol": "0.3.7"
   }
 }