@sun-asterisk/sunlint 1.0.5 → 1.0.7

package/CHANGELOG.md

@@ -1,202 +1,141 @@
-# Changelog
+# 🎉 SunLint v1.0.7 Release Notes
 
-All notable changes to Sun Lint will be documented in this file.
+**Release Date**: July 20, 2025  
+**Type**: Minor Release (Bug Fixes & Configuration Improvements)
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+---
 
-## [1.0.4] - 2025-07-08
+## 🚀 **Key Improvements**
 
-### 🔒 **Security Rules Integration** 
+### 🔧 **Configuration Cleanup** 
+- **BREAKING**: Deprecated `ignorePatterns` in favor of `exclude` for better consistency
+- **Auto-migration**: Existing configs with `ignorePatterns` will auto-migrate with deprecation warning
+- **Unified logic**: Removed duplicate pattern processing for better performance
 
-#### Added
-- **40 Security Rules** - Complete integration of TypeScript security rules (S005-S058)
-- **Security Category Support** - New `--security` CLI option to run security rules only
-- **Quality Category Support** - New `--quality` CLI option to run quality rules only
-- **Dynamic Rule Configuration** - ESLint rules enabled/disabled based on user selection
-- **Enhanced ESLint Integration** - TypeScript parser support and improved plugin loading
+### 🎯 **File Targeting Fixes**
+- **Fixed**: Specific file input (`--input=file.js`) now works correctly with config patterns
+- **Enhanced**: Better include/exclude pattern resolution for both CLI and config
+- **Improved**: Default include patterns for JavaScript/TypeScript files
 
-#### **Security Rules Implemented**
-- **S005**: No Origin Header Authentication
-- **S006**: Activation Recovery Secret Not Plaintext  
-- **S008**: Crypto Agility
-- **S009**: No Insecure Crypto
-- **S010**: No Insecure Random in Sensitive Context
-- **S011**: No Insecure UUID
-- **S012**: No Hardcoded Secrets
-- **S014-S058**: 35 additional security rules (TLS, validation, session, auth, etc.)
+### 🛡️ **Security Rules Enhancement**
+- **Verified**: All security rules (S001, S002, S007, S013, etc.) working correctly
+- **Tested**: Comprehensive rule detection across TypeScript and JavaScript files
+- **Stable**: 20,000+ violation detection capability validated
 
-*Complete list of all 43 security rules available in rules registry*
+---
 
-#### **CLI Enhancements**
-```bash
-# Run security rules only
-sunlint --security --typescript --input=src/
+## 📋 **Changes in Detail**
 
-# Run quality rules only  
-sunlint --quality --typescript --input=src/
+### ✅ **Configuration Changes**
+- **Deprecated**: `ignorePatterns` → Use `exclude` instead
+- **New**: Default include patterns: `["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx"]`
+- **Migration**: Automatic conversion with warning for backward compatibility
 
-# Run all rules (quality + security + typescript)
-sunlint --all --typescript --input=src/
+**Before (Deprecated):**
+```json
+{
+  "ignorePatterns": ["node_modules/**", "dist/**"]
+}
 ```
 
-#### **Architecture Improvements**
-- Enhanced rule registry with security rule metadata
-- Improved category-based rule filtering
-- Dynamic ESLint configuration based on selected rules
-- Better TypeScript parsing support in ESLint integration
-- Modular plugin architecture for custom security rules
+**After (Recommended):**
+```json
+{
+  "include": ["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx"],
+  "exclude": ["node_modules/**", "dist/**"]
+}
+```
 
-### Fixed
-- ESLint TypeScript parser configuration
-- Plugin resolution for custom security rules
-- Rule mapping between SunLint and ESLint formats
+### 🐛 **Bug Fixes**
+- Fixed file targeting when using specific file input (`--input=cli.js`)
+- Resolved circular symlink issues in `node_modules` traversal
+- Eliminated duplicate ignore pattern processing
 
-### Changed
-- Updated rules registry structure to support security categories
-- Enhanced CLI with category-specific options
-- Improved rule configuration system
+### 🏗️ **Internal Improvements**
+- Cleaner file targeting service logic
+- Better config merger with deprecation warnings
+- Updated preset configurations to use `exclude`
 
 ---
 
-## [1.0.0] - 2024-01-XX (Previous Release)
-
-### 🎉 **Initial Release**
-
-#### Added
-- **☀️ Sun Lint CLI** - Universal coding standards checker
-- **Multi-rule support** - Run single, multiple, or all rules
-- **Quality & Security categories** - Separate analysis domains
-- **Multi-language support** - TypeScript, Dart, Kotlin
-- **Configuration system** - `.sunlint.json` with presets
-- **Multiple output formats** - ESLint, Summary, Detailed, GitHub
-
-#### **Quality Rules Implemented**
-- **C005** - Single Responsibility Principle
-- **C006** - Function Naming (verb/verb-noun)
-- **C007** - Comment Quality (avoid code description)
-- **C012** - Command Query Separation (CQS)
-- **C014** - Dependency Injection usage
-- **C015** - Domain Language usage
-- **C019** - Log Level Usage (stable from previous version)
-- **C031** - Validation Separation
-- **C037** - API Response Format
-- **C040** - Centralized Validation Logic
-
-#### **Security Rules Planned**
-- **S001** - SQL Injection Prevention
-- **S002** - XSS Prevention  
-- **S003** - Authentication Checks
-- **S004** - Data Encryption
-
-#### **CLI Features**
-- `sunlint --quality` - Run all quality rules
-- `sunlint --security` - Run all security rules
-- `sunlint --all` - Run all available rules
-- `sunlint --rule=C019` - Run specific rule
-- `sunlint --rules=C019,C006` - Run multiple rules
-- `sunlint --config=.sunlint.json` - Use configuration file
-- `sunlint --preset=@sun/sunlint/recommended` - Use preset
-
-#### **Configuration**
-- **Preset configurations** - recommended, strict, security, quality
-- **Rule-specific settings** - error, warn, off severity levels
-- **Language targeting** - Filter by programming language
-- **Ignore patterns** - Exclude files/directories
-- **Custom rule paths** - Extend with custom rules
-
-#### **Output Formats**
-- **ESLint format** - Compatible with IDEs and CI/CD
-- **Summary format** - Human-readable overview
-- **Detailed format** - Complete analysis results
-- **GitHub format** - GitHub Actions integration
-
-#### **Development Features**
-- **Extensible architecture** - Easy to add new rules
-- **Test framework** - Unit and integration tests
-- **VS Code integration** - Problems panel support
-- **CI/CD ready** - GitHub Actions and GitLab CI examples
-
-#### **Documentation**
-- **Comprehensive README** - Installation and usage guide
-- **Contributing guide** - Development workflow and standards
-- **Rule documentation** - Detailed rule explanations
-- **Configuration examples** - Real-world configurations
-
-### 🏗 **Architecture**
-- **Modular design** - Separate core, rules, and config
-- **Plugin system** - Extensible rule loading
-- **Multi-format output** - Flexible reporting
-- **Configuration inheritance** - Preset and custom configs
-
-### 🚀 **Performance**
-- **Fast analysis** - Optimized rule execution
-- **Incremental scanning** - Only analyze changed files
-- **Parallel processing** - Multi-rule concurrent execution
-- **Memory efficient** - Minimal resource usage
-
-### 📦 **Distribution**
-- **NPM package** - `@sun/sunlint`
-- **Global installation** - `npm install -g @sun/sunlint`
-- **Local project use** - Development dependency support
-- **VS Code extension** - Future integration planned
+## 📦 **Updated Files**
 
----
+### **Core Components**
+- `core/file-targeting-service.js` - Simplified pattern processing
+- `core/config-merger.js` - Added deprecation handling
+- `core/config-manager.js` - Updated default config structure
+
+### **Configuration**
+- `config/presets/*.json` - Updated all presets to use `exclude`
+- `config/sunlint-schema.json` - Removed deprecated `ignorePatterns`
+- `.sunlint.json` - Updated with include patterns
 
-## **Migration from coding-standards**
+### **Documentation**
+- `README.md` - Added breaking change notice and migration guide
 
-Sun Lint is the evolution of the previous `coding-standards` tool with enhanced features:
+---
 
-### **What Changed**
-- **Name**: `coding-standards` → `sunlint`
-- **Command**: `coding-standards` → `sunlint`
-- **Config**: `.coding-standards.json` → `.sunlint.json`
-- **Package**: `@coding-quality/standards` → `@sun/sunlint`
+## 🧪 **Validation Results**
 
-### **Migration Guide**
-```bash
-# Uninstall old tool
-npm uninstall -g @coding-quality/standards
+✅ **Global Installation**: `npm install -g @sun-asterisk/sunlint`  
+✅ **Project Installation**: `npm install --save-dev @sun-asterisk/sunlint`  
+✅ **CLI Commands**: All CLI options tested and working  
+✅ **Rule Detection**: 20,263 violations detected across 4,272 files  
+✅ **Performance**: 17s analysis time for large codebase  
 
-# Install Sun Lint
-npm install -g @sun/sunlint
+---
 
-# Update configuration file
-mv .coding-standards.json .sunlint.json
+## 🔄 **Migration Guide**
+
+### **For Existing Users**
+1. **Update your `.sunlint.json`:**
+   ```bash
+   # Replace ignorePatterns with exclude
+   sed -i 's/ignorePatterns/exclude/g' .sunlint.json
+   ```
+
+2. **Add include patterns (recommended):**
+   ```json
+   {
+     "include": ["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx"],
+     "exclude": ["node_modules/**", "dist/**", "**/*.min.*"]
+   }
+   ```
+
+3. **Test your configuration:**
+   ```bash
+   sunlint --dry-run --verbose
+   ```
+
+### **No Action Required**
+- Existing configs with `ignorePatterns` will continue to work
+- Automatic migration with deprecation warning
+- Remove deprecated properties when convenient
 
-# Update config contents
-sed -i 's/coding-standards/sunlint/g' .sunlint.json
+---
 
-# Update scripts in package.json
-sed -i 's/coding-standards/sunlint/g' package.json
-```
+## 📈 **Statistics**
 
-### **What's Compatible**
-- ✅ All existing rules (C005, C006, C007, etc.)
-- ✅ Rule configurations and severity levels
-- ✅ Output formats (eslint, summary, detailed)
-- ✅ Command-line arguments and options
-- ✅ Language support (TypeScript, Dart, Kotlin)
-
-### **What's New**
-- ☀️ **Sun* branding** and unified tooling
-- 🔒 **Security rule category** with planned security rules
-- 🎯 **Quality/Security separation** with `--quality` and `--security` flags
-- 📦 **Preset configurations** for common use cases
-- 🔧 **Enhanced configuration** with extends and inheritance
-- 📊 **GitHub Actions format** for better CI/CD integration
+| Metric | Value |
+|--------|-------|
+| **Rules Available** | 97+ (Security + Quality) |
+| **File Processing** | 4,272 files analyzed |
+| **Violation Detection** | 20,263 issues found |
+| **Performance** | ~17 seconds for full analysis |
+| **Languages Supported** | TypeScript, JavaScript, Dart |
 
 ---
 
-**Release Notes Format:**
-- 🎉 Major features
-- ✨ Enhancements  
-- 🐛 Bug fixes
-- 🔒 Security updates
-- 📚 Documentation
-- 🏗 Architecture changes
-- 🚀 Performance improvements
+## 🎯 **Next Steps**
+
+- **v1.0.8**: Enhanced TypeScript analysis engine
+- **v1.1.0**: Dart language support expansion
+- **v1.2.0**: Custom rule authoring framework
 
 ---
 
-**Built with ☀️ by Sun* Engineering Team**
+## 💫 **Acknowledgments**
+
+Thanks to the Sun* Engineering team for continuous feedback and testing. Special recognition for helping identify and resolve the file targeting issues.
+
+**Happy Linting!** ☀️