disallow using barrel imports internally lint rule (iTwin#1846)

- add an eslint rule that disallows barrel import usage - fixed some barrel import usage using the rule - ignored some barrel files (for now) in some packages where they are being used as a pattern
KrishKash · Jul 20, 2021 · e4fe7d1 · e4fe7d1
1 parent f419a96
commit e4fe7d1
Show file tree

Hide file tree

Showing 81 changed files with 2,914 additions and 1,619 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1635,6 +1635,21 @@
         "[NODE] Certa Test Runner for Full Stack RPC Interface Tests",
         "[BACKEND] Local Backend for Full Stack RPC Interface Tests"
       ]
+    },
+    {
+      "name": "eslint rule test @bentley/no-internal-barrel-imports",
+      "presentation": {
+        "group": "6_Misc"
+      },
+      "cwd": "${workspaceFolder}/tools/eslint-plugin",
+      "type": "pwa-node",
+      "request": "launch",
+      "program": "${workspaceFolder}/tools/eslint-plugin/node_modules/mocha/bin/_mocha",
+      "args": [
+        "${workspaceFolder}/tools/eslint-plugin/tests/no-internal-barrel-imports.js",
+        "--timeout 50000" // for easier debugging
+      ],
+      "console": "integratedTerminal",
     }
   ],
   "compounds": [

diff --git a/common/api/ecschema-metadata.api.md b/common/api/ecschema-metadata.api.md
@@ -2469,7 +2469,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: SchemaItem;
             messageArgs?: [string, any, any] | undefined;
@@ -2481,7 +2481,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: SchemaItem;
             messageArgs?: [] | undefined;
@@ -2541,7 +2541,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [Mixin], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: EntityClass;
             messageArgs?: [Mixin] | undefined;
@@ -2553,7 +2553,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Mixin;
             messageArgs?: [string, any, any] | undefined;
@@ -2565,7 +2565,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: RelationshipClass;
             messageArgs?: [string, any, any] | undefined;
@@ -2599,7 +2599,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: CustomAttributeClass;
             messageArgs?: [string, any, any] | undefined;
@@ -2622,7 +2622,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, string, string], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Enumeration;
             messageArgs?: [string, string, string] | undefined;
@@ -2634,7 +2634,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [AnyEnumerator], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Enumeration;
             messageArgs?: [AnyEnumerator] | undefined;
@@ -2646,7 +2646,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [AnyEnumerator, string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Enumeration;
             messageArgs?: [AnyEnumerator, string, any, any] | undefined;
@@ -2658,7 +2658,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: KindOfQuantity;
             messageArgs?: [string, any, any] | undefined;
@@ -2670,7 +2670,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [Format | OverrideFormat], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: KindOfQuantity;
             messageArgs?: [Format | OverrideFormat] | undefined;
@@ -2682,7 +2682,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: PropertyCategory;
             messageArgs?: [string, any, any] | undefined;
@@ -2694,7 +2694,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, any, any], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Format;
             messageArgs?: [string, any, any] | undefined;
@@ -2706,7 +2706,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [Unit | InvertedUnit], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Format;
             messageArgs?: [Unit | InvertedUnit] | undefined;
@@ -2718,7 +2718,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [Unit | InvertedUnit, string | undefined, string | undefined], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Format;
             messageArgs?: [Unit | InvertedUnit, string | undefined, string | undefined] | undefined;
@@ -2730,7 +2730,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, string, string], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Format;
             messageArgs?: [string, string, string] | undefined;
@@ -2742,7 +2742,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, string, string], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: InvertedUnit;
             messageArgs?: [string, string, string] | undefined;
@@ -2754,7 +2754,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, string, string], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: InvertedUnit;
             messageArgs?: [string, string, string] | undefined;
@@ -2766,7 +2766,7 @@ export const SchemaCompareDiagnostics: {
         new (ecDefinition: SchemaItem, messageArgs: [string, string, string], category?: DiagnosticCategory): {
             readonly code: string;
             readonly messageText: string;
-            readonly schema: Schema;
+            readonly schema: Schema; /** Required message parameters: CustomAttributeClass name */
             readonly diagnosticType: DiagnosticType;
             ecDefinition: Constant;
             messageArgs?: [string, string, string] | undefined;

diff --git a/...y/backend-itwin-client/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...y/backend-itwin-client/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/backend-itwin-client",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/backend-itwin-client",
+  "email": "[email protected]"
+}
diff --git a/...tley/ecschema-metadata/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...tley/ecschema-metadata/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/ecschema-metadata",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/ecschema-metadata",
+  "email": "[email protected]"
+}
diff --git a/...@bentley/eslint-plugin/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...@bentley/eslint-plugin/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/eslint-plugin",
+      "comment": "add and recommend no-internal-barrel-imports rule",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/eslint-plugin",
+  "email": "[email protected]"
+}
diff --git a/...tley/frontend-devtools/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...tley/frontend-devtools/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/frontend-devtools",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/frontend-devtools",
+  "email": "[email protected]"
+}
diff --git a/...@bentley/geometry-core/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...@bentley/geometry-core/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/geometry-core",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/geometry-core",
+  "email": "[email protected]"
+}
diff --git a/...ntley/imodeljs-backend/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...ntley/imodeljs-backend/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/imodeljs-backend",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/imodeljs-backend",
+  "email": "[email protected]"
+}
diff --git a/...entley/imodeljs-common/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...entley/imodeljs-common/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/imodeljs-common",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/imodeljs-common",
+  "email": "[email protected]"
+}
diff --git a/...tley/imodeljs-frontend/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...tley/imodeljs-frontend/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/imodeljs-frontend",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/imodeljs-frontend",
+  "email": "[email protected]"
+}
diff --git a/...bentley/mobile-manager/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...bentley/mobile-manager/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/mobile-manager",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/mobile-manager",
+  "email": "[email protected]"
+}
diff --git a/...resentation-components/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...resentation-components/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/presentation-components",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/presentation-components",
+  "email": "[email protected]"
+}
diff --git a/...s/@bentley/ui-abstract/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...s/@bentley/ui-abstract/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/ui-abstract",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/ui-abstract",
+  "email": "[email protected]"
+}
diff --git a/...@bentley/ui-components/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...@bentley/ui-components/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/ui-components",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/ui-components",
+  "email": "[email protected]"
+}
diff --git a/...anges/@bentley/ui-core/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/...anges/@bentley/ui-core/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/ui-core",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/ui-core",
+  "email": "[email protected]"
+}
diff --git a/.../@bentley/ui-framework/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json b/.../@bentley/ui-framework/dont-use-barrel-imports-internally-lint-rule_2021-07-13-15-34.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@bentley/ui-framework",
+      "comment": "remove internal barrel-import usage",
+      "type": "none"
+    }
+  ],
+  "packageName": "@bentley/ui-framework",
+  "email": "[email protected]"
+}
diff --git a/common/config/rush/browser-approved-packages.json b/common/config/rush/browser-approved-packages.json
@@ -298,6 +298,10 @@
       "name": "@typescript-eslint/parser",
       "allowedCategories": [ "tools" ]
     },
+    {
+      "name": "@typescript-eslint/typescript-estree",
+      "allowedCategories": [ "tools" ]
+    },
     {
       "name": "@ungap/url-search-params",
       "allowedCategories": [ "common" ]