@aiready/consistency 0.6.8 → 0.6.12

package/.turbo/turbo-build.log

@@ -1,6 +1,6 @@
 
 
-> @aiready/consistency@0.6.8 build /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.6.12 build /Users/pengcao/projects/aiready/packages/consistency
 > tsup src/index.ts src/cli.ts --format cjs,esm --dts
 
 CLI Building entry: src/cli.ts, src/index.ts
@@ -10,15 +10,15 @@
 CJS Build start
 ESM Build start
 CJS dist/index.js 47.29 KB
-CJS dist/cli.js   46.58 KB
-CJS ⚡️ Build success in 99ms
-ESM dist/cli.mjs            8.55 KB
+CJS dist/cli.js   46.80 KB
+CJS ⚡️ Build success in 215ms
+ESM dist/cli.mjs            8.76 KB
+ESM dist/chunk-7PHHJOGC.mjs 36.87 KB
 ESM dist/index.mjs          9.40 KB
-ESM dist/chunk-HPG7P6PD.mjs 36.87 KB
-ESM ⚡️ Build success in 99ms
+ESM ⚡️ Build success in 215ms
 DTS Build start
-DTS ⚡️ Build success in 1083ms
+DTS ⚡️ Build success in 1940ms
 DTS dist/cli.d.ts    20.00 B
-DTS dist/index.d.ts  2.77 KB
+DTS dist/index.d.ts  2.99 KB
 DTS dist/cli.d.mts   20.00 B
-DTS dist/index.d.mts 2.77 KB
+DTS dist/index.d.mts 2.99 KB

package/.turbo/turbo-test.log

@@ -1,69 +1,299 @@
 
 
-> @aiready/consistency@0.6.8 test /Users/pengcao/projects/aiready/packages/consistency
+> @aiready/consistency@0.6.12 test /Users/pengcao/projects/aiready/packages/consistency
 > vitest run
 
 
  RUN  v2.1.9 /Users/pengcao/projects/aiready/packages/consistency
 
-[?25l     · should detect unclear boolean names
-     · should allow common abbreviations
-     · should NOT flag multi-line arrow function parameters (Phase 3)
-     · should NOT flag short-lived comparison variables (Phase 3)
+[?25l · src/__tests__/analyzer.test.ts (18)
+[?25l · src/__tests__/analyzer.test.ts (18)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠙ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
    · analyzePatterns (3)
-     · should detect mixed error handling
-     · should detect mixed async patterns
-     · should detect mixed import styles
    · consistency scoring (2)
-     · should calculate consistency score correctly
-     · should weight critical issues more than info
    · recommendations (3)
-     · should generate relevant recommendations
-     · should suggest standardizing error handling
-     · should suggest using async/await consistently
-[?25l[?25l[?25l[?25l[?25l[?25l[?25l     ✓ should detect unclear boolean names
-     ✓ should allow common abbreviations
-     ✓ should NOT flag multi-line arrow function parameters (Phase 3)
-     ✓ should NOT flag short-lived comparison variables (Phase 3)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠹ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠸ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠼ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠴ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠦ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ · src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠧ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠇ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠏ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠋ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠙ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠹ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠸ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+   ❯ analyzeConsistency (2)
+     ⠼ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠴ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠦ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ⠧ should analyze naming issues
+     · should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues 312ms
+     ⠙ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues 312ms
+     ⠹ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues 312ms
+     ⠸ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues 312ms
+     ⠼ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues 312ms
+     ⠴ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues 312ms
+     ⠦ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+ ✓ src/__tests__/analyzer.test.ts (18) 415ms
+ ✓ src/__tests__/language-filter.test.ts (3)
+
+ Test Files  2 passed (2)
+      Tests  21 passed (21)
+   Start at  18:01:20
+   Duration  2.38s (transform 742ms, setup 0ms, collect 2.26s, tests 425ms, environment 0ms, prepare 531ms)
+
+[?25h[?25h
+ms
+   ✓ analyzeNaming (8)
    ✓ analyzePatterns (3)
-     ✓ should detect mixed error handling
-     ✓ should detect mixed async patterns
-     ✓ should detect mixed import styles
    ✓ consistency scoring (2)
-     ✓ should calculate consistency score correctly
-     ✓ should weight critical issues more than info
    ❯ recommendations (3)
      ⠙ should generate relevant recommendations
      · should suggest standardizing error handling
      · should suggest using async/await consistently
- ✓ src/__tests__/analyzer.test.ts (18)
-   ✓ analyzeConsistency (2)
+ ✓ src/__tests__/language-filter.test.ts (3)
+ ✓ src/__tests__/analyzer.test.ts (18) 451ms
+ ✓ src/__tests__/language-filter.test.ts (3)
+
+ Test Files  2 passed (2)
+      Tests  21 passed (21)
+   Start at  18:01:19
+   Duration  2.72s (transform 1.07s, setup 0ms, collect 3.76s, tests 456ms, environment 0ms, prepare 214ms)
+
+[?25h[?25h
+st.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues
+     ⠹ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues
+     ⠸ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
      ✓ should analyze naming issues
-     ✓ should detect minimum severity filtering
+     ⠼ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ❯ analyzeConsistency (2)
+     ✓ should analyze naming issues
+     ⠴ should detect minimum severity filtering
+   · analyzeNaming (8)
+   · analyzePatterns (3)
+   · consistency scoring (2)
+   · recommendations (3)
+ ✓ src/__tests__/language-filter.test.ts (3)
+[?25l ❯ src/__tests__/analyzer.test.ts (18)
+   ✓ analyzeConsistency (2) 553ms
    ✓ analyzeNaming (8)
-     ✓ should detect single letter variables
-     ✓ should NOT flag acceptable abbreviations
-     ✓ should NOT flag common short English words
-     ✓ should detect snake_case in TypeScript files
-     ✓ should detect unclear boolean names
-     ✓ should allow common abbreviations
-     ✓ should NOT flag multi-line arrow function parameters (Phase 3)
-     ✓ should NOT flag short-lived comparison variables (Phase 3)
    ✓ analyzePatterns (3)
-     ✓ should detect mixed error handling
-     ✓ should detect mixed async patterns
-     ✓ should detect mixed import styles
    ✓ consistency scoring (2)
-     ✓ should calculate consistency score correctly
-     ✓ should weight critical issues more than info
-   ✓ recommendations (3)
-     ✓ should generate relevant recommendations
-     ✓ should suggest standardizing error handling
-     ✓ should suggest using async/await consistently
+   ❯ recommendations (3)
+     ⠙ should generate relevant recommendations
+     · should suggest standardizing error handling
+     · should suggest using async/await consistently
+ ✓ src/__tests__/language-filter.test.ts (3)
+ ✓ src/__tests__/analyzer.test.ts (18) 596ms
+ ✓ src/__tests__/language-filter.test.ts (3)
 
- Test Files  1 passed (1)
-      Tests  18 passed (18)
-   Start at  20:58:11
-   Duration  769ms (transform 126ms, setup 0ms, collect 331ms, tests 135ms, environment 0ms, prepare 55ms)
+ Test Files  2 passed (2)
+      Tests  21 passed (21)
+   Start at  18:01:19
+   Duration  2.68s (transform 1.41s, setup 0ms, collect 2.94s, tests 724ms, environment 0ms, prepare 693ms)
 
 [?25h[?25h

package/LANGUAGE-SUPPORT-FIX.md

@@ -0,0 +1,154 @@
+# Language Support Fix - Python Files Issue
+
+## Issue Report
+
+**Date:** 2026-01-20  
+**Reporter:** Consumer testing on receiptclaimer project  
+**Package:** @aiready/consistency
+
+### Problem Description
+
+The `@aiready/consistency` tool was attempting to parse **Python files (.py)** using a **TypeScript/JavaScript parser** (`@typescript-eslint/typescript-estree`), causing parse failures with misleading error messages.
+
+### Error Messages
+
+```
+Failed to parse /path/to/compute_weighted_ranking.py: Unterminated string literal.
+Failed to parse /path/to/search_console_to_bq.py: Unterminated string literal.
+Failed to parse /path/to/merge-web-coverage.ts: Invalid character.
+Failed to parse /path/to/merge-all-coverage.ts: '>' expected.
+```
+
+### Root Cause Analysis
+
+1. **File Scanner:** The core `scanFiles()` utility includes multiple language patterns by default:
+   ```typescript
+   include = ['**/*.{ts,tsx,js,jsx,py,java}']
+   ```
+
+2. **Parser Limitation:** The `@aiready/consistency` tool uses `@typescript-eslint/typescript-estree` which only supports TypeScript/JavaScript syntax.
+
+3. **No Language Filter:** The tool was processing all files returned by the scanner without filtering by supported language extensions.
+
+### Issue Classification
+
+| File Type | Status | Root Cause |
+|-----------|--------|------------|
+| Python files (.py) | **Tool Issue** | Tool tried to parse with wrong parser |
+| TypeScript files (.ts) | **File Issue** | Actual syntax errors in source files |
+
+## Fix Implementation
+
+### Changes Made
+
+#### 1. Added Language Filtering ([naming-ast.ts](packages/consistency/src/analyzers/naming-ast.ts))
+
+```typescript
+// Filter to only JS/TS files that the TypeScript parser can handle
+const supportedFiles = files.filter(file => 
+  /\.(js|jsx|ts|tsx)$/i.test(file)
+);
+```
+
+#### 2. Updated Documentation
+
+- **README.md:** Added "Supported Languages" section at the top
+- **README.md:** Added "Language Support" subsection explaining which files are skipped
+- **CLI Help:** Added language support information
+- **Code Comments:** Documented limitations in analyzer and parser functions
+
+#### 3. Improved Error Handling ([ast-parser.ts](packages/consistency/src/utils/ast-parser.ts))
+
+- Removed noisy `console.warn()` for parse failures
+- Added comments explaining that non-JS/TS files should be filtered upstream
+- Made parse failures silent (returns `null`) since they're now expected for excluded files
+
+#### 4. Added Test Coverage ([language-filter.test.ts](packages/consistency/src/__tests__/language-filter.test.ts))
+
+- Tests that Python/Java/Ruby files are filtered out
+- Verifies all JS/TS extensions are accepted
+- Ensures no crashes on mixed language projects
+
+### Design Decision: Core Scanner vs Tool Filtering
+
+**Question:** Should the core scanner exclude Python files, or should each tool filter?
+
+**Decision:** **Tool-level filtering** (implemented)
+
+**Rationale:**
+- Core scanner is designed for future multi-language support
+- Other tools (e.g., future Python linter) may need `.py` files
+- Each tool knows its language capabilities best
+- Follows separation of concerns principle
+
+### Verification
+
+✅ Build successful  
+✅ Tests passing (3 new tests added)  
+✅ Documentation updated  
+✅ No breaking changes
+
+## For Users
+
+### What Changed
+
+**Before:** Tool attempted to parse Python/Java files and showed confusing errors
+
+**After:** Tool silently skips unsupported languages and only analyzes JS/TS files
+
+### Migration Guide
+
+No action required. This is a non-breaking improvement.
+
+### New Behavior
+
+When running on a mixed-language project:
+```bash
+npx @aiready/consistency ./src
+```
+
+The tool will:
+1. ✅ Analyze all `.ts`, `.tsx`, `.js`, `.jsx` files
+2. ⏭️ Skip `.py`, `.java`, and other language files
+3. 📊 Report only on supported languages
+4. ❌ No more "Failed to parse" warnings for Python files
+
+## Future Enhancements
+
+Potential improvements for future versions:
+
+1. **Multi-Language Support**
+   - Add Python AST parser for Python files
+   - Add Java parser for Java files
+   - Create language-specific analyzers
+
+2. **Better Diagnostics**
+   - Count and report skipped files by language
+   - Suggest language-specific tools for unsupported files
+
+3. **Configuration Option**
+   - Allow users to explicitly specify supported languages
+   - Add `--strict` mode to error on unsupported files
+
+## Related Files
+
+- [packages/consistency/src/analyzers/naming-ast.ts](packages/consistency/src/analyzers/naming-ast.ts) - Added filtering
+- [packages/consistency/src/analyzer.ts](packages/consistency/src/analyzer.ts) - Updated docs
+- [packages/consistency/src/cli.ts](packages/consistency/src/cli.ts) - Updated help text
+- [packages/consistency/src/utils/ast-parser.ts](packages/consistency/src/utils/ast-parser.ts) - Improved error handling
+- [packages/consistency/README.md](packages/consistency/README.md) - Added language support section
+- [packages/core/src/utils/file-scanner.ts](packages/core/src/utils/file-scanner.ts) - Documented broad defaults
+
+## Testing
+
+Run the new tests:
+```bash
+cd packages/consistency
+pnpm test language-filter.test.ts
+```
+
+Verify on a mixed-language project:
+```bash
+# Should work without Python parse errors
+npx @aiready/consistency /path/to/mixed-project
+```

package/README.md

@@ -4,6 +4,10 @@
 
 Helps teams maintain consistent coding practices across their codebase, making it easier for AI tools to understand and work with your code.
 
+**Supported Languages:** TypeScript, JavaScript (`.ts`, `.tsx`, `.js`, `.jsx`)
+
+> **Note:** Python, Java, and other language files in your project will be safely ignored during analysis.
+
 ## 🚀 Quick Start
 
 **Zero config, works out of the box:**
@@ -54,6 +58,19 @@ CRITICAL (2 files)
 
 Inconsistent code patterns confuse AI models and reduce their effectiveness. This tool analyzes:
 
+### 🔧 Language Support
+
+**Fully Supported:**
+- TypeScript (`.ts`, `.tsx`)
+- JavaScript (`.js`, `.jsx`)
+
+**Not Yet Supported:**
+- Python (`.py`) - Files will be skipped
+- Java (`.java`) - Files will be skipped
+- Other languages - Files will be skipped
+
+If you see "Failed to parse" warnings for non-JS/TS files, this is expected behavior and won't affect the analysis of your JavaScript/TypeScript code.
+
 ### 🏷️ Naming Quality & Conventions
 - **Single-letter variables** - Detects unclear variable names (skips common iterators: i, j, k, l, x, y, z in appropriate contexts)
 - **Abbreviations** - Identifies unclear abbreviations while allowing 60+ standard ones (env, req, res, ctx, max, min, etc.)