eslint-config-handsome

eslint-config-handsome

🤘Handsome ESLint shareable config. Enforces strict and readable code.🤘

Rules

This config aims to improve code readability which is good for team collaboration. So it's a little bit strict but not too much.
The details are more cumbersome, not one by one description here. You could find detailed rules in the code.

Here are some basic rules about stylistic:

• Tab indentation - You can control width personalized "Why tabs are superior".
• One true brace style with single line allowed
• Single-quotes - Except to avoid escaping.
• No unused variables - This one catches tons of bugs!
• Semicolons - By default. But there may be a config to support no semicolons.
• Space after keyword - if (condition) {}
• Space after function name - function name (arg) { ... }
• No space in array bracket - const arr = [1, 2, 3]
• Always space in block - const obj = { foo: 'bar' }
• Always === instead of ==
• Always handle the node.js err function parameter

Install

By npm:

npm i eslint-config-handsome --save-dev

By yarn:

yarn add -D eslint-config-handsome

Usage

Shareable configs are designed to work with the extends feature of ESLint configuration files or eslintConfig field in package.json file. You can learn more about Shareable Configs on the official ESLint website.

After install eslint-config-handsome package, there's 2 ways to active it:

• by package.json file
• by ESLint configuration file

package.json file

Add this to your package.json file:

{
  "eslintConfig": {
    "extends": "handsome"
  }
}

ESLint configuration file

Add this to your ESLint configuration file such as .eslintrc:

{
  "extends": "handsome"
}

Badge

Use this in one of your projects? Include one of these badges in your README file to let people know that your code is using the handsome style.

[![badge](https://img.shields.io/badge/eslint-handsome-brightgreen.svg)](https://github.com/poppinlp/eslint-config-handsome)

[![flat badge](https://img.shields.io/badge/eslint-handsome-brightgreen.svg?style=flat-square)](https://github.com/poppinlp/eslint-config-handsome)