chore(NA): enables isolatedModules on base tsconfig file (elastic#144841

) This PR enables `isolatedModules` on our `tsconfig.base.json`. Enabling this means that our codebase is safe for tools that use TypeScript APIs like `transpileModule` or alternative compilers like Babel. The requirements introduced by enabling `isolatedModules` were already in place for every piece of code transpiled with babel so we feel like its time to make it the default across the board inside our repository. The DX shouldn't be impacted negatively by these change as we introduced a lint rule verification for the critical part around `isolatedModules` which is around `const enums`. The PR also has a couple of `TODOs` to be removed once we upgrade into typescript v4.8 where we would be able to say everything that is typescript inside our repo should be consider a module by default. More information about `isolatedModules` can be found at https://www.typescriptlang.org/tsconfig#isolatedModules Co-authored-by: kibanamachine <[email protected]>
spalger · Nov 18, 2022 · 016e3e0 · 016e3e0
1 parent 9a0622b
commit 016e3e0
Show file tree

Hide file tree

Showing 68 changed files with 174 additions and 120 deletions.
diff --git a/packages/content-management/inspector/BUILD.bazel b/packages/content-management/inspector/BUILD.bazel
@@ -110,7 +110,6 @@ ts_project(
   srcs = SRCS,
   deps = TYPES_DEPS,
   declaration = True,
-  declaration_map = True,
   emit_declaration_only = True,
   out_dir = "target_types",
   tsconfig = ":tsconfig",
@@ -124,6 +123,14 @@ js_library(
   visibility = ["//visibility:public"],
 )
 
+js_library(
+  name = "npm_module_types",
+  srcs = NPM_MODULE_EXTRA_FILES,
+  deps = RUNTIME_DEPS + [":target_node", ":target_web", ":tsc_types"],
+  package_name = PKG_REQUIRE_NAME,
+  visibility = ["//visibility:public"],
+)
+
 pkg_npm(
   name = "npm_module",
   deps = [":" + PKG_DIRNAME],
@@ -135,17 +142,8 @@ filegroup(
   visibility = ["//visibility:public"],
 )
 
-pkg_npm_types(
-  name = "npm_module_types",
-  srcs = SRCS,
-  deps = [":tsc_types"],
-  package_name = PKG_REQUIRE_NAME,
-  tsconfig = ":tsconfig",
-  visibility = ["//visibility:public"],
-)
-
-filegroup(
+pkg_npm(
   name = "build_types",
-  srcs = [":npm_module_types"],
+  deps = [":npm_module_types"],
   visibility = ["//visibility:public"],
 )
diff --git a/packages/content-management/inspector/package.json b/packages/content-management/inspector/package.json
@@ -4,5 +4,6 @@
   "version": "1.0.0",
   "main": "./target_node/index.js",
   "browser": "./target_web/index.js",
-  "license": "SSPL-1.0 OR Elastic License 2.0"
+  "license": "SSPL-1.0 OR Elastic License 2.0",
+  "types": "./target_types/index.d.ts"
 }
diff --git a/packages/content-management/inspector/tsconfig.json b/packages/content-management/inspector/tsconfig.json
@@ -2,10 +2,8 @@
   "extends": "../../../tsconfig.bazel.json",
   "compilerOptions": {
     "declaration": true,
-    "declarationMap": true,
     "emitDeclarationOnly": true,
     "outDir": "target_types",
-    "stripInternal": false,
     "types": [
       "jest",
       "node",
@@ -17,6 +15,6 @@
   },
   "include": [
     "**/*.ts",
-      "**/*.tsx",
+    "**/*.tsx",
   ]
 }
diff --git a/packages/kbn-eslint-config/typescript.js b/packages/kbn-eslint-config/typescript.js
@@ -257,7 +257,14 @@ module.exports = {
           'import/no-default-export': 'error',
 
           'eslint-comments/no-unused-disable': 'error',
-          'eslint-comments/no-unused-enable': 'error'
+          'eslint-comments/no-unused-enable': 'error',
+          'no-restricted-syntax': [
+            'error',
+            {
+              "selector": "TSEnumDeclaration[const=true]",
+              "message": "Do not use `const` with enum declarations"
+            }
+          ]
         },
         eslintConfigPrettierRules
       )

diff --git a/packages/kbn-optimizer/src/worker/entry_point_creator.ts b/packages/kbn-optimizer/src/worker/entry_point_creator.ts
@@ -6,6 +6,9 @@
  * Side Public License, v 1.
  */
 
+// TODO: we should be able to remove this ts-ignore while using isolatedModules
+// this is a skip for the errors created when typechecking with isolatedModules
+// @ts-ignore
 module.exports = function ({
   entries,
 }: {

diff --git a/packages/kbn-securitysolution-list-hooks/src/use_api/types.ts b/packages/kbn-securitysolution-list-hooks/src/use_api/types.ts
diff --git a/packages/kbn-securitysolution-utils/src/path_validations/index.ts b/packages/kbn-securitysolution-utils/src/path_validations/index.ts
@@ -16,13 +16,13 @@ export const FILEPATH_WARNING = i18n.translate('utils.filename.pathWarning', {
   defaultMessage: `Path may be formed incorrectly; verify value`,
 });
 
-export const enum ConditionEntryField {
+export enum ConditionEntryField {
   HASH = 'process.hash.*',
   PATH = 'process.executable.caseless',
   SIGNER = 'process.Ext.code_signature',
 }
 
-export const enum EntryFieldType {
+export enum EntryFieldType {
   HASH = '.hash.',
   EXECUTABLE = '.executable.caseless',
   PATH = '.path',
@@ -39,7 +39,7 @@ export type AllConditionEntryFields =
   | BlocklistConditionEntryField
   | 'file.path.text';
 
-export const enum OperatingSystem {
+export enum OperatingSystem {
   LINUX = 'linux',
   MAC = 'macos',
   WINDOWS = 'windows',

diff --git a/src/plugins/bfetch/public/types.ts b/src/plugins/bfetch/public/types.ts
diff --git a/...s/console/public/application/containers/editor/legacy/console_editor/editor.test.mock.tsx b/...s/console/public/application/containers/editor/legacy/console_editor/editor.test.mock.tsx
@@ -6,6 +6,10 @@
  * Side Public License, v 1.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 jest.mock('../../../../contexts/editor_context/editor_registry', () => ({
   instance: {
     setInputEditor: () => {},

diff --git a/src/plugins/controls/public/index.ts b/src/plugins/controls/public/index.ts
@@ -32,21 +32,21 @@ export {
 } from '../common';
 
 export {
-  ControlGroupContainer,
+  type ControlGroupContainer,
   ControlGroupContainerFactory,
   type ControlGroupInput,
   type ControlGroupOutput,
 } from './control_group';
 
 export {
   OptionsListEmbeddableFactory,
-  OptionsListEmbeddable,
+  type OptionsListEmbeddable,
   type OptionsListEmbeddableInput,
 } from './options_list';
 
 export {
   RangeSliderEmbeddableFactory,
-  RangeSliderEmbeddable,
+  type RangeSliderEmbeddable,
   type RangeSliderEmbeddableInput,
 } from './range_slider';
 

diff --git a/src/plugins/data_view_field_editor/public/components/field_format_editor/editors/index.ts b/src/plugins/data_view_field_editor/public/components/field_format_editor/editors/index.ts
@@ -10,17 +10,17 @@ export type { DefaultFormatEditor } from './default';
 export type { FieldFormatEditor, FieldFormatEditorFactory, FormatEditorProps } from './types';
 export type { UrlFormatEditorFormatParams } from './url';
 
-export { BytesFormatEditor, bytesFormatEditorFactory } from './bytes';
-export { ColorFormatEditor, colorFormatEditorFactory } from './color';
-export { DateFormatEditor, dateFormatEditorFactory } from './date';
-export { DateNanosFormatEditor, dateNanosFormatEditorFactory } from './date_nanos';
+export { type BytesFormatEditor, bytesFormatEditorFactory } from './bytes';
+export { type ColorFormatEditor, colorFormatEditorFactory } from './color';
+export { type DateFormatEditor, dateFormatEditorFactory } from './date';
+export { type DateNanosFormatEditor, dateNanosFormatEditorFactory } from './date_nanos';
 export { defaultFormatEditorFactory } from './default';
-export { DurationFormatEditor, durationFormatEditorFactory } from './duration';
-export { GeoPointFormatEditor, geoPointFormatEditorFactory } from './geo_point';
-export { HistogramFormatEditor, histogramFormatEditorFactory } from './histogram';
-export { NumberFormatEditor, numberFormatEditorFactory } from './number';
-export { PercentFormatEditor, percentFormatEditorFactory } from './percent';
-export { StaticLookupFormatEditor, staticLookupFormatEditorFactory } from './static_lookup';
-export { StringFormatEditor, stringFormatEditorFactory } from './string';
-export { TruncateFormatEditor, truncateFormatEditorFactory } from './truncate';
-export { UrlFormatEditor, urlFormatEditorFactory } from './url';
+export { type DurationFormatEditor, durationFormatEditorFactory } from './duration';
+export { type GeoPointFormatEditor, geoPointFormatEditorFactory } from './geo_point';
+export { type HistogramFormatEditor, histogramFormatEditorFactory } from './histogram';
+export { type NumberFormatEditor, numberFormatEditorFactory } from './number';
+export { type PercentFormatEditor, percentFormatEditorFactory } from './percent';
+export { type StaticLookupFormatEditor, staticLookupFormatEditorFactory } from './static_lookup';
+export { type StringFormatEditor, stringFormatEditorFactory } from './string';
+export { type TruncateFormatEditor, truncateFormatEditorFactory } from './truncate';
+export { type UrlFormatEditor, urlFormatEditorFactory } from './url';
diff --git a/src/plugins/event_annotation/server/fetch_event_annotations/index.ts b/src/plugins/event_annotation/server/fetch_event_annotations/index.ts
@@ -8,6 +8,10 @@
 
 // TODO: implement this on the server
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 // import { StartServicesAccessor } from '@kbn/core/server';
 // import { EventAnnotationStartDependencies } from '../plugin';
 

diff --git a/src/plugins/expressions/server/index.ts b/src/plugins/expressions/server/index.ts
@@ -75,23 +75,23 @@ export type {
 export {
   buildExpression,
   buildExpressionFunction,
-  Execution,
-  Executor,
+  type Execution,
+  type Executor,
   ExpressionFunction,
-  ExpressionFunctionParameter,
+  type ExpressionFunctionParameter,
   ExpressionRenderer,
-  ExpressionRendererRegistry,
+  type ExpressionRendererRegistry,
   ExpressionType,
   FontStyle,
   FontWeight,
   format,
   formatExpression,
-  FunctionsRegistry,
+  type FunctionsRegistry,
   isExpressionAstBuilder,
   Overflow,
   parse,
   parseExpression,
   TextAlignment,
   TextDecoration,
-  TypesRegistry,
+  type TypesRegistry,
 } from '../common';
diff --git a/test/interpreter_functional/plugins/kbn_tp_run_pipeline/public/types.ts b/test/interpreter_functional/plugins/kbn_tp_run_pipeline/public/types.ts
@@ -9,5 +9,4 @@
 import { ExpressionsStart, ExpressionRenderHandler } from '@kbn/expressions-plugin/public';
 import { Adapters } from '@kbn/inspector-plugin/public';
 
-export type { ExpressionsStart, Adapters };
-export { ExpressionRenderHandler };
+export type { ExpressionsStart, ExpressionRenderHandler, Adapters };
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1211,6 +1211,13 @@
     "strict": true,
     // for now, don't use unknown in catch
     "useUnknownInCatchVariables": false,
+    // enabled to point out not supported features when emitting in an isolated module environment
+    "isolatedModules": true,
+    // TODO(jbudz): should be uncommented when upgrading to [email protected]
+    //
+    // ensures every non-declaration file is treated as a module
+    // "moduleDetection": "force",
+    //
     // disabled for better IDE support, enabled when running the type_check script
     "composite": false,
     // enabled for improved performance

diff --git a/x-pack/plugins/apm/common/anomaly_detection/apm_ml_detectors.ts b/x-pack/plugins/apm/common/anomaly_detection/apm_ml_detectors.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-export const enum ApmMlDetectorType {
+export enum ApmMlDetectorType {
   txLatency = 'txLatency',
   txThroughput = 'txThroughput',
   txFailureRate = 'txFailureRate',

diff --git a/x-pack/plugins/apm/common/privilege_type.ts b/x-pack/plugins/apm/common/privilege_type.ts
@@ -7,7 +7,7 @@
 
 import * as t from 'io-ts';
 
-export const enum PrivilegeType {
+export enum PrivilegeType {
   EVENT = 'event:write',
   AGENT_CONFIG = 'config_agent:read',
 }

diff --git a/x-pack/plugins/apm/public/components/shared/charts/helper/get_timeseries_color.ts b/x-pack/plugins/apm/public/components/shared/charts/helper/get_timeseries_color.ts
@@ -7,7 +7,7 @@
 
 import { euiPaletteColorBlind } from '@elastic/eui';
 
-export const enum ChartType {
+export enum ChartType {
   LATENCY_AVG,
   LATENCY_P95,
   LATENCY_P99,

diff --git a/x-pack/plugins/cases/public/common/mock/match_media.ts b/x-pack/plugins/cases/public/common/mock/match_media.ts
@@ -5,6 +5,10 @@
  * 2.0.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 window.matchMedia = jest.fn().mockImplementation((query) => ({
   matches: false,
   media: query,

diff --git a/x-pack/plugins/cases/public/components/actions/tags/edit_tags_selectable.tsx b/x-pack/plugins/cases/public/components/actions/tags/edit_tags_selectable.tsx
@@ -37,18 +37,18 @@ interface Props {
 
 type TagSelectableOption = EuiSelectableOption<{ tagIcon: IconType; newItem?: boolean }>;
 
-const enum TagState {
+enum TagState {
   CHECKED = 'checked',
   PARTIAL = 'partial',
   UNCHECKED = 'unchecked',
 }
 
-const enum Actions {
+enum Actions {
   CHECK_TAG,
   UNCHECK_TAG,
 }
 
-const enum ICONS {
+enum ICONS {
   CHECKED = 'check',
   PARTIAL = 'asterisk',
   UNCHECKED = 'empty',

diff --git a/x-pack/plugins/cases/server/common/index.ts b/x-pack/plugins/cases/server/common/index.ts
@@ -5,6 +5,10 @@
  * 2.0.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 // Careful of exporting anything from this file as any file(s) you export here will cause your functions to be exposed as public.
 // If you're using functions/types/etc... internally or within integration tests it's best to import directly from their paths
 // than expose the functions/types/etc... here. You should _only_ expose functions/types/etc... that need to be shared with other plugins here.

diff --git a/...ns/cross_cluster_replication/public/__jest__/client_integration/mocks/breadcrumbs.mock.ts b/...ns/cross_cluster_replication/public/__jest__/client_integration/mocks/breadcrumbs.mock.ts
@@ -5,6 +5,10 @@
  * 2.0.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 jest.mock('../../../app/services/breadcrumbs', () => {
   const original = jest.requireActual('../../../app/services/breadcrumbs');
 

diff --git a/...ross_cluster_replication/public/__jest__/client_integration/mocks/track_ui_metric.mock.ts b/...ross_cluster_replication/public/__jest__/client_integration/mocks/track_ui_metric.mock.ts
@@ -5,6 +5,10 @@
  * 2.0.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 jest.mock('../../../app/services/track_ui_metric', () => {
   const original = jest.requireActual('../../../app/services/track_ui_metric');
 

diff --git a/...board_drilldown/components/dashboard_drilldown_config/dashboard_drilldown_config.test.tsx b/...board_drilldown/components/dashboard_drilldown_config/dashboard_drilldown_config.test.tsx
@@ -5,6 +5,10 @@
  * 2.0.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 // Need to wait for https://github.com/elastic/eui/pull/3173/
 // to unit test this component
 // basic interaction is covered in end-to-end tests

diff --git a/x-pack/plugins/enterprise_search/common/types/api.ts b/x-pack/plugins/enterprise_search/common/types/api.ts
@@ -14,7 +14,7 @@ import { ErrorCode } from './error_codes';
  * Each Status string corresponds to a possible status in a request's lifecycle
  */
 
-export const enum Status {
+export enum Status {
   IDLE,
   LOADING,
   SUCCESS,

diff --git a/...lications/app_search/components/engines/components/tables/__mocks__/engines_logic.mock.ts b/...lications/app_search/components/engines/components/tables/__mocks__/engines_logic.mock.ts
@@ -5,6 +5,10 @@
  * 2.0.
  */
 
+// TODO(jbudz): should be removed when upgrading to [email protected]
+// this is a skip for the errors created when typechecking with isolatedModules
+export {};
+
 jest.mock('../../..', () => ({
   EnginesLogic: { actions: { deleteEngine: jest.fn() } },
 }));
diff --git a/...e_search/public/applications/enterprise_search_content/components/new_index/new_index.tsx b/...e_search/public/applications/enterprise_search_content/components/new_index/new_index.tsx
@@ -33,7 +33,7 @@ import { MethodApi } from './method_api/method_api';
 import { MethodConnector } from './method_connector/method_connector';
 import { MethodCrawler } from './method_crawler/method_crawler';
 
-export const enum IngestionMethodId {
+export enum IngestionMethodId {
   api = 'api',
   connector = 'connector',
   crawler = 'crawler',