Code Quality Checker 🚀

A powerful CLI tool to analyze your project's code quality using Google Gemini AI. It checks for:

• 📂 Folder Structure: Best practices and organization.
• ♻️ DRY Principles: Code duplication and logic reuse.
• 🧱 SOLID Principles: Adherence to software design principles.

Generates a beautiful HTML Report with a quality score (0-100) and actionable suggestions.

📦 Installation

You can install this package in your project as a development dependency:

npm install --save-dev code-quality-checker-deepak
# or
yarn add -D code-quality-checker-deepak

🛠 Usage

1. Get a Gemini API Key

You need a Google Gemini API Key to use this tool. Get one here.

2. Add to package.json Scripts (Recommended)

Add a script to your package.json to run the checker easily:

"scripts": {
  "quality-check": "code-quality-checker --key YOUR_API_KEY"
}

Note: It is recommended to use an environment variable for the key:

"scripts": {
  "quality-check": "code-quality-checker --key %GEMINI_API_KEY%"
}

3. Run Analysis

Now you can run the analysis with a simple command:

npm run quality-check

4. CLI Options

You can also run it directly with npx:

npx code-quality-checker --key <YOUR_KEY> --path ./src

| Option | Alias | Description | Default | |--------|-------|-------------|---------| | --key | -k | Required: Your Google Gemini API Key. | process.env.GEMINI_API_KEY | | --path | -p | Path to the directory to analyze. | Current directory (.) | | --help | -h | Show help information. | |

📊 Output

• Console: Real-time progress with spinners.
• HTML Report: Generates code-quality-report.html in your project root.

Built with ❤️ using TypeScript, Commander, and Google Gemini.