Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blond/eslint-config-pedant
:bowtie: Pedant preset for eslint
https://github.com/blond/eslint-config-pedant
errors es2015 es3 es5 eslint pedant shareable-configs typos
Last synced: 21 days ago
JSON representation
:bowtie: Pedant preset for eslint
- Host: GitHub
- URL: https://github.com/blond/eslint-config-pedant
- Owner: blond
- License: mit
- Created: 2016-03-05T10:45:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-20T22:33:38.000Z (almost 5 years ago)
- Last Synced: 2024-10-05T08:42:50.014Z (about 1 month ago)
- Topics: errors, es2015, es3, es5, eslint, pedant, shareable-configs, typos
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 20
- Watchers: 5
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
eslint-config-pedant
====================
An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) to find errors, typos and potentially dangerous code.
[![NPM Status][npm-img]][npm]
[![Travis Status][test-img]][travis]
[npm]: https://www.npmjs.org/package/eslint-config-pedant
[npm-img]: https://img.shields.io/npm/v/eslint-config-pedant.svg
[travis]: https://travis-ci.org/blond/eslint-config-pedant
[test-img]: https://img.shields.io/travis/blond/eslint-config-pedant/master.svg?label=tests
Table of Contents
-----------------
* [Install](#install)
* [Usage](#usage)
* [Presets](#presets)
* [FAQ](#faq)
* [Semantic Versioning Policy](#semantic-versioning-policy)
Install
-------
You'll first need to install ESLint:
```
$ npm install eslint --save-dev
```
**Note**: You may install ESLint globally using the `-g` flag.
Next, install `eslint-config-pedant`:
```
$ npm install eslint-config-pedant --save-dev
```
**Note**: If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-config-pedant` globally.
A globally-installed instance of ESLint can only use globally-installed ESLint plugins. A locally-installed ESLint can make use of both locally- and globally- installed ESLint plugins.
Usage
-----
Shareable configs are designed to work with the `extends` feature of `.eslintrc` files. You can learn more about [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) on the official ESLint website.
Add this to your `.eslintrc.json` file:
```json
{
"extends": "pedant"
}
```
**Note**: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint.
You can override settings from the shareable config by adding them directly into your `.eslintrc.json` file.
Presets
-------
### ECMAScript
By default rules are suitable for `ECMAScript 2015` or higher.
For `ECMAScript 2015` or higher, your config file should look like this:
```json
{
"extends": "pedant",
"parserOptions": {
"ecmaVersion": 6
}
}
```
If you are not using `ECMAScript 2015`, you can choose the config for `ECMAScript 5`:
```json
{
"extends": "pedant/es5"
}
```
Or config for `ECMAScript 3`:
```json
{
"extends": "pedant/es3"
}
```
FAQ
---
* [Whether this config is suitable for me?](#whether-this-config-is-suitable-for-me)
* [Why this config does not contain stylistic rules?](#why-this-config-does-not-contain-stylistic-rules)
### Whether this config is suitable for me?
Most likely this config will suite you, because it contains only those rules which are necessary to find errors, typos and potentially dangerous code.
To make sure that this config is right for you:
* Look at the [examples](./examples/bad/) of **incorrect** code.
* Look at the [rules](./index.js) from this config. The detailed information about each rule you can find on the [eslint](http://eslint.org/docs/rules/) website.
* Try this config in your project. If you agree with those errors then this config is for you.
### Why this config does not contain stylistic rules?
This config intentionally does not limit your choice of code style.
If you want to check code style of your code you can add [stylistic rules](http://eslint.org/docs/rules/#stylistic-issues) to your config in your project.
Also, you can create your own [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) or use one of the existing.
Semantic Versioning Policy
--------------------------
The `eslint-config-pedant` follows [semantic versioning](semver) and [ESLint's Semantic Versioning Policy](eslint-semver).
[semver]: http://semver.org
[eslint-semver]: https://github.com/eslint/eslint#semantic-versioning-policy
However, due to the nature of ESLint, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, ESLint defined the following semantic versioning policy:
* Patch release (intended to not break your lint build)
* A bug fix in a rule options that results in ESLint reporting fewer errors.
* Improvements to documentation.
* Non-user-facing changes such as refactoring code, modifying tests, and increasing examples coverage.
* Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
* An existing rule is replaced (if rule is deprecated) that results in ESLint reporting fewer errors.
* Minor release (might break your lint build)
* A bug fix in a rule options that results in ESLint reporting more errors.
* An existing rule is replaced (if rule is deprecated) that results in ESLint reporting more errors.
* A new rule is added that does not result in ESLint reporting more errors by default.
* A new option to an existing rule is added that does not result in ESLint reporting more errors by default.
* New capabilities to the public API are added (new presets, etc.).
* Major release (likely to break your lint build)
* A new rule is added that results in ESLint reporting more errors by default.
* A new option to an existing rule is added that results in ESLint reporting more errors by default.
* An existing rule is removed (if rule is not deprecated).
* Part of the public API is removed or changed in an incompatible way (removed presets, etc.).
According to our policy, any minor update may report more errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (`~`) in `package.json` e.g. `"eslint-config-pedant": "~1.0.0"` to guarantee the results of your builds.
License
-------
MIT © [Andrew Abramov](https://github.com/blond)