Skip to content

Commit

Permalink
First commit
Browse files Browse the repository at this point in the history
  • Loading branch information
alwalxed committed Dec 21, 2024
0 parents commit 117fdf2
Show file tree
Hide file tree
Showing 8 changed files with 506 additions and 0 deletions.
175 changes: 175 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Caches

.cache

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Awa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Context Dump For AI

An interactive CLI tool to create AI-friendly context from selected files.

## Features

- Interactive file selection with checkboxes
- Ignores common files/folders (e.g., `node_modules`, `.git`)
- Respects `.gitignore` rules
- Outputs JSON with project structure and file contents

## Installation

Install globally with:

```bash
npm i -g context-dump
```

## Usage

### Basic Command

Run the tool:

```bash
context-dump
```

By default, it outputs to `ai_context.json` in the current directory.

### Options

- `-o, --output <file>`: Specify the output file (default: `ai_context.json`).

```bash
context-dump -o output.json
```

- `-e, --exclude <items>`: Exclude specific files or folders (comma-separated).

```bash
context-dump -e foo,boo
```

## Screenshots

![context-dump-for-ai](https://raw.githubusercontent.com/alwalxed/context-dump/refs/heads/main/screenshot.png)

## Contributing

Submit issues or pull requests for feedback.

## License

MIT License. See [LICENSE](https://github.com/alwalxed/context-dump/blob/main/LICENSE).
Binary file added bun.lockb
Binary file not shown.
101 changes: 101 additions & 0 deletions index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
#!/usr/bin/env node

import { program } from "commander";
import fs from "fs";
import inquirer from "inquirer";
import path from "path";
import {
generateAIFriendlyOutput,
getAllFiles,
loadGitignore,
} from "./utils.js";

const defaultIgnored: string[] = [
"node_modules",
".git",
"dist",
"build",
".vscode",
".idea",
];

program
.version("1.0.0")
.argument("[directory]", "Directory to process", "./")
.option("-o, --output <file>", "Output file name", "ai_context.json")
.option(
"-e, --exclude <items>",
"Comma-separated list of files/folders to exclude",
)
.parse(process.argv);

const options = program.opts();
const inputDirectory: string = program.args[0] || "./";
const outputFile: string = options.output;
const excludeFiles: string[] = options.exclude
? options.exclude.split(",")
: [];

async function run(): Promise<void> {
if (!fs.existsSync(inputDirectory)) {
console.error(`Error: The directory "${inputDirectory}" does not exist.`);
process.exit(1);
}

const ignoredFiles: string[] = [
...defaultIgnored,
...loadGitignore(inputDirectory),
...excludeFiles,
];

const allFiles: string[] = getAllFiles(inputDirectory, ignoredFiles);

if (allFiles.length === 0) {
console.log(
"No files found in the specified directory after applying exclusions.",
);
process.exit(0);
}

const choices = allFiles.map((file) => ({
name: path.relative(inputDirectory, file),
value: file,
checked: false,
}));

const answers = await (inquirer as any).prompt([
{
type: "checkbox",
name: "selectedFiles",
message: "Select files to include in the AI context:",
choices,
pageSize: 20,
validate: (answer: string[]) => {
if (answer.length === 0) {
return "You must select at least one file or press Ctrl+C to cancel.";
}
return true;
},
},
]);

const { selectedFiles } = answers;

if (selectedFiles.length === 0) {
console.log("No files selected. Exiting without generating output.");
process.exit(0);
}

try {
generateAIFriendlyOutput(inputDirectory, outputFile, selectedFiles);
console.log(`AI-friendly context written to ${outputFile}`);
} catch (error) {
console.error("Error generating output:", error);
process.exit(1);
}
}

run().catch((error) => {
console.error("An unexpected error occurred:", error);
process.exit(1);
});
Loading

0 comments on commit 117fdf2

Please sign in to comment.