Skip to content

Latest commit

 

History

History
142 lines (88 loc) · 3.88 KB

README.md

File metadata and controls

142 lines (88 loc) · 3.88 KB
Raw

Copy for Context - VS Code Extension

Overview

"Copy for Context" is a Visual Studio Code extension that allows you to quickly copy selected files as formatted markdown. This is particularly useful when you need to share code snippets with AI assistants like ChatGPT or Claude, or when you want to create documentation that includes code from multiple files.

Features

  • Copy for Context:

    • Select multiple files in the VS Code Explorer, right-click, and choose "Copy for Context."
    • Automatically copies selected files as markdown to your clipboard.
    • Includes file paths and automatically detects language for syntax highlighting.

  • Copy This File for Context:

    • Right-click on any tab title or use the command palette to copy the active file as markdown.

  • Copy This Tab Group for Context:

    • Right-click on any tab title or use the command palette to copy all files in the current tab group as markdown.

  • Copy All Open Tabs for Context:

    • Use the command palette or right-click on any tab title to copy all open tabs as markdown.

  • Works with all file types supported by VS Code.

Installation

From VSIX File

  1. Download the .vsix file from the releases page.
  2. Open VS Code.
  3. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on Mac).
  4. Click on the '...' at the top of the Extensions view.
  5. Choose 'Install from VSIX...'.
  6. Select the downloaded .vsix file.

From VS Code Marketplace

(Note: Include this section only if you've published to the VS Code Marketplace)

  1. Open VS Code.
  2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on Mac).
  3. Search for "Copy for Context".
  4. Click "Install".

Usage

  1. Copy for Context:

    • In the VS Code Explorer, select one or more files you want to copy.
    • Right-click on the selection.
    • Choose "Copy for Context" from the context menu.
    • The selected files will be copied to your clipboard as formatted markdown.

  2. Copy This File for Context:

    • Right-click on the tab title of the file you want to copy.
    • Choose "Copy This File for Context" from the context menu.
    • The file will be copied to your clipboard as formatted markdown.

  3. Copy This Tab Group for Context:

    • Right-click on the tab title of any file in the tab group.
    • Choose "Copy This Tab Group for Context" from the context menu.
    • All files in the tab group will be copied to your clipboard as formatted markdown.

  4. Copy All Open Tabs for Context:

    • Right-click on any tab title or use the command palette.
    • Choose "Copy All Open Tabs for Context".
    • All open tabs will be copied to your clipboard as formatted markdown.

  5. Paste the content wherever you need it (e.g., in a conversation with an AI assistant).

Example Output

When you copy files using this extension, the output will look something like this:

## File: src/example.js

Language: javascript

```javascript
function hello() {
  console.log("Hello, world!");
}
```

File: src/styles.css

Language: css

body {
  font-family: Arial, sans-serif;
}

Configuration

Currently, this extension does not require any configuration. It works out of the box!

Known Issues

(List any known issues or limitations here. If there are none, you can omit this section.)

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT

Support

If you encounter any problems or have any suggestions, please open an issue on the GitHub repository.

Development

This project uses ESLint and Prettier for code linting and formatting. These checks are run in the CI pipeline for all pull requests.

To manually run linting:

npm run lint

To manually run formatting:

npm run format

Happy coding, and enjoy using Copy for Context!