refactor: fix lint, setup generator

Author: BioPhoton

tools/zod2md-jsdocs/eslint.config.js

@@ -44,6 +44,13 @@ module.exports = tseslint.config(
       '@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: {

tools/zod2md-jsdocs/src/lib/generators/sync-zod2md-setup/README.md

@@ -87,14 +87,54 @@ This is especially useful when integrating the sync generator into CI or workspa
 
 ---
 
-## Registering / Testing the generator
+## Register a Global Sync Generator
 
-To register the generator in your workspace:
+Global sync generators are registered in the _nx.json_ file like this:
 
-```bash
-nx g @tooling/zod2md-jsdocs:sync-zod2md-setup --register
+_nx.json_
+
+```json
+{
+  "sync": {
+    "globalGenerators": ["./tools/zod2md-jsdocs:sync-zod2md-setup"]
+  }
+}
+```
+
+## Register a Local Sync Generator
+
+Local sync generators are registered in the project's `package.json` or `project.json` file under the `syncGenerators` property for specific targets:
+
+_package.json_
+
+```json
+{
+  "name": "my-project",
+  "nx": {
+    "targets": {
+      "build": {
+        "syncGenerators": ["./tools/zod2md-jsdocs:sync-zod2md-setup"]
+      }
+    }
+  }
+}
 ```
 
+_project.json_
+
+```json
+{
+  "name": "my-project",
+  "targets": {
+    "build": {
+      "syncGenerators": ["./tools/zod2md-jsdocs:sync-zod2md-setup"]
+    }
+  }
+}
+```
+
+With this configuration, the sync generator will run automatically before the specified target (e.g., `build`).
+
 ## Notes
 
 - This is a **sync generator**, not a build step

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

@@ -11,13 +11,13 @@ import * as path from 'node:path';
 import {
   GENERATE_DOCS_TARGET_NAME,
   PATCH_TS_TARGET_NAME,
-} from '../../plugin/constants.js';
-import { DEFAULT_ZOD2MD_CONFIG_FILE_NAME } from '../configuration/constants.js';
+} from '../../plugin/constants';
+import { DEFAULT_ZOD2MD_CONFIG_FILE_NAME } from '../configuration/constants';
 import {
   type PluginDefinition,
   addZod2MdTransformToTsConfig,
   getFirstExistingTsConfig,
-} from '../configuration/tsconfig.js';
+} from '../configuration/tsconfig';
 
 const missingTsconfig = 'missing-tsconfig' as const;
 const missingTarget = 'missing-target' as const;

tools/zod2md-jsdocs/src/lib/plugin/nx-plugin.ts

@@ -49,9 +49,7 @@ const createNodesV2: CreateNodesV2 = [
                         projects: 'self',
                       },
                     ],
-                    syncGenerators: [
-                      './tools/zod2md-jsdocs/dist:sync-zod2md-setup',
-                    ],
+                    syncGenerators: ['./tools/zod2md-jsdocs:sync-zod2md-setup'],
                   },
                   [GENERATE_DOCS_TARGET_NAME]: createDocsTargetConfig({
                     config,