Add no-submodule-imports rule #3091

aervin · 2017-08-02T19:49:17Z

Attempt at the functionality requested here: #3051

This essentially extends the import-blacklist rule with a custom implementation of checkForBannedImport().

optionsDescription: A list of modules whose submodules are blocked from being imported directly.

palantirtech · 2017-08-02T19:49:19Z

Thanks for your interest in palantir/tslint, @aervin! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

aervin · 2017-08-02T19:58:34Z

Fixing CI issue now

…ignore list

adidahiya

most importantly: can you please use the rule name I suggested in the original issue, no-submodule-imports?

After thinking about it some more, I think it should ban submodule imports from all external packages by default, and optionally accept a whitelist of modules where such imports are allowed.

adidahiya · 2017-08-04T12:29:04Z

src/rules/importBlacklistSubmodulesRule.ts

+ */
+
+import {
+    isCallExpression, isExternalModuleReference, isIdentifier, isImportDeclaration, isImportEqualsDeclaration, isTextualLiteral,


nit: please split these imports into multiple lines

adidahiya · 2017-08-04T12:30:11Z

src/rules/importBlacklistSubmodulesRule.ts

+        description: Lint.Utils.dedent`
+            Disallows importing any submodule of the listed modules.`,
+        rationale: Lint.Utils.dedent`
+            Not sure on this exactly...`,


Try this:

Submodules of some packages are treated as private APIs and the import paths may change without deprecation periods. It's best to stick with top-level package exports.

adidahiya · 2017-08-04T12:30:29Z

src/rules/importBlacklistSubmodulesRule.ts

+            Disallows importing any submodule of the listed modules.`,
+        rationale: Lint.Utils.dedent`
+            Not sure on this exactly...`,
+        optionsDescription: "A list of modules whose submodules are blacklisted.",


"A list of packages whose submodules ..."

adidahiya · 2017-08-04T12:31:35Z

src/rules/importBlacklistSubmodulesRule.ts

+        typescriptOnly: false,
+    };
+
+    public static FAILURE_STRING = "This submodule is blacklisted, try importing from a parent module";


How about:

"Submodule import paths from this package are disallowed; import from the root instead"

adidahiya · 2017-08-04T12:32:06Z

src/rules/importBlacklistSubmodulesRule.ts

+
+    public static FAILURE_STRING = "This submodule is blacklisted, try importing from a parent module";
+
+    public isEnabled(): boolean {


I don't think you need to override this method, we don't do it elsewhere

adidahiya · 2017-08-04T12:32:25Z

src/rules/importBlacklistSubmodulesRule.ts

+        if (isTextualLiteral(expression)) {
+            let blacklistOption = "";
+
+            this.options.forEach((option: string) => {


please use a for-of loop, not forEach

adidahiya · 2017-08-04T12:32:59Z

test/rules/import-blacklist-submodules/test.ts.lint

@@ -0,0 +1,25 @@
+import { submodule } from '@blueprintjs/core';


nit: please use double quotes to be consistent with the default config presets (quotemark: [true, "double"])

adidahiya · 2017-08-04T12:33:22Z

test/rules/import-blacklist-submodules/test.ts.lint

+                                              ~~~~~~~~~~~~~~~~~ [0]
+
+// non-static imports cannot be checked
+import {Observable} from rxjs;


is this valid TS?

I was confused by this as well. I relied heavily on the import-blacklist test code to get my test case up and running. Could use some clarification on this point.

I introduced this test case back then.
It's not valid typescript, but the parser consumes it. The AST can contain any expression as module specifier and tslint should not crash because it only expects string literals.

adidahiya · 2017-08-04T12:35:13Z

test/rules/import-blacklist-submodules/test.ts.lint

+// non-static imports cannot be checked
+import {Observable} from rxjs;
+import forOwn = require(lodash);
+


can you test dynamic import syntax too? You'll probably need to make a new test file that applies to TS 2.4 only (so CI knows not to run the test with TS parser <v2.4). see an example here

tslint/test/rules/no-reference/ts240.ts.lint

Line 1 in 30f8344

[typescript]: >=2.4.0

You mean something like:
const forOwn = require(lodash).forOwn?

adidahiya · 2017-08-04T12:38:36Z

also, can you please remove the package-lock.json file? We use yarnpkg lockfiles instead.

aervin · 2017-08-04T12:55:43Z

@adidahiya thanks for all the feedback! I'll work on this later today. May ask for further guidance if that's alright.

ajafff · 2017-08-04T15:24:26Z

src/rules/importBlacklistSubmodulesRule.ts

+    public walk(sourceFile: ts.SourceFile) {
+        const findRequire = (node: ts.Node): void => {
+            if (isCallExpression(node) && node.arguments.length === 1 &&
+                isIdentifier(node.expression) && node.expression.text === "require") {


Add || node.expression.kind === ts.SyntaxKind.ImportKeyword here to make it work with dynamic imports

TS is yelling at me unless I use node.expression.originalKeywordKind--I was grouping w/ node.expression.text === "require" like so:
isIdentifier(node.expression) && (node.expression.text === "require" || node.expression.originalKeywordKind === ts.SyntaxKind.ImportKeyword)

Am I way off here?

(isIdentifier(node.expression) && node.expression.text === "require" || node.expression.kind === ts.SyntaxKind.ImportKeyword)

ajafff · 2017-08-05T18:16:07Z

src/rules/noSubmoduleImportsRule.ts

+            Submodules of some packages are treated as private APIs and the import
+            paths may change without deprecation periods. It's best to stick with
+            top-level package exports.`,
+        optionsDescription: "A list of packages whose submodules are blacklisted.",


Consider making this a whitelist and ban all submodule imports by default.
That means we're only interested in imports that are no relative or absolute paths: !/^(..?(\/|$)|\/)/.test(path)
It should handle scoped and unscoped package names.

Okay great, will tackle it sometime this weekend. Thanks!

And just to clarify: you mean that import { forOwn } from "lodash"; and import { Something } from "@angular/core"; would both be allowed by default, right?

Correct, those are always allowed. And import * as forOwn from "lodash/forown"; as well as import { NgModel } from "@angular/forms/src/directives" would be banned by default unless lodash or @angular/forms are whitelisted respectively.

ajafff

You have modified the file permissions of every single file in this repo. That needs to be reverted.

ajafff · 2017-08-06T08:46:30Z

src/rules/noSubmoduleImportsRule.ts

+        const scopedPath = (path: string): boolean => {
+            return path[0] === "@";
+        };
+        const submodulePath = (path: string): boolean => {


Move those functions out of this method and make them function declarations. Also prepend is to each name

ajafff · 2017-08-06T08:46:45Z

src/rules/noSubmoduleImportsRule.ts

@@ -0,0 +1,133 @@
+/**
+ * @license
+ * Copyright 2016 Palantir Technologies, Inc.


ajafff · 2017-08-06T08:47:18Z

src/rules/noSubmoduleImportsRule.ts

+    public static metadata: Lint.IRuleMetadata = {
+        ruleName: "no-submodule-imports",
+        description: Lint.Utils.dedent`
+            Disallows importing any submodule of the listed modules.`,


Remove of the listed modules

ajafff · 2017-08-06T08:47:33Z

src/rules/noSubmoduleImportsRule.ts

+            items: {
+                type: "string",
+            },
+            minLength: 1,


ajafff · 2017-08-06T08:48:36Z

src/rules/noSubmoduleImportsRule.ts

+
+class NoSubmoduleImportsWalker extends Lint.AbstractWalker<string[]> {
+    public walk(sourceFile: ts.SourceFile) {
+        const findRequire = (node: ts.Node): void => {


Better name would be findDynamicImport

ajafff · 2017-08-06T09:33:19Z

src/rules/noSubmoduleImportsRule.ts

+            let whitelisted = false;
+
+            for (const option of this.options) {
+                if (expression.text.indexOf(option) !== -1) {


`.startsWith(option +"/")

ajafff · 2017-08-06T09:33:42Z

src/rules/noSubmoduleImportsRule.ts

+
+            for (const option of this.options) {
+                if (expression.text.indexOf(option) !== -1) {
+                    whitelisted = true;


Just return here

ajafff · 2017-08-06T09:36:30Z

src/rules/noSubmoduleImportsRule.ts

+
+            if (whitelisted) { return; }
+
+            this.addFailure(


Simply use addFailureAtNode(expression, Rule.FAILURE_STRING)

ajafff · 2017-08-06T09:37:48Z

src/configs/all.ts

@@ -117,6 +117,7 @@ export const rules = {
    "no-string-literal": true,
    "no-string-throw": true,
    "no-sparse-arrays": true,
+    // "no-submodule-imports": no sensible default


Can be enabled by default

aervin · 2017-08-06T12:51:20Z

I'll tackle these latest change requests this morning. @ajafff do I need to add some additional test coverage for dynamic imports?

aervin · 2017-08-06T13:28:34Z

Help @ajafff! CI build error is beyond my control I think. Needs retriggered?

ajafff

I left some final suggestions. These are not required, so you can choose to ignore them.

ajafff · 2017-08-06T17:14:52Z

src/rules/noSubmoduleImportsRule.ts

+    private checkForBannedImport(expression: ts.Expression) {
+        if (isTextualLiteral(expression)) {
+            if (isAbsoluteOrRelativePath(expression.text)) { return; }
+            if (!isSubmodulePath(expression.text)) { return; }


Both if statements can be combined with the outer if.

ajafff · 2017-08-06T17:17:13Z

src/rules/noSubmoduleImportsRule.ts

+                }
+            }
+
+            this.addFailureAtNode(


Could be written in one line

ajafff · 2017-08-06T17:19:25Z

src/rules/noSubmoduleImportsRule.ts

+}
+
+function isSubmodulePath(path: string): boolean {
+    const pathDepth: number = path.split("/").length;


Could be simplified to

return path.split("/").length > (isScopedPath(path) ? 2 : 1);

ajafff · 2017-08-06T17:37:27Z

CI is very flaky lately. I restarted it.

There's still the problem with the changed file permissions. Have a look at the Changes tab of this PR to see what I mean. I can't see your tests because there are too many changed files to display.

ajafff · 2017-08-06T18:53:31Z

test/rules/no-submodule-imports/static-imports/test.ts.lint

+import { submodule } from "rxjs";
+import { submodule } from "rxjs/a/b/c/sub-module";
+import submodule = require("rxjs");
+import submodule = require("rxjs/a/b/c/sub-module");


Please add a test with a relative path

ajafff · 2017-08-06T18:54:29Z

test/rules/no-submodule-imports/dynamic-imports/test.ts.lint

@@ -0,0 +1,23 @@
+const dynamicImport = import "lodash";


It's actually const dynamicImport = import("lodash");

aervin · 2017-08-07T14:18:07Z

I think I've addressed all requested changes thus far. Happy to make further edits, however.

ajafff · 2017-08-07T14:31:22Z

Sorry for the delay. I'm currently on vacation and don't have that much time to offer and mobile internet connection is pretty bad.
However, the code looks good to me. Thanks for your great work.

We may also want to enable this rule in the tslint:latest preset.

aervin · 2017-08-07T14:37:48Z

Don't let me bug you @ajafff-- have a great vacation and thanks for all your help!

adidahiya

looks good; just some minor stylistic comments that can be addressed in a follow-up

adidahiya · 2017-08-07T15:23:06Z

src/rules/noSubmoduleImportsRule.ts

+
+class NoSubmoduleImportsWalker extends Lint.AbstractWalker<string[]> {
+    public walk(sourceFile: ts.SourceFile) {
+        const findDynamicImport = (node: ts.Node): void => {


this doesn't need to be a const, please make it a plain helper function at the end of the file

It can't. It uses the lexical this binding

adidahiya · 2017-08-07T15:23:56Z

src/rules/noSubmoduleImportsRule.ts

+        }
+    }
+
+    private checkForBannedImport(expression: ts.Expression) {


this is a static function (doesn't use this), you can make it static or move to a plain helper function

Only if this addFailureAtNode is moved out of the function. This one should stay as is.

adidahiya · 2017-08-07T15:26:28Z

I'm going to merge this and look into the minor style comments + tslint:latest separately.

aervin · 2017-08-07T16:02:04Z

Can open a fresh PR for those updates later tonight. Do you imagine many more import-related rules coming along in future? If so, might be nice to keep a template/list of all the different import syntax possibilities that TsLint supports/tests. Becomes a sort of copy and paste job for anyone who needs to test their import-related rule.

ajafff · 2017-08-07T16:07:05Z

@aervin I'm planning to add a function to tsutils that finds all imports in a file. That will reduce code duplication in tslint rules

aervin · 2017-08-07T16:14:21Z

@ajafff that would help a very great deal. I was referring to what would go in an import rule's test.ts.lint in the above comment. I just found it tedious to make sure I was covering all bases in the rule's tests.

Also, we've talked about moving away from relative imports at work. no-relative-imports rule might be useful?

Aaron Ervin added 3 commits August 2, 2017 11:54

lockfile

99e309e

init implementation

a6b53f0

test.lint ~~~ now more specific

3289577

Aaron Ervin added 3 commits August 2, 2017 16:09

like import-blacklist rule, no sensible default; added to tslint:all …

1fb4d85

…ignore list

template literal requirement in rule's source ts

fdbf7f6

additional tests

9994fc9

adidahiya suggested changes Aug 4, 2017

View reviewed changes

ajafff reviewed Aug 4, 2017

View reviewed changes

Aaron Ervin added 2 commits August 4, 2017 12:07

forEach -> for of; naming updates; dynamic import checking

77cc105

ruleName metadata updated

8199561

ajafff reviewed Aug 5, 2017

View reviewed changes

ajafff suggested changes Aug 6, 2017

View reviewed changes

ajafff reviewed Aug 6, 2017

View reviewed changes

Aaron Ervin added 4 commits August 6, 2017 14:03

reverting to commit before permissions thing happened

0242b89

changes for readability; isSubmodulePath() updates

baa9386

whitespace

eabbc33

listed correctly in all.ts

1510446

ajafff reviewed Aug 6, 2017

View reviewed changes

Aaron Ervin added 3 commits August 6, 2017 16:32

additional tests for relative paths; dynamic import syntax correction

e392f7c

require relative path tests

f659a53

added [typescript]: >=2.4.0 to dynamic import test file

ec9673f

ajafff approved these changes Aug 7, 2017

View reviewed changes

adidahiya changed the title ~~First pass at new rule proposal #3051: import-blacklist-submodules~~ Add no-submodule imports rule Aug 7, 2017

adidahiya changed the title ~~Add no-submodule imports rule~~ Add no-submodule-imports rule Aug 7, 2017

adidahiya approved these changes Aug 7, 2017

View reviewed changes

adidahiya merged commit a4b0642 into palantir:master Aug 7, 2017

HyphnKnight pushed a commit to HyphnKnight/tslint that referenced this pull request Apr 9, 2018

Add no-submodule-imports rule (palantir#3091)

15e46ee


		public static FAILURE_STRING = "This submodule is blacklisted, try importing from a parent module";

		public isEnabled(): boolean {

		@@ -0,0 +1,25 @@
		import { submodule } from '@blueprintjs/core';

Add no-submodule-imports rule #3091

Add no-submodule-imports rule #3091

Conversation

aervin commented Aug 2, 2017

palantirtech commented Aug 2, 2017

aervin commented Aug 2, 2017

adidahiya 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

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

adidahiya commented Aug 4, 2017

aervin commented Aug 4, 2017

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

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

Choose a reason for hiding this comment

aervin commented Aug 6, 2017

aervin commented Aug 6, 2017

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

ajafff commented Aug 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aervin commented Aug 7, 2017

ajafff commented Aug 7, 2017

aervin commented Aug 7, 2017

adidahiya 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

adidahiya commented Aug 7, 2017 • edited Loading

aervin commented Aug 7, 2017

ajafff commented Aug 7, 2017

aervin commented Aug 7, 2017 • edited Loading

adidahiya commented Aug 7, 2017 •

edited

Loading

aervin commented Aug 7, 2017 •

edited

Loading