Transforms .gitignore patterns to ones compatible with the glob package (used by Grunt & others)
InstallationTo install the package and add it to your
npm install gitignore-to-glob --save-dev
.gitignoreuses a different format than the
globpackage used, among others, by Grunt. Sometimes it's desirable to exclude files excluded by
.gitignorein a glob pattern so a transformation function is needed.
UsageOnce the package has been installed, it may be used via:
'.gitignore'by default and
dirsToCheckis an optional array of directories where we assume all files matched by the glob pattern exist. The parameter is optional but may be passed for performance reasons. The rationale is that
.gitignorepatterns not starting with
/are treated as if a glob pattern started with
**/and that would be expensive as some directories like
node_modulesusually contain a lot of files so excluding them all manually would be slow.
Usage ExamplesThe most basic usage:
This will convert files from the main
This will convert the
require('gitignore-to-glob')('app/.gitignore', ['app', 'test']);
'app/.gitignore'file but will omit patterns outside directories
Supported Node.js versionsThis project aims to support all Node.js LTS versions in the "active" phase (see LTS README for more details) as well as the latest stable Node.js.
ContributingIn lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using