JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 851989
  • Score
    100M100P100Q190624F
  • License MIT

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

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 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', ...]

Configure options

You can also pass options to the function to change its behavior. By default, the results of parsing a file are cached. To disable this, set the cache option:

gitignore('.gitignore', [], { cache: false });
//=> ['*.DS_Store', 'node_modules', ...]

About

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.