driftfence 0.0.1 → 0.0.2

package/README.md

@@ -8,7 +8,7 @@ DriftFence is a TypeScript Node.js CLI that catches outdated README and docs com
 
 ## Install
 
-Once published to npm:
+Install from npm:
 
 ```sh
 npm install -D driftfence
@@ -24,10 +24,14 @@ npx driftfence check
 
 Check a specific project directory:
 
+<!-- driftfence-ignore-start -->
+
 ```sh
 npx driftfence check ./path/to/project
 ```
 
+<!-- driftfence-ignore-end -->
+
 ## Example Output
 
 The local clean demo exits with code 0:
@@ -44,6 +48,8 @@ npm run demo:drift
 
 Example output from the drift fixture:
 
+<!-- driftfence-ignore-start -->
+
 ```text
 DriftFence found documentation drift.
 
@@ -60,6 +66,8 @@ Env vars:
 4 issues found.
 ```
 
+<!-- driftfence-ignore-end -->
+
 ## MVP Checks
 
 DriftFence checks `README.md` and `docs/**/*.md` for documentation drift.
@@ -73,6 +81,8 @@ Current checks:
 
 Package script references include commands like:
 
+<!-- driftfence-ignore-start -->
+
 ```sh
 npm run build
 npm test
@@ -81,21 +91,31 @@ pnpm build
 yarn build
 ```
 
+<!-- driftfence-ignore-end -->
+
 Env var checks currently support references like:
 
+<!-- driftfence-ignore-start -->
+
 ```text
 API_URL
 DATABASE_URL
 VITE_API_URL
 ```
 
+<!-- driftfence-ignore-end -->
+
 and source usages like:
 
+<!-- driftfence-ignore-start -->
+
 ```ts
 process.env.API_URL
 import.meta.env.VITE_API_URL
 ```
 
+<!-- driftfence-ignore-end -->
+
 ## Exit Codes
 
 DriftFence uses stable CLI exit codes:
@@ -116,4 +136,4 @@ DriftFence uses stable CLI exit codes:
 
 AI features are not included in the MVP.
 
-DriftFence is deterministic-first: it checks concrete references in docs and code instead of guessing.
+DriftFence is deterministic-first: it checks concrete references in docs and code instead of guessing.

package/dist/{chunk-4RCBAET6.js → chunk-WK3NGHEY.js}

@@ -126,7 +126,7 @@ async function readPackageJson(projectRoot) {
     };
   }
   try {
-    return { packageJson: JSON.parse(rawPackageJson) };
+    return { packageJson: JSON.parse(stripBom(rawPackageJson)) };
   } catch (error) {
     return {
       issue: {
@@ -156,6 +156,9 @@ function normalizeCommand(command) {
 function hasOwn(object, key) {
   return Object.prototype.hasOwnProperty.call(object, key);
 }
+function stripBom(content) {
+  return content.startsWith("\uFEFF") ? content.slice(1) : content;
+}
 function getErrorCode(error) {
   return typeof error === "object" && error !== null && "code" in error ? String(error.code) : void 0;
 }
@@ -238,6 +241,52 @@ function uniquePathReferences(references) {
 // src/checkers/envVars.ts
 import { readFile as readFile2, readdir } from "fs/promises";
 import { join as join2, relative } from "path";
+
+// src/markdown/extractMarkdownText.ts
+import remarkParse from "remark-parse";
+import { unified } from "unified";
+var ignoreStart = "<!-- driftfence-ignore-start -->";
+var ignoreEnd = "<!-- driftfence-ignore-end -->";
+function extractMarkdownText(markdown) {
+  const tree = unified().use(remarkParse).parse(stripIgnoredMarkdownBlocks(markdown));
+  const references = [];
+  collectMarkdownText(tree, references);
+  return references;
+}
+function stripIgnoredMarkdownBlocks(markdown) {
+  let strippedMarkdown = "";
+  let position = 0;
+  while (position < markdown.length) {
+    const startIndex = markdown.indexOf(ignoreStart, position);
+    if (startIndex === -1) {
+      strippedMarkdown += markdown.slice(position);
+      break;
+    }
+    strippedMarkdown += markdown.slice(position, startIndex);
+    const endIndex = markdown.indexOf(
+      ignoreEnd,
+      startIndex + ignoreStart.length
+    );
+    if (endIndex === -1) {
+      break;
+    }
+    position = endIndex + ignoreEnd.length;
+  }
+  return strippedMarkdown;
+}
+function collectMarkdownText(node, references) {
+  if ((node.type === "code" || node.type === "inlineCode") && typeof node.value === "string") {
+    references.push({ kind: node.type, value: node.value });
+  }
+  if (!Array.isArray(node.children)) {
+    return;
+  }
+  for (const child of node.children) {
+    collectMarkdownText(child, references);
+  }
+}
+
+// src/checkers/envVars.ts
 var envVarPattern = /\b[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)+\b/g;
 var processEnvPattern = /\bprocess\.env\.([A-Z][A-Z0-9]*(?:_[A-Z0-9]+)+)\b/g;
 var importMetaEnvPattern = /\bimport\.meta\.env\.([A-Z][A-Z0-9]*(?:_[A-Z0-9]+)+)\b/g;
@@ -273,11 +322,13 @@ function findEnvExampleNames(content) {
 }
 function findMarkdownEnvVarReferences(document) {
   return uniqueEnvVarReferences(
-    [...document.content.matchAll(envVarPattern)].map((match) => ({
-      name: match[0],
-      source: "markdown",
-      path: document.path
-    }))
+    [...stripIgnoredMarkdownBlocks(document.content).matchAll(envVarPattern)].map(
+      (match) => ({
+        name: match[0],
+        source: "markdown",
+        path: document.path
+      })
+    )
   );
 }
 async function readEnvExampleNames(projectRoot) {
@@ -369,27 +420,6 @@ function getErrorCode2(error) {
   return typeof error === "object" && error !== null && "code" in error ? String(error.code) : void 0;
 }
 
-// src/markdown/extractMarkdownText.ts
-import remarkParse from "remark-parse";
-import { unified } from "unified";
-function extractMarkdownText(markdown) {
-  const tree = unified().use(remarkParse).parse(markdown);
-  const references = [];
-  collectMarkdownText(tree, references);
-  return references;
-}
-function collectMarkdownText(node, references) {
-  if ((node.type === "code" || node.type === "inlineCode") && typeof node.value === "string") {
-    references.push({ kind: node.type, value: node.value });
-  }
-  if (!Array.isArray(node.children)) {
-    return;
-  }
-  for (const child of node.children) {
-    collectMarkdownText(child, references);
-  }
-}
-
 // src/markdown/readMarkdownDocuments.ts
 import { readFile as readFile3, readdir as readdir2 } from "fs/promises";
 import { join as join3, relative as relative2 } from "path";
@@ -567,9 +597,9 @@ export {
   findPackageScriptReferences,
   checkFilePaths,
   findFilePathReferences,
+  extractMarkdownText,
   checkEnvVars,
   findEnvExampleNames,
-  extractMarkdownText,
   readMarkdownDocuments,
   formatReport,
   checkProject

package/dist/cli.js

@@ -2,7 +2,7 @@
 import {
   checkProject,
   formatReport
-} from "./chunk-4RCBAET6.js";
+} from "./chunk-WK3NGHEY.js";
 
 // src/cli.ts
 import { stat } from "fs/promises";

package/dist/index.js

@@ -9,7 +9,7 @@ import {
   findPackageScriptReferences,
   formatReport,
   readMarkdownDocuments
-} from "./chunk-4RCBAET6.js";
+} from "./chunk-WK3NGHEY.js";
 export {
   checkEnvVars,
   checkFilePaths,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "driftfence",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "keywords": [
     "cli",
@@ -65,4 +65,4 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.10"
   }
-}
+}