Ignore is a manager and filter for .gitignore rules, the one used by eslint, gitbook and many others. 

kael

ignore

  "description": "Ignore is a manager and filter for .gitignore rules, the one used by eslint, gitbook and many others.",

    "build": "babel -o legacy.js index.js",

    "test:tsc": "tsc ./test/ts/simple.ts --lib ES6",

    "test:ts": "node ./test/ts/simple.js",

    "test:git": "tap test/git-check-ignore.js",

    "test:cases": "tap test/*.js --coverage",

    "test:only": "npm run test:lint && npm run test:tsc && npm run test:ts && npm run test:cases",

    "test:win32": "IGNORE_TEST_WIN32=1 npm run test",

    "posttest": "tap --coverage-report=html && codecov"

    "url": "git@github.com:kaelzhang/node-ignore.git"

    "url": "https://github.com/kaelzhang/node-ignore/issues"

      src="https://travis-ci.org/kaelzhang/node-ignore.svg?branch=master"

      src="https://ci.appveyor.com/api/projects/status/github/kaelzhang/node-ignore?branch=master&svg=true"

      src="https://codecov.io/gh/kaelzhang/node-ignore/branch/master/graph/badge.svg"

      src="http://img.shields.io/npm/dm/ignore.svg"

      alt="npm module downloads per month" /></a>

`ignore` is a manager, filter and parser which implemented in pure JavaScript according to the [.gitignore spec 2.22.1](http://git-scm.com/docs/gitignore).

`ignore` is used by eslint, gitbook and [many others](https://www.npmjs.com/browse/depended/ignore).

Pay **ATTENTION** that [`minimatch`](https://www.npmjs.org/package/minimatch) (which used by `fstream-ignore`) does not follow the gitignore spec.

To filter filenames according to a .gitignore file, I recommend this npm package, `ignore`.

To parse an `.npmignore` file, you should use `minimatch`, because an `.npmignore` file does not work in the .gitignore way.

To parse an `.npmignore` file, you should use `minimatch`, because an `.npmignore` file is parsed by npm using `minimatch` and it does not work in the .gitignore way.

`ignore` is fully tested, and has more than **five hundreds** of unit tests.

- Windows + Node: `0.10` - `7.x`, node < `0.10` is not tested due to the lack of support of appveyor.

Actually, `ignore` does not rely on any versions of node specially.

Since `4.0.0`, ignore will no longer support `node < 6` by default, to use in node < 6, `require('ignore/legacy')`. For details, see [CHANGELOG](https://github.com/kaelzhang/node-ignore/blob/master/CHANGELOG.md).

- [`Pathname` Conventions](#pathname-conventions)

  - [`glob-gitignore`](https://www.npmjs.com/package/glob-gitignore) matches files using patterns and filters them according to gitignore rules.

const ig = ignore().add(['.abc/*', '!.abc/d/'])

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

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

ig.filter(['.abc\\a.js', '.abc\\d\\e.js'])

// if the code above runs on windows, the result will be

- `ignore` is a standalone module, and is much simpler so that it could easy work with other programs, unlike [isaacs](https://npmjs.org/~isaacs)'s [fstream-ignore](https://npmjs.org/package/fstream-ignore) which must work with the modules of the fstream family.

- `ignore` only contains utility methods to filter paths according to the specified ignore rules, so

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

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

- Exactly according to [gitignore man page](http://git-scm.com/docs/gitignore), 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.

  - Prevent re-including a file if a parent directory of that file is excluded.

    - `'a '`(one space) should not match `'a  '`(two spaces).

  - All test cases are verified with the result of `git check-ignore`.

## .add(patterns: Array<string | Ignore>): this

- **pattern** `String | Ignore` An ignore pattern string, or the `Ignore` instance

- **patterns** `Array<String | Ignore>` Array of ignore patterns.

Adds a rule or several rules to the current manager.

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().add('#abc').ignores('#abc')    // false

ignore().add('\#abc').ignores('#abc')   // true

`pattern` could either be a line of ignore pattern or a string of multiple ignore patterns, which means we could just `ignore().add()` the content of a ignore file:

.add(fs.readFileSync(filenameOfGitignore).toString())

		{
		"name": "ignore",
		"version": "5.1.7",
		"version": "5.1.8",
		"description": "Ignore is a manager and filter for .gitignore rules, the one used by eslint, gitbook and many others.",
		@@ -5,0 +5,0 @@ "files": [

		@@ -46,3 +46,3 @@ <table><thead>

		To parse an `.npmignore` file, you should use `minimatch`, because an `.npmignore` file does not work in the .gitignore way.
		To parse an `.npmignore` file, you should use `minimatch`, because an `.npmignore` file is parsed by npm using `minimatch` and it does not work in the .gitignore way.

		@@ -49,0 +49,0 @@ ### Tested on

Improved metrics