refactor: adjust plugin code

Author: John Doe

tools/zod2md-nx-plugin/README.md

@@ -1,40 +1,100 @@
 # @code-pushup/zod2md-nx-plugin
 
-[![npm](https://img.shields.io/npm/v/%40code-pushup%2Futils.svg)](https://www.npmjs.com/package/@code-pushup/zod2md-nx-plugin)
-[![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Futils)](https://npmtrends.com/@code-pushup/zod2md-nx-plugin)
-[![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/utils)](https://www.npmjs.com/package/@code-pushup/zod2md-nx-plugin?activeTab=dependencies)
+The Nx Plugin for [zod2md](https://github.com/code-pushup/zod2md), a tool for generating documentation from Zod schemas.
 
-Low-level **utilities** (helper functions, etc.) used by [Code PushUp CLI](../cli/README.md).
+Why should you use this plugin?
 
-## Setup
+- Zero setup cost. Just add a `zod2md.config.ts` file and you're good to go.
+- Automatic target generation
+- Minimal configuration
+- Automated caching and dependency tracking
 
-If you've already installed another `@code-pushup/*` package, then you may have already installed `@code-pushup/zod2md-nx-plugin` indirectly.
-
-If not, you can always install it separately:
+## Usage
 
-```sh
-npm install --save-dev @code-pushup/zod2md-nx-plugin
+```jsonc
+// nx.json
+{
+  //...
+  "plugins": ["./tools/zod2md-nx-plugin/src/lib/plugin.js"],
+}
 ```
 
-```sh
-yarn add --dev @code-pushup/zod2md-nx-plugin
+or with options:
+
+```jsonc
+// nx.json
+{
+  //...
+  "plugins": [
+    {
+      "plugin": "./tools/zod2md-nx-plugin/src/lib/plugin.js",
+      "options": {
+        "targetName": "docs",
+      },
+    },
+  ],
+}
 ```
 
-```sh
-pnpm add --save-dev @code-pushup/zod2md-nx-plugin
+Now every project with a `zod2md.config.ts` file will have a `generate-docs` target automatically created.
+
+- `nx run <project-name>:generate-docs`
+
+Run it and the project will automatically generate documentation from your Zod schemas.
+
+```text
+Root/
+├── project-name/
+│   ├── zod2md.config.ts
+│   ├── docs/
+│   │   └── project-name-reference.md 👈 generated
+│   └── ...
+└── ...
 ```
 
-## Usage
+The generated target:
 
-```ts
-import { executeProcess, readJsonFile, slugify } from '@code-pushup/zod2md-nx-plugin';
+1. Runs `zod2md` with the project's configuration
+2. Formats the generated markdown with Prettier
+3. Caches the result for better performance
 
-await executeProcess({
-  command: 'npx',
-  args: ['eslint', '--format=json', '--output-file=output.json', '**/*.js'],
-});
+## Options
 
-const data = await readJsonFile('output.json');
+| Name           | type                               | description                                            |
+| -------------- | ---------------------------------- | ------------------------------------------------------ |
+| **targetName** | `string` (DEFAULT 'generate-docs') | The id used to identify a target in your project.json. |
 
-const slug = slugify('Hello, world!'); // "hello-world"
+All options are optional and provided in the `nx.json` file.
+
+```jsonc
+// nx.json
+{
+  //...
+  "plugins": [
+    {
+      "plugin": "./tools/zod2md-nx-plugin/src/lib/plugin.js",
+      "options": {
+        "targetName": "docs",
+      },
+    },
+  ],
+}
+```
+
+## Configuration
+
+Create a `zod2md.config.ts` file in your project:
+
+```ts
+import type { Config } from 'zod2md';
+
+export default {
+  entry: 'packages/models/src/index.ts',
+  tsconfig: 'packages/models/tsconfig.lib.json',
+  format: 'esm',
+  title: 'Models reference',
+  output: 'packages/models/docs/models-reference.md',
+} satisfies Config;
 ```
+
+For a full list of configuration options visit the [zod2md documentation](https://github.com/code-pushup/zod2md#readme).

tools/zod2md-nx-plugin/package.json

@@ -2,27 +2,14 @@
   "name": "@code-pushup/zod2md-nx-plugin",
   "version": "0.0.0",
   "license": "MIT",
-  "homepage": "https://github.com/code-pushup/cli/tree/main/tools/zod2md-nx-plugin#readme",
   "publishConfig": {
     "access": "public"
   },
   "type": "module",
   "engines": {
     "node": ">=17.0.0"
   },
-  "dependencies": {
-    "@code-pushup/models": "0.92.0",
-    "ansis": "^3.3.0",
-    "build-md": "^0.4.2",
-    "bundle-require": "^5.1.0",
-    "esbuild": "^0.25.2",
-    "ora": "^9.0.0",
-    "semver": "^7.6.0",
-    "simple-git": "^3.20.0",
-    "string-width": "^8.1.0",
-    "wrap-ansi": "^9.0.2",
-    "zod": "^4.0.5"
-  },
+  "dependencies": {},
   "files": [
     "src",
     "!**/*.tsbuildinfo"

tools/zod2md-nx-plugin/src/lib/plugin.js

@@ -3,6 +3,9 @@ import { dirname } from 'node:path';
 export const createNodesV2 = [
   `**/zod2md.config.ts`,
   async (zod2MdConfigurationFiles, createNodesOptions, context) => {
+    const options = createNodesOptions ?? {};
+    const targetName = options.targetName ?? 'generate-docs';
+
     return Promise.all(
       zod2MdConfigurationFiles.map(async zod2MdConfigurationFile => {
         const projectRoot = dirname(zod2MdConfigurationFile);
@@ -11,22 +14,24 @@ export const createNodesV2 = [
           projects: {
             [normalizedProjectRoot]: {
               targets: {
-                'generate-docs': {
+                [targetName]: {
                   executor: 'nx:run-commands',
                   options: {
                     commands: [
-                      'zod2md --config {projectRoot}/zod2md.config.ts',
-                      'prettier --write {projectRoot}/docs/{projectName}-reference.md',
+                      'zod2md --config {args.config} --output {args.output}',
+                      'prettier --write {args.output}',
                     ],
                     parallel: false,
+                    config: '{projectRoot}/zod2md.config.ts',
+                    output: '{projectRoot}/docs/{projectName}-reference.md',
                   },
                   cache: true,
                   inputs: [
                     'production',
                     '^production',
                     '{projectRoot}/zod2md.config.ts',
                   ],
-                  outputs: ['{projectRoot}/docs/{projectName}-reference.md'],
+                  outputs: ['{projectRoot}/docs/{outputFile}'],
                 },
               },
             },