@descent-vtt/spec-guard 0.5.0 → 0.5.1

package/dist/text.js

@@ -10,22 +10,33 @@
 /** Offsets at which each line begins. Index 0 is line 1. */
 export function lineStarts(source) {
     const starts = [0];
-    for (let index = 0; index < source.length; index++) {
-        if (source[index] === '\n')
-            starts.push(index + 1);
+    // Driven by indexOf rather than a character loop. Same answer, one less
+    // bound to get wrong - `index < source.length` reads past the end harmlessly
+    // when loosened, so nothing could ever fail on it - and it hands the scan to
+    // the engine's own memchr instead of walking UTF-16 units in JavaScript.
+    for (let at = source.indexOf('\n'); at !== -1; at = source.indexOf('\n', at + 1)) {
+        starts.push(at + 1);
     }
     return starts;
 }
-/** Resolves an offset to a 1-based line and column, in O(log n). */
+/**
+ * Resolves an offset to a 1-based line and column, in O(log n).
+ *
+ * The search is half-open - `high` is one past the last candidate - and narrows
+ * until exactly one candidate is left. Written with an inclusive `high` it
+ * needed a `- 1` that could be perturbed without changing any answer, because
+ * an out-of-range probe reads `undefined`, compares false, and converges anyway.
+ * There is no arithmetic here that a wrong value would leave working.
+ */
 export function locate(starts, index) {
     let low = 0;
-    let high = starts.length - 1;
-    while (low < high) {
-        const mid = (low + high + 1) >> 1;
+    let high = starts.length;
+    while (high - low > 1) {
+        const mid = (low + high) >> 1;
         if (starts[mid] <= index)
             low = mid;
         else
-            high = mid - 1;
+            high = mid;
     }
     return { line: low + 1, column: index - starts[low] + 1 };
 }
@@ -43,25 +54,25 @@ export function maskRanges(source, ranges) {
     // per character in the file, and measured at roughly half the throughput of
     // this on a 1 MB source. Both are O(n); only one of them is fast.
     // Sorted because the cursor only moves forward: an out-of-order range would
-    // be clamped away by the guard below and silently never masked.
+    // be clamped away and silently never masked.
     const sorted = [...ranges].sort((a, b) => a[0] - b[0]);
     const parts = [];
     let cursor = 0;
     for (const [start, end] of sorted) {
         const from = Math.max(start, cursor);
         const to = Math.min(end, source.length);
-        // Covers three things at once, which is why there is no separate filter:
-        // an empty range, an inverted one, and a range already inside one that has
-        // been masked. Letting the third through would move the cursor backwards
-        // and duplicate the text between.
-        if (to <= from)
-            continue;
-        if (from > cursor)
-            parts.push(source.slice(cursor, from));
+        // No guard on the degenerate cases, because there is nothing left for one
+        // to do. An empty range, an inverted one and a range already inside one
+        // that has been masked all produce two empty or already-emitted slices,
+        // and advancing the cursor to the furthest point reached - rather than to
+        // `to`, which can lie behind it - is what stops it moving backwards and
+        // duplicating the text between. The special case used to be a branch whose
+        // only distinguishing input was one nothing produces; now it is arithmetic.
+        parts.push(source.slice(cursor, from));
         // No `u` flag: the replacement walks UTF-16 code units, so a surrogate pair
         // becomes two spaces and every later offset still lands where it did.
         parts.push(source.slice(from, to).replace(/[^\n]/g, ' '));
-        cursor = to;
+        cursor = Math.max(from, to);
     }
     parts.push(source.slice(cursor));
     return parts.join('');

package/dist/text.js.map

@@ -1 +1 @@
-{"version":3,"file":"text.js","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,4DAA4D;AAC5D,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;QACnD,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,MAAM,CAAC,MAAyB,EAAE,KAAa;IAC7D,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,IAAI,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC7B,OAAO,GAAG,GAAG,IAAI,EAAE,CAAC;QAClB,MAAM,GAAG,GAAG,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAClC,IAAK,MAAM,CAAC,GAAG,CAAY,IAAI,KAAK;YAAE,GAAG,GAAG,GAAG,CAAC;;YAC3C,IAAI,GAAG,GAAG,GAAG,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,GAAI,MAAM,CAAC,GAAG,CAAY,GAAG,CAAC,EAAE,CAAC;AACxE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,MAA2C;IACpF,yEAAyE;IACzE,2EAA2E;IAC3E,4EAA4E;IAC5E,kEAAkE;IAClE,4EAA4E;IAC5E,gEAAgE;IAChE,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,yEAAyE;QACzE,2EAA2E;QAC3E,yEAAyE;QACzE,kCAAkC;QAClC,IAAI,EAAE,IAAI,IAAI;YAAE,SAAS;QACzB,IAAI,IAAI,GAAG,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,4EAA4E;QAC5E,sEAAsE;QACtE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QAC1D,MAAM,GAAG,EAAE,CAAC;IACd,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxB,CAAC"}
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,4DAA4D;AAC5D,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;IACnB,wEAAwE;IACxE,6EAA6E;IAC7E,6EAA6E;IAC7E,yEAAyE;IACzE,KAAK,IAAI,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;QACjF,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,MAAM,CAAC,MAAyB,EAAE,KAAa;IAC7D,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC;IACzB,OAAO,IAAI,GAAG,GAAG,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAK,MAAM,CAAC,GAAG,CAAY,IAAI,KAAK;YAAE,GAAG,GAAG,GAAG,CAAC;;YAC3C,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,GAAI,MAAM,CAAC,GAAG,CAAY,GAAG,CAAC,EAAE,CAAC;AACxE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc,EAAE,MAA2C;IACpF,yEAAyE;IACzE,2EAA2E;IAC3E,4EAA4E;IAC5E,kEAAkE;IAClE,4EAA4E;IAC5E,6CAA6C;IAC7C,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IAEf,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACxC,0EAA0E;QAC1E,wEAAwE;QACxE,wEAAwE;QACxE,0EAA0E;QAC1E,wEAAwE;QACxE,2EAA2E;QAC3E,4EAA4E;QAC5E,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QACvC,4EAA4E;QAC5E,sEAAsE;QACtE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QAC1D,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACxB,CAAC"}

package/package.json

@@ -1,73 +1,73 @@
-{
-  "name": "@descent-vtt/spec-guard",
-  "version": "0.5.0",
-  "description": "Executable architecture assertions for Markdown specs & ADRs.",
-  "keywords": [
-    "adr",
-    "architecture",
-    "documentation",
-    "drift",
-    "lint",
-    "markdown",
-    "ripgrep",
-    "spec"
-  ],
-  "license": "MIT",
-  "type": "module",
-  "engines": {
-    "node": ">=22"
-  },
-  "bin": {
-    "spec-guard": "bin/spec-guard.js"
-  },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "bin",
-    "dist",
-    "CHANGELOG.md",
-    "README.md",
-    "LICENSE"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
-    "lint": "tsc -p tsconfig.json --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "test:mutation": "stryker run",
-    "selfcheck": "node ./bin/spec-guard.js \"docs/**/*.md\" \"README.md\" --verbose",
-    "prepublishOnly": "npm run clean && npm run build"
-  },
-  "devDependencies": {
-    "@stryker-mutator/core": "^10.0.0",
-    "@stryker-mutator/vitest-runner": "^10.0.0",
-    "@types/node": "^26.4.1",
-    "@vitest/coverage-v8": "^4.1.11",
-    "@vscode/ripgrep": "^1.18.0",
-    "typescript": "^7.0.2",
-    "vitest": "^4.1.11"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/DescentVTT/spec-guard.git"
-  },
-  "bugs": {
-    "url": "https://github.com/DescentVTT/spec-guard/issues"
-  },
-  "homepage": "https://github.com/DescentVTT/spec-guard#readme",
-  "overrides": {
-    "qs": "^6.16.0"
-  }
-}
+{
+  "name": "@descent-vtt/spec-guard",
+  "version": "0.5.1",
+  "description": "Executable architecture assertions for Markdown specs & ADRs.",
+  "keywords": [
+    "adr",
+    "architecture",
+    "documentation",
+    "drift",
+    "lint",
+    "markdown",
+    "ripgrep",
+    "spec"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
+  "bin": {
+    "spec-guard": "bin/spec-guard.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "CHANGELOG.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "lint": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:mutation": "stryker run",
+    "selfcheck": "node ./bin/spec-guard.js \"docs/**/*.md\" \"README.md\" --verbose",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "devDependencies": {
+    "@stryker-mutator/core": "^10.0.0",
+    "@stryker-mutator/vitest-runner": "^10.0.0",
+    "@types/node": "^26.4.1",
+    "@vitest/coverage-v8": "^4.1.11",
+    "@vscode/ripgrep": "^1.18.0",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.11"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DescentVTT/spec-guard.git"
+  },
+  "bugs": {
+    "url": "https://github.com/DescentVTT/spec-guard/issues"
+  },
+  "homepage": "https://github.com/DescentVTT/spec-guard#readme",
+  "overrides": {
+    "qs": "^6.16.0"
+  }
+}