Fast Ignore

A fast parser and processor for .gitignore files.

Note: terminal slashes on globs are ignored for now.

Install

1npm install --save fast-ignore

Usage

1import fastIgnore from 'fast-ignore';
2
3// Let's create the content of a .gitignore file
4
5const gitignore = `
6# Some always-ignore files
7*~
8*.err
9*.log
10._*
11.cache
12.fseventsd
13.DocumentRevisions*
14.DS_Store
15.TemporaryItems
16.Trashes
17Thumbs.db
18
19# Some project-specific ignores
20dist
21node_modules
22`;
23
24// Let's create our ignore function
25
26const ignore = fastIgnore ( gitignore );
27
28// Now we can check if a relative path should be ignored
29
30ignore ( 'foo/bar.js' ); // false
31ignore ( 'node_modules/foo/bar.js' ); // true
32ignore ( 'dist/foo/bar.js' ); // true
33
34// We can also work with multiple ignore files at once, which is faster than handling them individually
35// This goes roughly as fast as just concatenating the files together, but with the semantics of separate files
36// The difference is that an ignore file that comes later won't be able to un-ignore something that was ignored by a previous one
37// As a result please note that writing `fastIgnore ([ 'dist', '!dist' ])` may work differently than you expected
38
39const prettierignore = `
40**/test
41**/__test__
42
43# The following globs are effectively useless
44# because they can't un-ignore something that was ignored by any previous ignore files
45!dist
46!node_modules
47`;
48
49const comboIgnore = fastIgnore ([ gitignore, prettierignore ]);
50
51comboIgnore ( 'foo/bar.js' ); // false
52comboIgnore ( 'node_modules/foo/bar.js' ); // true
53comboIgnore ( 'dist/foo/bar.js' ); // true
54comboIgnore ( 'test/foo/bar.js' ); // true

License

MIT © Fabio Spampinato