@eriknaslund/skiss 0.3.0 → 0.4.0

package/dist/index.js

@@ -3,7 +3,8 @@ var isWs = (c) => c === " " || c === "	";
 var trimWs = (s) => s.replace(/^[ \t]+/, "").replace(/[ \t]+$/, "");
 var CLASS_NAME = /^[A-Z][A-Za-z0-9]*$/;
 var FIELD_NAME = /^[a-z][A-Za-z0-9]*$/;
-var SYSTEM_OR_VALUE = /^[A-Za-z][A-Za-z0-9_-]*$/;
+var SYSTEM_NAME = /^[A-Za-z][A-Za-z0-9_-]*$/;
+var ENUM_VALUE = /^[A-Za-z0-9][A-Za-z0-9_-]*$/;
 var PRIMITIVES = {
   string: "string",
   int: "int",
@@ -308,7 +309,7 @@ function parseSystem(c, at) {
       system ?? afterSpan(at)
     );
   }
-  if (!SYSTEM_OR_VALUE.test(system.text)) {
+  if (!SYSTEM_NAME.test(system.text)) {
     return fail(
       "E_UNPARSABLE",
       `A system name is letters, digits, \`-\` and \`_\`, starting with a letter: \`${system.text}\``,
@@ -366,10 +367,10 @@ function parseType(c, colon) {
   }
   if (words.length > 1) {
     for (const w of words) {
-      if (!SYSTEM_OR_VALUE.test(w.text)) {
+      if (!ENUM_VALUE.test(w.text)) {
         return fail(
           "E_UNPARSABLE",
-          `An enum value is letters, digits, \`-\` and \`_\`, starting with a letter: \`${w.text}\``,
+          `An enum value is letters, digits, \`-\` and \`_\`, and does not start with \`-\` or \`_\`: \`${w.text}\``,
           c.line,
           w
         );
@@ -506,6 +507,18 @@ function resolve(doc) {
         );
       } else if (field.type?.kind === "class") {
         reference(field.type.name);
+      } else if (field.type?.kind === "enum") {
+        const seen = /* @__PURE__ */ new Set();
+        for (const value of field.type.values) {
+          if (seen.has(value.text)) {
+            warn(
+              "W_DUPLICATE_ENUM_VALUE",
+              `value \`${value.text}\` is already in this enum; it is carried once`,
+              value
+            );
+          }
+          seen.add(value.text);
+        }
       }
       if (field.joinsTo !== void 0) {
         const { className, fieldName } = field.joinsTo;
@@ -619,7 +632,8 @@ function toLinkML(doc, opts) {
   const classNames = new Set(classes.map((cls) => cls.node.name.text));
   for (const name2 of resolved.undeclared) classNames.add(name2.text);
   const enums = nameEnums(classes, classNames);
-  const prefixes = { linkml: "https://w3id.org/linkml/" };
+  const prefixes = nameKeyed();
+  prefixes.linkml = "https://w3id.org/linkml/";
   if (!Object.hasOwn(prefixes, schemaName)) prefixes[schemaName] = `${BASE_URI}/${schemaName}/`;
   const systemPrefix = /* @__PURE__ */ new Map();
   const addSystem = (system) => {
@@ -650,12 +664,12 @@ function toLinkML(doc, opts) {
     prefixes,
     imports: ["linkml:types"]
   };
-  const out = {};
+  const out = nameKeyed();
   for (const cls of classes) {
     out[cls.node.name.text] = buildClass(cls, mappingPrefix, enums);
   }
   for (const name2 of resolved.undeclared) {
-    if (!(name2.text in out)) out[name2.text] = { annotations: { undeclared: true } };
+    if (!Object.hasOwn(out, name2.text)) out[name2.text] = { annotations: { undeclared: true } };
   }
   if (Object.keys(out).length > 0) schema.classes = out;
   const enumBlock = buildEnums(classes, enums);
@@ -713,13 +727,13 @@ function nameEnums(classes, classNames) {
   return names;
 }
 function buildEnums(classes, enums) {
-  const out = {};
+  const out = nameKeyed();
   for (const { node, fields } of classes) {
     for (const field of fields) {
       if (field.type?.kind !== "enum") continue;
       const name2 = enums.get(useKey(node.name.text, field.name.text));
-      if (name2 === void 0 || name2 in out) continue;
-      const values = {};
+      if (name2 === void 0 || Object.hasOwn(out, name2)) continue;
+      const values = nameKeyed();
       for (const value of field.type.values) values[value.text] = null;
       out[name2] = { permissible_values: values };
     }
@@ -738,7 +752,7 @@ function buildClass(cls, mappingPrefix, enums) {
     const target = node.similarTo.text;
     out.close_mappings = [`${mappingPrefix(target)}:${target}`];
   }
-  const attributes = {};
+  const attributes = nameKeyed();
   for (const field of fields) {
     attributes[field.name.text] = buildAttribute(field, node.name.text, enums);
   }
@@ -776,10 +790,12 @@ function rangeOf(field, className, enums) {
   }
 }
 var RESERVED_PREFIXES = /* @__PURE__ */ new Set(["linkml", "xsd", "shex", "schema"]);
+var PROTOTYPE_KEYS = /* @__PURE__ */ new Set(["__proto__", "constructor", "prototype"]);
+var nameKeyed = () => /* @__PURE__ */ Object.create(null);
 var linkmlName = (text) => {
   const name2 = text.toLowerCase().replace(/[^a-z0-9]/g, "_");
   if (!/[a-z0-9]/.test(name2)) return "sketch";
-  if (RESERVED_PREFIXES.has(name2)) return `${name2}_`;
+  if (RESERVED_PREFIXES.has(name2) || PROTOTYPE_KEYS.has(name2)) return `${name2}_`;
   return /^[0-9]/.test(name2) ? `_${name2}` : name2;
 };
 var capitalise = (text) => text.charAt(0).toUpperCase() + text.slice(1);
@@ -942,10 +958,15 @@ function typeText2(type) {
   }
   return type.many ? `${text}[]` : text;
 }
+function writeDescription(text) {
+  const attached = text.replace(/[ \t]+\?(?=[ \t]|$)/g, "?");
+  return /^\?([ \t]|$)/.test(attached) ? `#${attached}` : `# ${attached}`;
+}
+var rewordsDescription = (text) => writeDescription(text) !== `# ${text}`;
 function withTrailer(head, node) {
   const parts2 = [];
   if (node.description !== void 0 && node.description !== "")
-    parts2.push(`# ${node.description}`);
+    parts2.push(writeDescription(node.description));
   if (node.note !== void 0 && node.note !== "") parts2.push(`? ${node.note}`);
   if (parts2.length === 0) return head;
   const gap = head.length < TRAILER_COLUMN - 1 ? " ".repeat(TRAILER_COLUMN - head.length) : "  ";
@@ -983,6 +1004,7 @@ var QUIET_SCHEMA_KEYS = /* @__PURE__ */ new Set([
   "slots",
   "enums"
 ]);
+var REWORDED = "a standalone `?` is attached to the word before it";
 var UNKNOWN_TYPE = /^[a-z][a-z0-9_-]*$/;
 function fromLinkML(schema) {
   const root = asRecord(schema);
@@ -1026,7 +1048,7 @@ function fromLinkML(schema) {
     const rawValues = get(asRecord(get(enumDefs, key2)) ?? {}, "permissible_values");
     const values = asRecord(rawValues);
     const keys = Object.keys(values ?? {});
-    const bad = keys.find((value) => !SYSTEM_OR_VALUE.test(value));
+    const bad = keys.find((value) => !ENUM_VALUE.test(value));
     if (values === void 0 && present(rawValues)) {
       unwritable.set(key2, `${shown(rawValues)} is not a map of permissible values`);
     } else if (keys.length < 2) {
@@ -1057,14 +1079,26 @@ function fromLinkML(schema) {
       }
       continue;
     }
+    const undeclared = annotations.get("undeclared");
+    if (undeclared !== void 0 && typeof undeclared !== "boolean") {
+      report("annotation", name2, notText("undeclared", undeclared));
+    }
     const node = { name: at0(name2), fields: [], line: 0 };
     const description = oneLine(stringOf(get(def, "description")));
-    if (description !== void 0) node.description = description;
+    if (description !== void 0) {
+      node.description = description;
+      if (rewordsDescription(description)) report("reworded", name2, REWORDED);
+    }
     const system = annotations.get("system");
-    if (typeof system === "string" && SYSTEM_OR_VALUE.test(system)) node.system = at0(system);
-    else if (system !== void 0) report("annotation", name2, "`system` is not a system name");
-    const note = oneLine(stringOf(annotations.get("note")));
-    if (note !== void 0) node.note = note;
+    if (typeof system === "string") {
+      if (SYSTEM_NAME.test(system)) node.system = at0(system);
+      else report("annotation", name2, "`system` is not a system name");
+    } else if (system !== void 0) report("annotation", name2, notText("system", system));
+    const rawNote = annotations.get("note");
+    if (typeof rawNote === "string") {
+      const note = oneLine(rawNote);
+      if (note !== void 0) node.note = note;
+    } else if (rawNote !== void 0) report("annotation", name2, notText("note", rawNote));
     const mappings = stringList(get(def, "close_mappings"));
     const first = mappings[0];
     const target = first === void 0 ? "" : localName(first);
@@ -1169,13 +1203,18 @@ function fromLinkML(schema) {
       line: 0
     };
     const description = oneLine(stringOf(get(def, "description")));
-    if (description !== void 0) field.description = description;
+    if (description !== void 0) {
+      field.description = description;
+      if (rewordsDescription(description)) report("reworded", element, REWORDED);
+    }
     const type = typeFor(element, name2, def);
     if (type !== void 0) field.type = type;
     const annotations = annotationsOf(def);
     const system = annotations.get("system");
-    if (typeof system === "string" && SYSTEM_OR_VALUE.test(system)) field.system = at0(system);
-    else if (system !== void 0) report("annotation", element, "`system` is not a system name");
+    if (typeof system === "string") {
+      if (SYSTEM_NAME.test(system)) field.system = at0(system);
+      else report("annotation", element, "`system` is not a system name");
+    } else if (system !== void 0) report("annotation", element, notText("system", system));
     const joins = annotations.get("joins_to");
     if (typeof joins === "string") {
       const dot = joins.indexOf(".");
@@ -1188,9 +1227,12 @@ function fromLinkML(schema) {
         reference(element, target, targetClass);
         reference(element, targetField, targetName);
       } else report("annotation", element, "`joins_to` is not `Class.field`");
-    } else if (joins !== void 0) report("annotation", element, "`joins_to` is not text");
-    const note = oneLine(stringOf(annotations.get("note")));
-    if (note !== void 0) field.note = note;
+    } else if (joins !== void 0) report("annotation", element, notText("joins_to", joins));
+    const rawNote = annotations.get("note");
+    if (typeof rawNote === "string") {
+      const note = oneLine(rawNote);
+      if (note !== void 0) field.note = note;
+    } else if (rawNote !== void 0) report("annotation", element, notText("note", rawNote));
     for (const other of Object.keys(def)) {
       if (!SLOT_KEYS.has(other)) {
         report(other, element);
@@ -1265,13 +1307,17 @@ var COUNTED = {
   class: ["class", "classes"],
   slot: ["slot", "slots"],
   schema: ["schema key", "schema keys"],
+  narrowed: ["narrowed range", "narrowed ranges"],
+  enum_detail: ["enum detail", "enum details"],
+  annotation: ["unreadable annotation", "unreadable annotations"],
+  reworded: ["description reworded", "descriptions reworded"],
   // `mixin: true` marks the class; `mixins: [M]` points at another one.
   mixin: ["mixin class", "mixin classes"],
   mixins: ["mixin", "mixins"],
   pattern: ["pattern", "patterns"],
   unit: ["unit", "units"]
 };
-var ENUM_KINDS = /* @__PURE__ */ new Set(["enum_detail"]);
+var UNREADABLE = "unreadable";
 function formatDropped(dropped) {
   const groups = /* @__PURE__ */ new Map();
   for (const entry of dropped) {
@@ -1280,15 +1326,21 @@ function formatDropped(dropped) {
     else group.push(entry);
   }
   const drops = [];
+  const notRead = [];
   let renamed = "";
   let inlined = "";
   for (const [kind, entries] of groups) {
+    if (kind === UNREADABLE) {
+      for (const entry of entries) notRead.push(entry.detail ?? "the schema could not be read");
+      continue;
+    }
     const phrase = phraseFor(kind, entries);
     if (kind === "renamed") renamed = phrase;
     else if (kind === "inlined") inlined = phrase;
     else drops.push(phrase);
   }
   const sentences = [];
+  if (notRead.length > 0) sentences.push(`Not read: ${notRead.join("; ")}.`);
   if (drops.length > 0) sentences.push(`Dropped: ${drops.join(", ")}.`);
   if (renamed !== "") sentences.push(`Renamed: ${renamed}.`);
   if (inlined !== "") sentences.push(`Inlined: ${inlined}.`);
@@ -1298,11 +1350,10 @@ function phraseFor(kind, entries) {
   const n = entries.length;
   const counted = Object.hasOwn(COUNTED, kind) ? COUNTED[kind] : void 0;
   if (counted !== void 0) return `${n} ${n === 1 ? counted[0] : counted[1]}`;
-  return `${kind} on ${n} ${nounFor(kind, entries)}`;
+  return `${kind} on ${n} ${nounFor(entries)}`;
 }
-function nounFor(kind, entries) {
+function nounFor(entries) {
   const one = entries.length === 1;
-  if (ENUM_KINDS.has(kind)) return one ? "enum" : "enums";
   const slots = entries.filter((entry) => entry.element.includes(".")).length;
   if (slots === entries.length) return one ? "slot" : "slots";
   if (slots === 0) return one ? "class" : "classes";
@@ -1353,12 +1404,18 @@ function annotationsOf(def) {
   if (annotations === void 0) return out;
   for (const tag of Object.keys(annotations)) {
     const raw = get(annotations, tag);
-    const value = asRecord(raw) === void 0 ? raw : get(asRecord(raw) ?? {}, "value");
-    if (typeof value === "string" || typeof value === "boolean") out.set(tag, value);
-    else out.set(tag, String(value));
+    const long = asRecord(raw);
+    const value = long === void 0 ? raw : get(long, "value");
+    out.set(tag, value ?? null);
   }
   return out;
 }
+function notText(tag, value) {
+  if (value === null) return `\`${tag}\` was written with no value`;
+  if (Array.isArray(value)) return `\`${tag}\` is a list, not text`;
+  if (typeof value === "object") return `\`${tag}\` is a map, not text`;
+  return `\`${tag}\` is a ${typeof value}, not text`;
+}
 function slotKeysOf(def) {
   const keys = Object.keys(asRecord(get(def, "attributes")) ?? {});
   for (const slot of stringList(get(def, "slots"))) {
@@ -1383,7 +1440,7 @@ var schemaElement = (root) => stringOf(get(root, "name")) ?? "schema";
 var nothing = (element, detail) => ({
   document: parse(""),
   source: "",
-  dropped: [{ kind: "schema", element, detail }]
+  dropped: [{ kind: UNREADABLE, element, detail }]
 });
 
 // src/import.ts
@@ -1410,7 +1467,7 @@ function notYAML(error) {
 }
 
 // src/index.ts
-var VERSION = "0.3.0";
+var VERSION = "0.4.0";
 export {
   VERSION,
   compile,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eriknaslund/skiss",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A text notation for sketching data models, compiled to LinkML",
   "type": "module",
   "license": "MIT",
@@ -12,8 +12,10 @@
     "node": ">=20"
   },
   "packageManager": "pnpm@9.15.9",
+  "sideEffects": false,
   "files": [
-    "dist"
+    "dist",
+    "!dist/**/*.map"
   ],
   "exports": {
     ".": {