driftfence 0.0.2 → 0.0.3

package/README.md

@@ -1,6 +1,7 @@
 # DriftFence
 
 [![CI](https://github.com/CHAPAPOPA/driftfence/actions/workflows/ci.yml/badge.svg)](https://github.com/CHAPAPOPA/driftfence/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/driftfence.svg)](https://www.npmjs.com/package/driftfence)
 
 Make sure your README doesn't lie.
 
@@ -70,13 +71,13 @@ Env vars:
 
 ## MVP Checks
 
-DriftFence checks `README.md` and `docs/**/*.md` for documentation drift.
+DriftFence checks `README.md` and `docs/**/*.{md,mdx}` for documentation drift.
 
 Current checks:
 
 - package script references
 - file path references
-- env var references in Markdown docs
+- env var references in Markdown and MDX docs
 - env var usage in source files
 
 Package script references include commands like:
@@ -124,9 +125,27 @@ DriftFence uses stable CLI exit codes:
 - `1` — documentation drift found
 - `2` — invalid project directory or CLI usage error
 
+## Ignoring intentional examples
+
+Use ignore blocks when docs intentionally show fake paths, broken commands, fake env vars, or sample DriftFence output.
+
+````md
+<!-- driftfence-ignore-start -->
+
+```sh
+npm run missing-script
+```
+
+See `docs/missing.md`.
+Set `DATABASE_URL`.
+
+<!-- driftfence-ignore-end -->
+````
+
+Keep ignore blocks narrow so real setup instructions are still checked.
+
 ## Roadmap
 
-- MDX docs
 - GitHub Action
 - changed-files mode
 - configurable ignore rules

package/dist/{chunk-WK3NGHEY.js → chunk-T6PL4YLE.js}

@@ -170,6 +170,30 @@ function getErrorMessage(error) {
 import { access } from "fs/promises";
 import { resolve } from "path";
 var pathTokenPattern = /(?:^|[\s"'`(])((?:\.{1,2}[\\/][^\s"'`()<>[\]{}]+|[A-Za-z0-9_.-]+[\\/][^\s"'`()<>[\]{}]+|\.[A-Za-z0-9_-][A-Za-z0-9_.-]*|[A-Za-z0-9_-]+\.[A-Za-z][A-Za-z0-9]{1,7})(?:[?#][A-Za-z0-9_.:/#?=&-]+)?)/g;
+var javascriptDottedIdentifierRoots = /* @__PURE__ */ new Set([
+  "Array",
+  "Boolean",
+  "Buffer",
+  "Date",
+  "JSON",
+  "Map",
+  "Math",
+  "Number",
+  "Object",
+  "Promise",
+  "Reflect",
+  "RegExp",
+  "Set",
+  "String",
+  "Symbol",
+  "WeakMap",
+  "WeakSet",
+  "console",
+  "globalThis",
+  "import",
+  "module",
+  "process"
+]);
 async function checkFilePaths(projectRoot, references) {
   const pathReferences = findFilePathReferences(references);
   const issues = [];
@@ -199,6 +223,9 @@ function findFilePathReferences(references) {
 function findFilePathReferencesInText(text, markdownPath) {
   const references = [];
   for (const match of text.matchAll(pathTokenPattern)) {
+    if (isPartialDottedToken(text, match)) {
+      continue;
+    }
     const path = cleanPathCandidate(match[1]);
     if (!isLikelyFilePath(path)) {
       continue;
@@ -213,17 +240,83 @@ function cleanPathCandidate(candidate) {
   return withoutUrlSuffix.replace(/:\d+(?::\d+)?$/g, "").replace(/^\.\//, "");
 }
 function isLikelyFilePath(path) {
-  if (path.length === 0 || path.startsWith("@") || path.startsWith("-") || path.includes("://") || path.includes("*") || path.includes("$")) {
+  if (path.length === 0 || path.startsWith("@") || path.startsWith("-") || path.includes("://") || path.includes("*") || path.includes("$") || isUrlOrDomainLikeReference(path)) {
     return false;
   }
   if (!path.includes("/") && /^[A-Z][a-z]+(?:\.[a-z0-9]+)+$/.test(path)) {
     return false;
   }
+  if (isJavaScriptDottedIdentifier(path)) {
+    return false;
+  }
   return path.includes("/") || path.startsWith(".") || hasExtension(path);
 }
 function hasExtension(path) {
   return /(^|[/\\])[^/\\]+\.[A-Za-z][A-Za-z0-9]{1,7}$/.test(path);
 }
+function isJavaScriptDottedIdentifier(path) {
+  if (path.startsWith(".") || path.includes("/") || path.includes("\\")) {
+    return false;
+  }
+  const parts = path.split(".");
+  return parts.length > 1 && javascriptDottedIdentifierRoots.has(parts[0] ?? "") && parts.every((part) => /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(part));
+}
+function isPartialDottedToken(text, match) {
+  const candidate = match[1] ?? "";
+  const matchText = match[0] ?? "";
+  const candidateStart = (match.index ?? 0) + Math.max(matchText.lastIndexOf(candidate), 0);
+  const candidateEnd = candidateStart + candidate.length;
+  return text[candidateEnd] === "." && /^[A-Za-z0-9_-]$/.test(text[candidateEnd + 1] ?? "");
+}
+function isUrlOrDomainLikeReference(path) {
+  return isUrlReference(path) || isEmailLikeReference(path) || isLocalhostReference(path) || isIpv4AddressReference(path) || isBareDomainReference(path);
+}
+function isUrlReference(path) {
+  return /^https?:\/\//i.test(path);
+}
+function isEmailLikeReference(path) {
+  return /^[^\s@/\\]+@[^\s@/\\]+\.[^\s@/\\]+$/.test(path);
+}
+function isLocalhostReference(path) {
+  return /^localhost(?::\d+)?(?:\/.*)?$/i.test(path);
+}
+function isIpv4AddressReference(path) {
+  return /^(?:\d{1,3}\.){3}\d{1,3}(?::\d+)?(?:\/.*)?$/.test(path);
+}
+function isBareDomainReference(path) {
+  if (path.startsWith(".") || path.includes("\\") || path.includes("@")) {
+    return false;
+  }
+  const host = path.split("/")[0] ?? "";
+  return isDomainHost(host);
+}
+var commonDomainSuffixes = /* @__PURE__ */ new Set([
+  "ai",
+  "app",
+  "biz",
+  "co",
+  "com",
+  "dev",
+  "edu",
+  "gov",
+  "info",
+  "io",
+  "me",
+  "net",
+  "online",
+  "org",
+  "site",
+  "tv",
+  "xyz"
+]);
+function isDomainHost(host) {
+  const withoutPort = host.replace(/:\d+$/, "");
+  const parts = withoutPort.split(".");
+  const suffix = parts.at(-1)?.toLowerCase();
+  return parts.length > 1 && suffix !== void 0 && commonDomainSuffixes.has(suffix) && parts.every(
+    (part) => /^[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?$/.test(part)
+  );
+}
 function uniquePathReferences(references) {
   const seen = /* @__PURE__ */ new Set();
   const uniqueReferences = [];
@@ -471,12 +564,15 @@ async function findMarkdownPathsInDirectory(directory) {
       paths.push(...await findMarkdownPathsInDirectory(path));
       continue;
     }
-    if (entry.isFile() && entry.name.endsWith(".md")) {
+    if (entry.isFile() && isMarkdownDocument(entry.name)) {
       paths.push(path);
     }
   }
   return paths;
 }
+function isMarkdownDocument(fileName) {
+  return fileName.endsWith(".md") || fileName.endsWith(".mdx");
+}
 async function fileExists(path) {
   try {
     await readFile3(path, "utf8");

package/dist/cli.js

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

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "driftfence",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "MIT",
   "keywords": [
     "cli",
@@ -41,6 +41,7 @@
     "dev": "tsx src/cli.ts",
     "pack:dry": "npm pack --dry-run",
     "prepublishOnly": "npm run typecheck && npm test && npm run build",
+    "self:check": "node ./dist/cli.js check .",
     "test": "vitest run --pool=threads",
     "typecheck": "tsc --noEmit"
   },