Java Other
Clone or download
Latest commit d0dc830 Jul 23, 2018

README.md

.ignore 3.0.0

Gitter Build Status

Donate Backers on Open Collective Sponsors on Open Collective

Version Downloads Downloads last month

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)

files in your project. It supports following JetBrains IDEs:

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

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.

Early Access Preview repository channel

If you are interested in updating your IDE with release candidate version of .ignore plugin, you can use EAP repository:

  1. In the left-hand pane of the Settings / Preferences dialog (Ctrl + Alt + S), click Plugins.
  2. Click Browse repositories.
  3. In the Browse Repositories dialog, click Manage repositories.
  4. In the Custom Plugin Repositories dialog, click + and specify the repository URL: https://plugins.jetbrains.com/plugins/eap/7495
  5. Click Check Now to make sure that the URL is correct.

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.

    Generate new file

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

    Support for typing new rules

  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

    Code inspections

Changelog

v3.0.0 (2018-07-24)

Full Changelog

Implemented enhancements:

  • Separated builds for different IDE versions (139-181+)
  • Abandoned support for <139
  • Integration with IntelliJ Plugin Verifier

Fixed bugs:

  • Argument for @NotNull parameter 'settings' of HideIgnoredFilesTreeStructureProvider.modify must not be null #551
  • Projects leak in ExternalIndexableSetContributor.CACHE #553
  • Unable to save settings #552

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

Backers

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

Backers

Sponsors

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

Sponsors

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.

YourKit Java Profiler Logo

License

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