Skip to content

Add configuration and documentation for snapshots functionality #2161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 150 additions & 0 deletions .snapshots/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
{
"excluded_patterns": [
".git",
".gitignore",
"gradle",
"gradlew",
"gradlew.*",
"node_modules",
".snapshots",
".idea",
".vscode",
"*.log",
"*.tmp",
"target",
"dist",
"build",
".DS_Store",
"*.bak",
"*.swp",
"*.swo",
"*.lock",
"*.iml",
"coverage",
"*.min.js",
"*.min.css",
"__pycache__",
".marketing",
".env",
".env.*",
"*.jpg",
"*.jpeg",
"*.png",
"*.gif",
"*.bmp",
"*.tiff",
"*.ico",
"*.svg",
"*.webp",
"*.psd",
"*.ai",
"*.eps",
"*.indd",
"*.raw",
"*.cr2",
"*.nef",
"*.mp4",
"*.mov",
"*.avi",
"*.wmv",
"*.flv",
"*.mkv",
"*.webm",
"*.m4v",
"*.wfp",
"*.prproj",
"*.aep",
"*.psb",
"*.xcf",
"*.sketch",
"*.fig",
"*.xd",
"*.db",
"*.sqlite",
"*.sqlite3",
"*.mdb",
"*.accdb",
"*.frm",
"*.myd",
"*.myi",
"*.ibd",
"*.dbf",
"*.rdb",
"*.aof",
"*.pdb",
"*.sdb",
"*.s3db",
"*.ddb",
"*.db-shm",
"*.db-wal",
"*.sqlitedb",
"*.sql.gz",
"*.bak.sql",
"dump.sql",
"dump.rdb",
"*.vsix",
"*.jar",
"*.war",
"*.ear",
"*.zip",
"*.tar",
"*.tar.gz",
"*.tgz",
"*.rar",
"*.7z",
"*.exe",
"*.dll",
"*.so",
"*.dylib",
"*.app",
"*.dmg",
"*.iso",
"*.msi",
"*.deb",
"*.rpm",
"*.apk",
"*.aab",
"*.ipa",
"*.pkg",
"*.nupkg",
"*.snap",
"*.whl",
"*.gem",
"*.pyc",
"*.pyo",
"*.pyd",
"*.class",
"*.o",
"*.obj",
"*.lib",
"*.a",
"*.map"
],
"default": {
"default_prompt": "Enter your prompt here",
"default_include_all_files": false,
"default_include_entire_project_structure": true
},
"included_patterns": [
"build.gradle",
"settings.gradle",
"gradle.properties",
"pom.xml",
"Makefile",
"CMakeLists.txt",
"package.json",
"requirements.txt",
"Pipfile",
"Gemfile",
"composer.json",
".editorconfig",
".eslintrc.json",
".eslintrc.js",
".prettierrc",
".babelrc",
".dockerignore",
".gitattributes",
".stylelintrc",
".npmrc"
]
}
37 changes: 37 additions & 0 deletions .snapshots/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Snapshots Directory

This directory contains snapshots of your Language Server Protocol (LSP) code for AI interactions. Each snapshot is a markdown file that includes relevant code context and project structure information, capturing the state of your workspace at the time of the AI interaction.

## What's included in snapshots?

- Selected code files and their contents
- Current file context and selections
- Project structure information (if enabled)
- Your prompt/question for the AI
- Workspace folder structure
- Environment information

## Purpose

Snapshots help maintain a record of AI interactions and provide context for future reference. They can be useful for:

- Tracking changes suggested by AI
- Referencing past solutions
- Sharing context with team members
- Documenting your development process
- Preserving LSP specification and implementation details during development

## Configuration

You can customize snapshot behavior in `config.json`. Some configurable options include:

- Enabling/disabling snapshots
- Controlling the amount of context included
- Setting retention policies
- Specifying directories to include or exclude

## Note

Snapshots do not automatically sync with your code changes. If you modify files after creating a snapshot, the snapshot will still reflect the state at the time it was created.

For questions about this repository's Language Server Protocol implementation or specifications, please refer to the main documentation.
51 changes: 51 additions & 0 deletions .snapshots/sponsors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Thank you for using Snapshots for AI

Thanks for using Snapshots for AI. We hope this tool has helped you solve a problem or two.

If you would like to support our work, please help us by considering the following offers and requests:

## Ways to Support

### Join the GBTI Network!!! 🙏🙏🙏

The GBTI Network is a community of developers who are passionate about open source and community-driven development. Members enjoy access to exclussive tools, resources, a private Minecraft server, a listing in our members directory, co-op opportunities and more.

- Support our work by becoming a [GBTI Network member](https://gbti.network/membership/).

### Try out BugHerd 🐛

BugHerd is a visual feedback and bug-tracking tool designed to streamline website development by enabling users to pin feedback directly onto web pages. This approach facilitates clear communication among clients, designers, developers, and project managers.

- Start your free trial with [BugHerd](https://partners.bugherd.com/55z6c8az8rvr) today.

### Hire Developers from Codeable 👥

Codeable connects you with top-tier professionals skilled in frameworks and technologies such as Laravel, React, Django, Node, Vue.js, Angular, Ruby on Rails, and Node.js. Don't let the WordPress focus discourage you. Codeable experts do it all.

- Visit [Codeable](https://www.codeable.io/developers/?ref=z8h3e) to hire your next team member.

### Lead positive reviews on our marketplace listing ⭐⭐⭐⭐⭐

- Rate us on [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=GBTI.snapshots-for-ai)
- Review us on [Cursor marketplace](https://open-vsx.org/extension/GBTI/snapshots-for-ai)

### Star Our GitHub Repository ⭐

- Star and watch our [repository](https://github.com/gbti-network/vscode-snapshots-for-ai)

### 📡 Stay Connected

Follow us on your favorite platforms for updates, news, and community discussions:

- **[Twitter/X](https://twitter.com/gbti_network)**
- **[GitHub](https://github.com/gbti-network)**
- **[YouTube](https://www.youtube.com/channel/UCh4FjB6r4oWQW-QFiwqv-UA)**
- **[Dev.to](https://dev.to/gbti)**
- **[Daily.dev](https://dly.to/zfCriM6JfRF)**
- **[Hashnode](https://gbti.hashnode.dev/)**
- **[Discord Community](https://gbti.network)**
- **[Reddit Community](https://www.reddit.com/r/GBTI_network)**

---

Thank you for supporting open source software! 🙏