-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Update project/documentation links - Use open source Code Climate badge - Hard-wrap text - Fix YAML identation
- Loading branch information
Showing
1 changed file
with
39 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,57 @@ | ||
# Code Climate ESLint Engine | ||
|
||
[](https://codeclimate.com/repos/55841b7a6956801212006c92/feed) | ||
[![Code Climate][badge]][repo] | ||
|
||
`codeclimate-eslint` is a Code Climate engine that wraps [ESLint](https://github.com/eslint/eslint). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform. | ||
[badge]: https://codeclimate.com/github/codeclimate/codeclimate-eslint/badges/gpa.svg | ||
[repo]: https://codeclimate.com/repos/github/codeclimate-eslint | ||
|
||
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It can be configured using a [configuration file](https://github.com/eslint/eslint#usage). | ||
`codeclimate-eslint` is a Code Climate engine that wraps [ESLint][]. You can run | ||
it on your command line using the Code Climate CLI, or on our hosted analysis | ||
platform. | ||
|
||
ESLint is a tool for identifying and reporting on patterns found in | ||
ECMAScript/JavaScript code. It can be configured using a [configuration | ||
file][config]. | ||
|
||
[config]: http://eslint.org/docs/user-guide/configuring#using-configuration-files | ||
|
||
### Installation | ||
|
||
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate). | ||
2. Run `codeclimate engines:enable eslint`. This command both installs the engine and enables it in your `.codeclimate.yml` file. | ||
3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`. | ||
1. If you haven't already, [install the Code Climate CLI][CLI] | ||
|
||
2. Run `codeclimate engines:enable eslint`. This command both installs the | ||
engine and enables it in your `.codeclimate.yml` file | ||
|
||
3. You're ready to analyze! Browse into your project's folder and run | ||
`codeclimate analyze` | ||
|
||
[cli]: https://github.com/codeclimate/codeclimate | ||
|
||
### Configuration | ||
|
||
#### `ignore_warnings` | ||
By default, this engine will emit both ESLint errors and warnings as Code Climate issues. If you prefer, you can ignore warning-level violations by setting the `ignore_warnings` configuration option: | ||
|
||
By default, this engine will emit both ESLint errors and warnings as Code | ||
Climate issues. If you prefer, you can ignore warning-level violations by | ||
setting the `ignore_warnings` configuration option: | ||
|
||
```yaml | ||
eslint: | ||
enabled: true | ||
config: | ||
ignore_warnings: true | ||
enabled: true | ||
config: | ||
ignore_warnings: true | ||
``` | ||
### Need help? | ||
For help with ESLint, [check out their documentation](https://github.com/eslint/eslint). | ||
For help with ESLint, [check out their documentation][eslint-docs]. | ||
If you're running into a Code Climate issue, first look over this project's | ||
[GitHub Issues][issues], as your question may have already been covered. If not, | ||
[go ahead and open a support ticket with us][help]. | ||
[issues]: https://github.com/codeclimate/codeclimate-eslint/issues | ||
[help]: https://codeclimate.com/help | ||
If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-eslint/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help). | ||
[eslint]: http://eslint.org | ||
[eslint-docs]: http://eslint.org/docs/user-guide/ |