refactor: wip

Author: BioPhoton

testing/test-utils/src/lib/utils/execute-process.ts

@@ -1,3 +1,4 @@
+/** THIS IS A COPY OF THE UTILS PACKAGE AND TESTED THERE **/
 import { execFile } from 'node:child_process';
 import { promisify } from 'node:util';
 

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

@@ -13,15 +13,18 @@ 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,
@@ -38,6 +41,7 @@ describe('configurationGenerator', () => {
     ).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/tsconfig.unit.test.ts

@@ -12,6 +12,7 @@ describe('addZod2MdTransformToTsConfig', () => {
     testProjectName,
     DEFAULT_ZOD2MD_CONFIG_FILE_NAME,
   );
+
   beforeEach(() => {
     tree = createTreeWithEmptyWorkspace();
     tree.write(
@@ -39,6 +40,7 @@ describe('addZod2MdTransformToTsConfig', () => {
       `,
     );
   });
+
   it('should fail on missing tsconfig.json', () => {
     tree.delete(tsconfigLibPath);
     expect(() =>
@@ -48,6 +50,7 @@ describe('addZod2MdTransformToTsConfig', () => {
       }),
     ).toThrow('No config tsconfig.json file exists.');
   });
+
   it('should update tsconfig.lib.json with transform', () => {
     tree.write(
       tsconfigLibPath,
@@ -73,6 +76,7 @@ describe('addZod2MdTransformToTsConfig', () => {
       }),
     );
   });
+
   it('should skip creation if config already configured', () => {
     expect(() =>
       addZod2MdTransformToTsConfig(tree, testProjectName, {

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

@@ -12,42 +12,50 @@ describe('formatArrayToJSArray', () => {
         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(`
         "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(`
-        "import { CoreConfig } from "@zod2md/models";
-        import plugin from "../mx-plugin";"
-      `);
+      "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()']);
   });

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

@@ -52,30 +52,38 @@ export function readDefaultExportObject<
     ts.ScriptTarget.Latest,
     true,
   );
-  let result: Record<string, unknown> | null = null;
-  source.forEachChild(node => {
+  const matchingNode = source.getChildren().find(node => {
     if (!ts.isExportAssignment(node)) {
-      return;
+      return false;
     }
     const expr = ts.isSatisfiesExpression?.(node.expression)
       ? node.expression.expression
       : node.expression;
-    if (!ts.isObjectLiteralExpression(expr)) {
-      return;
-    }
-    result = expr.properties.reduce<Record<string, string>>((acc, prop) => {
-      if (
-        ts.isPropertyAssignment(prop) &&
-        ts.isIdentifier(prop.name) &&
-        ts.isStringLiteral(prop.initializer)
-      ) {
-        return {
-          ...acc,
-          [prop.name.text]: prop.initializer.text,
-        };
-      }
-      return acc;
-    }, {});
+    return ts.isObjectLiteralExpression(expr);
   });
+  const result =
+    matchingNode && ts.isExportAssignment(matchingNode)
+      ? (() => {
+          const expr = ts.isSatisfiesExpression?.(matchingNode.expression)
+            ? matchingNode.expression.expression
+            : matchingNode.expression;
+          if (!ts.isObjectLiteralExpression(expr)) {
+            return null;
+          }
+          return expr.properties.reduce<Record<string, string>>((acc, prop) => {
+            if (
+              ts.isPropertyAssignment(prop) &&
+              ts.isIdentifier(prop.name) &&
+              ts.isStringLiteral(prop.initializer)
+            ) {
+              return {
+                ...acc,
+                [prop.name.text]: prop.initializer.text,
+              };
+            }
+            return acc;
+          }, {});
+        })()
+      : null;
   return result as T | null;
 }

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

@@ -9,15 +9,18 @@ describe('generateZod2MdConfig options', () => {
   const testProjectName = 'test-app';
   const generateFilesSpy = vi.spyOn(devKit, 'generateFiles');
   const loggerWarnSpy = vi.spyOn(devKit.logger, 'warn');
+
   beforeEach(() => {
     tree = createTreeWithEmptyWorkspace();
     devKit.addProjectConfiguration(tree, testProjectName, {
       root: 'test-app',
     });
   });
+
   afterEach(() => {
     generateFilesSpy.mockReset();
   });
+
   it('should create zod2md.config.ts with options', () => {
     generateZod2MdConfig(tree, testProjectName, {
       entry: 'test-app/src/main.ts',
@@ -37,10 +40,12 @@ describe('generateZod2MdConfig options', () => {
       }),
     );
   });
+
   it('should call generateFilesSpy', () => {
     generateZod2MdConfig(tree, testProjectName);
     expect(generateFilesSpy).toHaveBeenCalledOnce();
   });
+
   it('should skip creation if config already exists', () => {
     tree.write(path.join(testProjectName, 'zod2md.config.js'), '');
     generateZod2MdConfig(tree, testProjectName);
@@ -52,6 +57,7 @@ describe('generateZod2MdConfig options', () => {
       ),
     );
   });
+
   it('should use correct templates', () => {
     generateZod2MdConfig(tree, testProjectName);
     expect(generateFilesSpy).toHaveBeenCalledWith(
@@ -70,6 +76,7 @@ describe('generateZod2MdConfig options', () => {
       expect.any(Object),
     );
   });
+
   it('should use correct testProjectName', () => {
     generateZod2MdConfig(tree, testProjectName);
     expect(generateFilesSpy).toHaveBeenCalledWith(
@@ -79,6 +86,7 @@ describe('generateZod2MdConfig options', () => {
       expect.any(Object),
     );
   });
+
   it('should use default options', () => {
     generateZod2MdConfig(tree, testProjectName);
     expect(generateFilesSpy).toHaveBeenCalledWith(

tools/zod2md-jsdocs/src/lib/generators/sync-zod2md-setup/sync-zod2md-setup.ts

@@ -213,15 +213,19 @@ function formatIssues(issues: readonly SyncIssue[]): string | undefined {
   if (issues.length === 0) {
     return undefined;
   }
-  const grouped = issues.reduce<
-    Record<SyncIssue['type'], readonly SyncIssue[]>
-  >(
-    (acc, issue) => ({
-      ...acc,
-      [issue.type]: [...(acc[issue.type] ?? []), issue],
-    }),
-    {} as Record<SyncIssue['type'], readonly SyncIssue[]>,
-  );
+  const grouped: Record<SyncIssue['type'], readonly SyncIssue[]> =
+    issues.reduce<Record<SyncIssue['type'], readonly SyncIssue[]>>(
+      (acc, issue) => ({
+        ...acc,
+        [issue.type]: [...(acc[issue.type] ?? []), issue],
+      }),
+      {
+        [missingTsconfig]: [],
+        [missingTarget]: [],
+        [missingBuildDeps]: [],
+        [missingTsPlugin]: [],
+      },
+    );
   return [
     grouped[missingTsconfig]?.length
       ? `Missing tsconfig in:\n${grouped[missingTsconfig]

tools/zod2md-jsdocs/src/lib/generators/sync-zod2md-setup/sync-zod2md-setup.unit.test.ts

@@ -35,6 +35,7 @@ describe('sync-zod2md-setup generator', () => {
     },
     tags: [],
   };
+
   beforeEach(async () => {
     tree = await generateWorkspaceAndProject({
       name: 'test',
@@ -67,13 +68,15 @@ describe('sync-zod2md-setup generator', () => {
       },
     }));
   });
+
   it('should pass if missing zod2md.config', async () => {
     tree.delete(zod2mdConfigPath);
     await expect(syncZod2mdSetupGenerator(tree)).resolves.toStrictEqual({
       outOfSyncMessage: undefined,
     });
     expect(tree.exists(zod2mdConfigPath)).toBeFalse();
   });
+
   it('should fail if missing tsconfig file', async () => {
     tree.delete(`${projectRoot}/tsconfig.json`);
     tree.delete(`${projectRoot}/tsconfig.lib.json`);
@@ -83,6 +86,7 @@ describe('sync-zod2md-setup generator', () => {
     });
     expect(tree.exists(`${projectRoot}/zod2md.config.ts`)).toBeTrue();
   });
+
   it('should fail if missing "zod2md" target in project config', async () => {
     updateJson(tree, `${projectRoot}/project.json`, config => ({
       ...config,
@@ -125,6 +129,7 @@ describe('sync-zod2md-setup generator', () => {
     });
     expect(tree.exists(`${projectRoot}/zod2md.config.ts`)).toBeTrue();
   });
+
   it('should fail if missing "dependsOn" targets in build target', async () => {
     updateJson(tree, `${projectRoot}/project.json`, config => ({
       ...config,
@@ -161,6 +166,7 @@ describe('sync-zod2md-setup generator', () => {
     });
     expect(tree.exists(`${projectRoot}/zod2md.config.ts`)).toBeTrue();
   });
+
   it('should fail if missing Zod2Md TypeScript plugin configuration', async () => {
     updateJson(tree, `${projectRoot}/tsconfig.lib.json`, config => ({
       ...config,
@@ -176,11 +182,13 @@ describe('sync-zod2md-setup generator', () => {
     });
     expect(tree.exists(`${projectRoot}/zod2md.config.ts`)).toBeTrue();
   });
+
   it('should pass if zod2md setup is correct', async () => {
     await expect(syncZod2mdSetupGenerator(tree)).resolves.toStrictEqual({
       outOfSyncMessage: undefined,
     });
   });
+
   it('should not duplicate dependencies when they exist as objects', async () => {
     const objectFormDependsOn = [
       '^build',

tools/zod2md-jsdocs/src/lib/transformers/transformers.ts

@@ -1,6 +1,5 @@
 import type { PluginConfig, TransformerExtras } from 'ts-patch';
-import type * as ts from 'typescript';
-import tsInstance from 'typescript';
+import * as ts from 'typescript';
 
 export function generateJSDocComment(
   typeName: string,
@@ -28,7 +27,7 @@ export function annotateTypeDefinitions(
         'Please configure it in your tsconfig.json plugins section.',
     );
   }
-  const tsLib = extras?.ts ?? tsInstance;
+  const tsLib = extras?.ts ?? ts;
   return (context: ts.TransformationContext) => {
     const visitor = (node: ts.Node): ts.Node => {
       if (

tools/zod2md-jsdocs/src/lib/transformers/transformers.unit.test.ts

@@ -17,14 +17,17 @@ describe('generateJSDocComment', () => {
        "
     `);
   });
+
   it('should use type name in description', () => {
     const result = generateJSDocComment('SchemaName123', 'https://example.com');
     expect(result).toContain('Type Definition: `SchemaName123`');
   });
+
   it('should convert type name to lowercase in the link anchor', () => {
     const result = generateJSDocComment('SchemaName123', 'https://example.com');
     expect(result).toContain('#schemaname123');
   });
+
   it('should baseUrl in the link', () => {
     const result = generateJSDocComment('Schema', 'https://example.com');
     expect(result).toContain('https://example.com#');