[eslint] fix and skip violations for cross-boundary imports (#136911)

elastic · Jul 29, 2022 · bebec37 · bebec37
1 parent 103aa67
commit bebec37
Show file tree

Hide file tree

Showing 379 changed files with 368 additions and 1,168 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -585,109 +585,6 @@ module.exports = {
       },
     },
 
-    /**
-     * Restricted paths
-     */
-    {
-      files: ['**/*.{js,mjs,ts,tsx}'],
-      rules: {
-        '@kbn/eslint/no-restricted-paths': [
-          'error',
-          {
-            basePath: __dirname,
-            zones: [
-              {
-                target: ['(src|x-pack)/**/*', '!src/core/**/*'],
-                from: ['src/core/utils/**/*'],
-                errorMessage: `Plugins may only import from src/core/server and src/core/public.`,
-              },
-              {
-                target: ['(src|x-pack)/plugins/*/server/**/*'],
-                from: ['(src|x-pack)/plugins/*/public/**/*'],
-                errorMessage: `Server code can not import from public, use a common directory.`,
-              },
-              {
-                target: ['(src|x-pack)/plugins/*/common/**/*'],
-                from: ['(src|x-pack)/plugins/*/(server|public)/**/*'],
-                errorMessage: `Common code can not import from server or public, use a common directory.`,
-              },
-              {
-                target: ['(src|x-pack)/plugins/**/(public|server)/**/*', 'examples/**/*'],
-                from: [
-                  'src/core/public/**/*',
-                  '!src/core/public/index.ts', // relative import
-                  '!src/core/public/mocks{,.ts}',
-                  '!src/core/server/types{,.ts}',
-                  '!src/core/public/utils/**/*',
-                  '!src/core/public/*.test.mocks{,.ts}',
-
-                  'src/core/server/**/*',
-                  '!src/core/server/index.ts', // relative import
-                  '!src/core/server/mocks{,.ts}',
-                  '!src/core/server/types{,.ts}',
-                  '!src/core/server/test_utils{,.ts}',
-                  // for absolute imports until fixed in
-                  // https://github.com/elastic/kibana/issues/36096
-                  '!src/core/server/*.test.mocks{,.ts}',
-
-                  'target/types/**',
-                ],
-                allowSameFolder: true,
-                errorMessage:
-                  'Plugins may only import from top-level public and server modules in core.',
-              },
-              {
-                target: [
-                  '(src|x-pack)/plugins/**/(public|server)/**/*',
-                  'examples/**/*',
-                  '!(src|x-pack)/**/*.test.*',
-                  '!(x-pack/)?test/**/*',
-                ],
-                from: [
-                  '(src|x-pack)/plugins/**/(public|server)/**/*',
-                  '!(src|x-pack)/plugins/**/(public|server)/mocks/index.{js,mjs,ts}',
-                  '!(src|x-pack)/plugins/**/(public|server)/(index|mocks).{js,mjs,ts,tsx}',
-                  '!(src|x-pack)/plugins/**/__stories__/index.{js,mjs,ts,tsx}',
-                  '!(src|x-pack)/plugins/**/__fixtures__/index.{js,mjs,ts,tsx}',
-                ],
-                allowSameFolder: true,
-                errorMessage: 'Plugins may only import from top-level public and server modules.',
-              },
-              {
-                target: [
-                  '(src|x-pack)/plugins/**/*',
-                  '!(src|x-pack)/plugins/**/server/**/*',
-
-                  'examples/**/*',
-                  '!examples/**/server/**/*',
-                ],
-                from: [
-                  'src/core/server',
-                  'src/core/server/**/*',
-                  '(src|x-pack)/plugins/*/server/**/*',
-                  'examples/**/server/**/*',
-                  // TODO: Remove the 'joi' eslint rule once IE11 support is dropped
-                  'joi',
-                ],
-                errorMessage:
-                  'Server modules cannot be imported into client modules or shared modules.',
-              },
-              {
-                target: ['src/core/**/*'],
-                from: ['plugins/**/*', 'src/plugins/**/*'],
-                errorMessage: 'The core cannot depend on any plugins.',
-              },
-              {
-                target: ['(src|x-pack)/plugins/*/public/**/*'],
-                from: ['ui/**/*'],
-                errorMessage: 'Plugins cannot import legacy UI code.',
-              },
-            ],
-          },
-        ],
-      },
-    },
-
     /**
      * Allow default exports
      */

diff --git a/examples/embeddable_examples/common/book_saved_object_attributes.ts b/examples/embeddable_examples/common/book_saved_object_attributes.ts
@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { SavedObjectAttributes } from '@kbn/core/types';
+import type { SavedObjectAttributes } from '@kbn/core/types';
 
 export const BOOK_SAVED_OBJECT = 'book';
 

diff --git a/examples/embeddable_examples/common/todo_saved_object_attributes.ts b/examples/embeddable_examples/common/todo_saved_object_attributes.ts
@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { SavedObjectAttributes } from '@kbn/core/types';
+import type { SavedObjectAttributes } from '@kbn/core/types';
 
 export interface TodoSavedObjectAttributes extends SavedObjectAttributes {
   task: string;

diff --git a/examples/field_formats_example/public/app.tsx b/examples/field_formats_example/public/app.tsx
@@ -32,10 +32,8 @@ import example1SampleCode from '!!raw-loader!./examples/1_using_existing_format'
 import example2SampleCodePart1 from '!!raw-loader!../common/example_currency_format';
 // @ts-ignore
 import example2SampleCodePart2 from '!!raw-loader!./examples/2_creating_custom_formatter';
-/* eslint-disable @kbn/eslint/no-restricted-paths */
 // @ts-ignore
 import example2SampleCodePart3 from '!!raw-loader!../server/examples/2_creating_custom_formatter';
-/* eslint-enable @kbn/eslint/no-restricted-paths */
 // @ts-ignore
 import example3SampleCode from '!!raw-loader!./examples/3_creating_custom_format_editor';
 

diff --git a/packages/core/config/core-config-server-internal/src/index.ts b/packages/core/config/core-config-server-internal/src/index.ts
@@ -8,4 +8,5 @@
 
 export { coreDeprecationProvider } from './deprecation';
 export { ensureValidConfiguration } from './ensure_valid_configuration';
+// eslint-disable-next-line @kbn/imports/no_boundary_crossing
 export { getDeprecationsFor, getDeprecationsForGlobalSettings } from './test_utils';
diff --git a/packages/elastic-apm-synthtrace/src/cli.ts b/packages/elastic-apm-synthtrace/src/cli.ts
@@ -6,4 +6,4 @@
  * Side Public License, v 1.
  */
 
-export { runSynthtrace } from './scripts/run_synthtrace';
+export { runSynthtrace } from './cli/run_synthtrace';
diff --git a/...-synthtrace/src/scripts/run_synthtrace.ts → ...-apm-synthtrace/src/cli/run_synthtrace.ts b/...-synthtrace/src/scripts/run_synthtrace.ts → ...-apm-synthtrace/src/cli/run_synthtrace.ts
diff --git a/...ic-apm-synthtrace/src/scripts/scenario.ts → ...lastic-apm-synthtrace/src/cli/scenario.ts b/...ic-apm-synthtrace/src/scripts/scenario.ts → ...lastic-apm-synthtrace/src/cli/scenario.ts
diff --git a/.../src/scripts/utils/get_common_services.ts → ...race/src/cli/utils/get_common_services.ts b/.../src/scripts/utils/get_common_services.ts → ...race/src/cli/utils/get_common_services.ts
diff --git a/...thtrace/src/scripts/utils/get_scenario.ts → ...-synthtrace/src/cli/utils/get_scenario.ts b/...thtrace/src/scripts/utils/get_scenario.ts → ...-synthtrace/src/cli/utils/get_scenario.ts
diff --git a/...trace/src/scripts/utils/interval_to_ms.ts → ...ynthtrace/src/cli/utils/interval_to_ms.ts b/...trace/src/scripts/utils/interval_to_ms.ts → ...ynthtrace/src/cli/utils/interval_to_ms.ts
diff --git a/.../src/scripts/utils/parse_run_cli_flags.ts → ...race/src/cli/utils/parse_run_cli_flags.ts b/.../src/scripts/utils/parse_run_cli_flags.ts → ...race/src/cli/utils/parse_run_cli_flags.ts
diff --git a/...pts/utils/start_historical_data_upload.ts → ...cli/utils/start_historical_data_upload.ts b/...pts/utils/start_historical_data_upload.ts → ...cli/utils/start_historical_data_upload.ts
diff --git a/...c/scripts/utils/start_live_data_upload.ts → ...e/src/cli/utils/start_live_data_upload.ts b/...c/scripts/utils/start_live_data_upload.ts → ...e/src/cli/utils/start_live_data_upload.ts
diff --git a/...ce/src/scripts/utils/synthtrace_worker.ts → ...htrace/src/cli/utils/synthtrace_worker.ts b/...ce/src/scripts/utils/synthtrace_worker.ts → ...htrace/src/cli/utils/synthtrace_worker.ts
diff --git a/...pm-synthtrace/src/scripts/utils/worker.js → ...ic-apm-synthtrace/src/cli/utils/worker.js b/...pm-synthtrace/src/scripts/utils/worker.js → ...ic-apm-synthtrace/src/cli/utils/worker.js
diff --git a/packages/elastic-apm-synthtrace/src/scenarios/agent_config.ts b/packages/elastic-apm-synthtrace/src/scenarios/agent_config.ts
@@ -7,9 +7,9 @@
  */
 
 import { observer, timerange } from '..';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 import { AgentConfigFields } from '../lib/agent_config/agent_config_fields';
 
 const scenario: Scenario<AgentConfigFields> = async (runOptions: RunOptions) => {

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/aws_lambda.ts b/packages/elastic-apm-synthtrace/src/scenarios/aws_lambda.ts
@@ -8,9 +8,9 @@
 
 import { apm, timerange } from '..';
 import { ApmFields } from '../lib/apm/apm_fields';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 
 const ENVIRONMENT = __filename;
 

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/kibana_stats.ts b/packages/elastic-apm-synthtrace/src/scenarios/kibana_stats.ts
@@ -7,9 +7,9 @@
  */
 
 import { stackMonitoring, timerange } from '..';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 import { ApmFields } from '../lib/apm/apm_fields';
 
 const scenario: Scenario<ApmFields> = async (runOptions: RunOptions) => {

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/low_throughput.ts b/packages/elastic-apm-synthtrace/src/scenarios/low_throughput.ts
@@ -10,9 +10,9 @@ import { random } from 'lodash';
 import { apm, timerange } from '..';
 import { ApmFields } from '../lib/apm/apm_fields';
 import { Instance } from '../lib/apm/instance';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 
 const ENVIRONMENT = __filename;
 

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/many_services.ts b/packages/elastic-apm-synthtrace/src/scenarios/many_services.ts
@@ -9,9 +9,9 @@
 import { random } from 'lodash';
 import { apm, timerange } from '..';
 import { Instance } from '../lib/apm/instance';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 import { ApmFields } from '../lib/apm/apm_fields';
 
 const ENVIRONMENT = __filename;

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/monitoring.ts b/packages/elastic-apm-synthtrace/src/scenarios/monitoring.ts
@@ -9,9 +9,9 @@
 // Run with: node ./src/scripts/run ./src/scripts/examples/03_monitoring.ts --target=http://elastic:changeme@localhost:9200
 
 import { stackMonitoring, timerange } from '..';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 import { StackMonitoringFields } from '../lib/stack_monitoring/stack_monitoring_fields';
 
 const scenario: Scenario<StackMonitoringFields> = async (runOptions: RunOptions) => {

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/simple_trace.ts b/packages/elastic-apm-synthtrace/src/scenarios/simple_trace.ts
@@ -9,9 +9,9 @@
 import { apm, timerange } from '..';
 import { ApmFields } from '../lib/apm/apm_fields';
 import { Instance } from '../lib/apm/instance';
-import { Scenario } from '../scripts/scenario';
-import { getLogger } from '../scripts/utils/get_common_services';
-import { RunOptions } from '../scripts/utils/parse_run_cli_flags';
+import { Scenario } from '../cli/scenario';
+import { getLogger } from '../cli/utils/get_common_services';
+import { RunOptions } from '../cli/utils/parse_run_cli_flags';
 
 const ENVIRONMENT = __filename;
 

diff --git a/packages/elastic-apm-synthtrace/src/scenarios/span_links.ts b/packages/elastic-apm-synthtrace/src/scenarios/span_links.ts
@@ -9,7 +9,7 @@
 import { compact, shuffle } from 'lodash';
 import { apm, ApmFields, EntityArrayIterable, timerange } from '..';
 import { generateLongId, generateShortId } from '../lib/utils/generate_id';
-import { Scenario } from '../scripts/scenario';
+import { Scenario } from '../cli/scenario';
 
 const ENVIRONMENT = __filename;
 

diff --git a/packages/home/sample_data_card/src/index.ts b/packages/home/sample_data_card/src/index.ts
@@ -20,5 +20,6 @@ export {
   getStoryArgTypes as getSampleDataCardStoryArgTypes,
   getStoryServices as getSampleDataCardStoryServices,
   getMockDataSet as getSampleDataCardMockDataSet,
+  // eslint-disable-next-line @kbn/imports/no_boundary_crossing
 } from './mocks';
 export type { Params as SampleDataCardStorybookParams } from './mocks';
diff --git a/packages/kbn-eslint-config/.eslintrc.js b/packages/kbn-eslint-config/.eslintrc.js
@@ -258,5 +258,6 @@ module.exports = {
     '@kbn/imports/no_unresolvable_imports': 'error',
     '@kbn/imports/uniform_imports': 'error',
     '@kbn/imports/no_unused_imports': 'error',
+    '@kbn/imports/no_boundary_crossing': 'error',
   },
 };
diff --git a/packages/kbn-eslint-plugin-eslint/BUILD.bazel b/packages/kbn-eslint-plugin-eslint/BUILD.bazel
@@ -34,7 +34,6 @@ RUNTIME_DEPS = [
   "@npm//dedent",
   "@npm//eslint",
   "@npm//eslint-module-utils",
-  "@npm//micromatch",
 ]
 
 js_library(

diff --git a/packages/kbn-eslint-plugin-eslint/README.mdx b/packages/kbn-eslint-plugin-eslint/README.mdx
@@ -83,47 +83,6 @@ Disallows the usage of `this` into class property initializers and enforce to de
 
 Disables the usage of a trailing slash in a node module import.
 
-## no-restricted-paths
-
-Defines a set of import paths valid to be imported for a given group of files.
-
-```
-module.exports = {
-  overrides: [
-    {    
-      files: ['**/*.{js,mjs,ts,tsx}'],
-      rules: {
-        '@kbn/eslint/no-restricted-paths': [
-          'error',
-          {
-            basePath: __dirname,
-            zones: [
-              {
-                target: [
-                  '(src|x-pack)/plugins/**/(public|server)/**/*',
-                  'examples/**/*',
-                  '!(src|x-pack)/**/*.test.*',
-                  '!(x-pack/)?test/**/*',
-                ],
-                from: [
-                  '(src|x-pack)/plugins/**/(public|server)/**/*',
-                  '!(src|x-pack)/plugins/**/(public|server)/mocks/index.{js,mjs,ts}',
-                  '!(src|x-pack)/plugins/**/(public|server)/(index|mocks).{js,mjs,ts,tsx}',
-                  '!(src|x-pack)/plugins/**/__stories__/index.{js,mjs,ts,tsx}',
-                  '!(src|x-pack)/plugins/**/__fixtures__/index.{js,mjs,ts,tsx}',
-                ],
-                allowSameFolder: true,
-                errorMessage: 'Plugins may only import from top-level public and server modules.',
-              },
-            ],
-          },
-        ],
-      },
-    }
-  ]    
-}
-```
-
 ## require-license-header
 
 Requires a given license header text on a group of files.

diff --git a/packages/kbn-eslint-plugin-eslint/index.js b/packages/kbn-eslint-plugin-eslint/index.js
@@ -10,7 +10,6 @@ module.exports = {
   rules: {
     'require-license-header': require('./rules/require_license_header'),
     'disallow-license-headers': require('./rules/disallow_license_headers'),
-    'no-restricted-paths': require('./rules/no_restricted_paths'),
     module_migration: require('./rules/module_migration'),
     no_export_all: require('./rules/no_export_all'),
     no_async_promise_body: require('./rules/no_async_promise_body'),