chore: import type lint rule and fixes (#1039)

Inspired by [this comment](#1020 (comment)) I've added a lint rule to enforce `import type`, and some additional package changes to add a `lint:fix`. The only changes I made manually here is to add the lint rule, and the package.json script. All the changes are auto-generated by the `lint:fix`. --------- Signed-off-by: Todd Baert <[email protected]>
open-feature · Oct 16, 2024 · 01fcb93 · 01fcb93
1 parent 924802b
commit 01fcb93
Show file tree

Hide file tree

Showing 93 changed files with 348 additions and 278 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,63 +1,54 @@
 {
-	"env": {
-		"browser": true,
-		"es2021": true
-	},
-	"ignorePatterns": ["**/dist/**/*"],
-	"extends": [
-		"eslint:recommended",
-		"plugin:@typescript-eslint/recommended",
-		"prettier",
-		"plugin:jsdoc/recommended"
-	],
-	"parser": "@typescript-eslint/parser",
-	"parserOptions": {
-		"ecmaVersion": "latest",
-		"sourceType": "module"
-	},
-	"plugins": [
-		"@typescript-eslint",
-		"check-file",
-		"jsdoc"
-	],
-	"rules": {
-		"jsdoc/require-jsdoc": [
-			"warn",
-			{
-				"publicOnly": true
-			}
-		],
-		"jsdoc/check-tag-names": [
-			"warn",
-			{
-				"definedTags": [
-					"experimental"
-				]
-			}
-		],
-		"linebreak-style": [
-			"error",
-			"unix"
-		],
-		"quotes": [
-			"error",
-			"single",
-			{
-				"avoidEscape": true
-			}
-		],
-		"semi": [
-			"error",
-			"always"
-		],
-		"check-file/filename-naming-convention": [
-			"error",
-			{
-				"**/*.{js,ts}": "KEBAB_CASE"
-			},
-			{
-				"ignoreMiddleExtensions": true
-			}
-		]
-	}
-}
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "ignorePatterns": ["**/dist/**/*"],
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier", "plugin:jsdoc/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "check-file", "jsdoc"],
+  "rules": {
+    "@typescript-eslint/consistent-type-imports": [
+      "error",
+      {
+        "disallowTypeAnnotations": true,
+        "fixStyle": "separate-type-imports",
+        "prefer": "type-imports"
+      }
+    ],
+    "jsdoc/require-jsdoc": [
+      "warn",
+      {
+        "publicOnly": true
+      }
+    ],
+    "jsdoc/check-tag-names": [
+      "warn",
+      {
+        "definedTags": ["experimental"]
+      }
+    ],
+    "linebreak-style": ["error", "unix"],
+    "quotes": [
+      "error",
+      "single",
+      {
+        "avoidEscape": true
+      }
+    ],
+    "semi": ["error", "always"],
+    "check-file/filename-naming-convention": [
+      "error",
+      {
+        "**/*.{js,ts}": "KEBAB_CASE"
+      },
+      {
+        "ignoreMiddleExtensions": true
+      }
+    ]
+  }
+}
diff --git a/package.json b/package.json
@@ -9,6 +9,7 @@
     "e2e-web": "git submodule update --init --recursive && shx cp test-harness/features/evaluation.feature packages/web/e2e/features && jest --selectProjects=web-e2e --verbose",
     "e2e": "npm run e2e-server && npm run e2e-web",
     "lint": "npm run lint --workspace=packages/shared --workspace=packages/server --workspace=packages/web --workspace=packages/react --workspace=packages/angular --workspace=packages/nest",
+    "lint:fix": "npm run lint:fix --workspace=packages/shared --workspace=packages/server --workspace=packages/web --workspace=packages/react --workspace=packages/angular --workspace=packages/nest",
     "clean": "shx rm -rf ./dist",
     "build": "npm run build --workspace=packages/shared --workspace=packages/server --workspace=packages/web --workspace=packages/react --workspace=packages/angular --workspace=packages/nest",
     "publish-all": "npm run publish-if-not-exists --workspace=packages/shared --workspace=packages/server --workspace=packages/web --workspace=packages/react --workspace=packages/angular --workspace=packages/nest",

diff --git a/packages/angular/angular.json b/packages/angular/angular.json
@@ -39,6 +39,7 @@
   "cli": {
     "schematicCollections": [
       "@angular-eslint/schematics"
-    ]
+    ],
+    "analytics": false
   }
 }
diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -5,6 +5,7 @@
     "ng": "ng",
     "start": "ng serve",
     "lint": "ng lint",
+    "lint:fix": "ng lint --fix",
     "watch": "ng build --watch --configuration development",
     "test": "jest",
     "build": "ng build && npm run postbuild",

diff --git a/packages/nest/package.json b/packages/nest/package.json
@@ -16,6 +16,7 @@
   "scripts": {
     "test": "jest --verbose",
     "lint": "eslint ./",
+    "lint:fix": "eslint ./ --fix",
     "clean": "shx rm -rf ./dist",
     "build:esm": "esbuild src/index.ts --bundle --external:@nestjs/* --external:@openfeature/server-sdk --sourcemap --target=es2015 --platform=node --format=esm --outfile=./dist/esm/index.js --analyze",
     "build:cjs": "esbuild src/index.ts --bundle --external:@nestjs/* --external:@openfeature/server-sdk --sourcemap --target=es2015 --platform=node --format=cjs --outfile=./dist/cjs/index.js --analyze",
@@ -60,4 +61,4 @@
     "@types/supertest": "^6.0.0",
     "supertest": "^7.0.0"
   }
-}
+}
diff --git a/packages/nest/src/context-factory.ts b/packages/nest/src/context-factory.ts
@@ -1,5 +1,6 @@
-import { EvaluationContext } from '@openfeature/core';
-import { ExecutionContext, Inject } from '@nestjs/common';
+import type { EvaluationContext } from '@openfeature/core';
+import type { ExecutionContext} from '@nestjs/common';
+import { Inject } from '@nestjs/common';
 
 /**
  * A factory function for creating an OpenFeature {@link EvaluationContext} from Nest {@link ExecutionContext}.

diff --git a/packages/nest/src/evaluation-context-interceptor.ts b/packages/nest/src/evaluation-context-interceptor.ts
@@ -1,5 +1,7 @@
-import { CallHandler, ExecutionContext, Inject, Injectable, NestInterceptor } from '@nestjs/common';
-import { ContextFactory, ContextFactoryToken } from './context-factory';
+import type { CallHandler, ExecutionContext, NestInterceptor } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
+import type { ContextFactory} from './context-factory';
+import { ContextFactoryToken } from './context-factory';
 import { Observable } from 'rxjs';
 import { OpenFeature } from '@openfeature/server-sdk';
 import { OpenFeatureModule } from './open-feature.module';

diff --git a/packages/nest/src/feature.decorator.ts b/packages/nest/src/feature.decorator.ts
@@ -1,14 +1,16 @@
 import { createParamDecorator, Inject } from '@nestjs/common';
-import {
+import type {
   EvaluationContext,
   EvaluationDetails,
   FlagValue,
-  JsonValue,
+  JsonValue} from '@openfeature/server-sdk';
+import {
   OpenFeature,
   Client,
 } from '@openfeature/server-sdk';
 import { getOpenFeatureClientToken } from './open-feature.module';
-import { from, Observable } from 'rxjs';
+import type { Observable } from 'rxjs';
+import { from } from 'rxjs';
 
 /**
  * Options for injecting an OpenFeature client into a constructor.

diff --git a/packages/nest/src/open-feature.module.ts b/packages/nest/src/open-feature.module.ts
@@ -1,24 +1,27 @@
-import {
+import type {
   DynamicModule,
-  Module,
   FactoryProvider as NestFactoryProvider,
   ValueProvider,
   ClassProvider,
-  Provider as NestProvider,
+  Provider as NestProvider} from '@nestjs/common';
+import {
+  Module,
   ExecutionContext,
 } from '@nestjs/common';
-import {
+import type {
   Client,
   Hook,
-  OpenFeature,
   Provider,
   EvaluationContext,
   ServerProviderEvents,
   EventHandler,
-  Logger,
+  Logger} from '@openfeature/server-sdk';
+import {
+  OpenFeature,
   AsyncLocalStorageTransactionContextPropagator,
 } from '@openfeature/server-sdk';
-import { ContextFactory, ContextFactoryToken } from './context-factory';
+import type { ContextFactory} from './context-factory';
+import { ContextFactoryToken } from './context-factory';
 import { APP_INTERCEPTOR } from '@nestjs/core';
 import { EvaluationContextInterceptor } from './evaluation-context-interceptor';
 import { ShutdownService } from './shutdown.service';

diff --git a/packages/nest/src/shutdown.service.ts b/packages/nest/src/shutdown.service.ts
@@ -1,4 +1,5 @@
-import { Injectable, OnApplicationShutdown } from '@nestjs/common';
+import type { OnApplicationShutdown } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { OpenFeature } from '@openfeature/server-sdk';
 
 @Injectable()

diff --git a/packages/nest/test/fixtures.ts b/packages/nest/test/fixtures.ts
@@ -1,5 +1,5 @@
 import { InMemoryProvider } from '@openfeature/server-sdk';
-import { ExecutionContext } from '@nestjs/common';
+import type { ExecutionContext } from '@nestjs/common';
 import { OpenFeatureModule } from '../src';
 
 export const defaultProvider = new InMemoryProvider({

diff --git a/packages/nest/test/open-feature-sdk.spec.ts b/packages/nest/test/open-feature-sdk.spec.ts
@@ -1,5 +1,6 @@
-import { Test, TestingModule } from '@nestjs/testing';
-import { INestApplication } from '@nestjs/common';
+import type { TestingModule } from '@nestjs/testing';
+import { Test } from '@nestjs/testing';
+import type { INestApplication } from '@nestjs/common';
 import supertest from 'supertest';
 import { OpenFeatureController, OpenFeatureControllerContextScopedController, OpenFeatureTestService } from './test-app';
 import { exampleContextFactory, getOpenFeatureDefaultTestModule } from './fixtures';

diff --git a/packages/nest/test/open-feature.module.spec.ts b/packages/nest/test/open-feature.module.spec.ts
@@ -1,6 +1,8 @@
-import { Test, TestingModule } from '@nestjs/testing';
+import type { TestingModule } from '@nestjs/testing';
+import { Test } from '@nestjs/testing';
 import { getOpenFeatureClientToken, OpenFeatureModule, ServerProviderEvents } from '../src';
-import { Client, OpenFeature } from '@openfeature/server-sdk';
+import type { Client} from '@openfeature/server-sdk';
+import { OpenFeature } from '@openfeature/server-sdk';
 import { getOpenFeatureDefaultTestModule } from './fixtures';
 
 describe('OpenFeatureModule', () => {

diff --git a/packages/nest/test/test-app.ts b/packages/nest/test/test-app.ts
@@ -1,7 +1,8 @@
 import { Controller, Get, Injectable, UseInterceptors } from '@nestjs/common';
-import { Observable, map } from 'rxjs';
+import type { Observable} from 'rxjs';
+import { map } from 'rxjs';
 import { BooleanFeatureFlag, ObjectFeatureFlag, NumberFeatureFlag, OpenFeatureClient, StringFeatureFlag } from '../src';
-import { Client, EvaluationDetails, FlagValue } from '@openfeature/server-sdk';
+import type { Client, EvaluationDetails, FlagValue } from '@openfeature/server-sdk';
 import { EvaluationContextInterceptor } from '../src';
 
 @Injectable()

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -16,6 +16,7 @@
   "scripts": {
     "test": "jest --verbose",
     "lint": "eslint ./",
+    "lint:fix": "eslint ./ --fix",
     "clean": "shx rm -rf ./dist",
     "build:react-esm": "esbuild src/index.ts --bundle  --external:react --external:@openfeature/web-sdk --sourcemap --target=es2015 --platform=browser --format=esm --outfile=./dist/esm/index.js --analyze",
     "build:react-cjs": "esbuild src/index.ts --bundle  --external:react --external:@openfeature/web-sdk --sourcemap --target=es2015 --platform=browser --format=cjs --outfile=./dist/cjs/index.js --analyze",
@@ -53,4 +54,4 @@
     "@openfeature/core": "*",
     "@openfeature/web-sdk": "*"
   }
-}
+}
diff --git a/packages/react/src/common/options.ts b/packages/react/src/common/options.ts
@@ -1,4 +1,4 @@
-import { FlagEvaluationOptions } from '@openfeature/web-sdk';
+import type { FlagEvaluationOptions } from '@openfeature/web-sdk';
 
 export type ReactFlagEvaluationOptions = ({
   /**

diff --git a/packages/react/src/common/suspense.ts b/packages/react/src/common/suspense.ts
@@ -1,4 +1,5 @@
-import { Client, ProviderEvents } from '@openfeature/web-sdk';
+import type { Client} from '@openfeature/web-sdk';
+import { ProviderEvents } from '@openfeature/web-sdk';
 
 /**
  * Suspends until the client is ready to evaluate feature flags.

diff --git a/packages/react/src/evaluation/hook-flag-query.ts b/packages/react/src/evaluation/hook-flag-query.ts
@@ -1,9 +1,10 @@
-import {
+import type {
   EvaluationDetails,
-  FlagValue,
+  FlagValue} from '@openfeature/web-sdk';
+import {
   StandardResolutionReasons
 } from '@openfeature/web-sdk';
-import { FlagQuery } from '../query';
+import type { FlagQuery } from '../query';
 
 
 // FlagQuery implementation, do not export

diff --git a/packages/react/src/evaluation/use-feature-flag.ts b/packages/react/src/evaluation/use-feature-flag.ts
@@ -1,21 +1,23 @@
-import {
+import type {
   Client,
   ClientProviderEvents,
   EvaluationDetails,
   EventHandler,
   FlagEvaluationOptions,
   FlagValue,
-  JsonValue,
+  JsonValue} from '@openfeature/web-sdk';
+import {
   ProviderEvents,
   ProviderStatus,
 } from '@openfeature/web-sdk';
 import { useEffect, useRef, useState } from 'react';
-import { DEFAULT_OPTIONS, ReactFlagEvaluationOptions, normalizeOptions } from '../common/options';
+import type { ReactFlagEvaluationOptions} from '../common/options';
+import { DEFAULT_OPTIONS, normalizeOptions } from '../common/options';
 import { suspendUntilReady } from '../common/suspense';
 import { useProviderOptions } from '../provider/context';
 import { useOpenFeatureClient } from '../provider/use-open-feature-client';
 import { useOpenFeatureClientStatus } from '../provider/use-open-feature-client-status';
-import { FlagQuery } from '../query';
+import type { FlagQuery } from '../query';
 import { HookFlagQuery } from './hook-flag-query';
 import { isEqual } from '../common/is-equal';
 

diff --git a/packages/react/src/provider/context.ts b/packages/react/src/provider/context.ts
@@ -1,6 +1,7 @@
-import { Client } from '@openfeature/web-sdk';
+import type { Client } from '@openfeature/web-sdk';
 import React from 'react';
-import { NormalizedOptions, ReactFlagEvaluationOptions, normalizeOptions } from '../common/options';
+import type { NormalizedOptions, ReactFlagEvaluationOptions} from '../common/options';
+import { normalizeOptions } from '../common/options';
 
 /**
  * The underlying React context.

diff --git a/packages/react/src/provider/provider.tsx b/packages/react/src/provider/provider.tsx
@@ -1,6 +1,7 @@
-import { Client, OpenFeature } from '@openfeature/web-sdk';
+import type { Client} from '@openfeature/web-sdk';
+import { OpenFeature } from '@openfeature/web-sdk';
 import * as React from 'react';
-import { ReactFlagEvaluationOptions } from '../common/options';
+import type { ReactFlagEvaluationOptions } from '../common/options';
 import { Context } from './context';
 
 type ClientOrDomain =

diff --git a/packages/react/src/provider/test-provider.tsx b/packages/react/src/provider/test-provider.tsx
@@ -1,12 +1,13 @@
+import type {
+  JsonValue,
+  Provider} from '@openfeature/web-sdk';
 import {
   InMemoryProvider,
-  JsonValue,
   NOOP_PROVIDER,
-  OpenFeature,
-  Provider,
+  OpenFeature
 } from '@openfeature/web-sdk';
 import React from 'react';
-import { NormalizedOptions } from '../common/options';
+import type { NormalizedOptions } from '../common/options';
 import { OpenFeatureProvider } from './provider';
 
 type FlagValueMap = { [flagKey: string]: JsonValue };

diff --git a/packages/react/src/provider/use-open-feature-client-status.ts b/packages/react/src/provider/use-open-feature-client-status.ts
@@ -1,6 +1,7 @@
 import { useEffect, useState } from 'react';
 import { useOpenFeatureClient } from './use-open-feature-client';
-import { ProviderEvents, ProviderStatus } from '@openfeature/web-sdk';
+import type { ProviderStatus } from '@openfeature/web-sdk';
+import { ProviderEvents } from '@openfeature/web-sdk';
 
 /**
  * Get the {@link ProviderStatus} for the OpenFeatureClient.