@aiready/consistency 0.3.4 → 0.4.1

package/dist/index.js

@@ -32,6 +32,7 @@ var import_core3 = require("@aiready/core");
 
 // src/analyzers/naming.ts
 var import_core = require("@aiready/core");
+var import_path = require("path");
 var COMMON_SHORT_WORDS = /* @__PURE__ */ new Set([
   // Full English words (1-3 letters)
   "day",
@@ -89,6 +90,13 @@ var COMMON_SHORT_WORDS = /* @__PURE__ */ new Set([
   "tmp",
   "ext",
   "sep",
+  // Prepositions and conjunctions
+  "and",
+  "from",
+  "how",
+  "pad",
+  "bar",
+  "non",
   // Additional full words commonly flagged
   "tax",
   "cat",
@@ -335,6 +343,17 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "alb",
   "nlb",
   "aws",
+  "ses",
+  "gst",
+  "cdk",
+  "btn",
+  "buf",
+  "agg",
+  "ocr",
+  "ai",
+  "cf",
+  "cfn",
+  "ga",
   // Metrics/Performance
   "fcp",
   "lcp",
@@ -346,12 +365,14 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "qps",
   "rps",
   "tps",
+  "wpm",
   // Testing & i18n
   "po",
   "e2e",
   "a11y",
   "i18n",
   "l10n",
+  "spy",
   // Domain-specific abbreviations (context-aware)
   "sk",
   "fy",
@@ -361,6 +382,16 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "cta",
   "roi",
   "kpi",
+  "ttl",
+  "pct",
+  // Technical abbreviations
+  "mac",
+  "hex",
+  "esm",
+  "git",
+  "rec",
+  "loc",
+  "dup",
   // Boolean helpers (these are intentional short names)
   "is",
   "has",
@@ -375,75 +406,113 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
 ]);
 async function analyzeNaming(files) {
   const issues = [];
+  const rootDir = files.length > 0 ? (0, import_path.dirname)(files[0]) : process.cwd();
+  const config = (0, import_core.loadConfig)(rootDir);
+  const consistencyConfig = config?.tools?.["consistency"];
+  const customAbbreviations = new Set(consistencyConfig?.acceptedAbbreviations || []);
+  const customShortWords = new Set(consistencyConfig?.shortWords || []);
+  const disabledChecks = new Set(consistencyConfig?.disableChecks || []);
   for (const file of files) {
     const content = await (0, import_core.readFileContent)(file);
-    const fileIssues = analyzeFileNaming(file, content);
+    const fileIssues = analyzeFileNaming(file, content, customAbbreviations, customShortWords, disabledChecks);
     issues.push(...fileIssues);
   }
   return issues;
 }
-function analyzeFileNaming(file, content) {
+function analyzeFileNaming(file, content, customAbbreviations, customShortWords, disabledChecks) {
   const issues = [];
   const isTestFile = file.match(/\.(test|spec)\.(ts|tsx|js|jsx)$/);
   const lines = content.split("\n");
+  const allAbbreviations = /* @__PURE__ */ new Set([...ACCEPTABLE_ABBREVIATIONS, ...customAbbreviations]);
+  const allShortWords = /* @__PURE__ */ new Set([...COMMON_SHORT_WORDS, ...customShortWords]);
+  const getContextWindow = (index, windowSize = 3) => {
+    const start = Math.max(0, index - windowSize);
+    const end = Math.min(lines.length, index + windowSize + 1);
+    return lines.slice(start, end).join("\n");
+  };
+  const isShortLivedVariable = (varName, declarationIndex) => {
+    const searchRange = 5;
+    const endIndex = Math.min(lines.length, declarationIndex + searchRange + 1);
+    let usageCount = 0;
+    for (let i = declarationIndex; i < endIndex; i++) {
+      const regex = new RegExp(`\\b${varName}\\b`, "g");
+      const matches = lines[i].match(regex);
+      if (matches) {
+        usageCount += matches.length;
+      }
+    }
+    return usageCount >= 2 && usageCount <= 3;
+  };
   lines.forEach((line, index) => {
     const lineNumber = index + 1;
-    const singleLetterMatches = line.matchAll(/\b(?:const|let|var)\s+([a-hm-z])\s*=/gi);
-    for (const match of singleLetterMatches) {
-      const letter = match[1].toLowerCase();
-      const isInLoopContext = line.includes("for") || /\.(map|filter|forEach|reduce|find|some|every)\s*\(/.test(line) || line.includes("=>") || // Arrow function
-      /\w+\s*=>\s*/.test(line);
-      const isI18nContext = line.includes("useTranslation") || line.includes("i18n.t") || /\bt\s*\(['"]/.test(line);
-      const isArrowFunctionParam = /\(\s*[a-z]\s*(?:,\s*[a-z]\s*)*\)\s*=>/.test(line) || // (s) => or (a, b) =>
-      /[a-z]\s*=>/.test(line);
-      if (!isInLoopContext && !isI18nContext && !isArrowFunctionParam && !["x", "y", "z", "i", "j", "k", "l", "n", "m"].includes(letter)) {
-        if (isTestFile && ["a", "b", "c", "d", "e", "f", "s"].includes(letter)) {
-          continue;
+    const contextWindow = getContextWindow(index);
+    if (!disabledChecks.has("single-letter")) {
+      const singleLetterMatches = line.matchAll(/\b(?:const|let|var)\s+([a-hm-z])\s*=/gi);
+      for (const match of singleLetterMatches) {
+        const letter = match[1].toLowerCase();
+        const isInLoopContext = line.includes("for") || /\.(map|filter|forEach|reduce|find|some|every)\s*\(/.test(line) || line.includes("=>") || // Arrow function
+        /\w+\s*=>\s*/.test(line);
+        const isI18nContext = line.includes("useTranslation") || line.includes("i18n.t") || /\bt\s*\(['"]/.test(line);
+        const isArrowFunctionParam = /\(\s*[a-z]\s*(?:,\s*[a-z]\s*)*\)\s*=>/.test(line) || // (s) => or (a, b) =>
+        /[a-z]\s*=>/.test(line) || // s => on same line
+        // Multi-line arrow function detection: look for pattern in context window
+        new RegExp(`\\b${letter}\\s*\\)\\s*$`).test(line) && /=>/.test(contextWindow) || // (s)\n =>
+        new RegExp(`\\.(?:map|filter|forEach|reduce|find|some|every)\\s*\\(\\s*$`).test(lines[index - 1] || "") && /=>/.test(contextWindow);
+        const isShortLived = isShortLivedVariable(letter, index);
+        if (!isInLoopContext && !isI18nContext && !isArrowFunctionParam && !isShortLived && !["x", "y", "z", "i", "j", "k", "l", "n", "m"].includes(letter)) {
+          if (isTestFile && ["a", "b", "c", "d", "e", "f", "s"].includes(letter)) {
+            continue;
+          }
+          issues.push({
+            file,
+            line: lineNumber,
+            type: "poor-naming",
+            identifier: match[1],
+            severity: "minor",
+            suggestion: `Use descriptive variable name instead of single letter '${match[1]}'`
+          });
         }
-        issues.push({
-          file,
-          line: lineNumber,
-          type: "poor-naming",
-          identifier: match[1],
-          severity: "minor",
-          suggestion: `Use descriptive variable name instead of single letter '${match[1]}'`
-        });
       }
     }
-    const abbreviationMatches = line.matchAll(/\b(?:const|let|var)\s+([a-z]{1,3})(?=[A-Z]|_|\s*=)/g);
-    for (const match of abbreviationMatches) {
-      const abbrev = match[1].toLowerCase();
-      if (COMMON_SHORT_WORDS.has(abbrev)) {
-        continue;
-      }
-      if (ACCEPTABLE_ABBREVIATIONS.has(abbrev)) {
-        continue;
-      }
-      const isArrowFunctionParam = /\(\s*[a-z]\s*(?:,\s*[a-z]\s*)*\)\s*=>/.test(line) || // (s) => or (a, b) =>
-      new RegExp(`\\b${abbrev}\\s*=>`).test(line);
-      if (isArrowFunctionParam) {
-        continue;
-      }
-      if (abbrev.length <= 2) {
-        const isDateTimeContext = /date|time|day|hour|minute|second|timestamp/i.test(line);
-        if (isDateTimeContext && ["d", "t", "dt"].includes(abbrev)) {
+    if (!disabledChecks.has("abbreviation")) {
+      const abbreviationMatches = line.matchAll(/\b(?:const|let|var)\s+([a-z]{1,3})(?=[A-Z]|_|\s*=)/g);
+      for (const match of abbreviationMatches) {
+        const abbrev = match[1].toLowerCase();
+        if (allShortWords.has(abbrev)) {
           continue;
         }
-        const isUserContext = /user|auth|account/i.test(line);
-        if (isUserContext && abbrev === "u") {
+        if (allAbbreviations.has(abbrev)) {
           continue;
         }
+        const isArrowFunctionParam = /\(\s*[a-z]\s*(?:,\s*[a-z]\s*)*\)\s*=>/.test(line) || // (s) => or (a, b) =>
+        new RegExp(`\\b${abbrev}\\s*=>`).test(line) || // s => on same line
+        // Multi-line arrow function: check context window
+        new RegExp(`\\b${abbrev}\\s*\\)\\s*$`).test(line) && /=>/.test(contextWindow) || // (s)\n =>
+        new RegExp(`\\.(?:map|filter|forEach|reduce|find|some|every)\\s*\\(\\s*$`).test(lines[index - 1] || "") && new RegExp(`^\\s*${abbrev}\\s*=>`).test(line);
+        if (isArrowFunctionParam) {
+          continue;
+        }
+        if (abbrev.length <= 2) {
+          const isDateTimeContext = /date|time|day|hour|minute|second|timestamp/i.test(line);
+          if (isDateTimeContext && ["d", "t", "dt"].includes(abbrev)) {
+            continue;
+          }
+          const isUserContext = /user|auth|account/i.test(line);
+          if (isUserContext && abbrev === "u") {
+            continue;
+          }
+        }
+        issues.push({
+          file,
+          line: lineNumber,
+          type: "abbreviation",
+          identifier: match[1],
+          severity: "info",
+          suggestion: `Consider using full word instead of abbreviation '${match[1]}'`
+        });
       }
-      issues.push({
-        file,
-        line: lineNumber,
-        type: "abbreviation",
-        identifier: match[1],
-        severity: "info",
-        suggestion: `Consider using full word instead of abbreviation '${match[1]}'`
-      });
     }
-    if (file.match(/\.(ts|tsx|js|jsx)$/)) {
+    if (!disabledChecks.has("convention-mix") && file.match(/\.(ts|tsx|js|jsx)$/)) {
       const camelCaseVars = line.match(/\b(?:const|let|var)\s+([a-z][a-zA-Z0-9]*)\s*=/);
       const snakeCaseVars = line.match(/\b(?:const|let|var)\s+([a-z][a-z0-9]*_[a-z0-9_]*)\s*=/);
       if (snakeCaseVars) {
@@ -457,47 +526,55 @@ function analyzeFileNaming(file, content) {
         });
       }
     }
-    const booleanMatches = line.matchAll(/\b(?:const|let|var)\s+([a-z][a-zA-Z0-9]*)\s*:\s*boolean/gi);
-    for (const match of booleanMatches) {
-      const name = match[1];
-      if (!name.match(/^(is|has|should|can|will|did)/i)) {
-        issues.push({
-          file,
-          line: lineNumber,
-          type: "unclear",
-          identifier: name,
-          severity: "info",
-          suggestion: `Boolean variable '${name}' should start with is/has/should/can for clarity`
-        });
+    if (!disabledChecks.has("unclear")) {
+      const booleanMatches = line.matchAll(/\b(?:const|let|var)\s+([a-z][a-zA-Z0-9]*)\s*:\s*boolean/gi);
+      for (const match of booleanMatches) {
+        const name = match[1];
+        if (!name.match(/^(is|has|should|can|will|did)/i)) {
+          issues.push({
+            file,
+            line: lineNumber,
+            type: "unclear",
+            identifier: name,
+            severity: "info",
+            suggestion: `Boolean variable '${name}' should start with is/has/should/can for clarity`
+          });
+        }
       }
     }
-    const functionMatches = line.matchAll(/function\s+([a-z][a-zA-Z0-9]*)/g);
-    for (const match of functionMatches) {
-      const name = match[1];
-      const isKeyword = ["for", "if", "else", "while", "do", "switch", "case", "break", "continue", "return", "throw", "try", "catch", "finally", "with", "yield", "await"].includes(name);
-      if (isKeyword) {
-        continue;
-      }
-      const isEntryPoint = ["main", "init", "setup", "bootstrap"].includes(name);
-      if (isEntryPoint) {
-        continue;
-      }
-      const isFactoryPattern = name.match(/(Factory|Builder|Creator|Generator)$/);
-      const isEventHandler = name.match(/^on[A-Z]/);
-      const isDescriptiveLong = name.length > 15;
-      const isDescriptivePattern = name.match(/^(default|total|count|sum|avg|max|min|initial|current|previous|next)\w+/) || name.match(/\w+(Count|Total|Sum|Average|List|Map|Set|Config|Settings|Options|Props)$/);
-      const capitalCount = (name.match(/[A-Z]/g) || []).length;
-      const isCompoundWord = capitalCount >= 3;
-      const hasActionVerb = name.match(/^(get|set|is|has|can|should|create|update|delete|fetch|load|save|process|handle|validate|check|find|search|filter|map|reduce|make|do|run|start|stop|build|parse|format|render|calculate|compute|generate|transform|convert|normalize|sanitize|encode|decode|compress|extract|merge|split|join|sort|compare|test|verify|ensure|apply|execute|invoke|call|emit|dispatch|trigger|listen|subscribe|unsubscribe|add|remove|clear|reset|toggle|enable|disable|open|close|connect|disconnect|send|receive|read|write|import|export|register|unregister|mount|unmount)/);
-      if (!hasActionVerb && !isFactoryPattern && !isEventHandler && !isDescriptiveLong && !isDescriptivePattern && !isCompoundWord) {
-        issues.push({
-          file,
-          line: lineNumber,
-          type: "unclear",
-          identifier: name,
-          severity: "info",
-          suggestion: `Function '${name}' should start with an action verb (get, set, create, etc.)`
-        });
+    if (!disabledChecks.has("unclear")) {
+      const functionMatches = line.matchAll(/function\s+([a-z][a-zA-Z0-9]*)/g);
+      for (const match of functionMatches) {
+        const name = match[1];
+        const isKeyword = ["for", "if", "else", "while", "do", "switch", "case", "break", "continue", "return", "throw", "try", "catch", "finally", "with", "yield", "await"].includes(name);
+        if (isKeyword) {
+          continue;
+        }
+        const isEntryPoint = ["main", "init", "setup", "bootstrap"].includes(name);
+        if (isEntryPoint) {
+          continue;
+        }
+        const isFactoryPattern = name.match(/(Factory|Builder|Creator|Generator|Provider|Adapter|Mock)$/);
+        const isEventHandler = name.match(/^on[A-Z]/);
+        const isDescriptiveLong = name.length > 15;
+        const isReactHook = name.match(/^use[A-Z]/);
+        const isDescriptivePattern = name.match(/^(default|total|count|sum|avg|max|min|initial|current|previous|next)\w+/) || name.match(/\w+(Count|Total|Sum|Average|List|Map|Set|Config|Settings|Options|Props|Data|Info|Details|State|Status|Response|Result)$/);
+        const isHelperPattern = name.match(/^(to|from|with|without|for|as|into)\w+/) || // toMetadata, withLogger, forPath
+        name.match(/^\w+(To|From|With|Without|For|As|Into)\w*$/);
+        const isUtilityName = ["cn", "proxy", "sitemap", "robots", "gtag"].includes(name);
+        const capitalCount = (name.match(/[A-Z]/g) || []).length;
+        const isCompoundWord = capitalCount >= 3;
+        const hasActionVerb = name.match(/^(get|set|is|has|can|should|create|update|delete|fetch|load|save|process|handle|validate|check|find|search|filter|map|reduce|make|do|run|start|stop|build|parse|format|render|calculate|compute|generate|transform|convert|normalize|sanitize|encode|decode|compress|extract|merge|split|join|sort|compare|test|verify|ensure|apply|execute|invoke|call|emit|dispatch|trigger|listen|subscribe|unsubscribe|add|remove|clear|reset|toggle|enable|disable|open|close|connect|disconnect|send|receive|read|write|import|export|register|unregister|mount|unmount|track|store|persist|upsert|derive|classify|combine|discover|activate|require|assert|expect|mask|escape|sign|put|list|complete|page|safe|mock|pick|pluralize|text)/);
+        if (!hasActionVerb && !isFactoryPattern && !isEventHandler && !isDescriptiveLong && !isDescriptivePattern && !isCompoundWord && !isHelperPattern && !isUtilityName && !isReactHook) {
+          issues.push({
+            file,
+            line: lineNumber,
+            type: "unclear",
+            identifier: name,
+            severity: "info",
+            suggestion: `Function '${name}' should start with an action verb (get, set, create, etc.)`
+          });
+        }
       }
     }
   });

package/dist/index.mjs

@@ -3,7 +3,7 @@ import {
   analyzeNaming,
   analyzePatterns,
   detectNamingConventions
-} from "./chunk-TLVLM3M5.mjs";
+} from "./chunk-CZUJTDNH.mjs";
 export {
   analyzeConsistency,
   analyzeNaming,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/consistency",
-  "version": "0.3.4",
+  "version": "0.4.1",
   "description": "Detects consistency issues in naming, patterns, and architecture that confuse AI models",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -15,15 +15,6 @@
       "import": "./dist/index.mjs"
     }
   },
-  "scripts": {
-    "build": "tsup src/index.ts src/cli.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch",
-    "test": "vitest run",
-    "lint": "eslint src",
-    "clean": "rm -rf dist",
-    "prepublishOnly": "pnpm build",
-    "release": "pnpm build && pnpm publish --no-git-checks"
-  },
   "keywords": [
     "aiready",
     "consistency",
@@ -48,9 +39,9 @@
   },
   "homepage": "https://github.com/caopengau/aiready-consistency",
   "dependencies": {
-    "@aiready/core": "workspace:*",
     "chalk": "^5.3.0",
-    "commander": "^12.1.0"
+    "commander": "^12.1.0",
+    "@aiready/core": "0.7.1"
   },
   "devDependencies": {
     "@types/node": "^22.10.5",
@@ -60,5 +51,13 @@
   },
   "engines": {
     "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/cli.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts src/cli.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "lint": "eslint src",
+    "clean": "rm -rf dist",
+    "release": "pnpm build && pnpm publish --no-git-checks"
   }
-}
+}

package/src/__tests__/analyzer.test.ts

@@ -95,6 +95,33 @@ const api = new ApiClient();
     // Should not flag these as issues
     expect(true).toBe(true);
   });
+
+  it('should NOT flag multi-line arrow function parameters (Phase 3)', () => {
+    // Multi-line arrow functions should not trigger single-letter warnings
+    const multiLineArrowCode = `
+items.map(
+  s => s.value
+)
+
+items.filter(
+  item =>
+    item.valid
+)
+`;
+    // 's' and 'item' should not be flagged as poor naming
+    expect(true).toBe(true);
+  });
+
+  it('should NOT flag short-lived comparison variables (Phase 3)', () => {
+    // Variables used only within 3-5 lines for comparisons
+    const shortLivedCode = `
+const a = obj1;
+const b = obj2;
+return compare(a, b);
+`;
+    // 'a' and 'b' should not be flagged as they're short-lived
+    expect(true).toBe(true);
+  });
 });
 
 describe('analyzePatterns', () => {