Skip to content

Aventuum/gpt-context-generator

 
 

Repository files navigation

GPT Context Generator

Code Style Airbnb VS Marketplace Version VS Marketplace Installs VS Marketplace Rating

This Visual Studio Code extension helps you generate context for .js/.jsx and .ts/.tsx files, making it easier to collaborate with AI models like OpenAI's GPT-4. The extension generates context by pulling in local dependencies such as API pages that are referenced in your code. It also respects .gitignore rules to avoid including unnecessary files.

Features

  • Generate GPT-compatible multi-file context from the currently open file and local imports
  • Generate GPT-compatible multi-file context of the entire VS Code workspace
  • Generate GPT-compatible multi-file context for marked files
  • Mark/Unmark files for inclusion in generated context
  • Estimate the number of OpenAI tokens in the generated context

Usage

Generate context for the currently open file and its local imports

  1. Open a file in Visual Studio Code.
  2. Press Ctrl+Shift+P (Windows) or Cmd+Shift+P (Mac) to open the Command Palette.
  3. Type Generate GPT Context (Current File + Imports) and select the command from the list.
  4. The generated context, including dependencies, will be displayed in a new editor tab or copied to the clipboard based on your configuration.

Generate context for the entire workspace

  1. Open a workspace in Visual Studio Code.
  2. Press Ctrl+Shift+P (Windows) or Cmd+Shift+P (Mac) to open the Command Palette.
  3. Type Generate GPT Context (Workspace) and select the command from the list.
  4. The generated context will be displayed in a new editor tab or copied to the clipboard based on your configuration.

Generate context for marked files

  1. Open a file in Visual Studio Code.
  2. Press Ctrl+Shift+P (Windows) or Cmd+Shift+P (Mac) to open the Command Palette.
  3. Type Mark/Unmark File for Inclusion and select the command to mark the file for inclusion.
  4. Repeat steps 1-3 for all files you want to include in the context.
  5. Press Ctrl+Shift+P (Windows) or Cmd+Shift+P (Mac) to open the Command Palette.
  6. Type Generate GPT Context (Marked Files) and select the command from the list.
  7. The generated context for marked files will be displayed in a new editor tab or copied to the clipboard based on your configuration.

Token Count Estimation

When generating context, the extension will also display an information message with an estimated number of OpenAI tokens in the generated text. This information can be helpful when working with AI models that have token limitations.

Configuration

From settings, you can configure the extension to work as you prefer.

  • Output method
    • Copy to Clipboard (default)
    • New Window
  • Output language (only applies when 'outputMethod' is set to 'newWindow')
    • Plaintext (default)
    • Markdown
  • Include package.json in open-file context (default: true)
  • Set File Extensions to Include in Workspace Context
    • defaults: js, jsx, ts, tsx, mdx, json

License

This extension is released under the MIT License.

About

VS Code Extension to generate GPT-friendly context for open files or workspaces

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%