Add type import/export lint rules

emberjs · Nov 16, 2023 · c35ac8a · c35ac8a
1 parent 93c38f4
commit c35ac8a
Show file tree

Hide file tree

Showing 62 changed files with 126 additions and 108 deletions.
diff --git a/config/eslint/typescript.cjs b/config/eslint/typescript.cjs
@@ -3,13 +3,21 @@ function rules(config) {
     {
       '@typescript-eslint/adjacent-overload-signatures': 'error',
       '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/consistent-type-exports': 'error',
+      '@typescript-eslint/consistent-type-imports': [
+        'error',
+        {
+          disallowTypeAnnotations: false,
+        },
+      ],
       'no-loop-func': 'off',
       '@typescript-eslint/no-loop-func': 'error',
       '@typescript-eslint/no-misused-promises': 'off',
       '@typescript-eslint/no-redundant-type-constituents': 'off',
       'no-shadow': 'off',
       '@typescript-eslint/no-shadow': 'error',
       'no-throw-literal': 'off',
+      '@typescript-eslint/no-import-type-side-effects': 'error',
       '@typescript-eslint/no-inferrable-types': 'error',
       '@typescript-eslint/no-meaningless-void-operator': 'error',
       '@typescript-eslint/no-throw-literal': 'error',
@@ -29,6 +37,9 @@ function rules(config) {
       '@typescript-eslint/prefer-reduce-type-parameter': 'error',
       '@typescript-eslint/prefer-return-this-type': 'error',
       '@typescript-eslint/prefer-ts-expect-error': 'error',
+      // Doesn't work properly with type imports
+      // 'import/no-duplicates': 'off',
+      // 'no-duplicate-imports': 'error',
       'prefer-const': 'error',
       'prefer-rest-params': 'off',
     },

diff --git a/packages/active-record/src/-private/builders/-utils.ts b/packages/active-record/src/-private/builders/-utils.ts
@@ -1,4 +1,4 @@
-import { type UrlOptions } from '@ember-data/request-utils';
+import type { UrlOptions } from '@ember-data/request-utils';
 import type { CacheOptions, ConstrainedRequestOptions } from '@warp-drive/core-types/request';
 
 export function copyForwardUrlOptions(urlOptions: UrlOptions, options: ConstrainedRequestOptions): void {

diff --git a/packages/active-record/src/-private/builders/save-record.ts b/packages/active-record/src/-private/builders/save-record.ts
@@ -11,7 +11,7 @@ import {
 } from '@ember-data/request-utils';
 import { recordIdentifierFor } from '@ember-data/store';
 import type { StableExistingRecordIdentifier, StableRecordIdentifier } from '@warp-drive/core-types/identifier';
-import {
+import type {
   ConstrainedRequestOptions,
   CreateRequestOptions,
   DeleteRequestOptions,

diff --git a/packages/adapter/src/index.ts b/packages/adapter/src/index.ts
@@ -197,7 +197,7 @@ import type {
   AdapterPayload,
   MinimumAdapterInterface,
 } from '@ember-data/legacy-compat/legacy-network-handler/minimum-adapter-interface';
-import { SerializerOptions } from '@ember-data/legacy-compat/legacy-network-handler/minimum-serializer-interface';
+import type { SerializerOptions } from '@ember-data/legacy-compat/legacy-network-handler/minimum-serializer-interface';
 import type Store from '@ember-data/store';
 import type { ModelSchema } from '@ember-data/store/-types/q/ds-model';
 

diff --git a/packages/adapter/src/rest.ts b/packages/adapter/src/rest.ts
@@ -16,7 +16,7 @@ import type { ModelSchema } from '@ember-data/store/-types/q/ds-model';
 import type { HTTPMethod } from '@warp-drive/core-types/request';
 
 import { determineBodyPromise, fetch, parseResponseHeaders, serializeIntoHash, serializeQueryParams } from './-private';
-import { MixtBuildURLMixin } from './-private/build-url-mixin';
+import type { MixtBuildURLMixin } from './-private/build-url-mixin';
 import type { FastBoot } from './-private/fastboot-interface';
 import AdapterError, {
   AbortError,

diff --git a/packages/core-types/src/cache.ts b/packages/core-types/src/cache.ts
@@ -1,17 +1,16 @@
 /**
  * @module @ember-data/experimental-preview-types
  */
-import { ResourceBlob } from './cache/aliases';
-import { Change } from './cache/change';
-import { Mutation } from './cache/mutations';
-import { Operation } from './cache/operations';
+import type { ResourceBlob } from './cache/aliases';
+import type { Change } from './cache/change';
+import type { Mutation } from './cache/mutations';
+import type { Operation } from './cache/operations';
 import type { CollectionRelationship, ResourceRelationship } from './cache/relationship';
-import type { StableRecordIdentifier } from './identifier';
-import { StableDocumentIdentifier } from './identifier';
+import type { StableDocumentIdentifier, StableRecordIdentifier } from './identifier';
 import type { Value } from './json/raw';
 import type { RequestContext, StructuredDataDocument, StructuredDocument } from './request';
-import { ResourceDocument, SingleResourceDataDocument } from './spec/document';
-import { ApiError } from './spec/error';
+import type { ResourceDocument, SingleResourceDataDocument } from './spec/document';
+import type { ApiError } from './spec/error';
 
 /**
  * A hash of changed attributes with the key being the attribute name and the value being an

diff --git a/packages/core-types/src/spec/raw.ts b/packages/core-types/src/spec/raw.ts
@@ -1,7 +1,7 @@
 /*
   @module @warp-drive/core-types
 */
-import { ArrayValue, ObjectValue } from '../json/raw';
+import type { ArrayValue, ObjectValue } from '../json/raw';
 
 export type Meta = ObjectValue;
 export type LinkObject = { href: string; meta?: Meta };

diff --git a/packages/diagnostic/src/-types.ts b/packages/diagnostic/src/-types.ts
@@ -1,4 +1,4 @@
-import { SuiteReport } from './-types/report';
+import type { SuiteReport } from './-types/report';
 
 export type CompatTestReport = {
   id: number;

diff --git a/packages/diagnostic/src/-utils.ts b/packages/diagnostic/src/-utils.ts
@@ -1,5 +1,5 @@
 /* global window, globalThis, global, self */
-import { GlobalHooksStorage, HooksCallback, ModuleInfo, TestContext } from './-types';
+import type { GlobalHooksStorage, HooksCallback, ModuleInfo, TestContext } from './-types';
 
 export function assert(message: string, test: unknown): asserts test {
   if (!test) {

diff --git a/packages/diagnostic/src/ember.ts b/packages/diagnostic/src/ember.ts
@@ -1,4 +1,5 @@
-import { getTestMetadata, setupContext, SetupContextOptions, teardownContext, TestContext } from '@ember/test-helpers';
+import type { SetupContextOptions, TestContext } from '@ember/test-helpers';
+import { getTestMetadata, setupContext, teardownContext } from '@ember/test-helpers';
 
 import AbstractTestLoader from 'ember-cli-test-loader/test-support/index';
 

diff --git a/packages/diagnostic/src/emitters/diagnostic.ts b/packages/diagnostic/src/emitters/diagnostic.ts
@@ -1,5 +1,5 @@
-import { CompatTestReport, Emitter } from '../-types';
-import { SuiteReport } from '../-types/report';
+import type { CompatTestReport, Emitter } from '../-types';
+import type { SuiteReport } from '../-types/report';
 import { assert } from '../-utils';
 
 type EmitEvent = {

diff --git a/packages/diagnostic/src/emitters/testem.ts b/packages/diagnostic/src/emitters/testem.ts
@@ -1,5 +1,5 @@
-import { CompatTestReport, Emitter } from '../-types';
-import { SuiteReport } from '../-types/report';
+import type { CompatTestReport, Emitter } from '../-types';
+import type { SuiteReport } from '../-types/report';
 import { assert } from '../-utils';
 
 type TestemSocket = {

diff --git a/packages/diagnostic/src/index.ts b/packages/diagnostic/src/index.ts
@@ -1,5 +1,5 @@
-import { ModuleCallback, ModuleInfo, OrderedMap, TestCallback, TestContext, TestInfo } from './-types';
-import { SuiteReport } from './-types/report';
+import type { ModuleCallback, ModuleInfo, OrderedMap, TestCallback, TestContext, TestInfo } from './-types';
+import type { SuiteReport } from './-types/report';
 import { assert, generateHash } from './-utils';
 import { Config, getCurrentModule, HooksDelegate, instrument, setCurrentModule } from './internals/config';
 import { DelegatingReporter } from './internals/delegating-reporter';

diff --git a/packages/diagnostic/src/internals/config.ts b/packages/diagnostic/src/internals/config.ts
@@ -1,5 +1,5 @@
 /* global Testem */
-import {
+import type {
   GlobalCallback,
   GlobalConfig,
   GlobalHooks,

diff --git a/packages/diagnostic/src/internals/delegating-reporter.ts b/packages/diagnostic/src/internals/delegating-reporter.ts
@@ -1,4 +1,4 @@
-import { Reporter, SuiteReport } from '../-types/report';
+import type { Reporter, SuiteReport } from '../-types/report';
 
 const Reporters = new Set<Reporter>();
 export function registerReporter(reporter: Reporter) {

diff --git a/packages/diagnostic/src/internals/diagnostic.ts b/packages/diagnostic/src/internals/diagnostic.ts
@@ -1,5 +1,5 @@
-import { GlobalConfig, TestContext, TestInfo } from '../-types';
-import { DiagnosticReport, Reporter, TestReport } from '../-types/report';
+import type { GlobalConfig, TestContext, TestInfo } from '../-types';
+import type { DiagnosticReport, Reporter, TestReport } from '../-types/report';
 import equiv from '../legacy/equiv';
 
 class InternalCompat<TC extends TestContext> {

diff --git a/packages/diagnostic/src/internals/run.ts b/packages/diagnostic/src/internals/run.ts
@@ -1,5 +1,5 @@
-import { HooksCallback, ModuleInfo, TestContext, TestInfo } from '../-types';
-import { ModuleReport, TestReport } from '../-types/report';
+import type { HooksCallback, ModuleInfo, TestContext, TestInfo } from '../-types';
+import type { ModuleReport, TestReport } from '../-types/report';
 import { getChain } from '../-utils';
 import { Config, groupLogs, instrument } from './config';
 import { DelegatingReporter } from './delegating-reporter';

diff --git a/packages/diagnostic/src/reporters/dom.ts b/packages/diagnostic/src/reporters/dom.ts
@@ -1,5 +1,5 @@
-import { CompatTestReport, Emitter } from '../-types';
-import { DiagnosticReport, ModuleReport, Reporter, SuiteReport, TestReport } from '../-types/report';
+import type { CompatTestReport, Emitter } from '../-types';
+import type { DiagnosticReport, ModuleReport, Reporter, SuiteReport, TestReport } from '../-types/report';
 import { getSettings, updateConfigValue, updateSuiteState } from '../internals/config';
 
 type SuiteLayout = {

diff --git a/packages/diagnostic/src/runners/dom.ts b/packages/diagnostic/src/runners/dom.ts
@@ -1,7 +1,8 @@
 import { registerReporter, start as _start } from '../';
 import type { Emitter } from '../-types';
 import { assert, getGlobal } from '../-utils';
-import { ConfigOptions, configure, getSettings } from '../internals/config';
+import type { ConfigOptions} from '../internals/config';
+import { configure, getSettings } from '../internals/config';
 import { DOMReporter } from '../reporters/dom';
 
 export async function start(config?: ConfigOptions) {

diff --git a/packages/graph/src/-private/-diff.ts b/packages/graph/src/-private/-diff.ts
@@ -7,8 +7,8 @@ import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import { isBelongsTo } from './-utils';
 import { assertPolymorphicType } from './debug/assert-polymorphic-type';
 import type { CollectionEdge } from './edges/collection';
-import { ResourceEdge } from './edges/resource';
-import { Graph } from './graph';
+import type { ResourceEdge } from './edges/resource';
+import type { Graph } from './graph';
 import replaceRelatedRecord from './operations/replace-related-record';
 import replaceRelatedRecords from './operations/replace-related-records';
 

diff --git a/packages/graph/src/-private/-utils.ts b/packages/graph/src/-private/-utils.ts
@@ -6,9 +6,9 @@ import { peekCache } from '@ember-data/store/-private';
 import type { CacheCapabilitiesManager } from '@ember-data/store/-types/q/cache-store-wrapper';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { UpdateRelationshipOperation } from '@warp-drive/core-types/graph';
-import { ResourceIdentifierObject } from '@warp-drive/core-types/spec/raw';
+import type { ResourceIdentifierObject } from '@warp-drive/core-types/spec/raw';
 
-import { UpgradedMeta } from './-edge-definition';
+import type { UpgradedMeta } from './-edge-definition';
 import { coerceId } from './coerce-id';
 import type { CollectionEdge } from './edges/collection';
 import type { ImplicitEdge } from './edges/implicit';

diff --git a/packages/graph/src/-private/graph.ts b/packages/graph/src/-private/graph.ts
@@ -2,7 +2,7 @@ import { assert } from '@ember/debug';
 
 import { LOG_GRAPH } from '@ember-data/debugging';
 import { DEBUG } from '@ember-data/env';
-import { MergeOperation } from '@ember-data/store/-types/q/cache';
+import type { MergeOperation } from '@ember-data/store/-types/q/cache';
 import type { CacheCapabilitiesManager } from '@ember-data/store/-types/q/cache-store-wrapper';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { RelationshipDiff } from '@warp-drive/core-types/cache';
@@ -29,7 +29,8 @@ import {
   removeIdentifierCompletelyFromRelationship,
 } from './-utils';
 import { type CollectionEdge, createCollectionEdge, legacyGetCollectionRelationshipData } from './edges/collection';
-import { createImplicitEdge, ImplicitEdge, ImplicitMeta } from './edges/implicit';
+import type { ImplicitEdge, ImplicitMeta } from './edges/implicit';
+import { createImplicitEdge } from './edges/implicit';
 import { createResourceEdge, legacyGetResourceRelationshipData, type ResourceEdge } from './edges/resource';
 import addToRelatedRecords from './operations/add-to-related-records';
 import { mergeIdentifier } from './operations/merge-identifier';

diff --git a/packages/graph/src/-private/operations/update-relationship.ts b/packages/graph/src/-private/operations/update-relationship.ts
@@ -1,6 +1,6 @@
 import { assert, warn } from '@ember/debug';
 
-import { IdentifierCache } from '@ember-data/store/-private/caches/identifier-cache';
+import type { IdentifierCache } from '@ember-data/store/-private/caches/identifier-cache';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { UpdateRelationshipOperation } from '@warp-drive/core-types/graph';
 import type { ExistingResourceIdentifierObject, NewResourceIdentifierObject } from '@warp-drive/core-types/spec/raw';

diff --git a/packages/json-api/src/-private/builders/-utils.ts b/packages/json-api/src/-private/builders/-utils.ts
@@ -1,13 +1,9 @@
 /**
  * @module @ember-data/json-api/request
  */
-import {
-  buildQueryParams as buildParams,
-  BuildURLConfig,
-  setBuildURLConfig as setConfig,
-} from '@ember-data/request-utils';
-import { type UrlOptions } from '@ember-data/request-utils';
-import { QueryParamsSource } from '@warp-drive/core-types/params';
+import type { BuildURLConfig, UrlOptions } from '@ember-data/request-utils';
+import { buildQueryParams as buildParams, setBuildURLConfig as setConfig } from '@ember-data/request-utils';
+import type { QueryParamsSource } from '@warp-drive/core-types/params';
 import type { CacheOptions, ConstrainedRequestOptions } from '@warp-drive/core-types/request';
 
 export interface JSONAPIConfig extends BuildURLConfig {

diff --git a/packages/json-api/src/-private/builders/save-record.ts b/packages/json-api/src/-private/builders/save-record.ts
@@ -10,7 +10,7 @@ import {
 } from '@ember-data/request-utils';
 import { recordIdentifierFor } from '@ember-data/store';
 import type { StableExistingRecordIdentifier, StableRecordIdentifier } from '@warp-drive/core-types/identifier';
-import {
+import type {
   ConstrainedRequestOptions,
   CreateRequestOptions,
   DeleteRequestOptions,

diff --git a/packages/json-api/src/-private/cache.ts b/packages/json-api/src/-private/cache.ts
@@ -29,7 +29,7 @@ import type {
   StableExistingRecordIdentifier,
   StableRecordIdentifier,
 } from '@warp-drive/core-types/identifier';
-import { Value } from '@warp-drive/core-types/json/raw';
+import type { Value } from '@warp-drive/core-types/json/raw';
 import type {
   StructuredDataDocument,
   StructuredDocument,

diff --git a/packages/legacy-compat/src/legacy-network-handler/fetch-manager.ts b/packages/legacy-compat/src/legacy-network-handler/fetch-manager.ts
@@ -20,7 +20,7 @@ import type { CollectionResourceDocument, SingleResourceDocument } from '@warp-d
 import { upgradeStore } from '../-private';
 import { assertIdentifierHasId } from './identifier-has-id';
 import { payloadIsNotBlank } from './legacy-data-utils';
-import { AdapterPayload, MinimumAdapterInterface } from './minimum-adapter-interface';
+import type { AdapterPayload, MinimumAdapterInterface } from './minimum-adapter-interface';
 import type { MinimumSerializerInterface } from './minimum-serializer-interface';
 import { normalizeResponseHelper } from './serializer-response';
 import Snapshot from './snapshot';

diff --git a/packages/model/src/-private/hooks.ts b/packages/model/src/-private/hooks.ts
@@ -6,7 +6,7 @@ import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { Cache } from '@warp-drive/core-types/cache';
 
 import type { ModelStore } from './model';
-import Model from './model';
+import type Model from './model';
 import { getModelFactory } from './schema-provider';
 import { normalizeModelName } from './util';
 

diff --git a/packages/model/src/-private/many-array.ts b/packages/model/src/-private/many-array.ts
@@ -12,7 +12,7 @@ import {
   recordIdentifierFor,
   SOURCE,
 } from '@ember-data/store/-private';
-import { IdentifierArrayCreateOptions } from '@ember-data/store/-private/record-arrays/identifier-array';
+import type { IdentifierArrayCreateOptions } from '@ember-data/store/-private/record-arrays/identifier-array';
 import type { CreateRecordProperties } from '@ember-data/store/-private/store-service';
 import type { Cache } from '@ember-data/store/-types/q/cache';
 import type { ModelSchema } from '@ember-data/store/-types/q/ds-model';
@@ -21,7 +21,7 @@ import type { FindOptions } from '@ember-data/store/-types/q/store';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
 import type { Links, PaginationLinks } from '@warp-drive/core-types/spec/raw';
 
-import { LegacySupport } from './legacy-relationships-support';
+import type { LegacySupport } from './legacy-relationships-support';
 
 export interface ManyArrayCreateArgs {
   identifiers: StableRecordIdentifier[];

diff --git a/packages/model/src/-private/model-methods.ts b/packages/model/src/-private/model-methods.ts
@@ -3,13 +3,14 @@ import { assert } from '@ember/debug';
 import { importSync } from '@embroider/macros';
 
 import { upgradeStore } from '@ember-data/legacy-compat/-private';
-import Store, { recordIdentifierFor } from '@ember-data/store';
+import type Store from '@ember-data/store';
+import { recordIdentifierFor } from '@ember-data/store';
 import { peekCache } from '@ember-data/store/-private';
 import { RecordStore } from '@warp-drive/core-types/symbols';
 
-import Errors from './errors';
+import type Errors from './errors';
 import { lookupLegacySupport } from './legacy-relationships-support';
-import RecordState from './record-state';
+import type RecordState from './record-state';
 
 export interface MinimalLegacyRecord {
   errors: Errors;

diff --git a/packages/model/src/-private/notify-changes.ts b/packages/model/src/-private/notify-changes.ts
@@ -4,7 +4,7 @@ import { cacheFor } from '@ember/object/internals';
 import type Store from '@ember-data/store';
 import type { NotificationType } from '@ember-data/store/-private/managers/notification-manager';
 import type { StableRecordIdentifier } from '@warp-drive/core-types';
-import { RelationshipSchema } from '@warp-drive/core-types/schema';
+import type { RelationshipSchema } from '@warp-drive/core-types/schema';
 
 import { LEGACY_SUPPORT } from './legacy-relationships-support';
 import type Model from './model';

diff --git a/packages/model/src/-private/promise-belongs-to.ts b/packages/model/src/-private/promise-belongs-to.ts
@@ -7,7 +7,7 @@ import type Store from '@ember-data/store';
 import type { RecordInstance } from '@ember-data/store/-types/q/record-instance';
 import { cached } from '@ember-data/tracking';
 
-import { LegacySupport } from './legacy-relationships-support';
+import type { LegacySupport } from './legacy-relationships-support';
 import { PromiseObject } from './promise-proxy-base';
 import type BelongsToReference from './references/belongs-to';
 

diff --git a/packages/model/src/-private/promise-many-array.ts b/packages/model/src/-private/promise-many-array.ts
@@ -1,7 +1,7 @@
 import { assert } from '@ember/debug';
 
 import { DEPRECATE_COMPUTED_CHAINS } from '@ember-data/deprecations';
-import { FindOptions } from '@ember-data/store/-types/q/store';
+import type { FindOptions } from '@ember-data/store/-types/q/store';
 import { compat } from '@ember-data/tracking';
 import { defineSignal } from '@ember-data/tracking/-private';
 

diff --git a/packages/model/src/-private/references/belongs-to.ts b/packages/model/src/-private/references/belongs-to.ts
@@ -17,7 +17,8 @@ import type {
 } from '@warp-drive/core-types/spec/raw';
 
 import { assertPolymorphicType } from '../debug/assert-polymorphic-type';
-import { areAllInverseRecordsLoaded, LEGACY_SUPPORT, LegacySupport } from '../legacy-relationships-support';
+import type { LegacySupport } from '../legacy-relationships-support';
+import { areAllInverseRecordsLoaded, LEGACY_SUPPORT } from '../legacy-relationships-support';
 
 /**
   @module @ember-data/model

diff --git a/packages/model/src/-private/references/has-many.ts b/packages/model/src/-private/references/has-many.ts
@@ -21,7 +21,8 @@ import type {
 } from '@warp-drive/core-types/spec/raw';
 
 import { assertPolymorphicType } from '../debug/assert-polymorphic-type';
-import { areAllInverseRecordsLoaded, LEGACY_SUPPORT, LegacySupport } from '../legacy-relationships-support';
+import type { LegacySupport } from '../legacy-relationships-support';
+import { areAllInverseRecordsLoaded, LEGACY_SUPPORT } from '../legacy-relationships-support';
 import type ManyArray from '../many-array';
 
 /**

diff --git a/packages/model/src/-private/schema-provider.ts b/packages/model/src/-private/schema-provider.ts
@@ -6,7 +6,7 @@ import type { RecordIdentifier } from '@warp-drive/core-types/identifier';
 import type { AttributesSchema, RelationshipsSchema } from '@warp-drive/core-types/schema';
 
 import type { FactoryCache, ModelFactory, ModelStore } from './model';
-import Model from './model';
+import type Model from './model';
 import _modelForMixin from './model-for-mixin';
 import { normalizeModelName } from './util';