@refrakt-md/editor 0.36.0 → 0.37.0

package/dist/stamp-on-insert.js

@@ -0,0 +1,108 @@
+/**
+ * Stamp-on-insert (SPEC-134 phase 3, WORK-593).
+ *
+ * A snippet inserted by a human who just looked at the code is the one moment
+ * when a marker is unambiguously honest — it costs nothing and it is the only
+ * stamping that needs no review step.
+ *
+ * **It happens on save, not on template insertion.** The editor's rune
+ * templates are skeletons: at the moment a `{% snippet %}` is dropped into the
+ * document it has no `path=` yet, so there is no slice to hash. The first point
+ * at which the invocation names a real region is when the page is written, so
+ * that is where this runs.
+ *
+ * **It reuses the review CLI's stamping path rather than recomputing a hash
+ * here.** The normalization must not have two implementations: a marker written
+ * by the editor and one written by `refrakt snippet review` have to be the same
+ * value for the same content, or `--check` would fire on everything the editor
+ * touched.
+ *
+ * `expand` is never stamped — it embeds a whole document rather than a region,
+ * so there is nothing of the right shape to hash.
+ */
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { BASE_LANGUAGES, formatMarker, hashSlice, maskSource, reindent, resolveAnchor, resolveLanguage, shouldReindent, } from '@refrakt-md/runes';
+const TAG = /\{%\s*(snippet|file-ref)\b([^%]*?)(\/?)%\}/g;
+function attr(attrs, name) {
+    return new RegExp(`\\b${name}\\s*=\\s*"([^"]*)"`).exec(attrs)?.[1];
+}
+/** Resolve an invocation's slice against the current file, or undefined when
+ *  it cannot be resolved — in which case nothing is stamped. */
+function sliceFor(projectRoot, path, attrs) {
+    let source;
+    try {
+        source = readFileSync(join(projectRoot, path), 'utf8');
+    }
+    catch {
+        return undefined;
+    }
+    const symbol = attr(attrs, 'symbol');
+    const match = attr(attrs, 'match');
+    const lines = attr(attrs, 'lines');
+    if (symbol || match) {
+        try {
+            const resolved = resolveAnchor(source, resolveLanguage(path), {
+                symbol,
+                match,
+                extent: attr(attrs, 'extent'),
+                until: attr(attrs, 'until'),
+                through: attr(attrs, 'through'),
+            }, path);
+            const raw = source
+                .split('\n')
+                .slice(resolved.start - 1, resolved.end)
+                .join('\n');
+            return shouldReindent(true, undefined) ? reindent(raw) : raw;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    if (lines) {
+        const m = /^(\d*)-?(\d*)$/.exec(lines.trim());
+        if (!m)
+            return undefined;
+        const all = source.split('\n');
+        const start = m[1] ? Number(m[1]) : 1;
+        const end = m[2] ? Number(m[2]) : start;
+        return all.slice(start - 1, end).join('\n');
+    }
+    return source;
+}
+/**
+ * Add a `reviewed` marker to any unmarked `snippet` / `file-ref` invocation
+ * whose slice resolves.
+ *
+ * Existing markers are left alone: re-stamping on save would silently clear a
+ * marker that was asking for a review, which is the one thing this feature
+ * cannot do.
+ *
+ * Fenced invocations are skipped — they are examples of the syntax rather than
+ * references, and stamping one would claim a review nobody performed.
+ */
+export function stampOnInsert(source, projectRoot) {
+    const maskedLines = maskSource(source, BASE_LANGUAGES.markdoc).split('\n');
+    const lines = source.split('\n');
+    const out = lines.map((line, i) => {
+        if (maskedLines[i] !== line)
+            return line;
+        TAG.lastIndex = 0;
+        return line.replace(TAG, (raw, _rune, attrs, selfClose) => {
+            if (attr(attrs, 'reviewed') !== undefined)
+                return raw;
+            const path = attr(attrs, 'path');
+            if (!path)
+                return raw;
+            const slice = sliceFor(projectRoot, path, attrs);
+            if (slice === undefined)
+                return raw;
+            const marker = ` reviewed="${formatMarker(hashSlice(slice))}"`;
+            // Rebuild rather than string-splice so the self-closing form is
+            // preserved exactly.
+            return `{%${attrs.replace(/\s+$/, '')}${marker} ${selfClose}%}`.replace(/\{%(\S)/, '{% $1');
+        });
+    });
+    return out.join('\n');
+}
+//# sourceMappingURL=stamp-on-insert.js.map

package/dist/stamp-on-insert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stamp-on-insert.js","sourceRoot":"","sources":["../src/stamp-on-insert.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EACN,cAAc,EACd,YAAY,EACZ,SAAS,EACT,UAAU,EACV,QAAQ,EACR,aAAa,EACb,eAAe,EACf,cAAc,GACd,MAAM,mBAAmB,CAAC;AAE3B,MAAM,GAAG,GAAG,6CAA6C,CAAC;AAE1D,SAAS,IAAI,CAAC,KAAa,EAAE,IAAY;IACxC,OAAO,IAAI,MAAM,CAAC,MAAM,IAAI,oBAAoB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC;AAED;gEACgE;AAChE,SAAS,QAAQ,CAAC,WAAmB,EAAE,IAAY,EAAE,KAAa;IACjE,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACJ,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEnC,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAG,aAAa,CAC7B,MAAM,EACN,eAAe,CAAC,IAAI,CAAC,EACrB;gBACC,MAAM;gBACN,KAAK;gBACL,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAU;gBACtC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC3B,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC;aAC/B,EACD,IAAI,CACJ,CAAC;YACF,MAAM,GAAG,GAAG,MAAM;iBAChB,KAAK,CAAC,IAAI,CAAC;iBACX,KAAK,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC;iBACvC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,OAAO,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC9D,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,SAAS,CAAC;QAClB,CAAC;IACF,CAAC;IAED,IAAI,KAAK,EAAE,CAAC;QACX,MAAM,CAAC,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACxC,OAAO,GAAG,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAAC,MAAc,EAAE,WAAmB;IAChE,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEjC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACjC,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAEzC,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,KAAa,EAAE,SAAiB,EAAE,EAAE;YACzE,IAAI,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,SAAS;gBAAE,OAAO,GAAG,CAAC;YACtD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YACjC,IAAI,CAAC,IAAI;gBAAE,OAAO,GAAG,CAAC;YAEtB,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YACjD,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,GAAG,CAAC;YAEpC,MAAM,MAAM,GAAG,cAAc,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC;YAC/D,gEAAgE;YAChE,qBAAqB;YACrB,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@refrakt-md/editor",
   "description": "Browser-based content editor for refrakt.md",
-  "version": "0.36.0",
+  "version": "0.37.0",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -52,11 +52,11 @@
   },
   "dependencies": {
     "@markdoc/markdoc": "0.4.0",
-    "@refrakt-md/content": "0.36.0",
-    "@refrakt-md/highlight": "0.36.0",
-    "@refrakt-md/runes": "0.36.0",
-    "@refrakt-md/transform": "0.36.0",
-    "@refrakt-md/types": "0.36.0"
+    "@refrakt-md/content": "0.37.0",
+    "@refrakt-md/highlight": "0.37.0",
+    "@refrakt-md/runes": "0.37.0",
+    "@refrakt-md/transform": "0.37.0",
+    "@refrakt-md/types": "0.37.0"
   },
   "devDependencies": {
     "@codemirror/autocomplete": "^6.20.0",