tiaanduplessis / eslint-config-nitpicky

ESLint config for the refined individual

ESLint config for the refined individual

Table of Contents

• About
• Usage
• Configuration
• Other
• Contribute
• License

About

Shareable configs are designed to work with the extends feature of eslint files. You can learn more about shareable configs on the official ESLint website.

Usage

This package has several peer dependencies. Run npm info "eslint-config-nitpicky@latest" peerDependencies to list them all.

Install all the dependencies:

npm install --save-dev eslint-config-nitpicky eslint babel-eslint prettier eslint-config-prettier eslint-plugin-promise eslint-plugin-import

# or

yarn add --dev eslint-config-nitpicky eslint babel-eslint prettier eslint-config-prettier eslint-plugin-promise eslint-plugin-import

Then, add this to your .eslintrc file:

{
  "extends": "nitpicky",
  "env": {
    "browser": true,
  }
}

Note: The eslint-config- prefix has been omitted since it is automatically assumed by ESLint.

You can override settings from the shareable config by adding them directly into your .eslintrc file.

Using with prettier

Follow instructions for prettier-eslint-cli installation and add script:

"format": "prettier-eslint --write --eslint-ignore"

Add a badge

[![nitpicky-code-style](https://img.shields.io/badge/code%20style-nitpicky-7681ED.svg?style=flat-square)](https://github.com/tiaanduplessis/eslint-config-nitpicky)

Configurations

React

Includes the default configuration as well as React specific environment specification and rules via:

• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-jsx-a11y

Setup:

$ npm install --save-dev eslint-config-nitpicky eslint babel-eslint prettier eslint-config-prettier eslint-plugin-promise eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-react-hooks

# or

yarn add --dev eslint-config-nitpicky eslint babel-eslint prettier eslint-config-prettier eslint-plugin-promise eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-react-hooks

In your .eslintrc:

{
  "extends": "nitpicky/react"
}

Other

Useful project specific plugins to consider:

• eslint-plugin-jest
• eslint-plugin-security
• eslint-plugin-flowtype
• eslint-plugin-compat

Contribute

1. Fork it and create your feature branch: git checkout -b my-new-feature
2. Commit your changes: git commit -am 'Add some feature'
3. Push to the branch: git push origin my-new-feature
4. Submit a pull request

License

MIT

eslint-config-nitpicky's Issues

ESLint rules for Node Security

https://www.npmjs.com/package/eslint-plugin-security

eslint-plugin-unicorn

https://github.com/sindresorhus/eslint-plugin-unicorn

eslint-plugin-promise

https://github.com/xjamundx/eslint-plugin-promise