https://github.com/codemix/gitignore-parser

A simple .gitignore parser for node.js
https://github.com/codemix/gitignore-parser

Last synced: 12 months ago
JSON representation

A simple .gitignore parser for node.js

• Host: GitHub
• URL: https://github.com/codemix/gitignore-parser
• Owner: codemix
• License: other
• Created: 2014-04-04T13:10:32.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2017-08-15T00:39:25.000Z (over 8 years ago)
• Last Synced: 2025-04-06T15:57:31.817Z (12 months ago)
• Language: JavaScript
• Size: 192 KB
• Stars: 98
• Watchers: 4
• Forks: 21
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Gitignore Parser

A very simple `.gitignore` parser for node.js.

[![Build Status](https://travis-ci.org/codemix/gitignore-parser.svg?branch=master)](https://travis-ci.org/codemix/gitignore-parser)

## Installation

`npm install gitignore-parser`

## Usage

```js

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](./LICENSE.md).