Merge 8a4a584 into 7b6e72c

Author: BioPhoton

e2e/nx-plugin-e2e/tests/plugin-plugins-config.e2e.test.ts

@@ -74,7 +74,8 @@ describe('nx-plugin pluginsConfig', () => {
 
     await materializeTree(tree, cwd);
 
-    const { code, projectJson } = await nxShowProjectJson(cwd, project);
+    const { code, stderr, projectJson } = await nxShowProjectJson(cwd, project);
+    expect(stderr).toBe('');
     expect(code).toBe(0);
 
     expect(projectJson).toStrictEqual(

nx.json

@@ -345,7 +345,7 @@
     "releaseTagPattern": "v{version}"
   },
   "plugins": [
-    "./tools/zod2md-jsdocs/src/nx-plugin.ts",
+    "./tools/zod2md-jsdocs/src/lib/plugin/nx-plugin.ts",
     {
       "plugin": "@push-based/nx-verdaccio",
       "options": {

packages/models/project.json

@@ -3,14 +3,10 @@
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "packages/models/src",
   "projectType": "library",
+  "implicitDependencies": ["zod2md-jsdocs"],
   "targets": {
     "build": {
-      "dependsOn": [
-        "^build",
-        "generate-docs",
-        { "projects": "zod2md-jsdocs", "target": "build" },
-        { "projects": "zod2md-jsdocs", "target": "ts-patch" }
-      ]
+      "dependsOn": ["^build", "generate-docs", "ts-patch"]
     },
     "lint": {},
     "unit-test": {},

testing/test-nx-utils/src/lib/utils/nx.ts

@@ -9,9 +9,9 @@ import {
 } from '@nx/devkit';
 import { libraryGenerator } from '@nx/js';
 import type { LibraryGeneratorSchema } from '@nx/js/src/generators/library/schema';
-import path from 'node:path';
+import * as path from 'node:path';
 import { createTreeWithEmptyWorkspace } from 'nx/src/generators/testing-utils/create-tree-with-empty-workspace';
-import { executeProcess } from '@code-pushup/utils';
+import { executeProcess } from '@code-pushup/test-utils';
 
 export function executorContext<
   T extends { projectName: string; cwd?: string },
@@ -95,11 +95,29 @@ export async function nxShowProjectJson<T extends ProjectConfiguration>(
   cwd: string,
   project: string,
 ) {
-  const { code, stderr, stdout } = await executeProcess({
-    command: 'npx',
-    args: ['nx', 'show', `project --json  ${project}`],
-    cwd,
-  });
+  try {
+    const { stderr, stdout } = await executeProcess({
+      command: 'npx',
+      args: ['nx', 'show', 'project', project, '--json'],
+      cwd,
+    });
 
-  return { code, stderr, projectJson: JSON.parse(stdout) as T };
+    return {
+      code: 0,
+      stderr,
+      projectJson: JSON.parse(stdout) as T,
+    };
+  } catch (error: unknown) {
+    const execError = error as {
+      code?: number | string | null;
+      stderr?: string;
+      stdout?: string;
+      message?: string;
+    };
+    return {
+      code: typeof execError.code === 'number' ? execError.code : 1,
+      stderr: execError.stderr ?? execError.message ?? String(error),
+      projectJson: JSON.parse('{}'),
+    };
+  }
 }

testing/test-utils/src/index.ts

@@ -12,3 +12,4 @@ export * from './lib/utils/project-graph.js';
 export * from './lib/utils/test-folder-setup.js';
 export * from './lib/utils/omit-trace-json.js';
 export * from './lib/utils/profiler.mock.js';
+export * from './lib/utils/execute-process.js';

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

@@ -0,0 +1,13 @@
+/** THIS IS A COPY OF THE UTILS PACKAGE AND TESTED THERE **/
+import { execFile } from 'node:child_process';
+import { promisify } from 'node:util';
+
+export async function executeProcess(cfg: {
+  command: string;
+  args: string[];
+  cwd: string;
+}) {
+  const execFileAsync = promisify(execFile);
+  const { command, args, cwd } = cfg;
+  return await execFileAsync(command, args, { cwd });
+}

tools/zod2md-jsdocs/README.md

@@ -4,44 +4,9 @@ A comprehensive toolset for generating and enhancing TypeScript documentation fr
 
 ## What's Included
 
-This package provides two main components:
+This package provides the following components:
 
-1. **[Nx Plugin](./docs/zod2md-jsdocs-nx-plugin.md)** - Automatically generates documentation targets for projects with Zod schemas
-2. **[TypeScript Transformer](./docs/zod2md-jsdocs-ts-transformer.md)** - Enhances generated type definitions with JSDoc comments and schema metadata
-
-## Quick Start
-
-### Using the Nx Plugin
-
-Add the plugin to your `nx.json`:
-
-```jsonc
-{
-  "plugins": ["./tools/zod2md-jsdocs/src/nx-plugin.ts"],
-}
-```
-
-Create a `zod2md.config.ts` in your project, and you'll automatically get a `generate-docs` target.
-
-[Learn more about the Nx Plugin →](./docs/zod2md-jsdocs-nx-plugin.md)
-
-### Using the TypeScript Transformer
-
-1. Install ts-patch: `ts-patch install`
-2. Add to your `tsconfig.json`:
-
-```json
-{
-  "compilerOptions": {
-    "plugins": [
-      {
-        "transform": "./tools/zod2md-jsdocs/dist/src",
-        "afterDeclarations": true,
-        "baseUrl": "https://github.com/code-pushup/cli/blob/main/packages/<PROJECT-NAME>/docs/models-reference.md"
-      }
-    ]
-  }
-}
-```
-
-[Learn more about the TypeScript Transformer →](./docs/zod2md-jsdocs-ts-transformer.md)
+1. **[Nx Plugin](./src/lib/plugin/README.md)** - Automatically generates documentation targets for projects with Zod schemas
+2. **[Nx Configuration Generator](./src/lib/generators/configuration/README.md)** - Automatically generates documentation targets for projects with Zod schemas
+3. **[Nx Sync Zod2Md Setup Generator](./src/lib/generators/sync-zod2md-setup/README.md)** - Automatically generates documentation targets for projects with Zod schemas
+4. **[TypeScript Transformer](./src/lib/transformers/README.md)** - Enhances generated type definitions with JSDoc comments and schema metadata

tools/zod2md-jsdocs/docs/zod2md-jsdocs-nx-plugin.md

@@ -1,11 +1,60 @@
+const tseslint = require('typescript-eslint');
 const baseConfig = require('../../eslint.config.js').default;
 
-module.exports = [
+module.exports = tseslint.config(
   ...baseConfig,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: __dirname,
+      },
+    },
+  },
+  {
+    files: ['**/*.ts'],
+    rules: {
+      // Nx plugins don't yet support ESM: https://github.com/nrwl/nx/issues/15682
+      'unicorn/prefer-module': 'off',
+      // used instead of verbatimModuleSyntax tsconfig flag (requires ESM)
+      '@typescript-eslint/consistent-type-imports': [
+        'warn',
+        {
+          fixStyle: 'inline-type-imports',
+          disallowTypeAnnotations: false,
+        },
+      ],
+      '@typescript-eslint/consistent-type-exports': [
+        'warn',
+        { fixMixedExportsWithInlineTypeSpecifier: true },
+      ],
+      // `import path from 'node:path'` incompatible with CJS runtime, prefer `import * as path from 'node:path'`
+      'unicorn/import-style': [
+        'warn',
+        { styles: { 'node:path': { namespace: true } } },
+      ],
+      // `import { logger } from '@nx/devkit' is OK here
+      'no-restricted-imports': 'off',
+    },
+  },
   {
     files: ['**/*.json'],
     rules: {
       '@nx/dependency-checks': 'error',
     },
   },
-];
+  // Nx compiles the sync generators on the fly with SWC and there the .js ending is not working
+  {
+    files: ['**/sync-*.ts'],
+    rules: {
+      'n/file-extension-in-import': 'off',
+    },
+  },
+  {
+    files: ['**/package.json', '**/generators.json'],
+    rules: {
+      '@nx/nx-plugin-checks': 'error',
+    },
+  },
+);

tools/zod2md-jsdocs/eslint.config.js

@@ -0,0 +1,19 @@
+{
+  "generators": {
+    "sync-zod2md-setup": {
+      "factory": "./src/lib/generators/sync-zod2md-setup/sync-zod2md-setup",
+      "schema": "./src/lib/generators/sync-zod2md-setup/schema.json",
+      "description": "sync-zod2md-setup generator"
+    },
+    "configuration": {
+      "factory": "./src/lib/generators/configuration/configuration",
+      "schema": "./src/lib/generators/configuration/schema.json",
+      "description": "configuration generator"
+    },
+    "sync-zod2md-docs": {
+      "factory": "./src/lib/generators/sync-zod2md-docs/sync-zod2md-docs",
+      "schema": "./src/lib/generators/sync-zod2md-docs/schema.json",
+      "description": "sync-zod2md-docs generator"
+    }
+  }
+}