gitno
v0.0.2
Published
Automatically fetch gitignore files for any project type from github into your new project
Readme
gitno
Automatically fetch github's excellent .gitignore files for any of your new projects
Here is the list of available types
Use as a global utility
Install
npm install gitno -gUsage
To list out all of the available types:
gitno -typesTo create a .gitignore for rails:
gitno railsThat's it.
Use programmatically as a module
Install
npm install gitnoand require
var gi = require(`gitno`);API
.getTypes(callback)
Gets the types via https request to GitHub.
callback(err, types)
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.
.writeFile(options, callback)
Gets the .gitignore file from GitHub of the specified options.type and stores it in the writable stream at options.file or options.writable.
options
.type (string) - The type associated with the .gitignore file to be fetched
.file, .writable (writable stream) - A writable stream (a file, sdtout, etc) that the results should be written to
callback(err)
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 null or undefined.
