@aiready/consistency 0.3.3 → 0.3.4

package/dist/index.js

@@ -32,12 +32,154 @@ var import_core3 = require("@aiready/core");
 
 // src/analyzers/naming.ts
 var import_core = require("@aiready/core");
+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",
+  // 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",
@@ -55,6 +197,9 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "rss",
   "xhr",
   "ajax",
+  "cors",
+  "ws",
+  "wss",
   // Data formats
   "json",
   "xml",
@@ -64,12 +209,27 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "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",
@@ -86,6 +246,8 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "cli",
   "cmd",
   "exe",
+  "cwd",
+  "pwd",
   // UI/UX
   "ui",
   "ux",
@@ -98,6 +260,7 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "ctx",
   "err",
   "msg",
+  "auth",
   // Mathematics/Computing
   "max",
   "min",
@@ -115,12 +278,17 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "var",
   "int",
   "num",
+  "idx",
   // Time
   "now",
   "utc",
   "tz",
   "ms",
   "sec",
+  "hr",
+  "min",
+  "yr",
+  "mo",
   // Common patterns
   "app",
   "cfg",
@@ -140,13 +308,70 @@ var ACCEPTABLE_ABBREVIATIONS = /* @__PURE__ */ new Set([
   "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",
+  // Metrics/Performance
+  "fcp",
+  "lcp",
+  "cls",
+  "ttfb",
+  "tti",
+  "fid",
+  "fps",
+  "qps",
+  "rps",
+  "tps",
+  // Testing & i18n
+  "po",
+  "e2e",
+  "a11y",
+  "i18n",
+  "l10n",
+  // Domain-specific abbreviations (context-aware)
+  "sk",
+  "fy",
+  "faq",
+  "og",
+  "seo",
+  "cta",
+  "roi",
+  "kpi",
   // Boolean helpers (these are intentional short names)
   "is",
   "has",
   "can",
   "did",
   "was",
-  "are"
+  "are",
+  // Date/Time context (when in date contexts)
+  "d",
+  "t",
+  "dt"
 ]);
 async function analyzeNaming(files) {
   const issues = [];
@@ -159,14 +384,22 @@ async function analyzeNaming(files) {
 }
 function analyzeFileNaming(file, content) {
   const issues = [];
+  const isTestFile = file.match(/\.(test|spec)\.(ts|tsx|js|jsx)$/);
   const lines = content.split("\n");
   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") || line.includes(".map") || line.includes(".filter") || line.includes(".forEach") || line.includes(".reduce");
-      if (!isInLoopContext && !["x", "y", "z", "i", "j", "k", "l", "n", "m"].includes(letter)) {
+      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;
+        }
         issues.push({
           file,
           line: lineNumber,
@@ -180,16 +413,35 @@ function analyzeFileNaming(file, content) {
     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 (!ACCEPTABLE_ABBREVIATIONS.has(abbrev)) {
-        issues.push({
-          file,
-          line: lineNumber,
-          type: "abbreviation",
-          identifier: match[1],
-          severity: "info",
-          suggestion: `Consider using full word instead of abbreviation '${match[1]}'`
-        });
+      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)) {
+          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 (file.match(/\.(ts|tsx|js|jsx)$/)) {
       const camelCaseVars = line.match(/\b(?:const|let|var)\s+([a-z][a-zA-Z0-9]*)\s*=/);
@@ -222,11 +474,22 @@ function analyzeFileNaming(file, content) {
     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 > 20;
+      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) {
+      if (!hasActionVerb && !isFactoryPattern && !isEventHandler && !isDescriptiveLong && !isDescriptivePattern && !isCompoundWord) {
         issues.push({
           file,
           line: lineNumber,

package/dist/index.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aiready/consistency",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "Detects consistency issues in naming, patterns, and architecture that confuse AI models",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -15,6 +15,15 @@
       "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",
@@ -39,9 +48,9 @@
   },
   "homepage": "https://github.com/caopengau/aiready-consistency",
   "dependencies": {
+    "@aiready/core": "workspace:*",
     "chalk": "^5.3.0",
-    "commander": "^12.1.0",
-    "@aiready/core": "0.7.0"
+    "commander": "^12.1.0"
   },
   "devDependencies": {
     "@types/node": "^22.10.5",
@@ -51,13 +60,5 @@
   },
   "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

@@ -49,12 +49,25 @@ const result = x + y;
     const acceptableAbbreviations = [
       'env', 'req', 'res', 'ctx', 'err', 'api', 'url', 'id',
       'max', 'min', 'now', 'utm', 'has', 'is', 'can',
-      'db', 'fs', 'os', 'ui', 'tmp', 'src', 'dst'
+      'db', 'fs', 'os', 'ui', 'tmp', 'src', 'dst',
+      // New additions from Phase 1
+      'img', 'txt', 'doc', 'md', 'ts', 'js', 'ddb', 's3',
+      'fcp', 'lcp', 'fps', 'po', 'dto', 'e2e', 'a11y', 'i18n'
     ];
     // These abbreviations should not trigger warnings
     expect(acceptableAbbreviations.length).toBeGreaterThan(0);
   });
 
+  it('should NOT flag common short English words', () => {
+    // Full words, not abbreviations - should be accepted
+    const commonWords = [
+      'day', 'key', 'net', 'to', 'go', 'for', 'not', 'new', 'old',
+      'top', 'end', 'run', 'try', 'use', 'get', 'set', 'add', 'put'
+    ];
+    // These are full words and should not be flagged as abbreviations
+    expect(commonWords.length).toBeGreaterThan(0);
+  });
+
   it('should detect snake_case in TypeScript files', () => {
     const testCode = `
 const user_name = 'John';