improvement(eslint-config-fluid): Update type import/export rules to …

…help prevent runtime side-effects (microsoft#21402) Adds the [@typescript-eslint/no-import-type-side-effects](https://typescript-eslint.io/rules/no-import-type-side-effects/) rule to our strict eslint configuration. Pre-fixes violations across the repo.
daesunp · Jun 13, 2024 · bbc17a2 · bbc17a2
1 parent b62a70b
commit bbc17a2
Show file tree

Hide file tree

Showing 172 changed files with 673 additions and 697 deletions.
diff --git a/common/build/eslint-config-fluid/printed-configs/strict.json b/common/build/eslint-config-fluid/printed-configs/strict.json
@@ -241,6 +241,9 @@
         "@typescript-eslint/no-implied-eval": [
             "error"
         ],
+        "@typescript-eslint/no-import-type-side-effects": [
+            "error"
+        ],
         "@typescript-eslint/no-inferrable-types": [
             "off"
         ],

diff --git a/common/build/eslint-config-fluid/strict.js b/common/build/eslint-config-fluid/strict.js
@@ -73,6 +73,8 @@ module.exports = {
 				/**
 				 * Requires that type-only exports be done using `export type`. Being explicit allows the TypeScript
 				 * `isolatedModules` flag to be used, and isolated modules are needed to adopt modern build tools like swc.
+				 *
+				 * @see {@link https://typescript-eslint.io/rules/consistent-type-exports/}
 				 */
 				"@typescript-eslint/consistent-type-exports": [
 					"error",
@@ -82,12 +84,21 @@ module.exports = {
 				/**
 				 * Requires that type-only imports be done using `import type`. Being explicit allows the TypeScript
 				 * `isolatedModules` flag to be used, and isolated modules are needed to adopt modern build tools like swc.
+				 *
+				 * @see {@link https://typescript-eslint.io/rules/consistent-type-imports/}
 				 */
 				"@typescript-eslint/consistent-type-imports": [
 					"error",
 					{ fixStyle: "separate-type-imports" },
 				],
 
+				/**
+				 * Ensures that type-only import statements do not result in runtime side-effects.
+				 *
+				 * @see {@link https://typescript-eslint.io/rules/no-import-type-side-effects/}
+				 */
+				"@typescript-eslint/no-import-type-side-effects": "error",
+
 				/**
 				 * Prefer Record to index-signature object style. That is, prefer:
 				 *

diff --git a/experimental/framework/tree-react-api/api-report/tree-react-api.alpha.api.md b/experimental/framework/tree-react-api/api-report/tree-react-api.alpha.api.md
@@ -7,14 +7,14 @@
 import { DataObject } from '@fluidframework/aqueduct/internal';
 import type { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
 import type { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { ImplicitFieldSchema } from '@fluidframework/tree';
+import type { ImplicitFieldSchema } from '@fluidframework/tree';
 import * as React_2 from 'react';
-import { SchemaCompatibilityStatus } from '@fluidframework/tree';
+import type { SchemaCompatibilityStatus } from '@fluidframework/tree';
 import type { SharedObjectKind } from '@fluidframework/shared-object-base';
-import { TreeConfiguration } from '@fluidframework/tree';
-import { TreeFieldFromImplicitField } from '@fluidframework/tree';
+import type { TreeConfiguration } from '@fluidframework/tree';
+import type { TreeFieldFromImplicitField } from '@fluidframework/tree';
 import { TreeNode } from '@fluidframework/tree';
-import { TreeView } from '@fluidframework/tree';
+import type { TreeView } from '@fluidframework/tree';
 
 // @public
 export interface IReactTreeDataObject<TSchema extends ImplicitFieldSchema> extends ITreeDataObject<TSchema> {

diff --git a/experimental/framework/tree-react-api/api-report/tree-react-api.beta.api.md b/experimental/framework/tree-react-api/api-report/tree-react-api.beta.api.md
@@ -7,14 +7,14 @@
 import { DataObject } from '@fluidframework/aqueduct/internal';
 import type { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
 import type { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { ImplicitFieldSchema } from '@fluidframework/tree';
+import type { ImplicitFieldSchema } from '@fluidframework/tree';
 import * as React_2 from 'react';
-import { SchemaCompatibilityStatus } from '@fluidframework/tree';
+import type { SchemaCompatibilityStatus } from '@fluidframework/tree';
 import type { SharedObjectKind } from '@fluidframework/shared-object-base';
-import { TreeConfiguration } from '@fluidframework/tree';
-import { TreeFieldFromImplicitField } from '@fluidframework/tree';
+import type { TreeConfiguration } from '@fluidframework/tree';
+import type { TreeFieldFromImplicitField } from '@fluidframework/tree';
 import { TreeNode } from '@fluidframework/tree';
-import { TreeView } from '@fluidframework/tree';
+import type { TreeView } from '@fluidframework/tree';
 
 // @public
 export interface IReactTreeDataObject<TSchema extends ImplicitFieldSchema> extends ITreeDataObject<TSchema> {

diff --git a/experimental/framework/tree-react-api/api-report/tree-react-api.public.api.md b/experimental/framework/tree-react-api/api-report/tree-react-api.public.api.md
@@ -7,14 +7,14 @@
 import { DataObject } from '@fluidframework/aqueduct/internal';
 import type { IFluidDataStoreFactory } from '@fluidframework/runtime-definitions/internal';
 import type { IFluidLoadable } from '@fluidframework/core-interfaces';
-import { ImplicitFieldSchema } from '@fluidframework/tree';
+import type { ImplicitFieldSchema } from '@fluidframework/tree';
 import * as React_2 from 'react';
-import { SchemaCompatibilityStatus } from '@fluidframework/tree';
+import type { SchemaCompatibilityStatus } from '@fluidframework/tree';
 import type { SharedObjectKind } from '@fluidframework/shared-object-base';
-import { TreeConfiguration } from '@fluidframework/tree';
-import { TreeFieldFromImplicitField } from '@fluidframework/tree';
+import type { TreeConfiguration } from '@fluidframework/tree';
+import type { TreeFieldFromImplicitField } from '@fluidframework/tree';
 import { TreeNode } from '@fluidframework/tree';
-import { TreeView } from '@fluidframework/tree';
+import type { TreeView } from '@fluidframework/tree';
 
 // @public
 export interface IReactTreeDataObject<TSchema extends ImplicitFieldSchema> extends ITreeDataObject<TSchema> {

diff --git a/experimental/framework/tree-react-api/src/reactSharedTreeView.tsx b/experimental/framework/tree-react-api/src/reactSharedTreeView.tsx
@@ -13,14 +13,14 @@ import {
 import type { IFluidHandle, IFluidLoadable } from "@fluidframework/core-interfaces";
 import type { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions/internal";
 import type { SharedObjectKind } from "@fluidframework/shared-object-base";
-import {
-	type ITree,
-	type SchemaCompatibilityStatus,
+import type {
+	ITree,
+	SchemaCompatibilityStatus,
 	// eslint-disable-next-line import/no-deprecated
-	type TreeConfiguration,
-	type TreeFieldFromImplicitField,
-	type TreeView,
-	type ImplicitFieldSchema,
+	TreeConfiguration,
+	TreeFieldFromImplicitField,
+	TreeView,
+	ImplicitFieldSchema,
 } from "@fluidframework/tree";
 import { configuredSharedTree, typeboxValidator } from "@fluidframework/tree/internal";
 import * as React from "react";

diff --git a/packages/common/core-interfaces/src/handles.ts b/packages/common/core-interfaces/src/handles.ts
@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { type ErasedType } from "./erasedType.js";
+import type { ErasedType } from "./erasedType.js";
 import type { IRequest, IResponse } from "./fluidRouter.js";
 
 /**

diff --git a/packages/dds/cell/api-report/cell.alpha.api.md b/packages/dds/cell/api-report/cell.alpha.api.md
@@ -4,15 +4,15 @@
 
 ```ts
 
-import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
-import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
-import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
-import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
-import { ISharedObject } from '@fluidframework/shared-object-base/internal';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
+import type { AttributionKey } from '@fluidframework/runtime-definitions/internal';
+import type { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
+import type { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
+import type { IChannelServices } from '@fluidframework/datastore-definitions/internal';
+import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
+import type { ISharedObject } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
 import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
-import { Serializable } from '@fluidframework/datastore-definitions/internal';
+import type { Serializable } from '@fluidframework/datastore-definitions/internal';
 import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
 
 ```
diff --git a/packages/dds/cell/api-report/cell.beta.api.md b/packages/dds/cell/api-report/cell.beta.api.md
@@ -4,15 +4,15 @@
 
 ```ts
 
-import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
-import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
-import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
-import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
-import { ISharedObject } from '@fluidframework/shared-object-base/internal';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
+import type { AttributionKey } from '@fluidframework/runtime-definitions/internal';
+import type { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
+import type { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
+import type { IChannelServices } from '@fluidframework/datastore-definitions/internal';
+import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
+import type { ISharedObject } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
 import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
-import { Serializable } from '@fluidframework/datastore-definitions/internal';
+import type { Serializable } from '@fluidframework/datastore-definitions/internal';
 import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
 
 ```
diff --git a/packages/dds/cell/api-report/cell.public.api.md b/packages/dds/cell/api-report/cell.public.api.md
@@ -4,15 +4,15 @@
 
 ```ts
 
-import { AttributionKey } from '@fluidframework/runtime-definitions/internal';
-import { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
-import { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
-import { IChannelServices } from '@fluidframework/datastore-definitions/internal';
-import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
-import { ISharedObject } from '@fluidframework/shared-object-base/internal';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
+import type { AttributionKey } from '@fluidframework/runtime-definitions/internal';
+import type { IChannelAttributes } from '@fluidframework/datastore-definitions/internal';
+import type { IChannelFactory } from '@fluidframework/datastore-definitions/internal';
+import type { IChannelServices } from '@fluidframework/datastore-definitions/internal';
+import type { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions/internal';
+import type { ISharedObject } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
 import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
-import { Serializable } from '@fluidframework/datastore-definitions/internal';
+import type { Serializable } from '@fluidframework/datastore-definitions/internal';
 import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
 
 ```
diff --git a/packages/dds/cell/src/cell.ts b/packages/dds/cell/src/cell.ts
@@ -4,29 +4,29 @@
  */
 
 import { assert, unreachableCase } from "@fluidframework/core-utils/internal";
-import {
-	type IChannelAttributes,
-	type IFluidDataStoreRuntime,
-	type Serializable,
-	type IChannelStorageService,
+import type {
+	IChannelAttributes,
+	IFluidDataStoreRuntime,
+	Serializable,
+	IChannelStorageService,
 } from "@fluidframework/datastore-definitions/internal";
 import {
 	MessageType,
 	type ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import { readAndParse } from "@fluidframework/driver-utils/internal";
-import {
-	type ISummaryTreeWithStats,
-	type AttributionKey,
+import type {
+	ISummaryTreeWithStats,
+	AttributionKey,
 } from "@fluidframework/runtime-definitions/internal";
-import { type IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
 import { SharedObject, createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
 
-import {
-	type ICellLocalOpMetadata,
-	type ICellOptions,
-	type ISharedCell,
-	type ISharedCellEvents,
+import type {
+	ICellLocalOpMetadata,
+	ICellOptions,
+	ISharedCell,
+	ISharedCellEvents,
 } from "./interfaces.js";
 
 /**

diff --git a/packages/dds/cell/src/cellFactory.ts b/packages/dds/cell/src/cellFactory.ts
@@ -3,16 +3,16 @@
  * Licensed under the MIT License.
  */
 
-import {
-	type IChannelAttributes,
-	type IChannelFactory,
-	type IFluidDataStoreRuntime,
-	type IChannelServices,
+import type {
+	IChannelAttributes,
+	IChannelFactory,
+	IFluidDataStoreRuntime,
+	IChannelServices,
 } from "@fluidframework/datastore-definitions/internal";
 import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { SharedCell as SharedCellClass } from "./cell.js";
-import { type ISharedCell } from "./interfaces.js";
+import type { ISharedCell } from "./interfaces.js";
 import { pkgVersion } from "./packageVersion.js";
 
 /**

diff --git a/packages/dds/cell/src/interfaces.ts b/packages/dds/cell/src/interfaces.ts
@@ -3,11 +3,11 @@
  * Licensed under the MIT License.
  */
 
-import { type Serializable } from "@fluidframework/datastore-definitions/internal";
-import { type AttributionKey } from "@fluidframework/runtime-definitions/internal";
-import {
-	type ISharedObject,
-	type ISharedObjectEvents,
+import type { Serializable } from "@fluidframework/datastore-definitions/internal";
+import type { AttributionKey } from "@fluidframework/runtime-definitions/internal";
+import type {
+	ISharedObject,
+	ISharedObjectEvents,
 } from "@fluidframework/shared-object-base/internal";
 
 /**

diff --git a/packages/dds/cell/src/test/cell.spec.ts b/packages/dds/cell/src/test/cell.spec.ts
@@ -18,7 +18,7 @@ import {
 
 import { SharedCell } from "../cell.js";
 import { CellFactory } from "../cellFactory.js";
-import { type ICellOptions, type ISharedCell } from "../interfaces.js";
+import type { ICellOptions, ISharedCell } from "../interfaces.js";
 
 function createConnectedCell(
 	id: string,

diff --git a/packages/dds/counter/api-report/counter.alpha.api.md b/packages/dds/counter/api-report/counter.alpha.api.md
@@ -4,8 +4,8 @@
 
 ```ts
 
-import { ISharedObject } from '@fluidframework/shared-object-base/internal';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObject } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
 import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
 import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
 

diff --git a/packages/dds/counter/api-report/counter.beta.api.md b/packages/dds/counter/api-report/counter.beta.api.md
@@ -4,8 +4,8 @@
 
 ```ts
 
-import { ISharedObject } from '@fluidframework/shared-object-base/internal';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObject } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
 import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
 import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
 

diff --git a/packages/dds/counter/api-report/counter.public.api.md b/packages/dds/counter/api-report/counter.public.api.md
@@ -4,8 +4,8 @@
 
 ```ts
 
-import { ISharedObject } from '@fluidframework/shared-object-base/internal';
-import { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObject } from '@fluidframework/shared-object-base/internal';
+import type { ISharedObjectEvents } from '@fluidframework/shared-object-base/internal';
 import { ISharedObjectKind } from '@fluidframework/shared-object-base/internal';
 import { SharedObjectKind } from '@fluidframework/shared-object-base/internal';
 

diff --git a/packages/dds/counter/src/counter.ts b/packages/dds/counter/src/counter.ts
@@ -4,21 +4,21 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import {
-	type IChannelAttributes,
-	type IFluidDataStoreRuntime,
-	type IChannelStorageService,
+import type {
+	IChannelAttributes,
+	IFluidDataStoreRuntime,
+	IChannelStorageService,
 } from "@fluidframework/datastore-definitions/internal";
 import {
 	MessageType,
 	type ISequencedDocumentMessage,
 } from "@fluidframework/driver-definitions/internal";
 import { readAndParse } from "@fluidframework/driver-utils/internal";
-import { type ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
-import { type IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
 import { SharedObject, createSingleBlobSummary } from "@fluidframework/shared-object-base/internal";
 
-import { type ISharedCounter, type ISharedCounterEvents } from "./interfaces.js";
+import type { ISharedCounter, ISharedCounterEvents } from "./interfaces.js";
 
 /**
  * Describes the operation (op) format for incrementing the {@link SharedCounter}.

diff --git a/packages/dds/counter/src/counterFactory.ts b/packages/dds/counter/src/counterFactory.ts
@@ -3,16 +3,16 @@
  * Licensed under the MIT License.
  */
 
-import {
-	type IChannelAttributes,
-	type IChannelFactory,
-	type IFluidDataStoreRuntime,
-	type IChannelServices,
+import type {
+	IChannelAttributes,
+	IChannelFactory,
+	IFluidDataStoreRuntime,
+	IChannelServices,
 } from "@fluidframework/datastore-definitions/internal";
 import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { SharedCounter as SharedCounterClass } from "./counter.js";
-import { type ISharedCounter } from "./interfaces.js";
+import type { ISharedCounter } from "./interfaces.js";
 import { pkgVersion } from "./packageVersion.js";
 
 /**

diff --git a/packages/dds/counter/src/interfaces.ts b/packages/dds/counter/src/interfaces.ts
@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import {
-	type ISharedObject,
-	type ISharedObjectEvents,
+import type {
+	ISharedObject,
+	ISharedObjectEvents,
 } from "@fluidframework/shared-object-base/internal";
 
 /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -241,6 +241,9 @@ @@
             "@typescript-eslint/no-implied-eval": [
                 "error"
             ],
+            "@typescript-eslint/no-import-type-side-effects": [
+                "error"
+            ],
             "@typescript-eslint/no-inferrable-types": [
                 "off"
             ],
@@ Expand Down @@