Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sidmohanty11/codemerge
cli tool to merge all code file's content to one single json
https://github.com/sidmohanty11/codemerge
Last synced: 24 days ago
JSON representation
cli tool to merge all code file's content to one single json
- Host: GitHub
- URL: https://github.com/sidmohanty11/codemerge
- Owner: sidmohanty11
- Created: 2023-12-31T14:55:54.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2023-12-31T16:22:15.000Z (10 months ago)
- Last Synced: 2024-10-05T09:48:06.352Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/codemerge
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# codemerge
`codemerge` is a simple, yet powerful command-line tool for merging all your code files into a single JSON file. This tool is especially handy for developers who need to aggregate source code from various files for analysis, backup, or documentation purposes.
## Features
- **Easy to Use**: Run `codemerge` in any directory to merge your code files.
- **Customizable**: Exclude specific files or directories.
- **Comprehensive**: Supports various code file types.
- **Interactive Prompts**: Guided experience using `inquirer.js`.
## Why It's Useful?
- **GPT Builders**: By merging code into a single JSON, `codemerge` simplifies the process of using code repositories for training AI models, such as GPT. This can be invaluable for understanding large codebases or for building AI-powered coding assistants.
## Usage
Run the tool in the directory where your code files are located:
```bash
npx codemerge
```
Upon running, codemerge will:
1. Prompt you to enter the path to the directory (or use the current directory by default).
2. Ask for comma-separated file names or directories that you want to exclude (e.g., node_modules, .env).
The tool will then generate a `merged_code_files.json` file in your current directory containing the contents of all your code files, formatted as an array of objects with `path` and `content` keys.
## Output Format
The output JSON file will have the following format:
```json
[
{
"path": "/path/to/file1.js",
"content": "code content here..."
},
{
"path": "/path/to/file2.py",
"content": "code content here..."
}
// ... more files
]
```
## Supported File Types
`codemerge` supports various code file types, including but not limited to `.js`, `.py`, `.html`, `.css`. Feel free to extend this as per your requirements.
## Contributing
Contributions are welcome! If you have a suggestion or fix, please open a pull request or issue in the repository.
## License
codemerge is open-sourced software licensed under the MIT license.