Creates a .npmignore file.
npm install @kgryte/npmignore.npmignore
=========
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]
> Creates a .npmignore file.
`` bash`
$ npm install @kgryte/npmignore
` javascript`
var cp = require( '@kgryte/npmignore' );
#### cp( dest[, opts ][, clbk ] )
Asynchronously create a .npmignore file in a specified destination directory.
` javascript
cp( 'path/to/a/directory', onCreate );
function onCreate( error ) {
if ( error ) {
throw error;
}
console.log( 'Success!' );
}
`
The function accepts the following options:.npmignore
* __template__: template name. Default: 'default'.
By default, a default template is used. To specify a different .npmignore template, set the template option.
` javascript`
cp( 'path/to/a/directory', {
'template': 'default'
});
#### cp.sync( dest[, opts] )
Synchronously create a .npmignore file in a specified destination directory.
` javascript`
cp.sync( 'path/to/a/directory' );
The function accepts the same options as the asynchronous version.
* Supported templates may be found in the ./lib directory and are named according to the directory name.
` javascript
var mkdirp = require( 'mkdirp' ),
path = require( 'path' ),
cp = require( '@kgryte/npmignore' );
var dirpath = path.resolve( __dirname, '../build/' + new Date().getTime() );
mkdirp.sync( dirpath );
cp.sync( dirpath, {
'template': 'default'
});
`
To run the example code from the top-level application directory,
` bash`
$ node ./examples/index.js
---
To use the module as a general utility, install the module globally
` bash`
$ npm install -g @kgryte/npmignore
` bash
Usage: npmignore [options] [destination]
Options:
-h, --help Print this message.
-V, --version Print the package version.
-tmpl --template [name] Template name. Default: 'default'.
`
` bash`
$ cd ~/my/project/directory
$ npmignore=> creates a .npmignore file in the current working directory
To specify a destination other than the current working directory, provide a destination.
` bash`
$ npmignore ./../some/other/directory
---
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
` bash`
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
` bash`
$ make test-cov
Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,
` bash``
$ make view-cov
---
Copyright © 2015. Athan Reines.
[npm-image]: http://img.shields.io/npm/v/@kgryte/npmignore.svg
[npm-url]: https://npmjs.org/package/@kgryte/npmignore
[travis-image]: http://img.shields.io/travis/kgryte/npmignore/master.svg
[travis-url]: https://travis-ci.org/kgryte/npmignore
[codecov-image]: https://img.shields.io/codecov/c/github/kgryte/npmignore/master.svg
[codecov-url]: https://codecov.io/github/kgryte/npmignore?branch=master
[dependencies-image]: http://img.shields.io/david/kgryte/npmignore.svg
[dependencies-url]: https://david-dm.org/kgryte/npmignore
[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/npmignore.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/npmignore
[github-issues-image]: http://img.shields.io/github/issues/kgryte/npmignore.svg
[github-issues-url]: https://github.com/kgryte/npmignore/issues