Rename to arrow-return-shorthand and fix metadata

palantir · Jan 7, 2017 · ff252e2 · ff252e2
1 parent f7ca02f
commit ff252e2
Show file tree

Hide file tree

Showing 15 changed files with 69 additions and 32 deletions.
diff --git a/docs/_data/rules.json b/docs/_data/rules.json
@@ -61,7 +61,7 @@
     "description": "Requires parentheses around the parameters of arrow function definitions.",
     "hasFix": true,
     "rationale": "Maintains stylistic consistency with other arrow function definitions.",
-    "optionsDescription": "\nif `ban-single-arg-parens` is specified, then arrow functions with one parameter\nmust not have parentheses if removing them is allowed by TypeScript.",
+    "optionsDescription": "\nIf `ban-single-arg-parens` is specified, then arrow functions with one parameter\nmust not have parentheses if removing them is allowed by TypeScript.",
     "options": {
       "type": "string",
       "enum": [
@@ -75,6 +75,24 @@
     "type": "style",
     "typescriptOnly": false
   },
+  {
+    "ruleName": "arrow-return-shorthand",
+    "description": "Suggests to convert `() => { return x; }` to `() => x`.",
+    "hasFix": true,
+    "optionsDescription": "\nIf `multiline` is specified, then this will warn even if the function spans multiple lines.",
+    "options": {
+      "type": "string",
+      "enum": [
+        "multiline"
+      ]
+    },
+    "optionExamples": [
+      "[true]",
+      "[true, \"multiline\"]"
+    ],
+    "type": "style",
+    "typescriptOnly": false
+  },
   {
     "ruleName": "ban",
     "description": "Bans the use of specific functions or global methods.",
@@ -1189,18 +1207,6 @@
     "type": "style",
     "typescriptOnly": false
   },
-  {
-    "ruleName": "prefer-arrow-shorthand-return",
-    "description": "Suggests to convert `() => { return x; }` to `() => x`.",
-    "optionsDescription": "Not configurable.",
-    "options": null,
-    "optionExamples": [
-      "[true]",
-      "[true, \"multiline\"]"
-    ],
-    "type": "functionality",
-    "typescriptOnly": false
-  },
   {
     "ruleName": "prefer-const",
     "description": "Requires that variable declarations use `const` instead of `let` if possible.",

diff --git a/docs/rules/arrow-parens/index.html b/docs/rules/arrow-parens/index.html
@@ -5,7 +5,7 @@
 rationale: Maintains stylistic consistency with other arrow function definitions.
 optionsDescription: |-
 
-  if `ban-single-arg-parens` is specified, then arrow functions with one parameter
+  If `ban-single-arg-parens` is specified, then arrow functions with one parameter
   must not have parentheses if removing them is allowed by TypeScript.
 options:
   type: string

diff --git a/docs/rules/arrow-return-shorthand/index.html b/docs/rules/arrow-return-shorthand/index.html
@@ -0,0 +1,26 @@
+---
+ruleName: arrow-return-shorthand
+description: 'Suggests to convert `() => { return x; }` to `() => x`.'
+hasFix: true
+optionsDescription: |-
+
+  If `multiline` is specified, then this will warn even if the function spans multiple lines.
+options:
+  type: string
+  enum:
+    - multiline
+optionExamples:
+  - '[true]'
+  - '[true, "multiline"]'
+type: style
+typescriptOnly: false
+layout: rule
+title: 'Rule: arrow-return-shorthand'
+optionsJSON: |-
+  {
+    "type": "string",
+    "enum": [
+      "multiline"
+    ]
+  }
+---
diff --git a/src/rules/arrowParensRule.ts b/src/rules/arrowParensRule.ts
@@ -29,7 +29,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         hasFix: true,
         rationale: "Maintains stylistic consistency with other arrow function definitions.",
         optionsDescription: Lint.Utils.dedent`
-            if \`${BAN_SINGLE_ARG_PARENS}\` is specified, then arrow functions with one parameter
+            If \`${BAN_SINGLE_ARG_PARENS}\` is specified, then arrow functions with one parameter
             must not have parentheses if removing them is allowed by TypeScript.`,
         options: {
             type: "string",

diff --git a/src/rules/preferArrowShorthandReturnRule.ts → src/rules/arrowReturnShorthandRule.ts b/src/rules/preferArrowShorthandReturnRule.ts → src/rules/arrowReturnShorthandRule.ts
@@ -24,15 +24,20 @@ const OPTION_MULTILINE = "multiline";
 export class Rule extends Lint.Rules.AbstractRule {
     /* tslint:disable:object-literal-sort-keys */
     public static metadata: Lint.IRuleMetadata = {
-        ruleName: "prefer-arrow-shorthand-return",
+        ruleName: "arrow-return-shorthand",
         description: "Suggests to convert `() => { return x; }` to `() => x`.",
-        optionsDescription: "Not configurable.",
-        options: null,
+        hasFix: true,
+        optionsDescription: Lint.Utils.dedent`
+            If \`${OPTION_MULTILINE}\` is specified, then this will warn even if the function spans multiple lines.`,
+        options: {
+            type: "string",
+            enum: [OPTION_MULTILINE],
+        },
         optionExamples: [
             `[true]`,
             `[true, "${OPTION_MULTILINE}"]`,
         ],
-        type: "functionality",
+        type: "style",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/...rrow-shorthand-return/default/test.js.fix → ...rrow-return-shorthand/default/test.js.fix b/...rrow-shorthand-return/default/test.js.fix → ...rrow-return-shorthand/default/test.js.fix
diff --git a/...row-shorthand-return/default/test.js.lint → ...row-return-shorthand/default/test.js.lint b/...row-shorthand-return/default/test.js.lint → ...row-return-shorthand/default/test.js.lint
diff --git a/...rrow-shorthand-return/default/test.ts.fix → ...rrow-return-shorthand/default/test.ts.fix b/...rrow-shorthand-return/default/test.ts.fix → ...rrow-return-shorthand/default/test.ts.fix
diff --git a/...row-shorthand-return/default/test.ts.lint → ...row-return-shorthand/default/test.ts.lint b/...row-shorthand-return/default/test.ts.lint → ...row-return-shorthand/default/test.ts.lint
diff --git a/test/rules/arrow-return-shorthand/default/tslint.json b/test/rules/arrow-return-shorthand/default/tslint.json
@@ -0,0 +1,8 @@
+{
+    "rules": {
+        "arrow-return-shorthand": true
+    },
+    "jsRules": {
+        "arrow-return-shorthand": true
+    }
+}
diff --git a/...ow-shorthand-return/multiline/test.ts.fix → ...ow-return-shorthand/multiline/test.ts.fix b/...ow-shorthand-return/multiline/test.ts.fix → ...ow-return-shorthand/multiline/test.ts.fix
diff --git a/...w-shorthand-return/multiline/test.ts.lint → ...w-return-shorthand/multiline/test.ts.lint b/...w-shorthand-return/multiline/test.ts.lint → ...w-return-shorthand/multiline/test.ts.lint
diff --git a/test/rules/arrow-return-shorthand/multiline/tslint.json b/test/rules/arrow-return-shorthand/multiline/tslint.json
@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "arrow-return-shorthand": [true, "multiline"]
+    }
+}
diff --git a/test/rules/prefer-arrow-shorthand-return/default/tslint.json b/test/rules/prefer-arrow-shorthand-return/default/tslint.json
diff --git a/test/rules/prefer-arrow-shorthand-return/multiline/tslint.json b/test/rules/prefer-arrow-shorthand-return/multiline/tslint.json