CodeCare CLI

A CLI tool for comprehensive codebase health checks, generating detailed PDF or JSON reports.

Overview

CodeCare is a lightweight and efficient command-line tool designed to analyze your codebase's health. It scans for potential issues like large files, duplicates, and empty files, providing a clear and actionable report in PDF or JSON format.

Features

• Codebase Analysis: Detects large files, duplicates, and empty files.
• Detailed Reports: Generates visually rich PDF reports or structured JSON files.
• Customizable Options: Adjust settings for tailored results.
• Simple Commands: Easy-to-use CLI commands for developers of all levels.

Installation

Install Globally (Recommended)

You can install the CodeCare CLI globally to use it anywhere:

npm install -g codecare

Install Locally (Optional)

Alternatively, you can install it locally in your project:

npm install codecare

Usage

After installing, you can use CodeCare directly from the command line.

IMPORTANT : Run codecare commands from the root folder of your project. This ensures that the tool can accurately scan all files within the project directory. Running the CLI outside the root folder may result in incomplete or incorrect analysis.

Commands

1. Check the health of the codebase

Analyzes the codebase and generates a report.

codecare check [options]

Options:

• -p, --pattern <pattern>
  Glob pattern to specify which files to include in the scan.
  Default: **/* (all files in the project directory).

  Example:

  codecare check --pattern "src/**/*.js"

  codecare check --p "src/**/*.js"

• -s, --size <size>
  Size limit (in bytes) to classify files as "large".
  Default: 50000 (50KB).

  Example:

  codecare check --size 100000

  codecare check --s 100000

• -o, --output <output>
  Format of the generated report.
  Options: pdf (default), json.

  Example:

  codecare check --output json

  codecare check --o json

• -l, --max-lines <maxLines>
  Maximum lines of code allowed in a single file.
  Default: 500 lines

  Example:

  codecare check --max-lines json

  codecare check --l json

• -d, --directory <directory>
  Directory where the generated report will be saved.
  Default: ./reports.

  Example:

  codecare check --directory ./custom-reports

  codecare check --d ./custom-reports

Global Commands

1. View Help

Displays the list of commands and options available in the CLI.

codecare help

2. View Version

Displays the current version of the CLI.

codecare --version

codecare --V

Examples

1. Run a basic health check and generate an PDF report in the default location:

   codecare check

2. Scan only .js files in the src directory:

   codecare check --pattern "src/**/*.js"

3. Set the size limit for large files to 100KB and output a JSON report:

   codecare check --size 100000 --output json

4. Generate an PDF report in a custom directory:

   codecare check --directory ./output/reports

5. Set the number of lines of code to 600 and output a PDF report

   codecare check --max-lines 600 --output pdf

Contributing

We welcome contributions to improve CodeCare! Feel free to submit issues or pull requests.

License

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