.ignore

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)

files in your project. It supports following JetBrains IDEs:

Android Studio
AppCode
CLion
IntelliJ IDEA
PhpStorm
PyCharm
RubyMine
WebStorm
0xDBE

Compiled with Java 1.6

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

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

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.
Support for typing new rules, linking rules with matched files
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

v1.3.2 (2016-04-04)

Full Changelog

Implemented enhancements:

Import / Export templates #194
Generate rules without duplicates #164
Global gitignore section resize #187
.eslintignore support #175
.cfignore support #161

Fixed bugs:

CPU performance fixes #154, #204
Ignored files are no longer being colored correctly #174
Fatal Error on changing project name #203 #193 #170
.gitignore_global causes plugin to crash #198
ClassCastException when editing .gitignore on remote file system #196
ClassCastException on JSP #195
Global gitignore section scrolling #186
"Unclosed character class" warning is wrong #166
IgnoreSettings settings must produce stable state #162
Global ignore error #190

Full Changelog History

Contribution

Check CONTRIBUTING.md file.

Compiling the source code

Clone idea-ignore project from https://github.com/hsz/idea-gitignore.git
Configure IntelliJ IDEA Plugin SDK
Install required plugins:
- Plugin DevKit (bundled)
- Grammar-Kit
- PsiViewer
- JFlex Support
Create New Project as a IntelliJ Platform Plugin and set Project location to the idea-gitignore sources
- In Project settings > Modules section mark:
  - gen as Sources
  - resources as Resources
  - src as Sources
  - tests as Test Sources
  - .idea as Excluded
  - out as Excluded
Add new Run/Debug configuration
- + Add new configuration > Plugin
- Add -Didea.is.internal=true to VM Options (it will allow you run internal actions like View PSI structure action)
- Remove -XX:MaxPermSize=250m from VM Options
Generate PSI classes
- Go to Ignore.bnf file and Generate Parser Code
  - Tools > Generate Parser Code (Ctrl + Shift + G)
- Go to Ignore.flex file and Run JFlex Generator
  - Tools > Run JFlex Generator (Ctrl + Shift + G)
  - For the first time it will download JFlex.jar and idea-flex.skeleton files - save them in the root project directory
Set Java Compiler to 1.6
- Go to Settings > Compiler > Java Compiler and set Project bytecode version to 1.6
In Ant Build add build.xml file and mark generate-templates-list task as Execute on > Before compilation

Developed By

@hsz Jakub Chrzanowski

Contributors

Tools

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

kenrachynski / idea-gitignore