@aiready/consistency 0.5.0 → 0.6.1

package/dist/index.mjs

@@ -1,12 +1,589 @@
 import {
   analyzeConsistency,
-  analyzeNaming,
-  analyzePatterns,
-  detectNamingConventions
-} from "./chunk-TXHPUU7A.mjs";
+  analyzeNamingAST,
+  analyzePatterns
+} from "./chunk-LD3CHHU2.mjs";
+
+// src/analyzers/naming.ts
+import { readFileContent, loadConfig } from "@aiready/core";
+import { dirname } from "path";
+var COMMON_SHORT_WORDS = /* @__PURE__ */ new Set([
+  // Full English words (1-3 letters)
+  "day",
+  "key",
+  "net",
+  "to",
+  "go",
+  "for",
+  "not",
+  "new",
+  "old",
+  "top",
+  "end",
+  "run",
+  "try",
+  "use",
+  "get",
+  "set",
+  "add",
+  "put",
+  "map",
+  "log",
+  "row",
+  "col",
+  "tab",
+  "box",
+  "div",
+  "nav",
+  "tag",
+  "any",
+  "all",
+  "one",
+  "two",
+  "out",
+  "off",
+  "on",
+  "yes",
+  "no",
+  "now",
+  "max",
+  "min",
+  "sum",
+  "avg",
+  "ref",
+  "src",
+  "dst",
+  "raw",
+  "def",
+  "sub",
+  "pub",
+  "pre",
+  "mid",
+  "alt",
+  "opt",
+  "tmp",
+  "ext",
+  "sep",
+  // Prepositions and conjunctions
+  "and",
+  "from",
+  "how",
+  "pad",
+  "bar",
+  "non",
+  // Additional full words commonly flagged
+  "tax",
+  "cat",
+  "dog",
+  "car",
+  "bus",
+  "web",
+  "app",
+  "war",
+  "law",
+  "pay",
+  "buy",
+  "win",
+  "cut",
+  "hit",
+  "hot",
+  "pop",
+  "job",
+  "age",
+  "act",
+  "let",
+  "lot",
+  "bad",
+  "big",
+  "far",
+  "few",
+  "own",
+  "per",
+  "red",
+  "low",
+  "see",
+  "six",
+  "ten",
+  "way",
+  "who",
+  "why",
+  "yet",
+  "via",
+  "due",
+  "fee",
+  "fun",
+  "gas",
+  "gay",
+  "god",
+  "gun",
+  "guy",
+  "ice",
+  "ill",
+  "kid",
+  "mad",
+  "man",
+  "mix",
+  "mom",
+  "mrs",
+  "nor",
+  "odd",
+  "oil",
+  "pan",
+  "pet",
+  "pit",
+  "pot",
+  "pow",
+  "pro",
+  "raw",
+  "rep",
+  "rid",
+  "sad",
+  "sea",
+  "sit",
+  "sky",
+  "son",
+  "tea",
+  "tie",
+  "tip",
+  "van",
+  "war",
+  "win",
+  "won"
+]);
+var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
+  // Standard identifiers
+  "id",
+  "uid",
+  "gid",
+  "pid",
+  // Loop counters and iterators
+  "i",
+  "j",
+  "k",
+  "n",
+  "m",
+  // Web/Network
+  "url",
+  "uri",
+  "api",
+  "cdn",
+  "dns",
+  "ip",
+  "tcp",
+  "udp",
+  "http",
+  "ssl",
+  "tls",
+  "utm",
+  "seo",
+  "rss",
+  "xhr",
+  "ajax",
+  "cors",
+  "ws",
+  "wss",
+  // Data formats
+  "json",
+  "xml",
+  "yaml",
+  "csv",
+  "html",
+  "css",
+  "svg",
+  "pdf",
+  // File types & extensions
+  "img",
+  "txt",
+  "doc",
+  "docx",
+  "xlsx",
+  "ppt",
+  "md",
+  "rst",
+  "jpg",
+  "png",
+  "gif",
+  // Databases
+  "db",
+  "sql",
+  "orm",
+  "dao",
+  "dto",
+  "ddb",
+  "rds",
+  "nosql",
+  // File system
+  "fs",
+  "dir",
+  "tmp",
+  "src",
+  "dst",
+  "bin",
+  "lib",
+  "pkg",
+  // Operating system
+  "os",
+  "env",
+  "arg",
+  "cli",
+  "cmd",
+  "exe",
+  "cwd",
+  "pwd",
+  // UI/UX
+  "ui",
+  "ux",
+  "gui",
+  "dom",
+  "ref",
+  // Request/Response
+  "req",
+  "res",
+  "ctx",
+  "err",
+  "msg",
+  "auth",
+  // Mathematics/Computing
+  "max",
+  "min",
+  "avg",
+  "sum",
+  "abs",
+  "cos",
+  "sin",
+  "tan",
+  "log",
+  "exp",
+  "pow",
+  "sqrt",
+  "std",
+  "var",
+  "int",
+  "num",
+  "idx",
+  // Time
+  "now",
+  "utc",
+  "tz",
+  "ms",
+  "sec",
+  "hr",
+  "min",
+  "yr",
+  "mo",
+  // Common patterns
+  "app",
+  "cfg",
+  "config",
+  "init",
+  "len",
+  "val",
+  "str",
+  "obj",
+  "arr",
+  "gen",
+  "def",
+  "raw",
+  "new",
+  "old",
+  "pre",
+  "post",
+  "sub",
+  "pub",
+  // Programming/Framework specific
+  "ts",
+  "js",
+  "jsx",
+  "tsx",
+  "py",
+  "rb",
+  "vue",
+  "re",
+  "fn",
+  "fns",
+  "mod",
+  "opts",
+  "dev",
+  // Cloud/Infrastructure
+  "s3",
+  "ec2",
+  "sqs",
+  "sns",
+  "vpc",
+  "ami",
+  "iam",
+  "acl",
+  "elb",
+  "alb",
+  "nlb",
+  "aws",
+  "ses",
+  "gst",
+  "cdk",
+  "btn",
+  "buf",
+  "agg",
+  "ocr",
+  "ai",
+  "cf",
+  "cfn",
+  "ga",
+  // Metrics/Performance
+  "fcp",
+  "lcp",
+  "cls",
+  "ttfb",
+  "tti",
+  "fid",
+  "fps",
+  "qps",
+  "rps",
+  "tps",
+  "wpm",
+  // Testing & i18n
+  "po",
+  "e2e",
+  "a11y",
+  "i18n",
+  "l10n",
+  "spy",
+  // Domain-specific abbreviations (context-aware)
+  "sk",
+  "fy",
+  "faq",
+  "og",
+  "seo",
+  "cta",
+  "roi",
+  "kpi",
+  "ttl",
+  "pct",
+  // Technical abbreviations
+  "mac",
+  "hex",
+  "esm",
+  "git",
+  "rec",
+  "loc",
+  "dup",
+  // Boolean helpers (these are intentional short names)
+  "is",
+  "has",
+  "can",
+  "did",
+  "was",
+  "are",
+  // Date/Time context (when in date contexts)
+  "d",
+  "t",
+  "dt",
+  // Coverage metrics (industry standard: statements/branches/functions/lines)
+  "s",
+  "b",
+  "f",
+  "l",
+  // Common media/content abbreviations
+  "vid",
+  "pic",
+  "img",
+  "doc",
+  "msg"
+]);
+async function analyzeNaming(files) {
+  const issues = [];
+  const rootDir = files.length > 0 ? dirname(files[0]) : process.cwd();
+  const config = 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 readFileContent(file);
+    const fileIssues = analyzeFileNaming(file, content, customAbbreviations, customShortWords, disabledChecks);
+    issues.push(...fileIssues);
+  }
+  return issues;
+}
+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 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 isCoverageContext = /coverage|summary|metrics|pct|percent/i.test(line) || /\.(?:statements|branches|functions|lines)\.pct/i.test(line);
+        if (isCoverageContext && ["s", "b", "f", "l"].includes(letter)) {
+          continue;
+        }
+        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]}'`
+          });
+        }
+      }
+    }
+    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;
+        }
+        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]}'`
+        });
+      }
+    }
+    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) {
+        issues.push({
+          file,
+          line: lineNumber,
+          type: "convention-mix",
+          identifier: snakeCaseVars[1],
+          severity: "minor",
+          suggestion: `Use camelCase '${snakeCaseToCamelCase(snakeCaseVars[1])}' instead of snake_case in TypeScript/JavaScript`
+        });
+      }
+    }
+    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`
+          });
+        }
+      }
+    }
+    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.)`
+          });
+        }
+      }
+    }
+  });
+  return issues;
+}
+function snakeCaseToCamelCase(str) {
+  return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+}
+function detectNamingConventions(files, allIssues) {
+  const camelCaseCount = allIssues.filter((i) => i.type === "convention-mix").length;
+  const totalChecks = files.length * 10;
+  if (camelCaseCount / totalChecks > 0.3) {
+    return { dominantConvention: "mixed", conventionScore: 0.5 };
+  }
+  return { dominantConvention: "camelCase", conventionScore: 0.9 };
+}
 export {
   analyzeConsistency,
   analyzeNaming,
+  analyzeNamingAST,
   analyzePatterns,
   detectNamingConventions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/consistency",
-  "version": "0.5.0",
+  "version": "0.6.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,11 @@
   },
   "homepage": "https://github.com/caopengau/aiready-consistency",
   "dependencies": {
-    "@aiready/core": "workspace:*",
+    "@typescript-eslint/types": "^8.53.0",
+    "@typescript-eslint/typescript-estree": "^8.53.0",
     "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 +53,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/analyzer.ts

@@ -1,7 +1,7 @@
 import { scanFiles } from '@aiready/core';
 import type { AnalysisResult, Issue } from '@aiready/core';
 import type { ConsistencyOptions, ConsistencyReport, ConsistencyIssue } from './types';
-import { analyzeNaming, detectNamingConventions } from './analyzers/naming';
+import { analyzeNamingAST } from './analyzers/naming-ast';
 import { analyzePatterns } from './analyzers/patterns';
 
 /**
@@ -22,7 +22,7 @@ export async function analyzeConsistency(
   const filePaths = await scanFiles(scanOptions);
 
   // Collect issues by category
-  const namingIssues = checkNaming ? await analyzeNaming(filePaths) : [];
+  const namingIssues = checkNaming ? await analyzeNamingAST(filePaths) : [];
   const patternIssues = checkPatterns ? await analyzePatterns(filePaths) : [];
 
   // Convert to AnalysisResult format
@@ -97,8 +97,8 @@ export async function analyzeConsistency(
   // Generate recommendations
   const recommendations = generateRecommendations(namingIssues, patternIssues);
 
-  // Detect naming conventions
-  const conventionAnalysis = detectNamingConventions(filePaths, namingIssues);
+  // Detect naming conventions (TODO: re-implement for AST version)
+  // const conventionAnalysis = detectNamingConventions(filePaths, namingIssues);
 
   return {
     summary: {