codebase-readme-generator

Project Overview

This project, codebase-readme-generator, automatically generates README files for codebases. It analyzes the codebase to determine the languages used, counts lines of code, and provides a structured overview. This README file was generated by the project itself!

The project is primarily written in JavaScript and utilizes several libraries for parsing, analysis, and reporting.

Key Features:

• Automatic language detection.
• Lines of code counting.
• Structured README generation.
• Dependency listing.
• Customizable templates (currently using a default template).

Project Structure

├── README.md             📄  This README file.
└── src
    ├── analyzer.js       📄  Analyzes the codebase.
    ├── generator.js      📄  Generates the README content.
    ├── index.js          📄  Main entry point.
    ├── utils.js          📄  Utility functions.
    ├── parser
    │   ├── javascript.js 📄  JavaScript parser.
    │   └── python.js     📄  Python parser (currently unimplemented or placeholder).
    └── templates
        └── default.md     📄  Template for README generation.

Dependencies

The project relies on the following dependencies:

| Name | Version | Description | |----------------------|-------------|--------------------------------------------------| | @babel/parser | ^7.28.0 | Babel parser for JavaScript | | @babel/traverse | ^7.28.0 | Babel AST traversal | | @google/generative-ai | ^0.24.1 | (Potentially used for AI-assisted features) | | chalk | ^5.5.0 | Terminal styling | | commander | ^14.0.0 | Command-line interface argument parsing | | dotenv | ^17.2.1 | Environment variable loading | | fs-extra | ^11.3.1 | File system utilities | | globby | ^14.1.0 | File matching utility | | inquirer | ^8.2.7 | Interactive command-line prompts | | js-yaml | ^4.1.0 | YAML parser | | jsdoc | ^4.0.4 | JSDoc parser (for documentation extraction?) | | marked | ^16.1.2 | Markdown parser | | openai | ^5.12.2 | OpenAI API client (Potentially for AI features) | | simple-git | ^3.28.0 | Git interaction | | typescript | ^5.9.2 | TypeScript compiler (if applicable) |

Installation

1. Clone the repository: git clone <repository_url>
2. Navigate to the project directory: cd codebase-readme-generator
3. Install dependencies: npm install

Usage

To generate a README for a project, run the following command from the project's root directory:

node src/index.js <path/to/project>

Replace <path/to/project> with the path to the codebase you want to analyze. The generated README will be saved in the specified project directory.

Contributing

Contributions are welcome! Please refer to the CONTRIBUTING.md file for guidelines.

License

[Specify License here, e.g., MIT License]