Automatically fetch github's excellent
.gitignore files for any of your new projects
Use as a global utility
npm install gitignore -g
Note: If NPX (NPM's official package runner) is available in your environment you can use it to avoid a global install: ex.
$ npx gitignore node is equivalent to
npm i -g gitignore && gitignore node but avoids the global install step
To list out all of the available types:
To create a
.gitignore for rails:
Use programmatically as a module
npm install gitignore
var gi = require(`gitignore`);
Gets the types via
https request to GitHub.
If an error occurred, or the request failed, an
Error object is passed as the first parameter. If the types were successfully requested, an array of types is passed as the second parameter with
null as the first.
.gitignore file from GitHub of the specified
options.type and stores it in the writable stream at
.type (string) - The type associated with the
.gitignore file to be fetched
.writable (writable stream) - A writable stream (a file, sdtout, etc) that the results should be written to
If an error occurred or the request did not go through, an error obect is passed as the first parameter. If the request was successful, the first parameter is