node package manager

parse-gitignore

parse-gitignore NPM version NPM monthly downloads NPM total downloads Linux Build Status

Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.

Install

Install with npm:

$ npm install --save parse-gitignore

Usage

var gitignore = require('parse-gitignore');
 
// pass a filepath 
var patterns = gitignore('.gitignore');
//=> ['*.DS_Store', 'node_modules', ...]; 

Pass additional patterns

Since the function already does unique-ifying on patterns, you can optionally pass an additional array of patterns to add to the patterns parsed from .gitignore:

gitignore('.gitignore', ['foo', 'bar']);
//=> ['*.DS_Store', 'node_modules', 'foo', 'bar', ...] 

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits Contributor
26 jonschlinkert
1 schnittstabil

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.