Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.83 KB

readme.md

File metadata and controls

74 lines (46 loc) · 2.83 KB
Raw

Repository Code Consolidator

This Python script provides a unified way to gather all the code from a repository into a singular text file. It also allows the user to specify a list of specific files to be included in the output. This feature aims to provide an easy, digestible format for artificial intelligence language models to analyze repository content.

Getting Started

Dependencies

To run this script, you'll need to install the gitignore_parser library. You can do this using the following command:

pip install gitignore_parser

Usage

Here's how you use this script:

python consolidate.py <repo_dir> <mode> [--file_list <file_list>]

This command will create a text file named combined_files.txt that contains the repository's code content based on the specified mode ('tree', 'code', or 'both').

If the --file_list argument is provided with a path to a text file, only the files listed in this text file will be included in the 'code' portion of the output. Each line in this file should be a path to a file in the repository, relative to the repository directory.

How It Works

Ignoring Unwanted Files

The script first verifies the presence of a .gitignore file within the repository. If such a file exists, the script employs the gitignore_parser library to derive a function that matches the ignore rules defined in the .gitignore file.

matcher = parse_ignore_file(repo_path)

If no .gitignore file exists, or if a file is not listed within it, the script will proceed to include that file's content in its operations. The .git directory, if present, is always ignored.

Walking Through Repository

The script employs os.walk() to traverse the directory tree of the repository, covering all directories and files recursively. During this walk, the script filters out any ignored files and directories based on the derived matching function from the .gitignore file.

for root, dirs, files in os.walk(repo_path):
    dirs[:] = filter_dirs(dirs, matcher, root)
    files = filter_files((Path(root) / f for f in files), matcher)

Processing Repository Content

Depending on the specified mode, the script either:

  • Prints and collects the names of the files (in 'tree' mode),
  • Copies the content of the files (in 'code' mode),
  • Or does both (in 'both' mode).

If a file list is provided, only the files in this list will be included in the 'code' portion of the output.

combined_files = consolidate_code(repo_path, args.mode, file_list_path=args.file_list)

Saving Output

The script consolidates all the processed content into a single string and writes it into a file named combined_files.txt.

with open(output_file, 'w', encoding='utf-8') as f:
    f.write(combined_files)

License

This project is licensed under the MIT License.