coffee-jshint
Advanced tools
Comparing version 0.2.6 to 0.2.7
@@ -5,2 +5,7 @@ # Change Log | ||
<a name="0.2.7"></a> | ||
## [0.2.7](https://github.com/marviq/coffee-jshint/compare/v0.2.6...v0.2.7) (2017-09-22) | ||
<a name="0.2.6"></a> | ||
@@ -7,0 +12,0 @@ ## [0.2.6](https://github.com/marviq/coffee-jshint/compare/v0.2.5...v0.2.6) (2017-01-24) |
@@ -9,3 +9,3 @@ { | ||
"dependencies": { | ||
"jshint": "^2.9.4", | ||
"jshint": "^2.9.5", | ||
"optimist": "~0.6.1", | ||
@@ -16,4 +16,4 @@ "underscore": "~1.8.3" | ||
"devDependencies": { | ||
"coffee-script": "^1.12.2", | ||
"standard-version": "^4.0.0" | ||
"coffee-script": "^1.12.7", | ||
"standard-version": "^4.2.0" | ||
}, | ||
@@ -54,3 +54,3 @@ "engines": { | ||
}, | ||
"version": "0.2.6" | ||
"version": "0.2.7" | ||
} |
# Coffee->JSHint | ||
[![npm version](https://badge.fury.io/js/coffee-jshint.svg)](http://badge.fury.io/js/coffee-jshint) | ||
[![David dependency drift detection](https://david-dm.org/marviq/coffee-jshint.svg)](https://david-dm.org/marviq/coffee-jshint) | ||
Runs your CoffeeScript source through [JSHint](http://www.jshint.com/) to check for errors. | ||
@@ -18,3 +21,3 @@ | ||
JSHint takes [a bunch of options](http://www.jshint.com/docs/#options) that tell it various rules to enforce or relax. Some of these don't make much sense to check for JS generated by the CoffeeScript compiler, so by default these options are turned on: | ||
JSHint takes [a bunch of options](http://www.jshint.com/docs/#options) that tell it various rules to enforce or relax. Some of these don't make much sense to check for JS generated by the CoffeeScript compiler, so by default these options are turned on: | ||
@@ -38,9 +41,9 @@ - **undef:** warns about use of undeclared variables | ||
You'll probably get a lot of complaints from Coffee->JSHint about undefined global variables like `console`, `$`, or `require`. Depending on where you're running your code, you might want to allow a few global variables. One easy way to handle this is to use JSHint's built in [environment options](http://www.jshint.com/docs/#environments). | ||
You'll probably get a lot of complaints from Coffee->JSHint about undefined global variables like `console`, `$`, or `require`. Depending on where you're running your code, you might want to allow a few global variables. One easy way to handle this is to use JSHint's built in [environment options](http://www.jshint.com/docs/#environments). | ||
For instance, if you're running your code using Node.js, then you'll want to turn on the `node` option. It works like any other option: | ||
For instance, if you're running your code using Node.js, then you'll want to turn on the `node` option. It works like any other option: | ||
coffee-jshint -o node ... | ||
If you have some globals that aren't covered by any of environments, well then you should probably check yo'self before you wreck yo'self. But if you really want to turn off warnings for some global variables, Coffee->JSHint supports it using the `--globals` or `-g` option. One use case is when using [Mocha](http://mochajs.org/), a testing library: | ||
If you have some globals that aren't covered by any of environments, well then you should probably check yo'self before you wreck yo'self. But if you really want to turn off warnings for some global variables, Coffee->JSHint supports it using the `--globals` or `-g` option. One use case is when using [Mocha](http://mochajs.org/), a testing library: | ||
@@ -51,3 +54,3 @@ coffee-jshint -o node --globals describe,it ... | ||
Coffee->JSHint plays nicely with your favorite Unix utilities. If you want to recursively search all the files in a directory, try piping in the results of a `find`. Here's an example that also uses `grep` to filter out files in `node_modules/`: | ||
Coffee->JSHint plays nicely with your favorite Unix utilities. If you want to recursively search all the files in a directory, try piping in the results of a `find`. Here's an example that also uses `grep` to filter out files in `node_modules/`: | ||
@@ -68,3 +71,3 @@ find . -type f -path "*.coffee" | grep -v "node_modules/" | xargs coffee-jshint | ||
This will take all the files you plan to commit changes to, run them through `coffee-jshint`, and exit with status code `1` if there are any warnings (which it will also print out). If there are warnings, the commit will be aborted, but you can always do `git commit --no-verify` to bypass the hook. | ||
This will take all the files you plan to commit changes to, run them through `coffee-jshint`, and exit with status code `1` if there are any warnings (which it will also print out). If there are warnings, the commit will be aborted, but you can always do `git commit --no-verify` to bypass the hook. | ||
@@ -92,3 +95,3 @@ ## Contributing | ||
* Set up [a helpful reminder](.gitmessage) of how to make [a good commit message](#commit-message-format-discipline). If you adhere to this, then a | ||
detailed, meaningful [CHANGELOG](CHANGELOG.md) can be constructed automatically; | ||
detailed, meaningful [CHANGELOG](./CHANGELOG.md) can be constructed automatically; | ||
* Install all required dependencies; | ||
@@ -110,3 +113,3 @@ * The latter command will also invoke `make` (no args) for you, creating a build. | ||
This project uses [`conventional-changelog/standard-version`](https://github.com/conventional-changelog/standard-version) for automatic versioning and | ||
[CHANGELOG](CHANGELOG.md) management. | ||
[CHANGELOG](./CHANGELOG.md) management. | ||
@@ -145,12 +148,31 @@ To make this work, *please* ensure that your commit messages adhere to the | ||
* Wrap up: | ||
```bash | ||
$ git push --all --follow-tags | ||
``` | ||
### Publish | ||
```bash | ||
$ npm publish | ||
``` | ||
#### To NPM | ||
```bash | ||
$ npm publish | ||
``` | ||
#### On GitHub | ||
```bash | ||
git push --follow-tags --all | ||
``` | ||
* Go to [https://github.com/marviq/coffee-jshint/releases](https://github.com/marviq/coffee-jshint/releases); | ||
* Click the `Draft a new release` button; | ||
* Select the appropriate `v<version>` tag from the dropdown menu; | ||
* You could enter a title and some release notes here but most of it _should_ have already been covered in the [CHANGELOG](./CHANGELOG.md). | ||
* Click the `Publish release` button; | ||
## ChangeLog | ||
See [CHANGELOG](./CHANGELOG.md). | ||
## License | ||
[BSD-3-Clause](LICENSE) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
16935
172
Updatedjshint@^2.9.5