refactor: rename compiler export to tsc

Author: Lubos

docs/openapi-ts/community/contributing/building.md

@@ -21,3 +21,7 @@ Your [pull request](https://help.github.com/articles/using-pull-requests) must:
 - contain a clean history of small, incremental, logically separate commits, with no merge commits
 - use clear commit messages
 - be possible to merge automatically
+
+## Start `@hey-api/openapi-ts`
+
+Run `pnpm --filter @hey-api/openapi-ts dev`.

packages/openapi-ts/src/generate/client.ts

@@ -4,10 +4,10 @@ import { fileURLToPath } from 'node:url';
 
 import ts from 'typescript';
 
-import type { ImportExportItemObject } from '../compiler/utils';
 import type { Client } from '../plugins/@hey-api/client-core/types';
 import { getClientPlugin } from '../plugins/@hey-api/client-core/utils';
 import type { DefinePlugin } from '../plugins/types';
+import type { ImportExportItemObject } from '../tsc/utils';
 import type { Config } from '../types/config';
 import { ensureDirSync, relativeModulePath } from './utils';
 

packages/openapi-ts/src/generate/file/index.ts

@@ -3,14 +3,11 @@ import path from 'node:path';
 
 import ts from 'typescript';
 
-import { compiler } from '../../compiler';
-import {
-  type ImportExportItemObject,
-  tsNodeToString,
-} from '../../compiler/utils';
 import type { IR } from '../../ir/types';
 import { getUniqueComponentName } from '../../openApi/shared/transforms/utils';
 import { ensureValidIdentifier } from '../../openApi/shared/utils/identifier';
+import { tsc } from '../../tsc';
+import { type ImportExportItemObject, tsNodeToString } from '../../tsc/utils';
 import type { StringCase } from '../../types/case';
 import { stringCase } from '../../utils/stringCase';
 import { ensureDirSync } from '../utils';
@@ -199,7 +196,7 @@ export class GeneratedFile {
   public getNode(id: string): NodeInfo {
     if (!this.nodes[id]) {
       this.nodes[id] = {
-        node: compiler.typeReferenceNode({ typeName: '' }),
+        node: tsc.typeReferenceNode({ typeName: '' }),
       };
     }
     return this.nodes[id]!;
@@ -382,7 +379,7 @@ export class GeneratedFile {
         }
       }
 
-      const node = compiler.namedImportDeclarations({
+      const node = tsc.namedImportDeclarations({
         imports,
         module: resolvedModule,
       });
@@ -421,7 +418,7 @@ export class GeneratedFile {
       components: Object.values(this.names),
     });
     this.names[id] = name;
-    const node = compiler.typeReferenceNode({ typeName: name });
+    const node = tsc.typeReferenceNode({ typeName: name });
     // update node
     if (!this.nodes[id]) {
       this.nodes[id] = { node };

packages/openapi-ts/src/generate/legacy/indexFile.ts

@@ -1,5 +1,5 @@
-import { compiler } from '../../compiler';
 import { getClientPlugin } from '../../plugins/@hey-api/client-core/utils';
+import { tsc } from '../../tsc';
 import type { Files } from '../../types/utils';
 import { getConfig, legacyNameFromConfig } from '../../utils/config';
 import { GeneratedFile } from '../file';
@@ -15,7 +15,7 @@ export const generateIndexFile = ({ files }: { files: Files }): void => {
 
   if (legacyNameFromConfig(config)) {
     files.index.add(
-      compiler.exportNamedDeclaration({
+      tsc.exportNamedDeclaration({
         exports: legacyNameFromConfig(config)!,
         module: `./${legacyNameFromConfig(config)}`,
       }),
@@ -24,22 +24,22 @@ export const generateIndexFile = ({ files }: { files: Files }): void => {
 
   if (config.exportCore) {
     files.index.add(
-      compiler.exportNamedDeclaration({
+      tsc.exportNamedDeclaration({
         exports: 'ApiError',
         module: './core/ApiError',
       }),
     );
     if (config.plugins['@hey-api/sdk']?.config.response === 'response') {
       files.index.add(
-        compiler.exportNamedDeclaration({
+        tsc.exportNamedDeclaration({
           exports: { asType: true, name: 'ApiResult' },
           module: './core/ApiResult',
         }),
       );
     }
     if (legacyNameFromConfig(config)) {
       files.index.add(
-        compiler.exportNamedDeclaration({
+        tsc.exportNamedDeclaration({
           exports: 'BaseHttpRequest',
           module: './core/BaseHttpRequest',
         }),
@@ -48,14 +48,14 @@ export const generateIndexFile = ({ files }: { files: Files }): void => {
     const clientPlugin = getClientPlugin(config);
     if (clientPlugin.name !== 'legacy/angular') {
       files.index.add(
-        compiler.exportNamedDeclaration({
+        tsc.exportNamedDeclaration({
           exports: ['CancelablePromise', 'CancelError'],
           module: './core/CancelablePromise',
         }),
       );
     }
     files.index.add(
-      compiler.exportNamedDeclaration({
+      tsc.exportNamedDeclaration({
         exports: ['OpenAPI', { asType: true, name: 'OpenAPIConfig' }],
         module: './core/OpenAPI',
       }),
@@ -73,7 +73,7 @@ export const generateIndexFile = ({ files }: { files: Files }): void => {
 
       if (file.exportFromIndex) {
         files.index!.add(
-          compiler.exportAllDeclaration({
+          tsc.exportAllDeclaration({
             module: `./${file.nameWithoutExtension()}`,
           }),
         );

packages/openapi-ts/src/generate/output.ts

@@ -2,9 +2,9 @@ import path from 'node:path';
 
 import ts from 'typescript';
 
-import { compiler } from '../compiler';
 import type { IR } from '../ir/types';
 import { getClientPlugin } from '../plugins/@hey-api/client-core/utils';
+import { tsc } from '../tsc';
 import { generateClientBundle } from './client';
 import { findTsConfigPath, loadTsConfig } from './tsConfig';
 import { removeDirSync } from './utils';
@@ -70,9 +70,7 @@ export const generateOutput = async ({ context }: { context: IR.Context }) => {
         }
         // TODO: parser - add export method for more granular control over
         // what's exported so we can support named exports
-        indexFile.add(
-          compiler.exportAllDeclaration({ module: resolvedModule }),
-        );
+        indexFile.add(tsc.exportAllDeclaration({ module: resolvedModule }));
       }
 
       file.write('\n\n', tsConfig);

packages/openapi-ts/src/index.ts

@@ -118,7 +118,6 @@ export const createClient = async (
 export const defineConfig = async (config: Configs): Promise<UserConfig> =>
   typeof config === 'function' ? await config() : config;
 
-export { compiler } from './compiler';
 export { defaultPaginationKeywords } from './config/parser';
 export { defaultPlugins } from './config/plugins';
 export type { IR } from './ir/types';
@@ -140,6 +139,7 @@ export type { Client } from './plugins/@hey-api/client-core/types';
 export type { ExpressionTransformer } from './plugins/@hey-api/transformers/expressions';
 export { definePluginConfig } from './plugins/shared/utils/config';
 export type { DefinePlugin, Plugin } from './plugins/types';
+export { compiler, tsc } from './tsc';
 export type { UserConfig } from './types/config';
 export type { LegacyIR } from './types/types';
 export { utils } from './utils/exports';

packages/openapi-ts/src/plugins/@hey-api/client-core/client.ts

@@ -1,5 +1,5 @@
-import { compiler } from '../../../compiler';
 import { clientModulePath } from '../../../generate/client';
+import { tsc } from '../../../tsc';
 import { parseUrl } from '../../../utils/url';
 import { typesId } from '../typescript/ref';
 import type { PluginHandler } from './types';
@@ -93,24 +93,24 @@ export const createClient = ({ plugin }: Parameters<PluginHandler>[0]) => {
   }
 
   const createConfigParameters = [
-    compiler.callExpression({
+    tsc.callExpression({
       functionName: createConfig.name,
       parameters: defaultValues.length
-        ? [compiler.objectExpression({ obj: defaultValues })]
+        ? [tsc.objectExpression({ obj: defaultValues })]
         : undefined,
       types: clientOptions.name
-        ? [compiler.typeReferenceNode({ typeName: clientOptions.name })]
+        ? [tsc.typeReferenceNode({ typeName: clientOptions.name })]
         : undefined,
     }),
   ];
 
-  const statement = compiler.constVariable({
+  const statement = tsc.constVariable({
     exportConst: true,
-    expression: compiler.callExpression({
+    expression: tsc.callExpression({
       functionName: createClient.name,
       parameters: createClientConfig
         ? [
-            compiler.callExpression({
+            tsc.callExpression({
               functionName: createClientConfig.name,
               parameters: createConfigParameters,
             }),

packages/openapi-ts/src/plugins/@hey-api/client-core/createClientConfig.ts

@@ -1,5 +1,5 @@
-import { compiler } from '../../../compiler';
 import { clientModulePath } from '../../../generate/client';
+import { tsc } from '../../../tsc';
 import { clientId } from '../client-core/utils';
 import { typesId } from '../typescript/ref';
 import type { PluginHandler } from './types';
@@ -34,12 +34,12 @@ export const createClientConfigType = ({
     name: 'ClientOptions',
   });
 
-  const defaultClientOptionsType = compiler.typeReferenceNode({
+  const defaultClientOptionsType = tsc.typeReferenceNode({
     typeName: defaultClientOptions.name,
   });
-  const tType = compiler.typeReferenceNode({ typeName: 'T' });
+  const tType = tsc.typeReferenceNode({ typeName: 'T' });
 
-  const typeCreateClientConfig = compiler.typeAliasDeclaration({
+  const typeCreateClientConfig = tsc.typeAliasDeclaration({
     comment: [
       'The `createClientConfig()` function will be called on client initialization',
       "and the returned object will become the client's initial configuration.",
@@ -50,26 +50,26 @@ export const createClientConfigType = ({
     ],
     exportType: true,
     name: 'CreateClientConfig',
-    type: compiler.functionTypeNode({
+    type: tsc.functionTypeNode({
       parameters: [
-        compiler.parameterDeclaration({
+        tsc.parameterDeclaration({
           name: 'override',
           required: false,
-          type: compiler.typeReferenceNode({
+          type: tsc.typeReferenceNode({
             typeArguments: [
-              compiler.typeIntersectionNode({
+              tsc.typeIntersectionNode({
                 types: [defaultClientOptionsType, tType],
               }),
             ],
             typeName: configType.name,
           }),
         }),
       ],
-      returnType: compiler.typeReferenceNode({
+      returnType: tsc.typeReferenceNode({
         typeArguments: [
-          compiler.typeIntersectionNode({
+          tsc.typeIntersectionNode({
             types: [
-              compiler.typeReferenceNode({
+              tsc.typeReferenceNode({
                 typeArguments: [defaultClientOptionsType],
                 typeName: 'Required',
               }),
@@ -83,7 +83,7 @@ export const createClientConfigType = ({
     typeParameters: [
       {
         default: clientOptions.name
-          ? compiler.typeReferenceNode({ typeName: clientOptions.name })
+          ? tsc.typeReferenceNode({ typeName: clientOptions.name })
           : undefined,
         extends: defaultClientOptionsType,
         name: 'T',

packages/openapi-ts/src/plugins/@hey-api/schemas/plugin-legacy.ts

@@ -1,7 +1,7 @@
-import { compiler } from '../../../compiler';
 import { GeneratedFile } from '../../../generate/file';
 import type { OpenApiV2Schema, OpenApiV3Schema } from '../../../openApi';
 import { ensureValidTypeScriptJavaScriptIdentifier } from '../../../openApi';
+import { tsc } from '../../../tsc';
 import { getConfig } from '../../../utils/config';
 import type { HeyApiSchemasPlugin } from './types';
 
@@ -93,8 +93,8 @@ export const handlerLegacy: HeyApiSchemasPlugin['LegacyHandler'] = ({
     schema: OpenApiV2Schema | OpenApiV3Schema,
   ) => {
     const obj = ensureValidSchemaOutput(schema);
-    const expression = compiler.objectExpression({ obj });
-    const statement = compiler.constVariable({
+    const expression = tsc.objectExpression({ obj });
+    const statement = tsc.constVariable({
       assertion: 'const',
       exportConst: true,
       expression,

packages/openapi-ts/src/plugins/@hey-api/schemas/plugin.ts

@@ -1,10 +1,10 @@
-import { compiler } from '../../../compiler';
 import type { IR } from '../../../ir/types';
 import type { OpenApiV2_0_XTypes } from '../../../openApi/2.0.x';
 import type { OpenApiV3_0_XTypes } from '../../../openApi/3.0.x';
 import type { OpenApiV3_1_XTypes } from '../../../openApi/3.1.x';
 import { ensureValidIdentifier } from '../../../openApi/shared/utils/identifier';
 import type { OpenApi } from '../../../openApi/types';
+import { tsc } from '../../../tsc';
 import type { HeyApiSchemasPlugin } from './types';
 
 const schemasId = 'schemas';
@@ -373,10 +373,10 @@ const schemasV2_0_X = ({
       plugin,
       schema,
     });
-    const statement = compiler.constVariable({
+    const statement = tsc.constVariable({
       assertion: 'const',
       exportConst: true,
-      expression: compiler.objectExpression({ obj }),
+      expression: tsc.objectExpression({ obj }),
       name: schemaName({ name, plugin, schema }),
     });
     context.file({ id: schemasId })!.add(statement);
@@ -401,10 +401,10 @@ const schemasV3_0_X = ({
       plugin,
       schema,
     });
-    const statement = compiler.constVariable({
+    const statement = tsc.constVariable({
       assertion: 'const',
       exportConst: true,
-      expression: compiler.objectExpression({ obj }),
+      expression: tsc.objectExpression({ obj }),
       name: schemaName({ name, plugin, schema }),
     });
     context.file({ id: schemasId })!.add(statement);
@@ -429,10 +429,10 @@ const schemasV3_1_X = ({
       plugin,
       schema,
     });
-    const statement = compiler.constVariable({
+    const statement = tsc.constVariable({
       assertion: 'const',
       exportConst: true,
-      expression: compiler.objectExpression({ obj }),
+      expression: tsc.objectExpression({ obj }),
       name: schemaName({ name, plugin, schema }),
     });
     context.file({ id: schemasId })!.add(statement);