Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonkohli/snapsource
Code extension that allows you to easily copy file and folder contents along with the project tree structure to your clipboard
https://github.com/leonkohli/snapsource
ai chatgpt code extension vscode vscode-extension
Last synced: 15 days ago
JSON representation
Code extension that allows you to easily copy file and folder contents along with the project tree structure to your clipboard
- Host: GitHub
- URL: https://github.com/leonkohli/snapsource
- Owner: LeonKohli
- License: mit
- Created: 2024-07-13T12:07:46.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-11-22T18:35:17.000Z (2 months ago)
- Last Synced: 2025-01-09T17:12:48.218Z (16 days ago)
- Topics: ai, chatgpt, code, extension, vscode, vscode-extension
- Language: JavaScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=LeonKohli.snapsource
- Size: 203 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SnapSource
SnapSource is a powerful Visual Studio Code extension that allows you to easily copy file and folder contents along with the project tree structure to your clipboard. It automatically ignores dot files, respects .gitignore rules, and provides plaintext, markdown, and XML output formats. This tool is particularly useful when working with Large Language Models (LLMs) and you need to provide context about your project.
## 🚀 Features
- 📋 Copy contents of files, folders, or multiple selections to your clipboard along with the project tree structure.
- 🔒 Automatically ignore dot files (like .env, .git) for security and cleanliness.
- 🚫 Respect .gitignore rules and custom exclude patterns.
- 🌳 Configurable project tree depth.
- 📄 Three output formats: plaintext, markdown, and XML.
- ⚡ Asynchronous processing for improved performance with large directories.
- 🛡️ Robust error handling for various edge cases.
- 🧠 Smart binary file detection to exclude non-text content.
- 📏 Configurable file size limit to prevent oversized outputs.
- 🔧 Option to include or exclude project tree structure in the output.
- 🗜️ Simple code compression option for more compact output.
- 🧹 Option to remove comments from code.
- 🔢 Token counting and cost estimation for various LLM models.
## 🔧 How to Use
1. Select one or multiple files or folders in the VS Code Explorer.
2. Right-click and select "Copy to Clipboard (SnapSource)" from the context menu.
3. The file/folder content(s) and project tree (if enabled) will be copied to your clipboard, excluding dot files, binary files, and respecting ignore patterns and size limits.
4. Paste the content into your preferred LLM interface.
## ⚙️ Extension Settings
This extension contributes the following settings:
| Setting | Description | Default |
|---------|-------------|---------|
| `snapsource.ignoreGitIgnore` | Respect .gitignore rules when generating the project tree and copying files | `true` |
| `snapsource.maxDepth` | Maximum depth of the project tree | `5` |
| `snapsource.excludePatterns` | Additional patterns to exclude from the project tree and file copying | `["node_modules", "*.log"]` |
| `snapsource.outputFormat` | Output format for the copied content (options: "plaintext", "markdown", "xml") | `"plaintext"` |
| `snapsource.maxFileSize` | Maximum file size (in bytes) to include in the output | `1048576` (1MB) |
| `snapsource.includeProjectTree` | Include the project tree structure in the output | `true` |
| `snapsource.compressCode` | Remove extra whitespace and empty lines from code when copying | `false` |
| `snapsource.removeComments` | Remove comments from code when copying | `false` |
| `snapsource.llmModel` | LLM model to use for token count and cost estimation | `"gpt-4o"` |
| `snapsource.maxTokens` | Maximum number of tokens allowed before warning | `null` |
| `snapsource.enableTokenWarning` | Enable warning when token count exceeds the maximum | `true` |
| `snapsource.enableTokenCounting` | Enable token counting and cost estimation (requires network access) | `false` |
> **Note:** Dot files are always ignored, and binary files are automatically detected and excluded.
## 📊 Output Formats
1. **Plaintext**: A simple text format with clear sections for project structure (if enabled) and file contents.
2. **Markdown**: A formatted markdown output with code blocks for project structure (if enabled) and file contents.
3. **XML**: A structured XML format with separate sections for project structure and file contents.
## 📋 Requirements
- Visual Studio Code version 1.89.0 or higher
## 🐛 Known Issues
None at this time.
## 📝 Release Notes
### 1.0.11
#### Fixed
- Resolved an issue where the `includeProjectTree` setting was not being respected.
- Fixed a linter error related to the `ignore` package usage.
#### Changed
- Removed unnecessary activation event from package.json.
For a full list of changes, please see the [CHANGELOG.md](CHANGELOG.md) file.
## 💬 Feedback and Contributions
If you have any feedback or would like to contribute to the development of SnapSource, please visit our [GitHub repository](https://github.com/LeonKohli/snapsource).
---
**Enjoy using SnapSource!**
[](https://marketplace.visualstudio.com/items?itemName=LeonKohli.snapsource)
[](https://github.com/yourusername/snapsource/stargazers)
[](https://github.com/yourusername/snapsource/blob/main/LICENSE)