chore: format output source files

We now format the generated hooks file to remove unused imports and fix some formatting issues.
7nohe · Apr 23, 2024 · 6c2d13f · 6c2d13f
1 parent 751c6ed
commit 6c2d13f
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 47 deletions.
diff --git a/src/common.mts b/src/common.mts
@@ -9,7 +9,7 @@ import {
   ClassDeclaration,
 } from "ts-morph";
 import { LimitedUserConfig } from "./cli.mjs";
-import { requestsOutputPath } from "./constants.mjs";
+import { queriesOutputPath, requestsOutputPath } from "./constants.mjs";
 
 export const TData = ts.factory.createIdentifier("TData");
 export const TError = ts.factory.createIdentifier("TError");
@@ -163,6 +163,10 @@ export function formatOptions(options: LimitedUserConfig) {
   return formattedOptions;
 }
 
-export function buildOutputPath(outputPath: string) {
+export function buildRequestsOutputPath(outputPath: string) {
   return path.join(outputPath, requestsOutputPath);
 }
+
+export function buildQueriesOutputPath(outputPath: string) {
+  return path.join(outputPath, queriesOutputPath);
+}
diff --git a/src/createImports.mts b/src/createImports.mts
@@ -16,20 +16,14 @@ export const createImports = ({
     .getSourceFiles()
     .find((sourceFile) => sourceFile.getFilePath().includes(modalsFileName));
 
-  const serviceFile = project
-    .getSourceFiles()
-    .find((sourceFile) => sourceFile.getFilePath().includes(serviceFileName));
+  const serviceFile = project.getSourceFileOrThrow(`${serviceFileName}.ts`);
 
   if (!modelsFile) {
     console.warn(`
 ⚠️ WARNING: No models file found.
   This may be an error if \`.components.schemas\` or \`.components.parameters\` is defined in your OpenAPI input.`);
   }
 
-  if (!serviceFile) {
-    throw new Error("No service file found");
-  }
-
   const modelNames = modelsFile
     ? Array.from(modelsFile.getExportedDeclarations().keys())
     : [];
@@ -42,10 +36,6 @@ export const createImports = ({
     name.endsWith(serviceEndName)
   );
 
-  const serviceNamesData = serviceExports.filter((name) =>
-    name.endsWith("Data")
-  );
-
   const imports = [
     ts.factory.createImportDeclaration(
       undefined,
@@ -107,14 +97,6 @@ export const createImports = ({
               ts.factory.createIdentifier(serviceName)
             )
           ),
-          // import all data objects from service file
-          ...serviceNamesData.map((dataName) =>
-            ts.factory.createImportSpecifier(
-              false,
-              undefined,
-              ts.factory.createIdentifier(dataName)
-            )
-          ),
         ])
       ),
       ts.factory.createStringLiteral(join("../requests", serviceFileName)),

diff --git a/src/createSource.mts b/src/createSource.mts
@@ -132,20 +132,22 @@ export const createSource = async ({
   const { commonSource, mainSource, suspenseSource, indexSource } =
     await createSourceFile(outputPath, serviceEndName);
 
+  const comment = `// generated with @7nohe/openapi-react-query-codegen@${version} \n\n`;
+
   const commonResult =
-    `// generated with @7nohe/openapi-react-query-codegen@${version} \n` +
+    comment +
     printer.printNode(ts.EmitHint.Unspecified, commonSource, commonFile);
 
   const mainResult =
-    `// generated with @7nohe/openapi-react-query-codegen@${version} \n` +
+    comment +
     printer.printNode(ts.EmitHint.Unspecified, mainSource, queriesFile);
 
   const suspenseResult =
-    `// generated with @7nohe/openapi-react-query-codegen@${version} \n` +
+    comment +
     printer.printNode(ts.EmitHint.Unspecified, suspenseSource, suspenseFile);
 
   const indexResult =
-    `// generated with @7nohe/openapi-react-query-codegen@${version} \n` +
+    comment +
     printer.printNode(ts.EmitHint.Unspecified, indexSource, indexFile);
 
   return [

diff --git a/src/format.mts b/src/format.mts
@@ -0,0 +1,25 @@
+import { IndentationText, NewLineKind, Project, QuoteKind } from "ts-morph";
+
+export const formatOutput = async (outputPath: string) => {
+  const project = new Project({
+    skipAddingFilesFromTsConfig: true,
+    manipulationSettings: {
+      indentationText: IndentationText.TwoSpaces,
+      newLineKind: NewLineKind.LineFeed,
+      quoteKind: QuoteKind.Double,
+      usePrefixAndSuffixTextForRename: false,
+      useTrailingCommas: true,
+    },
+  });
+
+  const sourceFiles = project.addSourceFilesAtPaths(`${outputPath}/**/*`);
+
+  const tasks = sourceFiles.map((sourceFile) => {
+    sourceFile.formatText();
+    sourceFile.fixMissingImports();
+    sourceFile.organizeImports();
+    return sourceFile.save();
+  });
+
+  await Promise.all(tasks);
+};
diff --git a/src/generate.mts b/src/generate.mts
@@ -1,11 +1,16 @@
 import { createClient, UserConfig } from "@hey-api/openapi-ts";
 import { print } from "./print.mjs";
 import { createSource } from "./createSource.mjs";
-import { buildOutputPath, formatOptions } from "./common.mjs";
+import {
+  buildQueriesOutputPath,
+  buildRequestsOutputPath,
+  formatOptions,
+} from "./common.mjs";
 import { LimitedUserConfig } from "./cli.mjs";
+import { formatOutput } from "./format.mjs";
 
 export async function generate(options: LimitedUserConfig, version: string) {
-  const openApiOutputPath = buildOutputPath(options.output);
+  const openApiOutputPath = buildRequestsOutputPath(options.output);
   const formattedOptions = formatOptions(options);
 
   const config: UserConfig = {
@@ -41,4 +46,6 @@ export async function generate(options: LimitedUserConfig, version: string) {
     serviceEndName: "Service", // we are hard coding this because changing the service end name was depreciated in @hey-api/openapi-ts
   });
   await print(source, formattedOptions);
+  const queriesOutputPath = buildQueriesOutputPath(options.output);
+  await formatOutput(queriesOutputPath);
 }
diff --git a/src/print.mts b/src/print.mts
@@ -2,7 +2,7 @@ import { mkdir, writeFile } from "fs/promises";
 import path from "path";
 import { queriesOutputPath } from "./constants.mjs";
 import { LimitedUserConfig } from "./cli.mjs";
-import { exists } from "./common.mjs";
+import { buildQueriesOutputPath, exists } from "./common.mjs";
 
 async function printGeneratedTS(
   result: {
@@ -11,7 +11,7 @@ async function printGeneratedTS(
   },
   options: Pick<LimitedUserConfig, "output">
 ) {
-  const dir = path.join(options.output, queriesOutputPath);
+  const dir = buildQueriesOutputPath(options.output);
   const dirExists = await exists(dir);
   if (!dirExists) {
     await mkdir(dir, { recursive: true });

diff --git a/tests/__snapshots__/createSource.test.ts.snap b/tests/__snapshots__/createSource.test.ts.snap
@@ -2,13 +2,15 @@
 
 exports[`createSource > createSource 1`] = `
 "// generated with @7nohe/[email protected] 
+
 export * from "./common";
 export * from "./queries";
 "
 `;
 
 exports[`createSource > createSource 2`] = `
 "// generated with @7nohe/[email protected] 
+
 import { useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
 import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
@@ -29,6 +31,7 @@ export type DefaultServiceDeletePetMutationResult = Awaited<ReturnType<typeof De
 
 exports[`createSource > createSource 3`] = `
 "// generated with @7nohe/[email protected] 
+
 import * as Common from "./common";
 import { useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
@@ -106,6 +109,7 @@ export const useDefaultServiceDeletePet = <TData = Common.DefaultServiceDeletePe
 
 exports[`createSource > createSource 4`] = `
 "// generated with @7nohe/[email protected] 
+
 import * as Common from "./common";
 import { useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";

diff --git a/tests/__snapshots__/generate.test.ts.snap b/tests/__snapshots__/generate.test.ts.snap
@@ -2,9 +2,9 @@
 
 exports[`generate > common.ts 1`] = `
 "// generated with @7nohe/[email protected] 
-import { useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
+
+import { UseQueryResult } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
 export type DefaultServiceFindPetsDefaultResponse = Awaited<ReturnType<typeof DefaultService.findPets>>;
 export type DefaultServiceFindPetsQueryResult<TData = DefaultServiceFindPetsDefaultResponse, TError = unknown> = UseQueryResult<TData, TError>;
 export const useDefaultServiceFindPetsKey = "DefaultServiceFindPets";
@@ -22,17 +22,19 @@ export type DefaultServiceDeletePetMutationResult = Awaited<ReturnType<typeof De
 
 exports[`generate > index.ts 1`] = `
 "// generated with @7nohe/[email protected] 
+
 export * from "./common";
 export * from "./queries";
 "
 `;
 
 exports[`generate > queries.ts 1`] = `
 "// generated with @7nohe/[email protected] 
-import * as Common from "./common";
-import { useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
+
+import { UseMutationOptions, UseQueryOptions, useMutation, useQuery } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
+import { NewPet } from "../requests/types.gen";
+import * as Common from "./common";
 /**
 * Returns all pets from the system that the user has access to
 * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
@@ -47,8 +49,8 @@ import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
 * @throws ApiError
 */
 export const useDefaultServiceFindPets = <TData = Common.DefaultServiceFindPetsDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, tags }: {
-    limit?: number;
-    tags?: string[];
+  limit?: number;
+  tags?: string[];
 } = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useQuery<TData, TError>({ queryKey: [Common.useDefaultServiceFindPetsKey, ...(queryKey ?? [{ limit, tags }])], queryFn: () => DefaultService.findPets({ limit, tags }) as TData, ...options });
 /**
 * @deprecated
@@ -66,7 +68,7 @@ export const useDefaultServiceGetNotDefined = <TData = Common.DefaultServiceGetN
 * @throws ApiError
 */
 export const useDefaultServiceFindPetById = <TData = Common.DefaultServiceFindPetByIdDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ id }: {
-    id: number;
+  id: number;
 }, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useQuery<TData, TError>({ queryKey: [Common.useDefaultServiceFindPetByIdKey, ...(queryKey ?? [{ id }])], queryFn: () => DefaultService.findPetById({ id }) as TData, ...options });
 /**
 * Creates a new pet in the store. Duplicates are allowed
@@ -77,9 +79,9 @@ export const useDefaultServiceFindPetById = <TData = Common.DefaultServiceFindPe
 * @throws ApiError
 */
 export const useDefaultServiceAddPet = <TData = Common.DefaultServiceAddPetMutationResult, TError = unknown, TContext = unknown>(options?: Omit<UseMutationOptions<TData, TError, {
-    requestBody: NewPet;
+  requestBody: NewPet;
 }, TContext>, "mutationFn">) => useMutation<TData, TError, {
-    requestBody: NewPet;
+  requestBody: NewPet;
 }, TContext>({ mutationFn: ({ requestBody }) => DefaultService.addPet({ requestBody }) as unknown as Promise<TData>, ...options });
 /**
 * @deprecated
@@ -97,19 +99,19 @@ export const useDefaultServicePostNotDefined = <TData = Common.DefaultServicePos
 * @throws ApiError
 */
 export const useDefaultServiceDeletePet = <TData = Common.DefaultServiceDeletePetMutationResult, TError = unknown, TContext = unknown>(options?: Omit<UseMutationOptions<TData, TError, {
-    id: number;
+  id: number;
 }, TContext>, "mutationFn">) => useMutation<TData, TError, {
-    id: number;
+  id: number;
 }, TContext>({ mutationFn: ({ id }) => DefaultService.deletePet({ id }) as unknown as Promise<TData>, ...options });
 "
 `;
 
 exports[`generate > suspense.ts 1`] = `
 "// generated with @7nohe/[email protected] 
-import * as Common from "./common";
-import { useQuery, useSuspenseQuery, useMutation, UseQueryResult, UseQueryOptions, UseMutationOptions, UseMutationResult } from "@tanstack/react-query";
+
+import { UseQueryOptions, useSuspenseQuery } from "@tanstack/react-query";
 import { DefaultService } from "../requests/services.gen";
-import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
+import * as Common from "./common";
 /**
 * Returns all pets from the system that the user has access to
 * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
@@ -124,8 +126,8 @@ import { Pet, NewPet, Error, $OpenApiTs } from "../requests/types.gen";
 * @throws ApiError
 */
 export const useDefaultServiceFindPetsSuspense = <TData = Common.DefaultServiceFindPetsDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ limit, tags }: {
-    limit?: number;
-    tags?: string[];
+  limit?: number;
+  tags?: string[];
 } = {}, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useSuspenseQuery<TData, TError>({ queryKey: [Common.useDefaultServiceFindPetsKey, ...(queryKey ?? [{ limit, tags }])], queryFn: () => DefaultService.findPets({ limit, tags }) as TData, ...options });
 /**
 * @deprecated
@@ -143,7 +145,7 @@ export const useDefaultServiceGetNotDefinedSuspense = <TData = Common.DefaultSer
 * @throws ApiError
 */
 export const useDefaultServiceFindPetByIdSuspense = <TData = Common.DefaultServiceFindPetByIdDefaultResponse, TError = unknown, TQueryKey extends Array<unknown> = unknown[]>({ id }: {
-    id: number;
+  id: number;
 }, queryKey?: TQueryKey, options?: Omit<UseQueryOptions<TData, TError>, "queryKey" | "queryFn">) => useSuspenseQuery<TData, TError>({ queryKey: [Common.useDefaultServiceFindPetByIdKey, ...(queryKey ?? [{ id }])], queryFn: () => DefaultService.findPetById({ id }) as TData, ...options });
 "
 `;