Package Exports

parse-gitignore

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (parse-gitignore) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

parse-gitignore

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

Install with npm

npm i parse-gitignore --save

Usage

var gitignore = require('parse-gitignore');

// pass a string
var str = fs.readFileSync('.gitignore', 'utf8');
gitignore(str);
//=> ['*.DS_Store', 'node_modules', ...]

Pass additional patterns

Since the function already does unique-ifying, you can optionally pass an array of patterns to combine additional patterns to whatever is in .gitignore and get an array of unique patterns:

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

Run tests

Install dev dependencies:

npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

This file was generated by verb-cli on February 27, 2015.