Added new jsx-ban-elements rule to ban jsx elements

dryganets · dryganets · commit 770059909a8b · 2018-01-09T17:20:04.000-08:00
diff --git a/README.md b/README.md
@@ -52,6 +52,8 @@ The built-in configuration preset you get with `"extends": "tslint-react"` is se
       size={size}
   />
   ```
+- `jsx-ban-elements` (since v3.3.4)
+  - Allows blacklisting of JSX elements with an optional explanatory message in the reported failure.
 - `jsx-ban-props` (since v2.3.0)
   - Allows blacklisting of props in JSX with an optional explanatory message in the reported failure.
 - `jsx-boolean-value` (since v2.5.0)
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "tslint-react",
-  "version": "3.3.3",
+  "version": "3.3.4",
   "description": "Lint rules related to React & JSX for TSLint",
   "main": "tslint-react.json",
   "scripts": {
diff --git a/src/rules/jsxBanElementsRule.ts b/src/rules/jsxBanElementsRule.ts
@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright 2018 Palantir Technologies, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as Lint from "tslint";
+import { isJsxOpeningElement, isJsxSelfClosingElement } from "tsutils";
+import * as ts from "typescript";
+
+interface IOption {
+    pattern: RegExp;
+    message?: string;
+}
+
+export class Rule extends Lint.Rules.AbstractRule {
+    /* tslint:disable:object-literal-sort-keys */
+    public static metadata: Lint.IRuleMetadata = {
+        ruleName: "jsx-ban-elements",
+        description: Lint.Utils.dedent`
+            Bans specific jsx elements from being used.`,
+        options: {
+            type: "list",
+            listType: {
+                type: "array",
+                items: { type: "string" },
+                minLength: 1,
+                maxLength: 2,
+            },
+        },
+        optionsDescription: Lint.Utils.dedent`
+            A list of \`["regex", "optional explanation here"]\`, which bans
+            types that match \`regex\``,
+        optionExamples: [[true, ["Object", "Use {} instead."], ["String"]]],
+        type: "typescript",
+        typescriptOnly: true,
+    };
+    /* tslint:enable:object-literal-sort-keys */
+
+    public static FAILURE_STRING_FACTORY(elementName: string, messageAddition?: string) {
+        return `JSX element '${elementName}' is banned.${messageAddition !== undefined ? ` ${messageAddition}` : ""}`;
+    }
+
+    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+        return this.applyWithFunction(sourceFile, walk, this.ruleArguments.map(parseOption));
+    }
+}
+
+function parseOption([pattern, message]: [string, string | undefined]): IOption {
+    return {message, pattern: new RegExp(`^${pattern}$`)};
+}
+
+function walk(ctx: Lint.WalkContext<IOption[]>) {
+    return ts.forEachChild(ctx.sourceFile, function cb(node: ts.Node): void {
+        if (isJsxOpeningElement(node) || isJsxSelfClosingElement(node)) {
+            const typeName = node.tagName.getText();
+            for (const ban of ctx.options) {
+                if (ban.pattern.test(typeName)) {
+                    ctx.addFailureAtNode(node, Rule.FAILURE_STRING_FACTORY(typeName, ban.message));
+                    break;
+                }
+            }
+        }
+        return ts.forEachChild(node, cb);
+    });
+}
diff --git a/test/rules/jsx-ban-elements/test.tsx.lint b/test/rules/jsx-ban-elements/test.tsx.lint
@@ -0,0 +1,8 @@
+<span className="primary" foo="bar">baz</span>
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [JSX element 'span' is banned. Use div instead.]
+
+<span bar={5}/>
+~~~~~~~~~~~~~~~ [JSX element 'span' is banned. Use div instead.]
+
+<button type="button">bar</button>
+
diff --git a/test/rules/jsx-ban-elements/tslint.json b/test/rules/jsx-ban-elements/tslint.json
@@ -0,0 +1,7 @@
+{
+    "rules": {
+        "jsx-ban-elements": [true, 
+            ["span", "Use div instead."]
+        ]
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "tslint-react",`
`3`		`- "version": "3.3.3",`
	`3`	`+ "version": "3.3.4",`
`4`	`4`	`"description": "Lint rules related to React & JSX for TSLint",`
`5`	`5`	`"main": "tslint-react.json",`
`6`	`6`	`"scripts": {`