A Visual Studio Code extension that automatically creates and populates .gitignore files based on your project type. Whether you're working with Node.js, Python, Java, .NET, or many other technologies, this extension streamlines the process of setting up your gitignore with the appropriate files and directories to ignore.
- Automatic Project Detection: Scans your workspace for project files (package.json, requirements.txt, etc.) to determine project type
- Multi-Framework Support: Supports 20+ programming languages and frameworks
- Smart Auto-Population: Creates an empty
.gitignorefile, and when you close it, automatically populates it with relevant entries - Context Menu Integration: Right-click in the Explorer to create a
.gitignorefile - Comprehensive Coverage: Includes entries for IDEs, build artifacts, dependencies, and environment files
- JavaScript/TypeScript: Node.js, React, Next.js, Svelte
- Python: Standard Python projects with various package managers
- Java: Maven and Gradle projects
- C#/.NET: .NET Core and Framework projects
- C++: CMake and Makefile projects
- PHP: Standard PHP and Laravel projects
- Ruby: Gem-based projects
- Go: Go modules
- Rust: Cargo projects
- Swift: Swift Package Manager
- Dart/Flutter: Flutter and Dart projects
- Kotlin: Kotlin projects
- Elixir: Mix projects
- Haskell: Stack and Cabal projects
- R: R projects
- Terraform: Infrastructure as Code
- Docker: Containerized applications
- Open the Command Palette (
Ctrl+Shift+PorCmd+Shift+P) - Type "Create .gitignore"
- Select the command to create an empty
.gitignorefile - Close the file to automatically populate it with project-specific entries
- Right-click on a folder in the Explorer
- Select "Create .gitignore"
- Close the file to automatically populate it
- The extension creates an empty
.gitignorefile - When you close the file, it automatically scans your workspace for project indicators
- Based on detected project types, it populates the
.gitignorewith appropriate entries - Shows a notification indicating which project types were detected
For a Node.js project with TypeScript, the extension will generate:
# General
.DS_Store
Thumbs.db
*.log
*.bak
*.swp
*.tmp
# IDE and Editor files
.vscode/
.idea/
*.sublime-*
# Node.js
node_modules/
npm-debug.log*
yarn-debug.log*
.npm
.eslintcache
.env
.env.local
dist/
build/
coverage/- Visual Studio Code 1.100.0 or higher
This extension contributes the following settings:
- Currently no configurable settings (coming in future versions)
- None currently reported
Initial release with support for 20+ programming languages and frameworks.
Found a bug or want to request a new feature? Please create an issue in the repository.
Enjoy automatic .gitignore generation!
Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
myExtension.enable: Enable/disable this extension.myExtension.thing: Set toblahto do something.
Calling out known issues can help limit users opening duplicate issues against your extension.
Users appreciate release notes as you update your extension.
Initial release of ...
Fixed issue #.
Added features X, Y, and Z.
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\on macOS orCtrl+\on Windows and Linux). - Toggle preview (
Shift+Cmd+Von macOS orShift+Ctrl+Von Windows and Linux). - Press
Ctrl+Space(Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!