https://github.com/kgryte/jshintignore

Creates a .jshintignore file.
https://github.com/kgryte/jshintignore

Last synced: 25 days ago
JSON representation

Creates a .jshintignore file.

• Host: GitHub
• URL: https://github.com/kgryte/jshintignore
• Owner: kgryte
• License: mit
• Created: 2015-07-24T07:54:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-24T05:25:51.000Z (almost 9 years ago)
• Last Synced: 2024-10-03T02:17:36.681Z (about 1 month ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
.jshintignore

=========

[![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 `.jshintignore` file.

## Installation

``` bash

$ npm install @kgryte/jshintignore

```

## Usage

``` javascript

var cp = require( '@kgryte/jshintignore' );

```

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

Asynchronously create a `.jshintignore` 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`:

*	__template__: `.jshintignore` template name. Default: `'default'`.

By default, a `default` template is used. To specify a different `.jshintignore` template, set the `template` option.

``` javascript

cp( 'path/to/a/directory', {

	'template': 'default'

});

```

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

Synchronously create a `.jshintignore` file in a specified `destination` directory.

``` javascript

cp.sync( 'path/to/a/directory' );

```

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

## Notes

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

## Examples

``` javascript

var mkdirp = require( 'mkdirp' ),

	path = require( 'path' ),

	cp = require( '@kgryte/jshintignore' );

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

```

---

## CLI

### Installation

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

``` bash

$ npm install -g @kgryte/jshintignore

```

### Usage

``` bash

Usage: jshintignore [options] [destination]

Options:

  -h,    --help                Print this message.

  -V,    --version             Print the package version.

  -tmpl  --template [name]     Template name. Default: 'default'.

```

### Examples

``` bash

$ cd ~/my/project/directory

$ jshintignore

# => creates a .jshintignore file in the current working directory

```

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

``` bash

$ jshintignore ./../some/other/directory

```

---

## Tests

### Unit

Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) 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](https://github.com/gotwarlost/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 © 2015. Athan Reines.

[npm-image]: http://img.shields.io/npm/v/@kgryte/jshintignore.svg

[npm-url]: https://npmjs.org/package/@kgryte/jshintignore

[travis-image]: http://img.shields.io/travis/kgryte/jshintignore/master.svg

[travis-url]: https://travis-ci.org/kgryte/jshintignore

[codecov-image]: https://img.shields.io/codecov/c/github/kgryte/jshintignore/master.svg

[codecov-url]: https://codecov.io/github/kgryte/jshintignore?branch=master

[dependencies-image]: http://img.shields.io/david/kgryte/jshintignore.svg

[dependencies-url]: https://david-dm.org/kgryte/jshintignore

[dev-dependencies-image]: http://img.shields.io/david/dev/kgryte/jshintignore.svg

[dev-dependencies-url]: https://david-dm.org/dev/kgryte/jshintignore

[github-issues-image]: http://img.shields.io/github/issues/kgryte/jshintignore.svg

[github-issues-url]: https://github.com/kgryte/jshintignore/issues