npm package: @kgryte/test-snippet
Description: Creates a test file.
Author: Athan Reines
Latest version: 3.0.2

Test Snippet
===
[![NPM version][npm-image]][npm-url] [![Build Status][build-image]][build-url] [![Coverage Status][coverage-image]][coverage-url] [![Dependencies][dependencies-image]][dependencies-url]

> Create a test file.


## Installation

``` bash
$ npm install @kgryte/test-snippet
```


## Usage

``` javascript
var cp = require( '@kgryte/test-snippet' );
```

#### cp( dest[, opts ][, clbk ] )

Asynchronously creates a file in a specified `destination` directory or according to a specified filepath.

``` javascript
cp( 'path/to/an/existing/directory', onCreate );

function onCreate( error ) {
	if ( error ) {
		throw error;
	}
	console.log( 'Success!' );
}
```

If `dest` is a directory, the output filename is `test.js`. To specify a different filename, provide an absolute filepath.

``` javascript
cp( 'path/to/an/existing/directory/test.foo.js', onCreate );

function onCreate( error ) {
    if ( error ) {
        throw error;
    }
    console.log( 'Success!' );
}
```

The function accepts the following `options`:
*	__template__: snippet template name. Default: `'tape'`.
*	__title__: test title. Default: `''`.

By default, a [`tape`][tape] template is used. To specify a different snippet template, set the `template` option.

``` javascript
cp( 'path/to/a/directory', {
	'template': 'mocha'
});
```

To specify snippet fields, set the corresponding `options`.

``` javascript
cp( 'path/to/a/directory', {
	'title': 'beep-boop'
});
```


#### cp.sync( dest[, opts] )

Synchronously creates a file in a specified `destination` directory or according to a specified filepath.

``` javascript
// Directory:
cp.sync( 'path/to/an/existing/directory' );

// Filepath:
cp.sync( 'path/to/an/existing/directory/test.foo.js' );
```

The function accepts the same `options` as the asynchronous version.


## Notes

* 	Supported templates may be found in the `./templates` directory and are named according to the directory name.


## Examples

``` javascript
var mkdirp = require( 'mkdirp' );
var path = require( 'path' );
var cp = require( '@kgryte/test-snippet' );

var dirpath = path.resolve( __dirname, '../build/'+(new Date().getTime()) );
mkdirp.sync( dirpath );

var filepath = path.join( dirpath, 'test.foo.js' );
cp.sync( filepath, {
    'template': 'mocha',
    'title': 'beep-boop'
});
```

To run the example code from the top-level application directory,

``` bash
$ node ./examples/index.js
```

---
## CLI


### Installation

To use the module as a general utility, install the module globally

``` bash
$ npm install -g @kgryte/test-snippet
```


### Usage

``` bash
Usage: test-snippet [options] [destination]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --templates           List available templates.
  -tmpl, --template name       Template name. Default: 'tape'.
         --title title         Test title. Default: ''.
```


### Examples

``` bash
$ cd ~/my/project/directory
$ test-snippet
# => creates a 'test.js' file in the current working directory
```

To specify a destination directory other than the current working directory, provide a `destination`.

``` bash
$ test-snippet ./../some/other/directory
```


---
## Tests

### Unit

Unit tests use the [Mocha][mocha] test framework with [Chai][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.


### Test Coverage

This repository uses [Istanbul][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
```


---
## License

[MIT license](http://opensource.org/licenses/MIT).


## Copyright

Copyright &copy; 2015-2016. Athan Reines.


[npm-image]: http://img.shields.io/npm/v/@kgryte/test-snippet.svg
[npm-url]: https://npmjs.org/package/@kgryte/test-snippet

[build-image]: http://img.shields.io/travis/kgryte/test-snippet/master.svg
[build-url]: https://travis-ci.org/kgryte/test-snippet

[coverage-image]: https://img.shields.io/codecov/c/github/kgryte/test-snippet/master.svg
[coverage-url]: https://codecov.io/github/kgryte/test-snippet?branch=master

[dependencies-image]: http://img.shields.io/david/kgryte/test-snippet.svg
[dependencies-url]: https://david-dm.org/kgryte/test-snippet

[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/test-snippet.svg
[dev-dependencies-url]: https://david-dm.org/dev/kgryte/test-snippet

[github-issues-image]: http://img.shields.io/github/issues/kgryte/test-snippet.svg
[github-issues-url]: https://github.com/kgryte/test-snippet/issues

[tape]: https://github.com/substack/tape
[mocha]: http://mochajs.org/
[chai]: http://chaijs.com
[istanbul]: https://github.com/gotwarlost/istanbul