Allow regex for requires #3516

helenanderson · 2017-11-28T00:51:53Z

PR checklist

Addresses an existing issue: Allow a regex for requires in no-var-requires and no-require-imports #3392
New feature, bugfix, or enhancement
- Includes tests
Documentation update

Overview of change:

Modifies noVarRequiresRule and noRequireImportsRule with an option to specify a regex for which to ignore the rule. Modeled after the ignore-module in noImportSideEffectRule.

Is there anything you'd like reviewers to focus on?

CHANGELOG.md entry:

ajafff

LGTM with suggestions

ajafff · 2017-11-28T08:57:52Z

src/rules/noRequireImportsRule.ts

@@ -37,12 +51,17 @@ export class Rule extends Lint.Rules.AbstractRule {
    public static FAILURE_STRING = "require() style import is forbidden";

    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
-        return this.applyWithFunction(sourceFile, walk);
+        const patternConfig = this.ruleArguments[this.ruleArguments.length - 1] as { "ignore-module": string } | undefined;
+        const ignorePattern = patternConfig === undefined ? undefined : new RegExp(patternConfig[OPTION_IGNORE_MODULE]);


also check if "ignore-module" property is not undefined

ajafff · 2017-11-28T09:01:26Z

src/rules/noVarRequiresRule.ts

+        const options = this.getOptions() as any[];
+        const patternConfig = options[0] as { "ignore-module": string } | undefined;
+        const ignorePattern = patternConfig === undefined ? undefined : new RegExp(patternConfig[OPTION_IGNORE_MODULE]);
+
        if (this.getCurrentDepth() <= 1 && expression.kind === ts.SyntaxKind.Identifier) {
            const identifierName = (expression as ts.Identifier).text;
            if (identifierName === "require") {


you can add an additional condition to ensure there is only one argument. that way you don't have to loop through the arguments below

ajafff · 2017-11-28T09:01:50Z

src/rules/noVarRequiresRule.ts

@@ -52,11 +66,19 @@ class NoVarRequiresWalker extends Lint.ScopeAwareRuleWalker<{}> {
    public visitCallExpression(node: ts.CallExpression) {
        const expression = node.expression;

+        const options = this.getOptions() as any[];
+        const patternConfig = options[0] as { "ignore-module": string } | undefined;
+        const ignorePattern = patternConfig === undefined ? undefined : new RegExp(patternConfig[OPTION_IGNORE_MODULE]);


consider moving this block of code right before the value is actually used to avoid unnecessary work

ajafff · 2017-11-28T09:02:43Z

src/rules/noRequireImportsRule.ts

@@ -37,12 +51,17 @@ export class Rule extends Lint.Rules.AbstractRule {
    public static FAILURE_STRING = "require() style import is forbidden";

    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
-        return this.applyWithFunction(sourceFile, walk);
+        const patternConfig = this.ruleArguments[this.ruleArguments.length - 1] as { "ignore-module": string } | undefined;


why not simply this.ruleArguments[0]?

ajafff · 2017-12-06T08:25:05Z

src/rules/noRequireImportsRule.ts

+            minLength: 0,
+            type: "array",
+        },
+        optionExamples: [true, [true, { [OPTION_IGNORE_MODULE]: "(\\.html|\\.css)$" }]],


I would actually prefer this to be a list of regex patterns. One big pattern like in no-import-side-effect is very hard to maintain.
#3504 also uses multiple patterns.

eps1lon · 2018-05-05T07:32:56Z

src/rules/noVarRequiresRule.ts

+        options: {
+            items: {
+                properties: {
+                    "ignore-module": {


Shouldn't this be [OPTION_IGNORE_MODULE] instead of ignore-module?

eps1lon · 2018-05-05T07:36:22Z

src/rules/noRequireImportsRule.ts

+        options: {
+            items: {
+                properties: {
+                    "ignore-module": {


Also [OPTION_IGNORE_MODULE] instead of ignore-module?

eps1lon · 2018-05-05T07:37:54Z

src/rules/noRequireImportsRule.ts

@@ -20,15 +20,33 @@ import * as ts from "typescript";

 import * as Lint from "../index";

+const OPTION_IGNORE_MODULE = "ignore-module";
+
 export class Rule extends Lint.Rules.AbstractRule {
    /* tslint:disable:object-literal-sort-keys */
    public static metadata: Lint.IRuleMetadata = {
        ruleName: "no-require-imports",
        description: "Disallows invocation of `require()`.",
        rationale: "Prefer the newer ES6-style imports over `require()`.",
        optionsDescription: "Not configurable.",


I don't know how this property is used but with the new option the rule is in fact configurable, no?

giladgray

@helenanderson please update this branch so we can review it, or close it if no longer relevant. we will close this if we do not hear from you in two weeks.

giladgray · 2018-07-28T00:14:35Z

src/rules/noRequireImportsRule.ts

-function walk(ctx: Lint.WalkContext<void>) {
-    for (const name of findImports(ctx.sourceFile, ImportKind.AllRequireLike)) {
-        ctx.addFailureAtNode(name.parent!, Rule.FAILURE_STRING);
+function extractIgnoreModule(patternConfig: { "ignore-module": string[] } | undefined) {


just pass the string[] | undefined instead of the whole object type

giladgray · 2018-07-28T00:15:28Z

src/rules/noVarRequiresRule.ts

+            minLength: 0,
+            type: "array",
+        },
+        optionExamples: [true, [true, { [OPTION_IGNORE_MODULE]: ["\\.html$", "\\.css$"] }]],


this is a bad example because html and CSS files are not appropriate for TSLint.

giladgray · 2018-07-28T00:15:47Z

src/rules/noVarRequiresRule.ts

            }
        }

        super.visitCallExpression(node);
    }
 }
+
+function extractIgnoreModule(patternConfig: { "ignore-module": string[] } | undefined) {


again, unwrap the options at a higher level

johnwiseheart · 2018-08-22T18:31:45Z

Closing due to age and inactivity. Feel free to re-open or create a new pull request if you decide to continue working on this.

Helen Anderson added 5 commits November 21, 2017 14:56

change applyWithWalker to applyWithFunction

60f320f

add ignore module

7b0935b

ignore-module for no-var-requires

acea803

ending newlines

014af2e

add blank line

34159b2

ajafff approved these changes Nov 28, 2017

View reviewed changes

respond to comments

a5be852

ajafff suggested changes Dec 6, 2017

View reviewed changes

ignore-module accepts array of regexps

0199e5c

eps1lon mentioned this pull request May 5, 2018

tslint no-var-requires for json eps1lon/poe-react-item#1

Open

eps1lon reviewed May 5, 2018

View reviewed changes

giladgray suggested changes Jul 28, 2018

View reviewed changes

johnwiseheart closed this Aug 22, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow regex for requires #3516

Allow regex for requires #3516

helenanderson commented Nov 28, 2017

ajafff left a comment

ajafff Nov 28, 2017

ajafff Nov 28, 2017

ajafff Nov 28, 2017

ajafff Nov 28, 2017

ajafff Dec 6, 2017

eps1lon May 5, 2018

eps1lon May 5, 2018

eps1lon May 5, 2018

giladgray left a comment

giladgray Jul 28, 2018

giladgray Jul 28, 2018

giladgray Jul 28, 2018

johnwiseheart commented Aug 22, 2018

Allow regex for requires #3516

Allow regex for requires #3516

Conversation

helenanderson commented Nov 28, 2017

PR checklist

Overview of change:

Is there anything you'd like reviewers to focus on?

CHANGELOG.md entry:

ajafff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

giladgray left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnwiseheart commented Aug 22, 2018