fix: [variable-name] Use id-denylist ESLint rule instread of id-blacklist that deprecated (#1221)

Hirotaka Tagawa · web-flow · commit bf5c9f9f03a6 · 2021-09-18T14:04:18.000-04:00
* Convert id-blacklist to id-denylist

* Add JSDoc
diff --git a/src/converters/lintConfigs/rules/ruleConverters/tests/variable-name.test.ts b/src/converters/lintConfigs/rules/ruleConverters/tests/variable-name.test.ts
@@ -29,7 +29,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -61,7 +61,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -93,7 +93,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -125,7 +125,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -157,7 +157,7 @@ describe(convertVariableName, () => {
                     notices: [ForbiddenLeadingTrailingIdentifierMsg],
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -189,7 +189,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -221,7 +221,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -254,7 +254,7 @@ describe(convertVariableName, () => {
                     ruleName: "no-underscore-dangle",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -287,7 +287,7 @@ describe(convertVariableName, () => {
                     ruleSeverity: "off",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -320,7 +320,7 @@ describe(convertVariableName, () => {
                     ruleSeverity: "off",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -357,7 +357,7 @@ describe(convertVariableName, () => {
                     ruleSeverity: "off",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                 },
                 {
                     ruleName: "id-match",
@@ -399,7 +399,7 @@ describe(convertVariableName, () => {
                     ruleSeverity: "off",
                 },
                 {
-                    ruleName: "id-blacklist",
+                    ruleName: "id-denylist",
                     ruleArguments: [
                         "any",
                         "Number",
diff --git a/src/converters/lintConfigs/rules/ruleConverters/variable-name.ts b/src/converters/lintConfigs/rules/ruleConverters/variable-name.ts
@@ -17,6 +17,22 @@ export const convertVariableName: RuleConverter = (tslintRule) => {
     const constRequiredForAllCaps = tslintRule.ruleArguments.includes("require-const-for-all-caps");
     const allowPascalCase = tslintRule.ruleArguments.includes("allow-pascal-case");
     const allowSnakeCase = tslintRule.ruleArguments.includes("allow-snake-case");
+    /**
+     * disallows the use of certain TypeScript keywords as variable or parameter names.
+     * @see https://palantir.github.io/tslint/rules/variable-name/
+     * @see https://github.com/palantir/tslint/blob/285fc1db18d1fd24680d6a2282c6445abf1566ee/src/rules/variableNameRule.ts#L26-L36
+     */
+    const banKeywords = [
+        "any",
+        "Number",
+        "number",
+        "String",
+        "string",
+        "Boolean",
+        "boolean",
+        "Undefined",
+        "undefined",
+    ];
 
     const getCamelCaseRuleOptions = () => {
         const camelCaseRules: Record<string, unknown>[] = [];
@@ -77,34 +93,24 @@ export const convertVariableName: RuleConverter = (tslintRule) => {
         };
     };
 
-    const getBlackListRuleOptions = () => {
-        const blackListOptionArguments = tslintRule.ruleArguments.includes("ban-keywords")
-            ? [
-                  "any",
-                  "Number",
-                  "number",
-                  "String",
-                  "string",
-                  "Boolean",
-                  "boolean",
-                  "Undefined",
-                  "undefined",
-              ]
+    const getDenyListRuleOptions = () => {
+        const denyListOptionArguments = tslintRule.ruleArguments.includes("ban-keywords")
+            ? banKeywords
             : [];
 
         return {
-            ...(blackListOptionArguments.length !== 0 && {
-                ruleArguments: blackListOptionArguments,
+            ...(denyListOptionArguments.length !== 0 && {
+                ruleArguments: denyListOptionArguments,
             }),
-            ruleName: "id-blacklist",
+            ruleName: "id-denylist",
         };
     };
 
     return {
         rules: [
             getCamelCaseRuleOptions(),
             getUnderscoreDangleRuleOptions(),
-            getBlackListRuleOptions(),
+            getDenyListRuleOptions(),
             {
                 ruleName: "id-match",
             },

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ describe(convertVariableName, () => {`
`29`	`29`	`ruleName: "no-underscore-dangle",`
`30`	`30`	`},`
`31`	`31`	`{`
`32`		`- ruleName: "id-blacklist",`
	`32`	`+ ruleName: "id-denylist",`
`33`	`33`	`},`
`34`	`34`	`{`
`35`	`35`	`ruleName: "id-match",`
`@@ -61,7 +61,7 @@ describe(convertVariableName, () => {`
`61`	`61`	`ruleName: "no-underscore-dangle",`
`62`	`62`	`},`
`63`	`63`	`{`
`64`		`- ruleName: "id-blacklist",`
	`64`	`+ ruleName: "id-denylist",`
`65`	`65`	`},`
`66`	`66`	`{`
`67`	`67`	`ruleName: "id-match",`
`@@ -93,7 +93,7 @@ describe(convertVariableName, () => {`
`93`	`93`	`ruleName: "no-underscore-dangle",`
`94`	`94`	`},`
`95`	`95`	`{`
`96`		`- ruleName: "id-blacklist",`
	`96`	`+ ruleName: "id-denylist",`
`97`	`97`	`},`
`98`	`98`	`{`
`99`	`99`	`ruleName: "id-match",`
`@@ -125,7 +125,7 @@ describe(convertVariableName, () => {`
`125`	`125`	`ruleName: "no-underscore-dangle",`
`126`	`126`	`},`
`127`	`127`	`{`
`128`		`- ruleName: "id-blacklist",`
	`128`	`+ ruleName: "id-denylist",`
`129`	`129`	`},`
`130`	`130`	`{`
`131`	`131`	`ruleName: "id-match",`
`@@ -157,7 +157,7 @@ describe(convertVariableName, () => {`
`157`	`157`	`notices: [ForbiddenLeadingTrailingIdentifierMsg],`
`158`	`158`	`},`
`159`	`159`	`{`
`160`		`- ruleName: "id-blacklist",`
	`160`	`+ ruleName: "id-denylist",`
`161`	`161`	`},`
`162`	`162`	`{`
`163`	`163`	`ruleName: "id-match",`
`@@ -189,7 +189,7 @@ describe(convertVariableName, () => {`
`189`	`189`	`ruleName: "no-underscore-dangle",`
`190`	`190`	`},`
`191`	`191`	`{`
`192`		`- ruleName: "id-blacklist",`
	`192`	`+ ruleName: "id-denylist",`
`193`	`193`	`},`
`194`	`194`	`{`
`195`	`195`	`ruleName: "id-match",`
`@@ -221,7 +221,7 @@ describe(convertVariableName, () => {`
`221`	`221`	`ruleName: "no-underscore-dangle",`
`222`	`222`	`},`
`223`	`223`	`{`
`224`		`- ruleName: "id-blacklist",`
	`224`	`+ ruleName: "id-denylist",`
`225`	`225`	`},`
`226`	`226`	`{`
`227`	`227`	`ruleName: "id-match",`
`@@ -254,7 +254,7 @@ describe(convertVariableName, () => {`
`254`	`254`	`ruleName: "no-underscore-dangle",`
`255`	`255`	`},`
`256`	`256`	`{`
`257`		`- ruleName: "id-blacklist",`
	`257`	`+ ruleName: "id-denylist",`
`258`	`258`	`},`
`259`	`259`	`{`
`260`	`260`	`ruleName: "id-match",`
`@@ -287,7 +287,7 @@ describe(convertVariableName, () => {`
`287`	`287`	`ruleSeverity: "off",`
`288`	`288`	`},`
`289`	`289`	`{`
`290`		`- ruleName: "id-blacklist",`
	`290`	`+ ruleName: "id-denylist",`
`291`	`291`	`},`
`292`	`292`	`{`
`293`	`293`	`ruleName: "id-match",`
`@@ -320,7 +320,7 @@ describe(convertVariableName, () => {`
`320`	`320`	`ruleSeverity: "off",`
`321`	`321`	`},`
`322`	`322`	`{`
`323`		`- ruleName: "id-blacklist",`
	`323`	`+ ruleName: "id-denylist",`
`324`	`324`	`},`
`325`	`325`	`{`
`326`	`326`	`ruleName: "id-match",`
`@@ -357,7 +357,7 @@ describe(convertVariableName, () => {`
`357`	`357`	`ruleSeverity: "off",`
`358`	`358`	`},`
`359`	`359`	`{`
`360`		`- ruleName: "id-blacklist",`
	`360`	`+ ruleName: "id-denylist",`
`361`	`361`	`},`
`362`	`362`	`{`
`363`	`363`	`ruleName: "id-match",`
`@@ -399,7 +399,7 @@ describe(convertVariableName, () => {`
`399`	`399`	`ruleSeverity: "off",`
`400`	`400`	`},`
`401`	`401`	`{`
`402`		`- ruleName: "id-blacklist",`
	`402`	`+ ruleName: "id-denylist",`
`403`	`403`	`ruleArguments: [`
`404`	`404`	`"any",`
`405`	`405`	`"Number",`