Add prevent-abbreviations rule

docs/rules/prevent-abbreviations.md

@@ -0,0 +1,145 @@
+# Prevent abbreviations
+
+Using complete words results in more readable code. Not everyone knows all your abbreviations. You only write code once, but it's read many times.
+
+This rule can also be used to replace terms, disallowed words, etc. See [`replacements`](#replacements) and [`extendDefaultReplacements`](#extenddefaultreplacements) options.
+
+Default replacements are available [here](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/rules/prevent-abbreviations.js#L13).
+
+This rule is fixable only for variable names where abbreviation has with exactly one replacement defined.
+
+
+## Fail
+
+```js
+const e = new Error();
+```
+
+```js
+const e = document.createEvent('Event');
+```
+
+```js
+const levels = {
+	err: 0
+};
+```
+
+```js
+this.evt = 'click';
+```
+
+```js
+class Btn {}
+```
+
+
+## Pass
+
+```js
+const error = new Error();
+```
+
+```js
+const event = document.createEvent('Event');
+```
+
+```js
+const levels = {
+	error: 0
+};
+```
+
+```js
+this.event = 'click';
+```
+
+```js
+class Button {}
+```
+
+
+## Options
+
+### replacements
+
+You can extend default replacements by passing this option.
+
+The example below disables the default `e` → `event` replacement and adds a custom `cmd` → `command` one.
+
+```js
+"unicorn/prevent-abbreviations": [
+	"error",
+	{
+		"replacements": {
+			"cmd": {
+				"command": true
+			},
+			"e": {
+				"event": false
+			}
+		}
+	}
+]
+```
+
+### extendDefaultReplacements
+
+Pass `false` here to override the default `replacements` completely.
+
+The example below disables all the default replacements and enables a custom `cmd` → `command` one.
+
+```js
+"unicorn/prevent-abbreviations": [
+	"error",
+	{
+		"extendDefaultReplacements": false,
+		"replacements": {
+			"cmd": {
+				"command": true
+			}
+		}
+	}
+]
+```
+
+### matchPascalCase
+
+By default replacements defined in camelCase match PascalCase identifiers too. For example, default replacement `evt` → `event` will match both `evt` and `Evt` (which could be automatically fixed to `Event`).
+
+Pass `false` here to disable this case-agnostic matching.
+
+The example below defines two replacements `res` → `response` and `Res` → `Result` different in case.
+
+```js
+"unicorn/prevent-abbreviations": [
+	"error",
+	{
+		"matchPascalCase": false,
+		"extendDefaultReplacements": false,
+		"replacements": {
+			"res": {
+				"response": true
+			},
+			"Res": {
+				"Result": true
+			}
+		}
+	}
+]
+```
+
+### checkPropertyNames
+
+Pass `false` here to disable checking property names.
+
+### checkVariableNames
+
+Pass `false` here to disable checking variable names.
+
+
+## Edge cases
+
+### arguments
+
+This rule does not report or fix `args` → `arguments` when it would result in a collision with the built-in [`arguments` object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/arguments);

index.js

@@ -47,7 +47,8 @@ module.exports = {
 				'unicorn/prefer-query-selector': 'error',
 				'unicorn/prefer-node-remove': 'error',
 				'unicorn/prefer-text-content': 'error',
-				'unicorn/no-for-loop': 'error'
+				'unicorn/no-for-loop': 'error',
+				'unicorn/prevent-abbreviations': 'error'
 			}
 		}
 	}

package.json

@@ -35,8 +35,10 @@
 		"eslint-ast-utils": "^1.0.0",
 		"import-modules": "^1.1.0",
 		"lodash.camelcase": "^4.1.1",
+		"lodash.defaultsdeep": "^4.6.0",
 		"lodash.kebabcase": "^4.0.1",
 		"lodash.snakecase": "^4.0.1",
+		"lodash.topairs": "^4.3.0",
 		"lodash.upperfirst": "^4.2.0",
 		"safe-regex": "^2.0.1"
 	},

readme.md

@@ -64,7 +64,8 @@ Configure it in `package.json`.
 			"unicorn/prefer-query-selector": "error",
 			"unicorn/prefer-node-remove": "error",
 			"unicorn/prefer-text-content": "error",
-			"unicorn/no-for-loop": "error"
+			"unicorn/no-for-loop": "error",
+			"unicorn/prevent-abbreviations": "error"
 		}
 	}
 }
@@ -104,6 +105,7 @@ Configure it in `package.json`.
 - [prefer-node-remove](docs/rules/prefer-node-remove.md) - Prefer `remove` over `parentNode.removeChild` and `parentElement.removeChild`. *(fixable)*
 - [prefer-text-content](docs/rules/prefer-text-content.md) - Prefer `textContent` over `innerText`. *(fixable)*
 - [no-for-loop](docs/rules/no-for-loop.md) - Do not use a `for` loop that can be replaced with a `for-of` loop. *(fixable)*
+- [prevent-abbreviations](docs/rules/prevent-abbreviations.md) - Prevent abbreviations *(partly fixable)*
 
 
 ## Recommended config

rules/catch-error-name.js

@@ -25,6 +25,7 @@ function isLintablePromiseCatch(node) {
 	return arg0.type === 'FunctionExpression' || arg0.type === 'ArrowFunctionExpression';
 }
 
+// TODO: Use `./utils/avoid-capture.js` instead
 function indexifyName(name, scope) {
 	const variables = scope.variableScope.set;