ignore

Ignore is a manager and filter for .gitignore rules.

npm install ignore
9 downloads in the last day
112 downloads in the last week
349 downloads in the last month

ignore NPM version Build Status Dependency Status

ignore is a manager and filter according to the .gitignore spec.

Installation

npm install ignore --save

Usage

var ignore = require('ignore');
var ig = ignore(options).addPattern(['.abc/*', '!.abc/d/']);

Filter the given paths

var paths = [
    '.abc/a.js',    // filtered out
    '.abc/d/e.js'   // included
];

ig.filter(paths); // ['.abc/d/e.js']

As the filter function

paths.filter(ig.createFilter()); // ['.abc/d/e.js']

With ignore files

For most cases, we'd better use only one ignore file. We could use ignore.select to select the first existing file.

ignore().addIgnoreFile(
    ignore.select([
        '.xxxignore',
        '.gitignore',
        '.ignore'
    ])
);

Why another ignore?

  1. ignore is a standalone module, and is much simpler so that it could easy work with other programs, unlike isaacs's fstream-ignore which must work with the modules of the fstream family.

  2. ignore only contains utility methods to filter paths according to the specified ignore rules, so

  3. ignore never try to find out ignore rules by traversing directories or fetching from git configurations.

  4. ignore don't cares about sub-modules of git projects.

  5. Exactly according to gitignore man page, fixes some known matching issues of fstream-ignore, such as:

    • '/*.js' should only match 'a.js', but not 'abc/a.js'.
    • '**/foo' should match 'foo' anywhere.

Methods

.addPattern(pattern)

Adds a rule or several rules to the current manager.

Returns this

pattern String|Array.<String>

The ignore rule or a array of rules.

Notice that a line starting with '#'(hash) is treated as a comment. Put a backslash ('\') in front of the first hash for patterns that begin with a hash, if you want to ignore a file with a hash at the beginning of the filename.

ignore().addPattern('#abc').filter(['#abc']); // ['abc']
ignore().addPattern('\#abc').filter(['#abc']); // []

.addIgnoreFile(path)

Adds rules from a ignore file or several files

Returns this

Rule String|Array.<String>

.filter(paths)

Filters the given array of pathnames, and returns the filtered array.

paths Array.<path>

The array of paths to be filtered.

NOTICE that each path here should be a relative path to the root of your repository. Suppose the dir structure is:

/path/to/your/repo
    |-- a
    |   |-- a.js
    |
    |-- .b
    |
    |-- .c
         |-- .DS_store

Then the paths might be like this:

[
    'a/a.js'
    '.b',
    '.c/.DS_store'
]

Usually, you could use glob to fetch the structure of the current directory:

var glob = require('glob');
glob('**', function(err, files){
    var filtered;

    if ( err ) {
        console.log(err);
    } else {
        filtered = ignore().addIgnoreFile('.gitignore').filter(files);
        console.log(filtered);
    }
});

.createFilter()

Creates a filter function which could filter an array of paths with Array.prototype.filter.

Returns function(path)

The filter function.

Constructor: ignore.Ignore

new ignore.Ignore(options);
ignore(options);

options.matchCase boolean=false

By default, all ignore rules will be treated as case-insensitive ones as well as the git does.

options.twoGlobstars boolean=false

By defailt, ignoreRules will omit every pattern that includes '**' (two consecutive asterisks) which is not compatible cross operating systems, because the behavior of file .gitignore depends on the implementation of command fnmatch in shell.

By the way, Mac OS doesn't support '**'.

options.ignore Array.<String>

The ignore rules to be added. Default to ['.git', '.svn', '.DS_Store']

If you want those directories to be included, you could

ignore({
    ignore: []
});

You can also use .addPattern() method to do this.

npm loves you