Contxt


Features

- Collects code from specified files and directories and adds to context.txt
- Excludes non-code files and directories based on user configuration.
- Allows excluding specific files and directories
- Automatically updates context when watched files change.
- Adds configuration and output files to .gitignore automatically
- Supports various file types.

Future features currently scoped:

- Add config setting to collect all relevant root files for smaller projects.
- Add config setting to cap the size of the context.txt file.
- Add a transformer to analyse the context.txt when it is updated and provide completions to enhance the project context.

Bugs

- If you find a bug or want to make an improvement please do.

Installation

You can install Contxt via npm:

npm install contxt

Usage

Run Contxt:

npx contxt

This command creates a context.config.json file in the root of your project to specify the files and directories to include or exclude:

{
"include": [
"package.json",
"tsconfig.json",
"tailwind.config.json",
"src",
"lib",
"api",
"README.md"
],
"exclude": [],
"allowedExtensions": [".js", ".ts", ".tsx", ".jsx", ".json", ".md", ".html", ".css", ".mjs"]
}

Configuration

include: An array of files and directories to include in the context.
exclude: An array of files and directories to exclude from the context.
allowedExtensions: An array of file extensions that are allowed to be included in the context.

As well as a context.txt file which contains the specified files with their paths. this file can be used to share with GPTs to receive more comprehensice completions, driving productivity and saving time.

After running npx contxt, your context.txt file might look like this:

# Included files:
contxt/
- contxt/package.json
- contxt/README.md
...

// Path: contxt/package.json
{
"name": "contxt",
"author": "David Sampson",
...
}

Building the Project

npm run build

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any bugs or features.

Fork the repository.
Create a new branch (git checkout -b feature-branch).
Make your changes.
Commit your changes (git commit -am 'Add new feature').
Push to the branch (git push origin feature-branch).
Open a pull request.