Code Summarizer

🚀 Code Summarizer

This tool is a command - line interface (CLI) that intelligently summarizes code files in a specified directory. It supports multiple programming languages and leverages the natural language processing capabilities of Gemini Flash 2.0 to generate concise code summaries.

🚀 Quick Start

✨ Features

• It is a CLI tool for intelligent code summarization in a specified directory.
• Supports multiple programming languages.
• Utilizes Gemini Flash 2.0's NLP capabilities to generate summaries.

📦 Installation

There are two ways to install this tool:

Method 1: Using npm Package Manager

npm install code-summarizer -g

Method 2: Installing from Source Code

1. Clone this repository to your local machine.
2. Navigate to the project directory and run:

npm install

Then add bin/code-summarizer to your system's PATH.

💻 Usage Examples

Basic Usage

code-summarizer <directory> [-d|--detail] [-l|--max-length]

Option Explanation

• <directory>: A required parameter specifying the code directory to be scanned.
• -d, --detail: Sets the level of detail for the summary. Valid values are 'low', 'medium', or 'high', with 'medium' being the default.
• -l, --max-length: Sets the maximum length (in characters) for each summary, with a default of 500.

Example

Generate a code summary with low detail:

code-summarizer ./src --detail low

📚 Documentation

Operation Process

1. Scan the specified directory and recursively traverse subfolders.
2. Filter out files and folders that do not need to be processed according to the .gitignore rules.
3. Identify the file type and only process code files of supported languages.
4. Analyze the content of each code file and generate an intelligent summary.
5. Output all summaries to the target file in the specified format.

Configuration Options

The tool allows flexible customization through command - line parameters or a configuration file:

Command - line Parameters

• --detail, -d: Sets the level of detail for the summary. Valid values are 'low', 'medium', or 'high', with 'medium' being the default.
• --max-length, -l: Sets the maximum length (in characters) for each summary, with a default of 500.

Configuration File

The tool supports configuration via a config.json file located in the project root directory. Here is an example:

{
  "detailLevel": "medium",
  "maxLength": 500,
  "supportedLanguages": ["typescript", "javascript", "python"],
  "ignoredFiles": ["**/*.test.ts", "**/*.spec.ts"]
}

Supported Languages and File Types

• TypeScript (.ts, .tsx)
• JavaScript (.js, .jsx)
• Python (.py)
• Java (.java)
• C++ (.cpp)
• C (.c)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• C# (.cs)
• Swift (.swift)
• Rust (.rs)
• Kotlin (.kt)
• Scala (.scala)
• Vue (.vue)
• HTML (.html)
• CSS (.css, .scss, .less)

Output Format

The generated summary file will follow the following format:

Relative path/File name
Summary content

Next relative path/Next file name
Next summary content

Project Structure

• index.ts: The main CLI implementation file
• src/: Source code directory
  • summarizer/: Core summary function module
  • mcp/: MCP server implementation
  • config/: Configuration management module
• bin/: CLI entry point
• config.json: Default configuration file
• tsconfig.json: TypeScript configuration file
• package.json: Project dependencies and script information
• .env.example: Environment variable configuration template
• .gitignore: Git ignore rules file
• __tests__: Directory for unit and integration tests
• __mocks__/mock-codebase: Mock codebase for testing

Environment Variables

The application can be configured via the following environment variables:

Use Cases

• Developers want to quickly understand the functionality and structure of large codebases.
• Project maintainers need to generate concise code overviews when creating documentation or README files.
• In education and training, it helps learners understand complex code.

Known Issues

• For very large codebases, performance degradation may occur. It is recommended to optimize the code structure or process in stages.
• The current version only supports preset languages and file types and does not support custom extensions.

Future Plans

• Add support for more programming languages.
• Provide more flexible configuration options, such as custom ignore rules and output formats.
• Develop a GUI version for visual operation.

Contribution Guidelines

Any contributions are welcome! Please follow these steps:

1. Fork this repository to your own account.
2. Make modifications or add features to your local copy.
3. Submit your code changes and create a Pull Request.
4. We will review your PR and merge it when appropriate.

📄 License

This project is licensed under the MIT License.