refactor: wip

Author: BioPhoton

packages/models/project.json

@@ -6,7 +6,7 @@
   "implicitDependencies": ["zod2md-jsdocs"],
   "targets": {
     "build": {
-      "dependsOn": ["^build", "generate-docs"]
+      "dependsOn": ["^build", "generate-docs", "ts-patch"]
     },
     "lint": {},
     "unit-test": {},

tools/zod2md-jsdocs/src/index.ts

@@ -4,5 +4,4 @@ export {
   annotateTypeDefinitions,
   generateJSDocComment,
 } from './lib/transformers/transformers.js';
-
 export default annotateTypeDefinitions;

tools/zod2md-jsdocs/src/lib/generators/configuration/__snapshots__/root-zod2md.config.ts

@@ -1,10 +1,8 @@
 import type { Config } from 'zod2md';
-
-// see: https://github.com/matejchalk/zod2md?tab=readme-ov-file#configuration-file-reference
 export default {
-  entry: 'libs/test-app/src/index.ts',
-  format: 'esm',
-  title: 'test-app reference',
-  output: 'libs/test-app/docs/test-app-reference.md',
-  tsconfig: 'libs/test-app/tsconfig.lib.json',
+    entry: 'libs/test-app/src/index.ts',
+    format: 'esm',
+    title: 'test-app reference',
+    output: 'libs/test-app/docs/test-app-reference.md',
+    tsconfig: 'libs/test-app/tsconfig.lib.json',
 } satisfies Config;

tools/zod2md-jsdocs/src/lib/generators/configuration/generator.int.test.ts

@@ -13,18 +13,15 @@ describe('configurationGenerator', () => {
   let tree: Tree;
   const testProjectName = 'test-app';
   const loggerInfoSpy = vi.spyOn(logger, 'info');
-
   beforeEach(() => {
     tree = createTreeWithEmptyWorkspace();
     addProjectConfiguration(tree, 'test-app', {
       root: 'test-app',
     });
   });
-
   afterEach(() => {
     tree.delete(testProjectName);
   });
-
   it('should skip config creation if skipConfig is used', async () => {
     await configurationGenerator(tree, {
       project: testProjectName,
@@ -33,17 +30,14 @@ describe('configurationGenerator', () => {
       output: 'docs/test-app-reference.md',
       title: 'Test App Reference',
     });
-
     readProjectConfiguration(tree, testProjectName);
-
     expect(
       tree.read(
         path.join('libs', testProjectName, DEFAULT_ZOD2MD_CONFIG_FILE_NAME),
       ),
     ).toBeNull();
     expect(loggerInfoSpy).toHaveBeenCalledWith('Skip config file creation');
   });
-
   it('should skip formatting', async () => {
     await configurationGenerator(tree, {
       project: testProjectName,

tools/zod2md-jsdocs/src/lib/generators/configuration/generator.ts

@@ -12,20 +12,16 @@ export async function configurationGenerator(
   options: ConfigurationGeneratorOptions,
 ) {
   const projectConfiguration = readProjectConfiguration(tree, options.project);
-
   const { skipConfig, skipFormat } = options;
-
   if (skipConfig === true) {
     logger.info('Skip config file creation');
   } else {
     generateZod2MdConfig(tree, projectConfiguration.root);
   }
-
   if (skipFormat === true) {
     logger.info('Skip formatting files');
   } else {
     await formatFiles(tree);
   }
 }
-
 export default configurationGenerator;

tools/zod2md-jsdocs/src/lib/generators/configuration/tsconfig.ts

@@ -33,7 +33,6 @@ export function getFirstExistingTsConfig(
       )
     : undefined;
 }
-
 export type PluginDefinition = {
   transform: string;
   afterDeclarations: boolean;
@@ -44,7 +43,6 @@ export type TsConfig = {
     plugins: PluginDefinition[];
   };
 };
-
 export function addZod2MdTransformToTsConfig(
   tree: Tree,
   root: string,
@@ -61,15 +59,12 @@ export function addZod2MdTransformToTsConfig(
   if (!firstExistingTsc) {
     throw new Error(`No config tsconfig.json file exists.`);
   }
-
   const tscJson = JSON.parse(tree.read(firstExistingTsc)?.toString() ?? `{}`);
   const compilerOptions = tscJson.compilerOptions ?? {};
   const plugins = (compilerOptions.plugins ?? []) as PluginDefinition[];
-
   const hasTransformPlugin = plugins.some(
     plugin => plugin.transform === './tools/zod2md-jsdocs/dist',
   );
-
   if (!hasTransformPlugin) {
     tree.write(
       firstExistingTsc,

tools/zod2md-jsdocs/src/lib/generators/configuration/tsconfig.unit.test.ts

@@ -12,7 +12,6 @@ describe('addZod2MdTransformToTsConfig', () => {
     testProjectName,
     DEFAULT_ZOD2MD_CONFIG_FILE_NAME,
   );
-
   beforeEach(() => {
     tree = createTreeWithEmptyWorkspace();
     tree.write(
@@ -40,7 +39,6 @@ describe('addZod2MdTransformToTsConfig', () => {
       `,
     );
   });
-
   it('should fail on missing tsconfig.json', () => {
     tree.delete(tsconfigLibPath);
     expect(() =>
@@ -50,7 +48,6 @@ describe('addZod2MdTransformToTsConfig', () => {
       }),
     ).toThrow('No config tsconfig.json file exists.');
   });
-
   it('should update tsconfig.lib.json with transform', () => {
     tree.write(
       tsconfigLibPath,
@@ -60,7 +57,6 @@ describe('addZod2MdTransformToTsConfig', () => {
       projectName: testProjectName,
       baseUrl: 'http://example.com',
     });
-
     expect(
       JSON.parse(tree.read(tsconfigLibPath)?.toString() ?? '{}'),
     ).toStrictEqual(
@@ -77,7 +73,6 @@ describe('addZod2MdTransformToTsConfig', () => {
       }),
     );
   });
-
   it('should skip creation if config already configured', () => {
     expect(() =>
       addZod2MdTransformToTsConfig(tree, testProjectName, {

tools/zod2md-jsdocs/src/lib/generators/configuration/types.ts

@@ -1,12 +1,9 @@
 export type ItemOrArray<T> = T | T[];
-
 export type ExtractArray<T> = T extends unknown[] ? T : never;
-
 export type ExecutableCode = {
   fileImports: ItemOrArray<string>;
   codeStrings: ItemOrArray<string>;
 };
-
 export type ExtractArrays<T extends Record<string, unknown>> = {
   [K in keyof T]: ExtractArray<T[K]>;
 };

tools/zod2md-jsdocs/src/lib/generators/configuration/utils.ts

@@ -10,8 +10,6 @@ export function normalizeItemOrArray<T>(
   }
   return [itemOrArray];
 }
-
-// Return a formatted JSON in TS object with the same keys as the input object but remove the " for the properties
 export function formatObjectToFormattedJsString(
   jsonObj?:
     | {
@@ -22,13 +20,9 @@ export function formatObjectToFormattedJsString(
   if (!jsonObj) {
     return;
   }
-  // Convert JSON object to a string with indentation
   const jsonString = JSON.stringify(jsonObj, null, 2);
-
-  // Remove double quotes around property names
   return jsonString.replace(/"(\w+)":/g, '$1:');
 }
-
 export function formatArrayToLinesOfJsString(
   lines?: string[],
   separator = '\n',
@@ -38,12 +32,10 @@ export function formatArrayToLinesOfJsString(
   }
   return lines.join(separator).replace(/'/g, '"');
 }
-
 export function formatArrayToJSArray(lines?: string[]) {
   if (!Array.isArray(lines)) {
     return;
   }
-
   return `[${formatArrayToLinesOfJsString(lines, ',\n') ?? ''}]`.replace(
     /"/g,
     '',

tools/zod2md-jsdocs/src/lib/generators/configuration/utils.unit.test.ts

@@ -6,64 +6,48 @@ import {
 
 describe('formatArrayToJSArray', () => {
   it('should return array as JS', () => {
-    expect(
-      formatArrayToJSArray(['plugin1()', 'plugin2()']),
-    ).toMatchInlineSnapshot(
-      `
+    expect(formatArrayToJSArray(['plugin1()', 'plugin2()']))
+      .toMatchInlineSnapshot(`
         "[plugin1(),
         plugin2()]"
-      `,
-    );
+      `);
   });
-
   it('should return empty array as JS for empty items', () => {
     expect(formatArrayToJSArray([])).toMatchInlineSnapshot('"[]"');
   });
-
   it('should return undefined for undefined values', () => {
     expect(formatArrayToJSArray(undefined)).toBeUndefined();
   });
 });
-
 describe('formatArrayToLinesOfJsString', () => {
   it('should return lines as JS', () => {
-    expect(
-      formatArrayToLinesOfJsString([`import plugin from "../nx-plugin";`]),
-    ).toMatchInlineSnapshot(
-      `
+    expect(formatArrayToLinesOfJsString([`import plugin from "../nx-plugin";`]))
+      .toMatchInlineSnapshot(`
         "import plugin from "../nx-plugin";"
-      `,
-    );
+      `);
   });
-
   it('should return lines as JS with normalized quotes', () => {
     expect(
       formatArrayToLinesOfJsString([
         `import { CoreConfig } from '@zod2md/models';`,
         `import plugin from "../mx-plugin";`,
       ]),
-    ).toMatchInlineSnapshot(
-      `
+    ).toMatchInlineSnapshot(`
         "import { CoreConfig } from "@zod2md/models";
         import plugin from "../mx-plugin";"
-      `,
-    );
+      `);
   });
-
   it('should return undefined for empty items', () => {
     expect(formatArrayToLinesOfJsString([])).toBeUndefined();
   });
-
   it('should return undefined for nullish values', () => {
     expect(formatArrayToLinesOfJsString()).toBeUndefined();
   });
 });
-
 describe('normalizeItemOrArray', () => {
   it('should turn string into string array', () => {
     expect(normalizeItemOrArray('myPlugin()')).toStrictEqual(['myPlugin()']);
   });
-
   it('should keep string array', () => {
     expect(normalizeItemOrArray('myPlugin()')).toStrictEqual(['myPlugin()']);
   });