flying-sheep / idea-gitignore

.ignore support plugin for IntelliJ IDEA

.ignore 3.1.2

Introduction

.ignore is a plugin for:

• .gitignore (Git)
• .hgignore (Mercurial)
• .npmignore (NPM)
• .dockerignore (Docker)
• .chefignore (Chef)
• .cvsignore (CVS)
• .bzrignore (Bazaar)
• .boringignore (Darcs)
• .mtn-ignore (Monotone)
• ignore-glob (Fossil)
• .jshintignore (JSHint)
• .tfignore (Team Foundation)
• .p4ignore (Perforce)
• .flooignore (Floobits)
• .eslintignore (ESLint)
• .cfignore (Cloud Foundry)
• .jpmignore (Jetpack)
• .stylelintignore (StyleLint)
• .stylintignore (Stylint)
• .swagger-codegen-ignore (Swagger Codegen)
• .helmignore (Kubernetes Helm)
• .upignore (Up)
• .prettierignore (Prettier)
• .ebignore (ElasticBeanstalk)
• .gcloudignore (Google Cloud)

files in your project. It supports following JetBrains IDEs:

• Android Studio
• AppCode
• CLion
• IntelliJ IDEA
• PhpStorm
• PyCharm
• RubyMine
• WebStorm
• DataGrip

Features

• Files syntax highlight
• Coloring ignored files in the Project View
• Gitignore templates filtering and selecting in rules generator by name and content
• User custom templates
• Show ignored files by specified Gitignore file (right click on .gitignore file)
• Create file in currently selected directory
• Generate Gitignore rules basing on GitHub's templates collection
• Add selected file/directory to Gitignore rules from popup menu
• Suggesting .gitignore file creation for new project
• Entries inspection (duplicated, covered, unused, incorrect syntax, relative entries) with fix actions
• Comments and brackets support
• Navigation to entries in Project view
• Renaming entries from ignore file
• Close opened ignored files action
• Custom user templates with import/export features

Supported IDEs

Since v3.0.0, .ignore plugin updates will be delivered to the IDE in version of 171+ - so all builds from 2017+.

But hey, no worries! It means .ignore for all IDE version from before - 139-163 - will be freezed at v3.0.0.

Installation

• Using IDE built-in plugin system:
  • Preferences > Plugins > Browse repositories... > Search for ".ignore" > Install Plugin
• Manually:
  • Download the latest release and install it manually using Preferences > Plugins > Install plugin from disk...

Restart IDE.

Usage

1. Generate new file and templates usage

   To generate new ignore file, just click on File > New or use Alt + Insert shortcut and select .ignore file element.

   

2. Support for typing new rules, linking rules with matched files

   

3. Code inspections

   Code inspections covers few cases:

   • duplicated entries (checks if entry is defined more than once)
   • covered entries - entry is covered by more general one
   • unused entries
   • incorrect syntax (regexp rules)
   • relative entries

   

Changelog

v3.1.2 (2019-05-14)

Full Changelog

Implemented enhancements:

• .gcloudignore (Google Cloud) support #577
• .nuxtignore (Nuxt.js) support #576
• Fixed deprecation warnings #567
• Removed "tracked & ignored" feature #547 #523 #528 #486
• Display external .git/info/exclude files in "Outer ignore rules" side editor
• Handle ~/.config/git/ignore ignore file #574

Fixed bugs:

• Adding 2+ templates without new line in between #561
• Fixed incorrect relative path resolving for ignored files #566
• Fixed "is covered by" false-positive behaviour #565 #228
• Fix for IllegalStateException when ProjectUtil.guessProjectDir called on default project
• Fixed incorrect double star pattern behaviour #579
• Update downgrades on 2018.2+ #572
• Group with id "GenerateGroup" isn't registered #573
• Directories marked as excluded are reported as never used #571
• All files are marked as ignored #581

Full Changelog History

Contribution

Check CONTRIBUTING.md file.

Compiling the source code

Since the project has been migrated to the Gradle and Gradle IntelliJ plugin, the build process is much simpler. The only thing to build the plugin is to run:

gradle build

All required dependencies like Grammar-Kit, JFlex are downloaded in the background and triggered properly during the build process. You can also test the plugin easily with running:

gradle runIdea

All of the gradle tasks can be connected to the IntelliJ debugger, so the development process is very easy.

Developed By

@hsz Jakub Chrzanowski

Contributors

• @zolotov Alexander Zolotov
• @nicity Maksim Mosienko
• @76200 Bartłomiej Czyż
• @bedla Ivo Šmíd
• @danpfe
• @maximilianonajle Maximiliano Najle
• @jimschubert Jim Schubert
• @sergei-ivanov Sergei Ivanov

Backers

Support us with a monthly donation and help us continue our activities.

Sponsors

Become a sponsor to get your logo on our README on Github.

Tools

I'm using Yourkit to locate and fix performance issues of .ignore. YourKit, LLC kindly provided a free open-source license of the YourKit Java Profiler.

License

Copyright (c) 2018 hsz Jakub Chrzanowski. See the LICENSE file for license rights and limitations (MIT).