CleanGuard 🛡️

Local. Safe. Clean. Pre-commit code review with 100% local static analysis - no AI, no cloud.

🚀 Why CleanGuard?

Tired of AI tools sending your code to the cloud? CleanGuard is 100% local, 100% transparent, 0% AI.

✅ No AI - Pure static analysis using ESLint + custom rules
✅ No Cloud - Everything runs locally on your machine
✅ No Privacy Risks - Your code never leaves your computer
✅ Fast & Reliable - Instant analysis without network delays
✅ Transparent - All rules are open source and auditable

🎯 Features

🔒 Security Analysis

Hardcoded secrets detection
SQL injection prevention
XSS vulnerability scanning
Dangerous function usage (eval, innerHTML)

⚡ Performance Optimization

Inefficient loop detection
DOM query optimization
Memory leak prevention
Synchronous operation warnings

🎨 Code Quality

Style consistency checks
Magic number detection
Console statement cleanup
Debugger statement removal

📊 Quality Metrics

Cyclomatic complexity analysis
Maintainability index calculation
Code duplication detection
Quality score trending

📈 Timeline & History

Visual quality trends
Review history tracking
Export capabilities (CSV/JSON)
Team dashboard insights

🚀 Quick Start

Install CleanGuard

# Install from VS Code Marketplace
code --install-extension nhtua.cleanguard

Review Your Code
- Press Ctrl+Shift+P → "CleanGuard: Review Current File"
- Or use the sidebar timeline view

Configure Rules

// .cleanguardrc
{
  "enabled": true,
  "rules": {
    "security": true,
    "performance": true,
    "style": true
  },
  "excludePatterns": ["**/node_modules/**"]
}

📸 Screenshots

Dashboard Overview

CleanGuard Dashboard

Issue Detection

Timeline View

🛠️ Commands

Command	Description
`CleanGuard: Review Current File`	Analyze the currently open file
`CleanGuard: Review Workspace`	Scan entire workspace
`CleanGuard: Show Timeline`	Open quality timeline dashboard
`CleanGuard: Export CSV`	Export timeline data to CSV
`CleanGuard: Export JSON`	Export timeline data to JSON
`CleanGuard: Export Report`	Generate quality report

⚙️ Configuration

VS Code Settings

{
  "cleanguard.enabled": true,
  "cleanguard.rules.security": true,
  "cleanguard.rules.performance": true,
  "cleanguard.rules.style": true,
  "cleanguard.autoAnalyzeOnSave": true,
  "cleanguard.showStatusBar": true
}

Workspace Configuration (.cleanguardrc)

{
  "enabled": true,
  "rules": {
    "security": true,
    "performance": true,
    "style": true
  },
  "customRules": [],
  "excludePatterns": [
    "**/node_modules/**",
    "**/dist/**",
    "**/build/**"
  ],
  "maxFileSize": 500,
  "autoAnalyzeOnSave": true
}

🔧 Custom Rules

Create your own rules by extending the base rule classes:

// src/rules/custom/myRule.ts
export class MyCustomRule {
    async analyze(code: string, fileName: string): Promise<Issue[]> {
        // Your custom analysis logic
        return issues;
    }
}

📊 Supported Languages

✅ TypeScript
✅ JavaScript
✅ React (TSX/JSX)
🔄 Python (coming soon)
🔄 Java (coming soon)

🚀 Performance

Startup Time: < 200ms
Memory Usage: < 50MB
Analysis Speed: < 1s per file
UI Responsiveness: < 100ms

🔒 Privacy & Security

CleanGuard is designed with privacy-first principles:

No Data Collection: We don't collect any usage data
No Telemetry: No analytics or tracking
No Network Calls: Everything runs offline
Open Source: All code is auditable
Local Storage: Data stays on your machine

🤝 Contributing

We welcome contributions! Here's how to get started:

Fork the repository

Create a feature branch

git checkout -b feature/amazing-feature

Make your changes
Run tests
```
npm test
```
Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/cleanguard/cleanguard.git

# Install dependencies
npm install

# Run in development mode
npm run watch

# Package extension
npm run package

📈 Roadmap

Version 1.1 (Coming Soon)

[ ] Python support
[ ] Java support
[ ] Custom rule builder UI
[ ] Team collaboration features

Version 1.2 (Future)

[ ] Git integration
[ ] CI/CD pipeline support
[ ] Advanced metrics
[ ] Plugin system

🆘 Support

Documentation: GitHub Wiki
Issues: GitHub Issues
Discussions: GitHub Discussions
Landing Page: GitHub Pages

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

ESLint team for the amazing static analysis engine
VS Code team for the excellent extension API
Open source community for inspiration and feedback

Made with ❤️ by developers, for developers

Install CleanGuard | View on GitHub | Report Issues

CleanGuard

Vietnamese Renamer