readme.md

eslint-plugin-unicorn

Various awesome ESLint rules

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

Propose or contribute a new rule ➡

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": 2019,
			"sourceType": "module"
		},
		"plugins": [
			"unicorn"
		],
		"rules": {
			"unicorn/catch-error-name": "error",
			"unicorn/custom-error-definition": "off",
			"unicorn/error-message": "error",
			"unicorn/escape-case": "error",
			"unicorn/explicit-length-check": "error",
			"unicorn/filename-case": "error",
			"unicorn/import-index": "error",
			"unicorn/new-for-builtins": "error",
			"unicorn/no-abusive-eslint-disable": "error",
			"unicorn/no-array-instanceof": "error",
			"unicorn/no-console-spaces": "error",
			"unicorn/no-fn-reference-in-iterator": "off",
			"unicorn/no-for-loop": "error",
			"unicorn/no-hex-escape": "error",
			"unicorn/no-new-buffer": "error",
			"unicorn/no-process-exit": "error",
			"unicorn/no-unreadable-array-destructuring": "error",
			"unicorn/no-unsafe-regex": "off",
			"unicorn/no-unused-properties": "off",
			"unicorn/no-zero-fractions": "error",
			"unicorn/number-literal-case": "error",
			"unicorn/prefer-add-event-listener": "error",
			"unicorn/prefer-exponentiation-operator": "error",
			"unicorn/prefer-includes": "error",
			"unicorn/prefer-node-append": "error",
			"unicorn/prefer-node-remove": "error",
			"unicorn/prefer-query-selector": "error",
			"unicorn/prefer-spread": "error",
			"unicorn/prefer-starts-ends-with": "error",
			"unicorn/prefer-text-content": "error",
			"unicorn/prefer-type-error": "error",
			"unicorn/prevent-abbreviations": "error",
			"unicorn/regex-shorthand": "error",
			"unicorn/throw-new-error": "error"
		}
	}
}

Rules

• catch-error-name - Enforce a specific parameter name in catch clauses.
• custom-error-definition - Enforce correct Error subclassing. (fixable)
• error-message - Enforce passing a message value when throwing a built-in error.
• escape-case - Require escape sequences to use uppercase values. (fixable)
• explicit-length-check - Enforce explicitly comparing the length property of a value. (partly fixable)
• filename-case - Enforce a case style for filenames.
• import-index - Enforce importing index files with .. (fixable)
• new-for-builtins - Enforce the use of new for all builtins, except String, Number, Boolean and Symbol. (fixable)
• no-abusive-eslint-disable - Enforce specifying rules to disable in eslint-disable comments.
• no-array-instanceof - Require Array.isArray() instead of instanceof Array. (fixable)
• no-console-spaces - Do not use leading/trailing space between console.log parameters. (fixable)
• no-fn-reference-in-iterator - Prevents passing a function reference directly to iterator methods. (fixable)
• no-for-loop - Do not use a for loop that can be replaced with a for-of loop. (fixable)
• no-hex-escape - Enforce the use of unicode escapes instead of hexadecimal escapes. (fixable)
• no-new-buffer - Enforce the use of Buffer.from() and Buffer.alloc() instead of the deprecated new Buffer(). (fixable)
• no-process-exit - Disallow process.exit().
• no-unreadable-array-destructuring - Disallow unreadable array destructuring.
• no-unsafe-regex - Disallow unsafe regular expressions.
• no-unused-properties - Disallow unused object properties.
• no-zero-fractions - Disallow number literals with zero fractions or dangling dots. (fixable)
• number-literal-case - Enforce lowercase identifier and uppercase value for number literals. (fixable)
• prefer-add-event-listener - Prefer addEventListener over on-functions. (fixable)
• prefer-exponentiation-operator - Prefer the exponentiation operator over Math.pow() (fixable)
• prefer-includes - Prefer .includes() over .indexOf() when checking for existence or non-existence. (fixable)
• prefer-node-append - Prefer append over appendChild. (fixable)
• prefer-node-remove - Prefer remove over parentNode.removeChild and parentElement.removeChild. (fixable)
• prefer-query-selector - Prefer querySelector over getElementById, querySelectorAll over getElementsByClassName and getElementsByTagName. (partly fixable)
• prefer-spread - Prefer the spread operator over Array.from(). (fixable)
• prefer-starts-ends-with - Prefer String#startsWith & String#endsWith over more complex alternatives.
• prefer-text-content - Prefer textContent over innerText. (fixable)
• prefer-type-error - Enforce throwing TypeError in type checking conditions. (fixable)
• prevent-abbreviations - Prevent abbreviations (partly fixable)
• regex-shorthand - Enforce the use of regex shorthands to improve readability. (fixable)
• throw-new-error - Require new when throwing an error. (fixable)

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": {
		"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

• Sindre Sorhus
• Jeroen Engels
• Sam Verschueren
• futpib

License

MIT