@sun-asterisk/sunlint 1.3.17 → 1.3.18

package/docs/DEPLOYMENT-STRATEGIES.md

@@ -1,270 +0,0 @@
-# SunLint Deployment Strategies
-
-This document outlines different deployment strategies for SunLint, demonstrating the modular approach that allows selective inclusion/exclusion of features.
-
-## Overview
-
-SunLint supports flexible deployment strategies through its modular architecture:
-
-- **Core Features**: Always included (heuristic regex, ESLint integration)
-- **AST Enhancement**: Optional Tree-sitter modules for improved accuracy
-- **Language-Specific**: Can include/exclude language-specific parsers
-- **AI Features**: Optional OpenAI integration
-
-## Deployment Strategies
-
-### 1. Full Distribution (Development/Enterprise)
-
-**Target**: Development teams, enterprise installations
-**Size**: Large (~50MB+ with all AST parsers)
-**Accuracy**: Highest
-
-```bash
-# Include everything
-npm install sunlint
-
-# Available engines: eslint, heuristic (with AST), openai
-sunlint --rule=C010 --engine=heuristic src/
-# Uses AST when available, falls back to regex
-```
-
-**Files Included**:
-```
-sunlint/
-├── engines/
-│   ├── eslint-engine.js        ✅ ESLint integration
-│   ├── heuristic-engine.js     ✅ Enhanced with AST
-│   └── openai-engine.js        ✅ AI-powered analysis
-├── core/ast-modules/           ✅ Full AST support
-│   ├── parsers/
-│   │   ├── javascript-parser.js   ✅ JS AST
-│   │   ├── typescript-parser.js   ✅ TS AST  
-│   │   ├── dart-parser.js         ✅ Dart AST
-│   │   ├── java-parser.js         ✅ Java AST
-│   │   └── ...                    ✅ All languages
-│   └── package.json               ✅ Tree-sitter deps
-└── ...
-```
-
-### 2. TypeScript-Only Distribution
-
-**Target**: TypeScript-only projects, Next.js, React
-**Size**: Medium (~15MB)
-**Accuracy**: High for TS/JS, regex for others
-
-```bash
-# Build script for TypeScript distribution
-npm run build:typescript
-
-# Available engines: eslint, heuristic (TS/JS AST only)
-sunlint --rule=C010 --engine=heuristic src/
-# Uses AST for .ts/.js files, regex for others
-```
-
-**Build Process**:
-```bash
-#!/bin/bash
-# build-typescript.sh
-
-# Copy base files
-cp -r engines/ dist/
-cp -r rules/ dist/
-cp -r core/ dist/
-
-# Keep only TypeScript/JavaScript AST parsers
-mkdir -p dist/core/ast-modules/parsers/
-cp core/ast-modules/index.js dist/core/ast-modules/
-cp core/ast-modules/base-parser.js dist/core/ast-modules/
-cp core/ast-modules/parsers/javascript-parser.js dist/core/ast-modules/parsers/
-cp core/ast-modules/parsers/typescript-parser.js dist/core/ast-modules/parsers/
-
-# Update package.json to include only JS/TS Tree-sitter deps
-cat > dist/core/ast-modules/package.json << 'EOF'
-{
-  "name": "@sunlint/ast-typescript",
-  "dependencies": {
-    "tree-sitter": "^0.20.0",
-    "tree-sitter-javascript": "^0.20.0", 
-    "tree-sitter-typescript": "^0.20.0"
-  }
-}
-EOF
-
-# Remove OpenAI engine for smaller bundle
-rm dist/engines/openai-engine.js
-
-npm pack dist/
-```
-
-### 3. Minimal Distribution (Regex-Only)
-
-**Target**: CI/CD, embedded systems, minimal installs
-**Size**: Small (~2MB)
-**Accuracy**: Basic regex patterns only
-
-```bash
-# Build script for minimal distribution
-npm run build:minimal
-
-# Available engines: eslint, heuristic (regex-only)
-sunlint --rule=C010 --engine=heuristic src/
-# Uses only regex patterns, no AST enhancement
-```
-
-**Build Process**:
-```bash
-#!/bin/bash
-# build-minimal.sh
-
-# Copy only essential files
-cp -r engines/ dist/
-cp -r rules/ dist/
-cp -r core/ dist/
-
-# Remove entire AST modules directory
-rm -rf dist/core/ast-modules/
-
-# Remove OpenAI engine
-rm dist/engines/openai-engine.js
-
-# Update heuristic engine to not reference AST modules
-sed -i 's/const ASTModuleRegistry = require.*//g' dist/engines/heuristic-engine.js
-sed -i 's/this.astRegistry = ASTModuleRegistry;//g' dist/engines/heuristic-engine.js
-
-npm pack dist/
-```
-
-### 4. Language-Specific Distributions
-
-**Example: Java-Only Distribution**
-
-```bash
-#!/bin/bash
-# build-java.sh
-
-# Base files
-cp -r engines/ dist/
-cp -r rules/ dist/
-cp -r core/ dist/
-
-# Keep only Java AST parser
-mkdir -p dist/core/ast-modules/parsers/
-cp core/ast-modules/index.js dist/core/ast-modules/
-cp core/ast-modules/base-parser.js dist/core/ast-modules/
-cp core/ast-modules/parsers/java-parser.js dist/core/ast-modules/parsers/
-
-# Java-specific package.json
-cat > dist/core/ast-modules/package.json << 'EOF'
-{
-  "name": "@sunlint/ast-java",
-  "dependencies": {
-    "tree-sitter": "^0.20.0",
-    "tree-sitter-java": "^0.20.0"
-  }
-}
-EOF
-
-# Remove ESLint engine (Java doesn't need it)
-rm dist/engines/eslint-engine.js
-
-# Update engine registry
-cat > dist/config/engines/engines.json << 'EOF'
-{
-  "engines": {
-    "heuristic": {
-      "enabled": true,
-      "path": "./engines/heuristic-engine.js",
-      "version": "2.0",
-      "supportedLanguages": ["java"],
-      "priority": 1,
-      "description": "Enhanced Java analyzer with AST support"
-    }
-  },
-  "defaultEngines": ["heuristic"],
-  "fallbackEngine": "heuristic"
-}
-EOF
-
-npm pack dist/
-```
-
-## Runtime Behavior
-
-### With AST Support Available
-```bash
-$ sunlint --rule=C010 --engine=heuristic --debug src/
-🌳 [AST-Enhanced] Analyzing C010 for typescript with AST support  
-🌳 [AST-Enhanced] Found 12 violations via AST, 3 via regex
-✅ heuristic: 15 violations found
-```
-
-### AST Support Not Available (Fallback)
-```bash
-$ sunlint --rule=C010 --engine=heuristic --debug src/
-⚠️ Tree-sitter TypeScript parser not available, falling back to regex
-✅ heuristic: 8 violations found
-```
-
-### Minimal Installation
-```bash
-$ sunlint --rule=C010 --engine=heuristic --debug src/
-# No AST warnings - AST modules not included
-✅ heuristic: 8 violations found
-```
-
-## Package.json Configurations
-
-### Full Distribution
-```json
-{
-  "name": "sunlint",
-  "dependencies": {
-    "minimatch": "^9.0.0",
-    "eslint": "^8.0.0"
-  },
-  "optionalDependencies": {
-    "tree-sitter": "^0.20.0",
-    "tree-sitter-javascript": "^0.20.0",
-    "tree-sitter-typescript": "^0.20.0",
-    "tree-sitter-dart": "^0.1.0",
-    "tree-sitter-java": "^0.20.0",
-    "tree-sitter-kotlin": "^0.3.0",
-    "tree-sitter-swift": "^0.4.0",
-    "tree-sitter-python": "^0.20.0",
-    "tree-sitter-go": "^0.20.0",
-    "tree-sitter-rust": "^0.20.0"
-  }
-}
-```
-
-### TypeScript-Only Distribution
-```json
-{
-  "name": "@sunlint/typescript",
-  "dependencies": {
-    "minimatch": "^9.0.0",
-    "eslint": "^8.0.0",
-    "tree-sitter": "^0.20.0",
-    "tree-sitter-javascript": "^0.20.0",
-    "tree-sitter-typescript": "^0.20.0"
-  }
-}
-```
-
-### Minimal Distribution
-```json
-{
-  "name": "@sunlint/minimal",
-  "dependencies": {
-    "minimatch": "^9.0.0"
-  }
-}
-```
-
-## Benefits
-
-1. **Flexibility**: Choose the right distribution for your needs
-2. **Performance**: Smaller bundles load faster, fewer dependencies to install
-3. **Compatibility**: Minimal distribution works everywhere, enhanced versions provide better accuracy
-4. **Gradual Adoption**: Start with minimal, upgrade to AST-enhanced when needed
-5. **Deployment Options**: Different distributions for different environments (CI vs development)

package/docs/ESLINT_INTEGRATION.md

@@ -1,238 +0,0 @@
-# ESLint Integration Feature
-
-## 🎯 **Overview**
-
-SunLint ESLint Integration cho phép teams **merge** existing ESLint configuration với SunLint rules trong **single execution pipeline**. Thay vì chạy parallel, SunLint sẽ **orchestrate** và **combine** cả 2 rule sets.
-
-### **Problem Solved**
-- ✅ Teams có existing ESLint (20 rules) + muốn add SunLint (93 rules) = **113 rules total**
-- ✅ Single command execution thay vì multiple tool chains
-- ✅ No degradation của existing ESLint workflow
-- ✅ Combined reporting cho easier debugging
-
-## 📖 **Configuration**
-
-### **Method 1: package.json Configuration**
-```json
-{
-  "scripts": {
-    "lint:integrated": "sunlint --all --eslint-integration --input=src"
-  },
-  "sunlint": {
-    "eslintIntegration": {
-      "enabled": true,
-      "mergeRules": true,
-      "preserveUserConfig": true
-    },
-    "rules": {
-      "C006": "warn",
-      "C019": "error"
-    }
-  }
-}
-```
-
-### **Method 2: .sunlint.json Configuration**
-```json
-{
-  "eslintIntegration": {
-    "enabled": true,
-    "mergeRules": true,
-    "preserveUserConfig": true,
-    "runAfterSunLint": false
-  },
-  "rules": {
-    "C006": "warn", 
-    "C019": "error",
-    "S047": "warn"
-  }
-}
-```
-
-### **Method 3: CLI Flags**
-```bash
-# Enable integration
-sunlint --all --eslint-integration --input=src
-
-# Merge rules (default: true)
-sunlint --all --eslint-integration --eslint-merge-rules --input=src
-
-# Preserve user config (default: true) 
-sunlint --all --eslint-integration --eslint-preserve-config --input=src
-
-# Run ESLint after SunLint (alternative to merge)
-sunlint --all --eslint-integration --eslint-run-after --input=src
-```
-
-## 🔧 **Integration Modes**
-
-### **Mode 1: Merged Execution (Default)**
-```bash
-sunlint --all --eslint-integration --input=src
-```
-
-**How it works:**
-1. SunLint discovers existing `.eslintrc.json`
-2. Merges SunLint rules + User ESLint rules
-3. Creates combined ESLint configuration
-4. Runs single ESLint execution with **merged ruleset**
-5. Categorizes results by rule source (SunLint vs User)
-
-**Output:**
-```
-🔗 ESLint Integration Summary:
-  📋 SunLint violations: 4
-  🔧 User ESLint violations: 6  
-  📊 Total combined violations: 10
-```
-
-### **Mode 2: Sequential Execution**
-```bash
-sunlint --all --eslint-integration --eslint-run-after --input=src
-```
-
-**How it works:**
-1. Run SunLint rules first
-2. Run user ESLint rules after
-3. Combine results for reporting
-4. Maintain separation of concerns
-
-## 🚀 **Usage Examples**
-
-### **Basic Integration**
-```bash
-# Analyze with both SunLint + existing ESLint rules
-sunlint --typescript --eslint-integration --input=src
-
-# Git integration + ESLint integration
-sunlint --all --eslint-integration --changed-files
-
-# CI pipeline
-sunlint --all --eslint-integration --changed-files --format=summary --fail-on-new-violations
-```
-
-### **Team Migration Scripts**
-```json
-{
-  "scripts": {
-    "lint": "npm run lint:integrated",
-    "lint:integrated": "sunlint --all --eslint-integration --input=src",
-    "lint:changed": "sunlint --all --eslint-integration --changed-files",
-    "lint:staged": "sunlint --all --eslint-integration --staged-files",
-    "ci:lint": "sunlint --all --eslint-integration --changed-files --format=summary"
-  }
-}
-```
-
-### **GitHub Actions Integration**
-```yaml
-name: Code Quality Check
-on: [pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-      - run: npm ci
-      - name: Run Integrated Linting
-        run: |
-          sunlint --all --eslint-integration --changed-files \
-            --diff-base=origin/main \
-            --format=summary \
-            --fail-on-new-violations
-```
-
-## 🏗️ **Architecture**
-
-### **ESLintIntegrationService**
-- **Responsibility**: Detect, load, and merge ESLint configurations
-- **Methods**:
-  - `hasExistingESLintConfig()`: Auto-detect existing ESLint setup
-  - `loadExistingESLintConfig()`: Load user's ESLint configuration
-  - `createMergedConfig()`: Merge SunLint + User rules
-  - `runIntegratedAnalysis()`: Execute combined analysis
-
-### **Configuration Merging Strategy**
-```javascript
-mergedConfig = {
-  extends: [...sunlintExtends, ...userExtends],
-  plugins: [...sunlintPlugins, ...userPlugins], 
-  rules: {
-    ...sunlintRules,
-    ...userRules  // User rules override SunLint in case of conflicts
-  }
-}
-```
-
-### **Result Categorization**
-```javascript
-{
-  results: [...],
-  categorized: {
-    sunlint: [/* SunLint violations */],
-    user: [/* User ESLint violations */],
-    combined: [/* All violations */]
-  },
-  integration: {
-    totalRules: 113,
-    sunlintRules: 93, 
-    userRules: 20
-  }
-}
-```
-
-## 🎯 **Benefits**
-
-### **For Development Teams**
-- ✅ **No workflow disruption**: Existing ESLint continues working
-- ✅ **Single command**: One execution for all quality checks
-- ✅ **Incremental adoption**: Can enable/disable integration easily
-- ✅ **Conflict resolution**: User rules take precedence over SunLint
-
-### **For CI/CD Pipelines**  
-- ✅ **Faster execution**: Single tool execution vs multiple tools
-- ✅ **Unified reporting**: Combined results, easier to track
-- ✅ **Git integration**: Works with `--changed-files`, `--staged-files`
-- ✅ **Baseline comparison**: `--fail-on-new-violations`
-
-### **For Enterprise Adoption**
-- ✅ **Backward compatibility**: No existing config changes required
-- ✅ **Gradual migration**: Teams can test integration without commitment
-- ✅ **Centralized enforcement**: SunLint rules + team-specific ESLint rules
-- ✅ **Compliance reporting**: Combined violation tracking
-
-## 📊 **Example Scenario**
-
-**Before Integration:**
-```bash
-# Team workflow (2 separate commands)
-npm run lint:eslint    # 20 rules, 6 violations
-npm run lint:sunlint   # 93 rules, 4 violations
-# Total: 10 violations, 2 command executions
-```
-
-**After Integration:**
-```bash
-# Single integrated command  
-npm run lint:integrated  # 113 rules, 10 violations
-# Total: 10 violations, 1 command execution
-```
-
-## 🔍 **Demo**
-
-Run the integration demo:
-```bash
-./demo-eslint-integration.sh
-```
-
-This demonstrates:
-1. Existing ESLint workflow (20 rules)
-2. SunLint-only analysis (93 rules)
-3. **Integrated analysis (113 rules total)**
-4. Available npm scripts for team adoption
-
----
-
-**🎉 Result**: Teams can now run **113 total rules** (93 SunLint + 20 existing ESLint) in **single command execution** without disrupting existing workflows!