gitignore-parser
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/gitignore-parser package

0.0.2 • Public • Published

Gitignore Parser

A very simple .gitignore parser for node.js.

Build Status

Installation

npm install gitignore-parser

Usage

var parser = require('gitignore-parser'),
    fs = require('fs');
 
var gitignore = parser.compile(fs.readFileSync('.gitignore', 'utf8'));
 
gitignore.accepts('LICENSE.md') === true;
gitignore.denies('LICENSE.md') === false;
 
gitignore.accepts('node_modules/mocha/bin') === false;
gitignore.denies('node_modules/mocha/bin') === true;
 
 
var files = [
  '.gitignore',
  '.travis.yml',
  'LICENSE.md',
  'README.md',
  'package.json',
  'lib/index.js',
  'test/index.js',
  'test/mocha.opts',
  'node_modules/mocha/bin/mocha',
  'node_modules/mocha/README.md'
];
 
// only files that are not gitignored
files.filter(gitignore.accepts);
 
// only files that *are* gitignored
files.filter(gitignore.denies);
 

License

Apache 2, see LICENSE.md.

Package Sidebar

Install

npm i gitignore-parser

Weekly Downloads

28,819

Version

0.0.2

License

none

Last publish

Collaborators

  • charlespick