@primmel/primmel 1.6.0 → 1.7.0

package/dist-cli/primmel.mjs

@@ -187,6 +187,7 @@ function createDuplicateIdChecker() {
 function parse(mmelString, parsers, options = {}) {
   const tokens = tokenizeWithPositions(mmelString);
   const dupChecker = createDuplicateIdChecker();
+  const constructs = [];
   let ctx = {
     root: "",
     metadata: null,
@@ -298,6 +299,15 @@ function parse(mmelString, parsers, options = {}) {
           ctx.issues.push(issue);
         }
       }
+      if (options.withProvenance) {
+        constructs.push({
+          field: cfg.field ?? keyword,
+          id: idTok.value,
+          keyword,
+          start: tok.start,
+          end: payloadTok.end
+        });
+      }
       updateCtx = cfg.parse(idTok.value, payloadTok.value);
     } else {
       if (i >= tokens.length) {
@@ -306,6 +316,15 @@ function parse(mmelString, parsers, options = {}) {
         );
       }
       const payloadTok = tokens[i++];
+      if (options.withProvenance) {
+        constructs.push({
+          field: cfg.field ?? keyword,
+          id: "",
+          keyword,
+          start: tok.start,
+          end: payloadTok.end
+        });
+      }
       updateCtx = cfg.parse(payloadTok.value);
     }
     const next = updateCtx(ctx);
@@ -314,6 +333,9 @@ function parse(mmelString, parsers, options = {}) {
     }
     ctx = next;
   }
+  if (options.withProvenance) {
+    ctx.constructs = constructs;
+  }
   return ctx;
 }
 
@@ -432,8 +454,12 @@ function forEachAttribute(data, visitor, errCtx) {
   while (i < t.length) {
     if (t[i] === "ref") {
       const nameParts2 = [t[i++]];
-      if (i < t.length) nameParts2.push(t[i++]);
-      if (i < t.length) nameParts2.push(t[i++]);
+      if (i < t.length) {
+        nameParts2.push(t[i++]);
+      }
+      if (i < t.length) {
+        nameParts2.push(t[i++]);
+      }
       let blockContent = "";
       if (i < t.length && t[i].charAt(0) === "{") {
         blockContent = unwrapBlock(t[i++]);
@@ -642,7 +668,9 @@ var parseDataClass = function(id, data) {
           const ref = { predicate: m[1], target: m[2] };
           if (details) {
             const noteMatch = /note\s+"([^"]*)"/.exec(details) ?? /note\s+(\S+)/.exec(details);
-            if (noteMatch) ref.note = noteMatch[1];
+            if (noteMatch) {
+              ref.note = noteMatch[1];
+            }
           }
           result.ref ??= [];
           result.ref.push(ref);
@@ -792,7 +820,9 @@ var dumpDataClass = function(dataclass) {
   if (dataclass.ref && dataclass.ref.length > 0) {
     for (const r of dataclass.ref) {
       out += "  ref " + r.predicate + ' "' + escapeString(r.target) + '"';
-      if (r.note) out += ' { note "' + escapeString(r.note) + '" }';
+      if (r.note) {
+        out += ' { note "' + escapeString(r.note) + '" }';
+      }
       out += "\n";
     }
   }
@@ -7525,6 +7555,8 @@ var parseTerm = function(id, data) {
         result.note = unwrapped(value);
       } else if (command === "source") {
         result.source = unwrapped(value);
+      } else if (command === "overlay") {
+        result.overlay = value() === "true";
       } else if (command === "scope_note") {
         result.scopeNote = unwrapped(value);
       } else if (command === "language") {
@@ -13228,6 +13260,55 @@ function packageFiles(dir) {
   }
   return files;
 }
+function countNewlines(text) {
+  let n = 0;
+  for (let i = 0; i < text.length; i++) {
+    if (text.charAt(i) === "\n") {
+      n++;
+    }
+  }
+  return n;
+}
+function chunkify(files) {
+  const chunks = [];
+  let offset = 0;
+  let line = 1;
+  for (const f of files) {
+    if (f.role !== "content") {
+      continue;
+    }
+    const text = preprocessIncludes(f.path);
+    chunks.push({ path: f.path, text, start: offset, lineStart: line });
+    offset += text.length + 2;
+    line += countNewlines(text) + 2;
+  }
+  return chunks;
+}
+function joinChunks(chunks) {
+  return chunks.map((c) => c.text).join("\n\n");
+}
+function mapConstructs(parsed, chunks, packageId) {
+  const out = {};
+  let ci = 0;
+  for (const c of parsed) {
+    while (ci + 1 < chunks.length && c.start.offset >= chunks[ci + 1].start) {
+      ci++;
+    }
+    const chunk = chunks[ci];
+    const local = (p) => ({
+      line: p.line - chunk.lineStart + 1,
+      col: p.col,
+      offset: p.offset - chunk.start
+    });
+    const source = {
+      file: chunk.path,
+      ...packageId !== void 0 ? { package: packageId } : {},
+      span: { start: local(c.start), end: local(c.end) }
+    };
+    (out[c.field] ??= {})[c.id] = source;
+  }
+  return out;
+}
 function readPackageManifest(path) {
   const manifestPath = join(resolve3(path), "package.primmel");
   if (!existsSync2(manifestPath)) {
@@ -13246,24 +13327,21 @@ function readPackageManifest(path) {
   }
   return manifest;
 }
-function loadPackageInternal(dir, options = {}) {
+function loadPackageInternal(dir, options = {}, withProvenance = false) {
   const files = packageFiles(dir);
   if (files.length === 0) {
     throw new Error(`loadPackage: no package files found in ${resolve3(dir)}`);
   }
   let manifest = null;
-  const chunks = [];
-  for (const f of files) {
-    if (f.role === "manifest") {
-      manifest = readPackageManifest(dir);
-    } else {
-      chunks.push(preprocessIncludes(f.path));
-    }
+  if (files.some((f) => f.role === "manifest")) {
+    manifest = readPackageManifest(dir);
   }
+  const chunks = chunkify(files);
   if (manifest && options.resolvePackage && effectiveUses(manifest).length > 0) {
-    return composePackage(dir, options, manifest);
+    return composePackage(dir, options, manifest, withProvenance);
   }
-  const ctx = parse(chunks.join("\n\n"), PARSER_CONFIG, options);
+  const parseOptions = withProvenance ? { ...options, withProvenance: true } : options;
+  const ctx = parse(joinChunks(chunks), PARSER_CONFIG, parseOptions);
   if (manifest) {
     ctx.packageManifest = manifest;
     const deprecated = extendsDeprecationIssue(manifest);
@@ -13272,7 +13350,15 @@ function loadPackageInternal(dir, options = {}) {
     }
   }
   const standard = resolve(ctx, RESOLVER_CONFIG);
-  return { standard, issues: ctx.issues };
+  const result = { standard, issues: ctx.issues };
+  if (withProvenance) {
+    const manifestFile = files.find((f) => f.role === "manifest")?.path;
+    result.provenance = {
+      ...manifestFile !== void 0 ? { manifest: manifestFile } : {},
+      constructs: mapConstructs(ctx.constructs ?? [], chunks, manifest?.id)
+    };
+  }
+  return result;
 }
 function loadPackageWithIssues(dir, options = {}) {
   return loadPackageInternal(dir, options);
@@ -13371,15 +13457,11 @@ var MERGE_FIELDS = [
   "texts"
 ];
 function parsePackageContent(dir, options) {
-  const chunks = [];
-  for (const f of packageFiles(dir)) {
-    if (f.role === "content") {
-      chunks.push(preprocessIncludes(f.path));
-    }
-  }
-  return parse(chunks.join("\n\n"), PARSER_CONFIG, options);
+  const chunks = chunkify(packageFiles(dir));
+  const ctx = parse(joinChunks(chunks), PARSER_CONFIG, options);
+  return { ctx, chunks };
 }
-function composePackage(rootDir, options, rootManifest) {
+function composePackage(rootDir, options, rootManifest, withProvenance = false) {
   const locate = options.resolvePackage;
   const rootId = rootManifest.id;
   const dirs = /* @__PURE__ */ new Map([[rootId, resolve3(rootDir)]]);
@@ -13430,9 +13512,13 @@ function composePackage(rootDir, options, rootManifest) {
     order.push(id);
   };
   visit(rootId);
+  const parseOptions = withProvenance ? { ...options, withProvenance: true } : options;
   const ctxs = /* @__PURE__ */ new Map();
+  const pkgChunks = /* @__PURE__ */ new Map();
   for (const id of order) {
-    ctxs.set(id, parsePackageContent(dirs.get(id), options));
+    const parsed = parsePackageContent(dirs.get(id), parseOptions);
+    ctxs.set(id, parsed.ctx);
+    pkgChunks.set(id, parsed.chunks);
   }
   const provenance = /* @__PURE__ */ new Map();
   for (const field of MERGE_FIELDS) {
@@ -13454,10 +13540,13 @@ function composePackage(rootDir, options, rootManifest) {
       )) {
         const prior = pm.get(key);
         if (prior !== void 0) {
-          throw new CompositionError(
-            "uses-no-redefine",
-            `package "${id}" redefines ${String(field)} id "${key}" already declared by package "${prior}" \u2014 an overlay may reference upstream ids, never redefine them (uses-no-redefine)`
-          );
+          const isOverlay = field === "terms" && typeof value === "object" && value !== null && value.overlay === true;
+          if (!isOverlay) {
+            throw new CompositionError(
+              "uses-no-redefine",
+              `package "${id}" redefines ${String(field)} id "${key}" already declared by package "${prior}" \u2014 an overlay may reference upstream ids, never redefine them (uses-no-redefine)`
+            );
+          }
         }
         target[key] = value;
         pm.set(key, id);
@@ -13514,11 +13603,32 @@ function composePackage(rootDir, options, rootManifest) {
   }
   acc.packageManifest = rootManifest;
   const standard = resolve(acc, RESOLVER_CONFIG);
-  return {
+  const result = {
     standard,
     issues: [...acc.issues, ...compositionIssues],
     composition: { root: rootId, order }
   };
+  if (withProvenance) {
+    const constructs = {};
+    for (const id of order) {
+      const perPackage = mapConstructs(
+        ctxs.get(id).constructs ?? [],
+        pkgChunks.get(id),
+        id
+      );
+      for (const [field, byId2] of Object.entries(perPackage)) {
+        const target = constructs[field] ??= {};
+        for (const [constructId, source] of Object.entries(byId2)) {
+          target[constructId] = source;
+        }
+      }
+    }
+    result.provenance = {
+      manifest: join(resolve3(rootDir), "package.primmel"),
+      constructs
+    };
+  }
+  return result;
 }
 
 // src/ser-des/prm.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primmel/primmel",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Primmel — parser, types, and serializer for the Primmel modelling language (successor to MMEL)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",