@sun-asterisk/sunlint 1.2.2 → 1.3.1

package/docs/PRODUCTION_SIZE_IMPACT.md

@@ -1,183 +0,0 @@
-# 📦 SunLint Production Size Impact Analysis
-
-## Tóm tắt cho Leadership
-
-**KẾT LUẬN: SunLint KHÔNG làm tăng size production khi sử dụng đúng cách.**
-
-## Chi tiết phân tích
-
-### 1. Package Size của SunLint
-
-```bash
-SunLint package size: 241.6 kB
-SunLint unpacked size: 1.1 MB
-Total files: 214
-```
-
-### 2. Test Production Impact
-
-Chúng tôi đã tạo một project test để kiểm tra impact thực tế:
-
-| Giai đoạn | Size | Ghi chú |
-|-----------|------|---------|
-| Project ban đầu | 8.0K | Chỉ có package.json và .gitignore |
-| Sau khi cài SunLint (devDependency) | 88M | Bao gồm tất cả devDependencies |
-| Production bundle (dist/) | 4.0K | Code production thực tế |
-| Sau npm prune --production | 156K | Đã xóa tất cả devDependencies |
-
-### 3. Khuyến nghị sử dụng trong Production
-
-#### ✅ ĐÚNG CÁCH (Production-friendly):
-
-```json
-{
-  "devDependencies": {
-    "@sun-asterisk/sunlint": "^1.1.4"
-  }
-}
-```
-
-**Lợi ích:**
-- ✅ Không ảnh hưởng size production bundle
-- ✅ Chỉ cài khi development (`npm install`)
-- ✅ Tự động loại trừ khỏi production (`npm prune --production`)
-- ✅ CI/CD có thể dùng để check code quality
-
-#### ❌ SAI CÁCH (Không khuyến nghị):
-
-```json
-{
-  "dependencies": {
-    "@sun-asterisk/sunlint": "^1.1.4"
-  }
-}
-```
-
-**Vấn đề:**
-- ❌ Tăng 1.1MB cho production bundle
-- ❌ Không cần thiết cho runtime
-- ❌ Làm chậm deployment
-
-### 4. Deployment Strategies
-
-#### Option 1: Development Only (Khuyến nghị)
-```bash
-# Development
-npm install
-
-# Production build
-npm run build
-npm prune --production
-# → SunLint sẽ bị xóa hoàn toàn
-```
-
-#### Option 2: CI/CD Pipeline
-```yaml
-# .github/workflows/ci.yml
-- name: Install deps
-  run: npm ci
-- name: Run SunLint
-  run: npx sunlint --quality --input=src
-- name: Build production
-  run: npm run build
-- name: Remove dev deps
-  run: npm prune --production
-```
-
-#### Option 3: Docker Multi-stage
-```dockerfile
-# Development stage với SunLint
-FROM node:18 as dev
-COPY package*.json ./
-RUN npm ci
-COPY . .
-RUN npx sunlint --all --input=src
-
-# Production stage KHÔNG có SunLint
-FROM node:18-alpine as prod
-COPY package*.json ./
-RUN npm ci --only=production
-COPY dist/ ./dist/
-```
-
-### 5. So sánh với các tools khác
-
-| Tool | Package Size | Production Impact | Use Case |
-|------|-------------|-------------------|-----------|
-| ESLint | ~500KB | ❌ Nếu để dependencies | Development only |
-| Prettier | ~200KB | ❌ Nếu để dependencies | Development only |
-| **SunLint** | **241KB** | **✅ KHÔNG (devDep)** | **Development + CI/CD** |
-| TypeScript | ~60MB | ❌ Nếu để dependencies | Development only |
-
-### 6. Best Practices cho Teams
-
-#### Developers:
-```bash
-# Local development
-npm install          # Cài tất cả deps (bao gồm SunLint)
-npx sunlint --quality --input=src
-
-# Pre-commit hook
-npx sunlint --changed-files
-```
-
-#### CI/CD:
-```bash
-# Build pipeline
-npm ci                       # Cài tất cả deps
-npx sunlint --all --input=src  # Quality check
-npm run build                # Build production
-npm prune --production       # Xóa devDeps
-```
-
-#### Production:
-```bash
-# Server deployment
-npm ci --only=production     # Chỉ cài production deps
-# → SunLint sẽ KHÔNG được cài
-```
-
-### 7. Monitoring & Verification
-
-#### Verify production size:
-```bash
-# Trước deploy
-du -sh node_modules
-du -sh dist/
-
-# Kiểm tra không có SunLint
-ls node_modules | grep sunlint  # Không có kết quả = OK
-```
-
-#### Bundle size monitoring:
-```bash
-# Add to package.json
-{
-  "scripts": {
-    "analyze-bundle": "du -sh dist/ && echo 'Production bundle size'",
-    "verify-prod": "npm ls --production --depth=0"
-  }
-}
-```
-
-## Kết luận
-
-### ✅ AN TOÀN cho Production:
-- SunLint được thiết kế như devDependency
-- Không ảnh hưởng size production bundle khi sử dụng đúng
-- Có thể tích hợp vào CI/CD mà không ảnh hưởng deployment
-
-### 📊 Số liệu cụ thể:
-- **Development**: +88MB (chỉ khi dev)
-- **Production**: +0KB (khi dùng đúng cách)
-- **CI/CD**: Impact chỉ ở build time, không ở runtime
-
-### 🚀 Khuyến nghị:
-1. **Luôn cài như devDependency**
-2. **Sử dụng trong CI/CD pipeline**
-3. **npm prune --production trước deploy**
-4. **Monitor bundle size định kỳ**
-
----
-
-*Tài liệu này được cập nhật cho SunLint v1.1.4 - July 2025*

package/docs/RELEASE_GUIDE.md

@@ -1,230 +0,0 @@
-# 🚀 SunLint v1.0.5 Release Guide
-
-## 📦 **Dual Release Strategy**
-
-SunLint v1.0.5 supports **two deployment methods** to meet different enterprise needs:
-
-### **1. GitHub Package Registry (Private/Enterprise)**
-- **Purpose**: Private enterprise distribution
-- **Benefits**: Free private packages, organization control
-- **Target**: Internal teams, enterprise customers
-
-### **2. Global Tarball Release (Public)**  
-- **Purpose**: Public distribution via GitHub Releases
-- **Benefits**: No NPM Registry fees, direct download
-- **Target**: Open source community, public usage
-
-## 🔧 **Release Process**
-
-### **Automated Release (Recommended)**
-
-1. **Trigger GitHub Action**:
-   - Go to GitHub Actions → "Release SunLint" workflow
-   - Click "Run workflow"
-   - Select parameters:
-     - **Version**: `1.0.5`
-     - **Release Type**: `both` (GitHub Package + Tarball)
-
-2. **Automated Steps**:
-   - ✅ Run tests
-   - ✅ Update version numbers
-   - ✅ Build package tarball
-   - ✅ Publish to GitHub Package Registry
-   - ✅ Create GitHub Release with tarball
-   - ✅ Generate installation documentation
-
-### **Manual Release (Alternative)**
-
-```bash
-# 1. Prepare release
-cd coding-quality/extensions/sunlint
-npm test
-npm run clean
-
-# 2. Update version
-npm version 1.0.5 --no-git-tag-version
-
-# 3. GitHub Package Registry
-cp package-github.json package.json
-npm publish --registry=https://npm.pkg.github.com
-
-# 4. Global tarball
-npm pack
-mv *.tgz sunlint-1.0.5.tgz
-
-# 5. Create GitHub release (manual upload)
-```
-
-## 📖 **Installation Methods**
-
-### **Method 1: GitHub Package Registry**
-
-**Setup (one-time)**:
-```bash
-# Configure GitHub Package Registry
-echo "@sun-asterisk:registry=https://npm.pkg.github.com" >> ~/.npmrc
-echo "//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}" >> ~/.npmrc
-```
-
-**Install**:
-```bash
-# Global installation
-npm install -g @sun-asterisk/sunlint
-
-# Project installation  
-npm install --save-dev @sun-asterisk/sunlint
-```
-
-### **Method 2: Direct Tarball**
-
-```bash
-# Global installation from release
-npm install -g https://github.com/sun-asterisk/engineer-excellence/releases/download/sunlint-v1.0.5/sunlint-1.0.5.tgz
-
-# Project installation
-npm install --save-dev https://github.com/sun-asterisk/engineer-excellence/releases/download/sunlint-v1.0.5/sunlint-1.0.5.tgz
-```
-
-### **Method 3: Setup Script**
-
-```bash
-# One-line setup for GitHub Package Registry
-curl -fsSL https://raw.githubusercontent.com/sun-asterisk/engineer-excellence/main/coding-quality/extensions/sunlint/scripts/setup-github-registry.sh | GITHUB_TOKEN=your_token bash
-```
-
-## 🎯 **Team Integration Examples**
-
-### **Enterprise Team (GitHub Package Registry)**
-
-```json
-{
-  "name": "my-enterprise-project",
-  "scripts": {
-    "lint": "sunlint --all --input=src",
-    "lint:changed": "sunlint --all --changed-files", 
-    "lint:eslint": "sunlint --all --eslint-integration --input=src",
-    "ci:lint": "sunlint --all --changed-files --fail-on-new-violations"
-  },
-  "devDependencies": {
-    "@sun-asterisk/sunlint": "^1.0.5"
-  }
-}
-```
-
-**.npmrc** (project-level):
-```
-@sun-asterisk:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
-```
-
-### **Open Source Project (Direct Tarball)**
-
-```json
-{
-  "name": "my-open-source-project",
-  "scripts": {
-    "lint": "sunlint --all --input=src",
-    "lint:eslint": "sunlint --all --eslint-integration --input=src"
-  },
-  "devDependencies": {
-    "@sun-asterisk/sunlint": "https://github.com/sun-asterisk/engineer-excellence/releases/download/sunlint-v1.0.5/sunlint-1.0.5.tgz"
-  }
-}
-```
-
-## 🚢 **CI/CD Integration**
-
-### **GitHub Actions with GitHub Package Registry**
-
-```yaml
-name: Code Quality
-on: [pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '18'
-          registry-url: 'https://npm.pkg.github.com'
-      
-      - name: Configure GitHub Package Registry
-        run: |
-          echo "@sun-asterisk:registry=https://npm.pkg.github.com" >> ~/.npmrc
-          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> ~/.npmrc
-      
-      - run: npm ci
-      - name: Run SunLint
-        run: |
-          npx @sun-asterisk/sunlint --all --eslint-integration --changed-files \
-            --diff-base=origin/main --fail-on-new-violations --format=summary
-```
-
-### **GitHub Actions with Direct Tarball**
-
-```yaml
-name: Code Quality
-on: [pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-      
-      - name: Install SunLint
-        run: |
-          npm install -g https://github.com/sun-asterisk/engineer-excellence/releases/download/sunlint-v1.0.5/sunlint-1.0.5.tgz
-      
-      - name: Run SunLint  
-        run: |
-          sunlint --all --eslint-integration --changed-files \
-            --diff-base=origin/main --fail-on-new-violations --format=summary
-```
-
-## 🔍 **Verification**
-
-After installation, verify SunLint is working:
-
-```bash
-# Check version
-sunlint --version
-
-# Test basic functionality
-sunlint --rule=C006 --input=src
-
-# Test ESLint integration
-sunlint --all --eslint-integration --input=src
-
-# Test Git integration
-sunlint --all --changed-files
-```
-
-## 📊 **Release Metrics**
-
-Track adoption through:
-- GitHub Package downloads
-- GitHub Release download statistics  
-- GitHub stars/forks
-- Issue reports and feature requests
-
-## 🎉 **Benefits Summary**
-
-### **For Teams**
-- ✅ **Zero-disruption**: Works with existing ESLint  
-- ✅ **Flexible deployment**: GitHub Package or direct download
-- ✅ **Enterprise-ready**: Private package distribution
-- ✅ **CI/CD optimized**: Git integration for performance
-
-### **For Maintainers**  
-- ✅ **Cost-effective**: No NPM Registry fees
-- ✅ **Control**: Private distribution via GitHub
-- ✅ **Automation**: GitHub Actions release pipeline
-- ✅ **Monitoring**: Built-in download analytics
-
----
-
-**🚀 Ready to deploy SunLint v1.0.5 with dual release strategy!**

package/docs/STANDARDIZED-CATEGORY-FILTERING.md

@@ -1,156 +0,0 @@
-# Standardized Category Filtering
-
-## Overview
-SunLint implements standardized category filtering to ensure consistent behavior between CLI and VSCode extension. Category commands (like `--security`, `--quality`) now use a unified approach that only includes rules from core files.
-
-## Core Principles
-
-### 1. Core Files Only
-Category filtering exclusively uses rules from core files:
-- `common-en.md` - Universal quality and security rules
-- `security-en.md` - Specialized security rules
-- Language-specific files (typescript-en.md, etc.) are **excluded** from category commands
-
-### 2. Language-Specific Rules are Opt-In
-- Language-specific rules are not included in category commands by default
-- Must be explicitly enabled via project configuration
-- This ensures category commands remain language-agnostic
-
-### 3. Principle-Based Filtering
-Rules are filtered by their `principle` field based on actual rule catalog:
-- `--security` → includes rules with principle: "SECURITY"
-- `--quality` → includes rules with principle: "CODE_QUALITY"
-
-Available principles in rule catalog:
-- **SECURITY** - Security-focused rules
-- **CODE_QUALITY** - Code quality and maintainability
-- **PERFORMANCE** - Performance optimization rules  
-- **MAINTAINABILITY** - Code maintainability rules
-- **TESTABILITY** - Testing and testability rules
-- **RELIABILITY** - System reliability rules
-- **DESIGN_PATTERNS** - Design pattern compliance
-- **INTEGRATION** - Integration best practices
-- **USABILITY** - User experience and usability
-
-## Implementation
-
-### SunlintRuleAdapter Methods
-
-```javascript
-// Get rules for standardized category filtering (core files only)
-getStandardCategoryRules(category) {
-  const coreRules = this.getCoreRules();
-  return coreRules.filter(rule => rule.principle === category);
-}
-
-// Category mapping based on actual principles
-const categoryPrincipleMap = {
-  'security': ['SECURITY'],
-  'quality': ['CODE_QUALITY'], 
-  'performance': ['PERFORMANCE'],
-  'maintainability': ['MAINTAINABILITY'],
-  'testability': ['TESTABILITY'],
-  'reliability': ['RELIABILITY'],
-  'design': ['DESIGN_PATTERNS'],
-  'integration': ['INTEGRATION'],
-  'usability': ['USABILITY']
-};
-```
-
-### CLI Integration
-
-The rule selection service now uses standardized category filtering:
-
-```javascript
-// core/rule-selection-service.js
-const rules = adapter.getStandardCategoryRules(category);
-console.log(`📋 Selected ${rules.length} ${category} rules from core files`);
-```
-
-## Rule Counts
-
-Based on current rule catalog:
-- **Total rules**: 256
-- **Core rules**: 135 (common-en.md + security-en.md)
-- **Security rules (core only)**: 60 rules
-- **Quality rules (core only)**: 112 rules
-- **Language-specific rules**: 121 rules (excluded from categories)
-
-## Usage Examples
-
-### CLI Commands
-```bash
-# Uses 60 security rules from core files only
-sunlint --input=src --security
-
-# Uses 112 quality rules from core files only  
-sunlint --input=src --quality
-
-# Custom rule selection (can include language-specific)
-sunlint --input=src --rules="TS001,TS002,S001"
-
-# Future categories (when CLI support is added)
-sunlint --input=src --performance
-sunlint --input=src --maintainability
-```
-
-### Project Configuration
-To include language-specific rules, use project config:
-
-```json
-{
-  "rules": ["TS001", "TS002"],
-  "presets": ["typescript", "security"]
-}
-```
-
-## Benefits
-
-### 1. Consistency
-- CLI and VSCode extension use identical rule selection logic
-- Predictable behavior across all interfaces
-
-### 2. Maintainability
-- Single source of truth for category definitions
-- Easy to add new categories or core rules
-
-### 3. Extensibility
-- Clear separation between core and language-specific rules
-- Framework for adding new languages without breaking existing categories
-
-### 4. Performance
-- Reduced rule count for category commands
-- Faster analysis for common security/quality checks
-
-## Migration from Legacy System
-
-### Before (Legacy)
-- Category commands included all rules matching principle
-- Language-specific rules were included by default
-- Different behavior between CLI and VSCode extension
-
-### After (Standardized)
-- Category commands use core files only
-- Language-specific rules are opt-in via config
-- Unified behavior across all interfaces
-
-## Validation
-
-Use the test script to validate category filtering:
-
-```bash
-node test-category-filtering.js
-```
-
-Expected output:
-- Core rules: 135
-- Security rules (core): 60  
-- Quality rules (core): 112
-- All tests pass ✅
-
-## Related Files
-
-- `core/adapters/sunlint-rule-adapter.js` - Main implementation
-- `core/rule-selection-service.js` - CLI integration
-- `test-category-filtering.js` - Validation script
-- `config/presets/recommended.json` - Updated preset config