chore: clean up types

Author: mrlubos

.changeset/warn-duplicate-plugins.md

@@ -1,5 +1,6 @@
 ---
 "@hey-api/openapi-ts": patch
+"@hey-api/shared": patch
 ---
 
-Warn when the same plugin is specified multiple times in the plugins array
+**config**: warn on duplicated plugin configurations

packages/openapi-python/src/config/plugins.ts

@@ -2,7 +2,7 @@ import type { AnyPluginName, PluginContext, PluginNames } from '@hey-api/shared'
 import {
   dependencyFactory,
   valueToObject,
-  warnDuplicatePlugins,
+  warnOnConflictingDuplicatePlugins,
 } from '@hey-api/shared';
 
 import { defaultPluginConfigs } from '../plugins/config';
@@ -147,7 +147,7 @@ export function getPlugins({
     }
   }
 
-  warnDuplicatePlugins(definedPlugins as ReadonlyArray<never>);
+  warnOnConflictingDuplicatePlugins(definedPlugins);
 
   const userPlugins = definedPlugins
     .map((plugin) => {

packages/openapi-ts/src/__tests__/index.test.ts

@@ -286,218 +286,6 @@ describe('createClient', () => {
     expect(results).toHaveLength(4);
   });
 
-  describe('duplicate plugin warnings', () => {
-    const baseConfig = {
-      dryRun: true as const,
-      input: {
-        info: { title: 'duplicate-plugin-test', version: '1.0.0' },
-        openapi: '3.1.0' as const,
-      },
-      logs: {
-        level: 'silent' as const,
-      },
-      output: 'output',
-    };
-
-    const conflictWarnings = (warnSpy: ReturnType<typeof vi.spyOn>) =>
-      warnSpy.mock.calls.filter(
-        (args: unknown[]) => typeof args[0] === 'string' && args[0].includes('conflicting options'),
-      );
-
-    it('warns when the same plugin is specified with conflicting options', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          { case: 'PascalCase', name: '@hey-api/typescript' },
-          { case: 'camelCase', name: '@hey-api/typescript' },
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(1);
-      expect(warnSpy).toHaveBeenCalledWith(expect.stringContaining('"@hey-api/typescript"'));
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when the same plugin is specified twice as a string', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: ['@hey-api/typescript', '@hey-api/typescript'],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when a string and an object with only name are specified', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: ['@hey-api/typescript', { name: '@hey-api/typescript' }],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when two identical object configurations are specified', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          { case: 'PascalCase', name: '@hey-api/typescript' },
-          { case: 'PascalCase', name: '@hey-api/typescript' },
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when objects differ only in key order', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          { case: 'PascalCase', name: '@hey-api/typescript' },
-          { name: '@hey-api/typescript', case: 'PascalCase' },
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when nested object configs differ only in key order', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          {
-            definitions: { case: 'PascalCase', name: 'foo' },
-            name: '@hey-api/typescript',
-          },
-          {
-            name: '@hey-api/typescript',
-            definitions: { name: 'foo', case: 'PascalCase' },
-          },
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('warns when an object adds extra config compared to a string entry', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: ['@hey-api/typescript', { case: 'PascalCase', name: '@hey-api/typescript' }],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(1);
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when array-valued options differ only in element key order', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          {
-            items: [{ from: 'foo', name: 'bar' }],
-            name: '@hey-api/typescript',
-          } as never,
-          {
-            items: [{ name: 'bar', from: 'foo' }],
-            name: '@hey-api/typescript',
-          } as never,
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('warns when array-valued options differ in element order', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          {
-            items: [{ from: 'a', name: 'x' }, { from: 'b', name: 'y' }],
-            name: '@hey-api/typescript',
-          } as never,
-          {
-            items: [{ from: 'b', name: 'y' }, { from: 'a', name: 'x' }],
-            name: '@hey-api/typescript',
-          } as never,
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(1);
-
-      warnSpy.mockRestore();
-    });
-
-    it('does not warn when function-valued options have identical source', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-      const transform = (s: string) => s.toUpperCase();
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          { definitions: { name: transform }, name: '@hey-api/typescript' },
-          { definitions: { name: transform }, name: '@hey-api/typescript' },
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(0);
-
-      warnSpy.mockRestore();
-    });
-
-    it('warns when function-valued options differ', async () => {
-      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
-
-      await createClient({
-        ...baseConfig,
-        plugins: [
-          {
-            definitions: { name: (s: string) => s.toUpperCase() },
-            name: '@hey-api/typescript',
-          },
-          {
-            definitions: { name: (s: string) => s.toLowerCase() },
-            name: '@hey-api/typescript',
-          },
-        ],
-      });
-
-      expect(conflictWarnings(warnSpy)).toHaveLength(1);
-
-      warnSpy.mockRestore();
-    });
-  });
-
   it('executes @angular/common HttpRequest builder path', async () => {
     const results = await createClient({
       dryRun: true,

packages/openapi-ts/src/config/plugins.ts

@@ -2,7 +2,7 @@ import type { AnyPluginName, PluginContext, PluginNames } from '@hey-api/shared'
 import {
   dependencyFactory,
   valueToObject,
-  warnDuplicatePlugins,
+  warnOnConflictingDuplicatePlugins,
 } from '@hey-api/shared';
 
 import { defaultPluginConfigs } from '../plugins/config';
@@ -150,7 +150,7 @@ export function getPlugins({
     }
   }
 
-  warnDuplicatePlugins(definedPlugins as ReadonlyArray<never>);
+  warnOnConflictingDuplicatePlugins(definedPlugins);
 
   const userPlugins = definedPlugins
     .map((plugin) => {

packages/shared/src/index.ts

@@ -99,7 +99,7 @@ export type {
   OpenApiSchemaObject,
 } from './openApi/types';
 export type { GetNameContext, Hooks } from './parser/hooks';
-export { warnDuplicatePlugins } from './plugins/duplicate';
+export { warnOnConflictingDuplicatePlugins } from './plugins/duplicate';
 export type { SchemaWithType } from './plugins/shared/types/schema';
 export { definePluginConfig, mappers } from './plugins/shared/utils/config';
 export type { PluginInstanceTypes } from './plugins/shared/utils/instance';