Rename no-constructor-vars to no-parameter-properties (palantir#1616)

Resolves palantir#1296.

README.md

@@ -80,7 +80,7 @@ The configuration file specifies which rules are enabled and their options. Thes
     /*
      * Any rules specified here will override those from the base config we are extending
      */
-    "no-constructor-vars": true
+    "no-parameter-properties": true
   },
   "rulesDirectory": [
     /*

docs/_data/rules.json

@@ -421,17 +421,6 @@
     ],
     "type": "functionality"
   },
-  {
-    "ruleName": "no-constructor-vars",
-    "description": "Disallows parameter properties.",
-    "rationale": "\nParameter properties can be confusing to those new to TS as they are less explicit\nthan other ways of declaring and initializing class members.",
-    "optionsDescription": "Not configurable.",
-    "options": null,
-    "optionExamples": [
-      "true"
-    ],
-    "type": "style"
-  },
   {
     "ruleName": "no-construct",
     "description": "Disallows access to the constructors of `String`, `Number`, and `Boolean`.",
@@ -624,6 +613,17 @@
     ],
     "type": "functionality"
   },
+  {
+    "ruleName": "no-parameter-properties",
+    "description": "Disallows parameter properties.",
+    "rationale": "\nParameter properties can be confusing to those new to TS as they are less explicit\nthan other ways of declaring and initializing class members.",
+    "optionsDescription": "Not configurable.",
+    "options": null,
+    "optionExamples": [
+      "true"
+    ],
+    "type": "style"
+  },
   {
     "ruleName": "no-reference",
     "description": "Disallows `/// <reference path=>` imports (use ES6-style imports instead).",

src/configs/recommended.ts

@@ -52,14 +52,14 @@ export const rules = {
         "trace",
     ],
     "no-construct": true,
-    "no-constructor-vars": false,
     "no-debugger": true,
     "no-duplicate-key": true,
     "no-duplicate-variable": true,
     "no-empty": true,
     "no-eval": true,
     "no-internal-module": true,
     "no-namespace": true,
+    "no-parameter-properties": false,
     "no-reference": true,
     "no-shadowed-variable": true,
     "no-string-literal": true,

src/rules/noConstructorVarsRule.ts → src/rules/noParameterPropertiesRule.ts

@@ -22,8 +22,8 @@ import * as Lint from "../lint";
 export class Rule extends Lint.Rules.AbstractRule {
     /* tslint:disable:object-literal-sort-keys */
     public static metadata: Lint.IRuleMetadata = {
-        ruleName: "no-constructor-vars",
-        description: "Disallows parameter properties.",
+        ruleName: "no-parameter-properties",
+        description: "Disallows parameter properties in class constructors.",
         rationale: Lint.Utils.dedent`
             Parameter properties can be confusing to those new to TS as they are less explicit
             than other ways of declaring and initializing class members.`,
@@ -37,11 +37,11 @@ export class Rule extends Lint.Rules.AbstractRule {
     public static FAILURE_STRING_FACTORY = (ident: string) => `Property '${ident}' cannot be declared in the constructor`;
 
     public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
-        return this.applyWithWalker(new NoConstructorVarsWalker(sourceFile, this.getOptions()));
+        return this.applyWithWalker(new NoParameterPropertiesWalker(sourceFile, this.getOptions()));
     }
 }
 
-export class NoConstructorVarsWalker extends Lint.RuleWalker {
+export class NoParameterPropertiesWalker extends Lint.RuleWalker {
     public visitConstructorDeclaration(node: ts.ConstructorDeclaration) {
         const parameters = node.parameters;
         for (let parameter of parameters) {

src/tsconfig.json

@@ -103,7 +103,6 @@
         "rules/noConditionalAssignmentRule.ts",
         "rules/noConsecutiveBlankLinesRule.ts",
         "rules/noConsoleRule.ts",
-        "rules/noConstructorVarsRule.ts",
         "rules/noConstructRule.ts",
         "rules/noDebuggerRule.ts",
         "rules/noDefaultExportRule.ts",
@@ -118,6 +117,7 @@
         "rules/noMergeableNamespaceRule.ts",
         "rules/noNamespaceRule.ts",
         "rules/noNullKeywordRule.ts",
+        "rules/noParameterPropertiesRule.ts",
         "rules/noReferenceRule.ts",
         "rules/noRequireImportsRule.ts",
         "rules/noShadowedVariableRule.ts",
@@ -157,4 +157,4 @@
         "test/parse.ts",
         "test/utils.ts"
     ]
-}
+}

test/rules/no-parameter-properties/tslint.json

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-parameter-properties": true
+  }
+}

test/tsconfig.json

@@ -98,7 +98,6 @@
         "../src/rules/noConditionalAssignmentRule.ts",
         "../src/rules/noConsecutiveBlankLinesRule.ts",
         "../src/rules/noConsoleRule.ts",
-        "../src/rules/noConstructorVarsRule.ts",
         "../src/rules/noConstructRule.ts",
         "../src/rules/noDebuggerRule.ts",
         "../src/rules/noDefaultExportRule.ts",
@@ -113,6 +112,7 @@
         "../src/rules/noMergeableNamespaceRule.ts",
         "../src/rules/noNamespaceRule.ts",
         "../src/rules/noNullKeywordRule.ts",
+        "../src/rules/noParameterPropertiesRule.ts",
         "../src/rules/noReferenceRule.ts",
         "../src/rules/noRequireImportsRule.ts",
         "../src/rules/noShadowedVariableRule.ts",
@@ -179,4 +179,4 @@
         "rule-tester/testData.ts",
         "rule-tester/utilsTests.ts"
     ]
-}
+}