eslint-plugin-unicorn

Various awesome ESLint rules

You might want to check out XO, which includes this plugin.

Install

$ npm install --save-dev eslint eslint-plugin-unicorn

Usage

Configure it in package.json.

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"env": {
			"es6": true
		},
		"parserOptions": {
			"ecmaVersion": 2017,
			"sourceType": "module"
		},
		"plugins": [
			"unicorn"
		],
		"rules": {
			"unicorn/catch-error-name": ["error", {"name": "err"}],
			"unicorn/explicit-length-check": "error",
			"unicorn/filename-case": ["error", {"case": "kebabCase"}],
			"unicorn/no-abusive-eslint-disable": "error",
			"unicorn/no-process-exit": "error",
			"unicorn/throw-new-error": "error",
			"unicorn/number-literal-case": "error",
			"unicorn/escape-case": "error",
			"unicorn/no-array-instanceof": "error",
			"unicorn/no-new-buffer": "error",
			"unicorn/no-hex-escape": "error",
			"unicorn/custom-error-definition": "error",
			"unicorn/prefer-starts-ends-with": "error",
			"unicorn/prefer-type-error": "error",
			"unicorn/no-fn-reference-in-iterator": "error",
			"unicorn/import-index": "error",
			"unicorn/new-for-builtins": "error",
			"unicorn/regex-shorthand": "error",
			"unicorn/prefer-spread": "error",
			"unicorn/error-message": "error"
		}
	}
}

Rules

catch-error-name - Enforce a specific parameter name in catch clauses.
explicit-length-check - Enforce explicitly comparing the length property of a value. (partly fixable)
filename-case - Enforce a case style for filenames.
no-abusive-eslint-disable - Enforce specifying rules to disable in eslint-disable comments.
no-process-exit - Disallow process.exit().
throw-new-error - Require new when throwing an error. (fixable)
number-literal-case - Enforce lowercase identifier and uppercase value for number literals. (fixable)
escape-case - Require escape sequences to use uppercase values. (fixable)
no-array-instanceof - Require Array.isArray() instead of instanceof Array. (fixable)
no-new-buffer - Enforce the use of Buffer.from() and Buffer.alloc() instead of the deprecated new Buffer(). (fixable)
no-hex-escape - Enforce the use of unicode escapes instead of hexadecimal escapes. (fixable)
custom-error-definition - Enforce correct Error subclassing. (fixable)
prefer-starts-ends-with - Prefer String#startsWith & String#endsWith over more complex alternatives.
prefer-type-error - Enforce throwing TypeError in type checking conditions. (fixable)
no-fn-reference-in-iterator - Prevents passing a function reference directly to iterator methods. (fixable)
import-index - Enforce importing index files with .. (fixable)
new-for-builtins - Enforce the use of new for all builtins, except String, Number and Boolean. (fixable)
regex-shorthand - Enforce the use of regex shorthands to improve readability. (fixable)
prefer-spread - Prefer the spread operator over Array.from(). (fixable)
error-message - Enforce passing a message value when throwing a built-in error.

Recommended config

This plugin exports a recommended config that enforces good practices.

Enable it in your package.json with the extends option:

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"plugins": [
			"unicorn"
		],
		"extends": "plugin:unicorn/recommended"
	}
}

See the ESLint docs for more information about extending config files.

Note: This config will also enable the correct parser options and environment.

Maintainers

License

MIT