refactor: refactor utils (#68)

* refactor: move types out of utils

* refactor: abstract saveFile and formatTypeScript utils

src/openapiToTsJsonSchema.ts

@@ -1,21 +1,19 @@
 import fs from 'fs/promises';
 import { existsSync } from 'fs';
-import path from 'path';
+import path from 'node:path';
 import $RefParser from '@apidevtools/json-schema-ref-parser';
 import YAML from 'yaml';
 import get from 'lodash.get';
 import {
   clearFolder,
   makeJsonSchemaFiles,
   REF_SYMBOL,
-  SchemaPatcher,
   convertOpenApiToJsonSchema,
   convertOpenApiParameters,
-  SchemaMetaDataMap,
-  JSONSchema,
   addSchemaToMetaData,
   pathToRef,
 } from './utils';
+import type { SchemaPatcher, SchemaMetaDataMap, JSONSchema } from './types';
 
 export async function openapiToTsJsonSchema({
   openApiSchema: openApiSchemaRelative,

src/utils/addSchemaToMetaData.ts

@@ -1,16 +1,18 @@
-import path from 'path';
+import path from 'node:path';
 // @ts-expect-error no type defs for namify
 import namify from 'namify';
 import filenamify from 'filenamify';
 import {
-  SchemaMetaDataMap,
-  SchemaMetaData,
-  JSONSchema,
   replaceInlinedRefsWithStringPlaceholder,
   patchJsonSchema,
-  SchemaPatcher,
   refToPath,
 } from '.';
+import type {
+  SchemaMetaDataMap,
+  SchemaMetaData,
+  JSONSchema,
+  SchemaPatcher,
+} from '../types';
 
 /*
  * Just an utility function to add entries to SchemaMetaDataMap Map keyed by ref

src/utils/convertOpenApiParameters.ts

@@ -1,5 +1,5 @@
 import { convertParametersToJSONSchema } from 'openapi-jsonschema-parameters';
-import type { JSONSchema } from '.';
+import type { JSONSchema } from '../types';
 
 /**
  * Parameters field can only be found in:

src/utils/convertOpenApiToJsonSchema.ts

@@ -1,5 +1,5 @@
 import { fromSchema } from '@openapi-contrib/openapi-schema-to-json-schema';
-import { OpenApiSchema } from '.';
+import type { OpenApiSchema } from '../types';
 
 export function convertOpenApiToJsonSchema(schema: OpenApiSchema) {
   /**

src/utils/index.ts

@@ -1,5 +1,4 @@
 export { patchJsonSchema } from './patchJsonSchema';
-export { clearFolder } from './clearFolder';
 export { jsonSchemaToTsConst } from './jsonSchemaToTsConst';
 export { convertOpenApiParameters } from './convertOpenApiParameters';
 export { convertOpenApiToJsonSchema } from './convertOpenApiToJsonSchema';
@@ -13,12 +12,9 @@ export {
 } from './refReplacementUtils';
 export { replaceInlinedRefsWithStringPlaceholder } from './replaceInlinedRefsWithStringPlaceholder';
 export { replacePlaceholdersWithImportedSchemas } from './jsonSchemaToTsConst/replacePlaceholdersWithImportedSchemas';
-export type {
-  JSONSchema,
-  OpenApiSchema,
-  SchemaPatcher,
-  SchemaMetaData,
-  SchemaMetaDataMap,
-} from './types';
 export { addSchemaToMetaData } from './addSchemaToMetaData';
+
+export { clearFolder } from './clearFolder';
 export { makeRelativePath } from './makeRelativePath';
+export { formatTypeScript } from './formatTypeScript';
+export { saveFile } from './saveFile';

src/utils/jsonSchemaToTsConst/index.ts

@@ -1,7 +1,7 @@
-import prettier from 'prettier';
 import { stringify } from 'comment-json';
 import { replacePlaceholdersWithImportedSchemas } from './replacePlaceholdersWithImportedSchemas';
-import type { SchemaMetaDataMap, SchemaMetaData } from '../';
+import { formatTypeScript } from '../';
+import type { SchemaMetaDataMap, SchemaMetaData } from '../../types';
 
 export async function jsonSchemaToTsConst({
   metaData,
@@ -25,9 +25,6 @@ export async function jsonSchemaToTsConst({
 
   tsSchema = tsSchema + `\n\nexport const $id = "${metaData.schemaId}";`;
 
-  const formattedSchema = await prettier.format(tsSchema, {
-    parser: 'typescript',
-  });
-
+  const formattedSchema = await formatTypeScript(tsSchema);
   return formattedSchema;
 }

src/utils/jsonSchemaToTsConst/replacePlaceholdersWithImportedSchemas.ts

@@ -1,4 +1,5 @@
-import { SchemaMetaDataMap, makeRelativePath, PLACEHOLDER_REGEX } from '..';
+import { makeRelativePath, PLACEHOLDER_REGEX } from '..';
+import type { SchemaMetaDataMap } from '../../types';
 
 /**
  * Replace Refs placeholders with imported schemas

src/utils/makeJsonSchemaFiles.ts

@@ -1,5 +1,5 @@
-import fs from 'fs/promises';
-import { jsonSchemaToTsConst, SchemaMetaDataMap } from '.';
+import { jsonSchemaToTsConst, saveFile } from '.';
+import type { SchemaMetaDataMap } from '../types';
 
 /**
  * Save TS JSON schema with the expected naming conventions
@@ -15,8 +15,7 @@ export async function makeJsonSchemaFiles({
       schemaMetaDataMap,
     });
 
-    const { schemaAbsoluteDirName, schemaAbsolutePath } = metaData;
-    await fs.mkdir(schemaAbsoluteDirName, { recursive: true });
-    await fs.writeFile(schemaAbsolutePath, tsSchema);
+    const { schemaAbsolutePath } = metaData;
+    await saveFile({ path: [schemaAbsolutePath], data: tsSchema });
   }
 }

src/utils/makeRelativePath.ts

@@ -1,4 +1,4 @@
-import path from 'path';
+import path from 'node:path';
 
 /**
  * Evaluate the relative path from/to the given absolute paths

src/utils/patchJsonSchema.ts

@@ -1,5 +1,5 @@
 import traverse from 'json-schema-traverse';
-import type { JSONSchema, SchemaPatcher } from './';
+import type { JSONSchema, SchemaPatcher } from '../types';
 
 export function patchJsonSchema(
   schema: JSONSchema,

src/utils/replaceInlinedRefsWithStringPlaceholder.ts

@@ -1,5 +1,6 @@
 import mapObject from 'map-obj';
-import { JSONSchema, refToPlaceholder, REF_SYMBOL } from '.';
+import { refToPlaceholder, REF_SYMBOL } from '.';
+import type { JSONSchema } from '../types';
 
 function isObject(value: unknown): value is Record<string | symbol, unknown> {
   return typeof value === 'object' && value !== null && !Array.isArray(value);

src/utils/saveFile.ts

@@ -0,0 +1,15 @@
+import fs from 'fs/promises';
+import nodePath from 'node:path';
+
+export async function saveFile({
+  path,
+  data,
+}: {
+  path: string[];
+  data: string;
+}): Promise<void> {
+  const absolutePath = nodePath.resolve(...path);
+  const dirname = nodePath.dirname(absolutePath);
+  await fs.mkdir(dirname, { recursive: true });
+  await fs.writeFile(absolutePath, data);
+}

test/dereferencing.test.ts

@@ -1,8 +1,9 @@
 import path from 'path';
 import fs from 'fs/promises';
 import { describe, it, expect } from 'vitest';
-import { importFresh, formatTypeScript } from './test-utils';
+import { importFresh } from './test-utils';
 import { openapiToTsJsonSchema } from '../src';
+import { formatTypeScript } from '../src/utils';
 
 const fixtures = path.resolve(__dirname, 'fixtures');
 

test/experimentalImportRefs.test.ts

@@ -1,8 +1,9 @@
 import path from 'path';
 import fs from 'fs/promises';
 import { describe, it, expect } from 'vitest';
-import { importFresh, formatTypeScript } from './test-utils';
+import { importFresh } from './test-utils';
 import { openapiToTsJsonSchema } from '../src';
+import { formatTypeScript } from '../src/utils';
 
 const fixtures = path.resolve(__dirname, 'fixtures');
 

test/test-utils/index.ts

@@ -1,2 +1 @@
 export { importFresh } from './importFresh';
-export { formatTypeScript } from './formatTypeScript';