Update rules to use 'layout' instead of 'style'

eslint · Nov 1, 2018 · b4ed91f · b4ed91f
1 parent fef4f9a
commit b4ed91f
Show file tree

Hide file tree

Showing 87 changed files with 179 additions and 176 deletions.
diff --git a/docs/developer-guide/nodejs-api.md b/docs/developer-guide/nodejs-api.md
@@ -348,7 +348,7 @@ The `CLIEngine` is a constructor, and you can create a new instance by passing i
 * `envs` - An array of environments to load (default: empty array). Corresponds to `--env`.
 * `extensions` - An array of filename extensions that should be checked for code. The default is an array containing just `".js"`. Corresponds to `--ext`. It is only used in conjunction with directories, not with filenames or glob patterns.
 * `fix` - A boolean or a function (default: `false`). If a function, it will be passed each linting message and should return a boolean indicating whether the fix should be included with the output report (errors and warnings will not be listed if fixed). Files on disk are never changed regardless of the value of `fix`. To persist changes to disk, call [`outputFixes()`](#cliengineoutputfixes).
-* `fixTypes` - An array of rule types for which fixes should be applied (default: `null`). This array acts like a filter, only allowing rules of the given types to apply fixes. Possible array values are `"problem"`, `"suggestion"`, and `"style"`.
+* `fixTypes` - An array of rule types for which fixes should be applied (default: `null`). This array acts like a filter, only allowing rules of the given types to apply fixes. Possible array values are `"problem"`, `"suggestion"`, and `"layout"`.
 * `globals` - An array of global variables to declare (default: empty array). Corresponds to `--global`.
 * `ignore` - False disables use of `.eslintignore`, `ignorePath` and `ignorePattern` (default: true). Corresponds to `--no-ignore`.
 * `ignorePath` - The ignore file to use instead of `.eslintignore` (default: null). Corresponds to `--ignore-path`.

diff --git a/docs/developer-guide/working-with-rules.md b/docs/developer-guide/working-with-rules.md
@@ -51,7 +51,10 @@ The source file for a rule exports an object with the following properties.
 
 `meta` (object) contains metadata for the rule:
 
-* `type` (string) indicates the type of rule, which is one of `"problem"`, `"suggestion"`, or `"style"`
+* `type` (string) indicates the type of rule, which is one of `"problem"`, `"suggestion"`, or `"layout"`:
+    * `"problem"` means the rule is identifying code that either will cause an error or may cause a confusing behavior. Developers should consider this a high priority to resolve.
+    * `"suggestion"` means the rule is identifying something that could be done in a better way but no errors will occur if the code isn't changed.
+    * `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes. These rules work on parts of the code that aren't specified in the AST.
 
 * `docs` (object) is required for core rules of ESLint:
 

diff --git a/docs/user-guide/command-line-interface.md b/docs/user-guide/command-line-interface.md
@@ -46,7 +46,7 @@ Specifying rules and plugins:
 Fixing problems:
   --fix                          Automatically fix problems
   --fix-dry-run                  Automatically fix problems without saving the changes to the file system
-  --fix-type Array               Specify the types of fixes to apply (problem, suggestion, style)
+  --fix-type Array               Specify the types of fixes to apply (problem, suggestion, layout)
 
 Ignoring files:
   --ignore-path path::String     Specify path of ignore file
@@ -240,17 +240,17 @@ This option allows you to specify the type of fixes to apply when using either `
 
 1. `problem` - fix potential errors in the code
 1. `suggestion` - apply fixes to the code that improve it
-1. `style` - apply fixes that do not mutate the program structure (AST)
+1. `layout` - apply fixes that do not change the program structure (AST)
 
 You can specify one or more fix type on the command line. Here are some examples:
 
 ```
 eslint --fix --fix-type suggestion .
 eslint --fix --fix-type suggestion --fix-type problem .
-eslint --fix --fix-type suggestion,style .
+eslint --fix --fix-type suggestion,layout .
 ```
 
-This option is helpful if you are using another program to style your code but you would still like ESLint to apply other types of fixes.
+This option is helpful if you are using another program to format your code but you would still like ESLint to apply other types of fixes.
 
 ### Ignoring files
 

diff --git a/lib/cli-engine.js b/lib/cli-engine.js
@@ -32,7 +32,7 @@ const fs = require("fs"),
 
 const debug = require("debug")("eslint:cli-engine");
 const resolver = new ModuleResolver();
-const validFixTypes = new Set(["problem", "suggestion", "style"]);
+const validFixTypes = new Set(["problem", "suggestion", "layout"]);
 
 //------------------------------------------------------------------------------
 // Typedefs

diff --git a/lib/options.js b/lib/options.js
@@ -100,7 +100,7 @@ module.exports = optionator({
         {
             option: "fix-type",
             type: "Array",
-            description: "Specify the types of fixes to apply (problem, suggestion, style)"
+            description: "Specify the types of fixes to apply (problem, suggestion, layout)"
         },
         {
             heading: "Ignoring files"

diff --git a/lib/rules/array-bracket-newline.js b/lib/rules/array-bracket-newline.js
@@ -13,7 +13,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce linebreaks after opening and before closing array brackets",

diff --git a/lib/rules/array-bracket-spacing.js b/lib/rules/array-bracket-spacing.js
@@ -12,7 +12,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing inside array brackets",

diff --git a/lib/rules/array-element-newline.js b/lib/rules/array-element-newline.js
@@ -13,7 +13,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce line breaks after each array element",

diff --git a/lib/rules/arrow-parens.js b/lib/rules/arrow-parens.js
@@ -16,7 +16,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require parentheses around arrow function arguments",

diff --git a/lib/rules/arrow-spacing.js b/lib/rules/arrow-spacing.js
@@ -16,7 +16,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing before and after the arrow in arrow functions",

diff --git a/lib/rules/block-spacing.js b/lib/rules/block-spacing.js
@@ -13,7 +13,7 @@ const util = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "disallow or enforce spaces inside of blocks after opening block and before closing block",

diff --git a/lib/rules/brace-style.js b/lib/rules/brace-style.js
@@ -13,7 +13,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent brace style for blocks",

diff --git a/lib/rules/comma-dangle.js b/lib/rules/comma-dangle.js
@@ -76,7 +76,7 @@ function normalizeOptions(optionValue) {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require or disallow trailing commas",

diff --git a/lib/rules/comma-spacing.js b/lib/rules/comma-spacing.js
@@ -12,7 +12,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing before and after commas",

diff --git a/lib/rules/comma-style.js b/lib/rules/comma-style.js
@@ -13,7 +13,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent comma style",

diff --git a/lib/rules/computed-property-spacing.js b/lib/rules/computed-property-spacing.js
@@ -12,7 +12,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing inside computed property brackets",

diff --git a/lib/rules/dot-location.js b/lib/rules/dot-location.js
@@ -13,7 +13,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent newlines before and after dots",

diff --git a/lib/rules/eol-last.js b/lib/rules/eol-last.js
@@ -16,7 +16,7 @@ const lodash = require("lodash");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require or disallow newline at the end of files",

diff --git a/lib/rules/func-call-spacing.js b/lib/rules/func-call-spacing.js
@@ -17,7 +17,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require or disallow spacing between function identifiers and their invocations",

diff --git a/lib/rules/func-name-matching.js b/lib/rules/func-name-matching.js
@@ -70,7 +70,7 @@ const optionsObject = {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "suggestion",
 
         docs: {
             description: "require function names to match the name of the variable or property to which they are assigned",

diff --git a/lib/rules/func-names.js b/lib/rules/func-names.js
@@ -26,7 +26,7 @@ function isFunctionName(variable) {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "suggestion",
 
         docs: {
             description: "require or disallow named `function` expressions",

diff --git a/lib/rules/function-paren-newline.js b/lib/rules/function-paren-newline.js
@@ -16,7 +16,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent line breaks inside function parentheses",

diff --git a/lib/rules/generator-star-spacing.js b/lib/rules/generator-star-spacing.js
@@ -27,7 +27,7 @@ const OVERRIDE_SCHEMA = {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing around `*` operators in generator functions",

diff --git a/lib/rules/id-blacklist.js b/lib/rules/id-blacklist.js
@@ -12,7 +12,7 @@
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "suggestion",
 
         docs: {
             description: "disallow specified identifiers",

diff --git a/lib/rules/id-length.js b/lib/rules/id-length.js
@@ -12,7 +12,7 @@
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "suggestion",
 
         docs: {
             description: "enforce minimum and maximum identifier lengths",

diff --git a/lib/rules/id-match.js b/lib/rules/id-match.js
@@ -11,7 +11,7 @@
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "suggestion",
 
         docs: {
             description: "require identifiers to match a specified regular expression",

diff --git a/lib/rules/implicit-arrow-linebreak.js b/lib/rules/implicit-arrow-linebreak.js
@@ -9,7 +9,7 @@
 //------------------------------------------------------------------------------
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce the location of arrow function bodies",

diff --git a/lib/rules/indent-legacy.js b/lib/rules/indent-legacy.js
@@ -21,7 +21,7 @@ const astUtils = require("../util/ast-utils");
 /* istanbul ignore next: this rule has known coverage issues, but it's deprecated and shouldn't be updated in the future anyway. */
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent indentation",

diff --git a/lib/rules/indent.js b/lib/rules/indent.js
@@ -490,7 +490,7 @@ const ELEMENT_LIST_SCHEMA = {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent indentation",

diff --git a/lib/rules/jsx-quotes.js b/lib/rules/jsx-quotes.js
@@ -38,7 +38,7 @@ const QUOTE_SETTINGS = {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce the consistent use of either double or single quotes in JSX attributes",

diff --git a/lib/rules/key-spacing.js b/lib/rules/key-spacing.js
@@ -128,7 +128,7 @@ const messages = {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing between keys and values in object literal properties",

diff --git a/lib/rules/keyword-spacing.js b/lib/rules/keyword-spacing.js
@@ -65,7 +65,7 @@ function isCloseParenOfTemplate(token) {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent spacing before and after keywords",

diff --git a/lib/rules/line-comment-position.js b/lib/rules/line-comment-position.js
@@ -12,7 +12,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce position of line comments",

diff --git a/lib/rules/linebreak-style.js b/lib/rules/linebreak-style.js
@@ -17,7 +17,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce consistent linebreak style",

diff --git a/lib/rules/lines-around-comment.js b/lib/rules/lines-around-comment.js
@@ -52,7 +52,7 @@ function getCommentLineNums(comments) {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require empty lines around comments",

diff --git a/lib/rules/lines-around-directive.js b/lib/rules/lines-around-directive.js
@@ -14,7 +14,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require or disallow newlines around directives",

diff --git a/lib/rules/lines-between-class-members.js b/lib/rules/lines-between-class-members.js
@@ -12,7 +12,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "require or disallow an empty line between class members",

diff --git a/lib/rules/max-len.js b/lib/rules/max-len.js
@@ -65,7 +65,7 @@ const OPTIONS_OR_INTEGER_SCHEMA = {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce a maximum line length",

diff --git a/lib/rules/max-statements-per-line.js b/lib/rules/max-statements-per-line.js
@@ -16,7 +16,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce a maximum number of statements allowed per line",

diff --git a/lib/rules/multiline-ternary.js b/lib/rules/multiline-ternary.js
@@ -13,7 +13,7 @@ const astUtils = require("../util/ast-utils");
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "layout",
 
         docs: {
             description: "enforce newlines between operands of ternary expressions",

diff --git a/lib/rules/new-cap.js b/lib/rules/new-cap.js
@@ -74,7 +74,7 @@ function calculateCapIsNewExceptions(config) {
 
 module.exports = {
     meta: {
-        type: "style",
+        type: "suggestion",
 
         docs: {
             description: "require constructor names to begin with a capital letter",