Skip to content

chore: add zod2md-nx-plugin #1162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
BioPhoton wants to merge 58 commits into
base: main
Choose a base branch
from
Open

chore: add zod2md-nx-plugin #1162

BioPhoton wants to merge 58 commits into from

Conversation

@BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Dec 2, 2025 •
edited
Loading

Followup of #1163
Precondition of #1188

This PR includes:

  • create nx plugin under zod2md-jsdocs
  • logic to add target config if file matches zod2md.config.ts
  • plugin docs
  • remove old config
  • remove file reference from production inputs as changes in the config may impact build output

A potential followup PR could implement a nx plugin for our build target and add dependsOn settings automatically. This is also noted in a clean up issue.

Note

This is tooling code and it is not planned to get released

Related:
#1168

@github-actions github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🛠️ tooling labels Dec 2, 2025
@nx-cloud
Copy link

nx-cloud bot commented Dec 2, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 2ac556a

Command Status Duration Result
nx run ci:code-pushup -- merge-diffs --files=/h... ✅ Succeeded 5s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 1m 31s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 12m 42s View ↗
nx run-many -t unit-test,int-test ✅ Succeeded 1m 10s View ↗

☁️ Nx Cloud last updated this comment at 2026-01-07 14:01:50 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 2, 2025 •
edited
Loading

Open in StackBlitz

@code-pushup/ci

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/ci@1162

@code-pushup/cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/cli@1162

@code-pushup/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@1162

@code-pushup/create-cli

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/create-cli@1162

@code-pushup/models

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/models@1162

@code-pushup/nx-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/nx-plugin@1162

@code-pushup/axe-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/axe-plugin@1162

@code-pushup/coverage-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/coverage-plugin@1162

@code-pushup/eslint-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/eslint-plugin@1162

@code-pushup/js-packages-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/js-packages-plugin@1162

@code-pushup/jsdocs-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/jsdocs-plugin@1162

@code-pushup/lighthouse-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/lighthouse-plugin@1162

@code-pushup/typescript-plugin

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/typescript-plugin@1162

@code-pushup/utils

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/utils@1162

commit: 2ac556a

@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025 •
edited
Loading

Code PushUp

🤨 Code PushUp report has both improvements and regressions – compared current commit 3e2a5d3 with previous commit d113fd1.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 40 🔴 34 ↓ −5.9
Code style 🟢 99 🟢 100 ↑ +0.4
Code coverage 🟢 91 🟢 91 ↓ −0.1
Bug prevention 🟡 75 🟡 75 ↓ −0.1
Axe Accessibility 🟡 88 🟡 88 ↓ −0.1
Documentation 🔴 36 🔴 36 ↓ −0.1
Security 🟡 51 🟡 51 –
Updates 🟡 79 🟡 79 –
Type Safety 🟡 67 🟡 67 –
Miscellaneous 🟡 67 🟡 67 –
Accessibility 🟢 92 🟢 92 –
Best Practices 🟢 100 🟢 100 –
SEO 🟢 92 🟢 92 –
👍 2 groups improved, 👎 3 groups regressed, 👍 1 audit improved, 👎 9 audits regressed, 12 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
ESLint Style guide (import) 🟡 80 🟢 100 ↑ +20
Lighthouse Performance 🔴 40 🔴 34 ↓ −5.9
ESLint Suggestions 🟢 99 🟢 100 ↑ +0.4
Code coverage Code coverage metrics 🟢 91 🟢 91 ↓ −0.1
JSDocs coverage Documentation coverage 🔴 36 🔴 36 ↓ −0.1

29 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Initial server response time was short 🟩 Root document took 600 ms 🟥 Root document took 670 ms ↑ +11.2 %
ESLint Forbid unassigned imports 🟥 1 warning 🟩 passed ↓ −100 %
Lighthouse Total Blocking Time 🟥 1,230 ms 🟥 2,270 ms ↑ +84.5 %
Lighthouse Speed Index 🟥 6.1 s 🟥 6.8 s ↑ +12.8 %
Lighthouse First Contentful Paint 🟥 3.1 s 🟥 3.3 s ↑ +5.7 %
Lighthouse Time to Interactive 🟥 12.8 s 🟥 13.8 s ↑ +7.3 %
Lighthouse Max Potential First Input Delay 🟥 690 ms 🟥 1,310 ms ↑ +90.8 %
Code coverage Line coverage 🟨 87 % 🟨 86.7 % ↓ −0.4 %
Code coverage Function coverage 🟩 94 % 🟩 93.9 % ↓ −0.1 %
Code coverage Branch coverage 🟨 87.3 % 🟨 87.2 % ↓ −0.1 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 2,116 KiB 🟩 Total size was 2,103 KiB ↓ −0.6 %
Lighthouse Minimizes main-thread work 🟥 7.5 s 🟥 10.5 s ↑ +38.8 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.2 %
Lighthouse JavaScript execution time 🟥 3.7 s 🟥 4.8 s ↑ +30.7 %
Lighthouse Metrics 🟩 100% 🟩 100% ↑ +7.3 %
Lighthouse Server Backend Latencies 🟩 1,260 ms 🟩 350 ms ↓ −72.3 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 95 KiB 🟥 Potential savings of 95 KiB ↑ +300 %
Lighthouse Largest Contentful Paint 🟥 11.4 s 🟥 11.6 s ↑ +1.7 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 219 KiB 🟥 Potential savings of 219 KiB ↑ +14.2 %
Lighthouse Remove duplicate modules in JavaScript bundles 🟥 Potential savings of 102 KiB 🟥 Potential savings of 103 KiB ↑ +33.3 %
Lighthouse Network Round Trip Times 🟩 70 ms 🟩 70 ms ↓ −6.2 %
JS packages Outdated npm prod dependencies. 🟨 16 outdated package versions (5 major, 8 minor, 3 patch) 🟨 15 outdated package versions (5 major, 8 minor, 2 patch) ↓ −6.2 %

657 other audits are unchanged.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 2, 2025 •
edited
Loading

Code PushUp

😐 Code PushUp report is unchanged – compared current commit 3e2a5d3 with previous commit d113fd1.

All of 14 projects are unchanged.

@BioPhoton BioPhoton marked this pull request as ready for review December 2, 2025 23:41
@BioPhoton BioPhoton requested a review from matejchalk December 2, 2025 23:41
matejchalk
matejchalk requested changes Dec 3, 2025
View reviewed changes
tools/zod2md-nx-plugin/package.json Outdated
Comment on lines 5 to 7
"publishConfig": {
"access": "public"
},
Copy link
Collaborator

@matejchalk matejchalk Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To prevent accidental publishing:

Suggested change
"publishConfig": {
"access": "public"
},
"private": true,

Why does this project even need a package.json, though?

Copy link
Collaborator

@hanna-skryl hanna-skryl Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the package.json in #928, thinking it was required for ts-patch to resolve the transformer module.

Looking at it now, I realize it was an oversight. If the transform path had pointed to the right place, Node would have found index.js automatically. Since the current setup already points to the right directory, +1 for removing it entirely.

matejchalk
matejchalk reviewed Dec 4, 2025
View reviewed changes
@BioPhoton BioPhoton mentioned this pull request Dec 4, 2025
Merged
@BioPhoton BioPhoton mentioned this pull request Dec 15, 2025
Draft
@BioPhoton
Copy link
Collaborator Author

BioPhoton commented Dec 16, 2025 •
edited
Loading

After switching to .ts format for the Nx plugin, the graph stopped computing because of NX invalid type: unit value, expected struct Options.
I researched and found out package updates help so I updated nx packages.

After the update errors popped up that i could not fully relate to the changes:

@matejchalk could you check this changes pls.

@BioPhoton BioPhoton requested a review from matejchalk December 16, 2025 01:09
John Doe added 3 commits January 6, 2026 00:11
Merge branch 'main' into chore/add-zod2md-nx-plugin
9e60d56 
# Conflicts:
#	package-lock.json
#	package.json
refactor: fix Binding issue in Nx v22
813244e
Merge branch 'main' into chore/add-zod2md-nx-plugin
d45247f 
# Conflicts:
#	packages/plugin-eslint/src/lib/eslint-plugin.int.test.ts
@BioPhoton
Copy link
Collaborator Author

BioPhoton commented Jan 5, 2026

I was able to resolve the same issue in NX v22 without changed in tests. (related: #1162 (comment))

@BioPhoton BioPhoton disabled auto-merge January 6, 2026 03:36
@BioPhoton BioPhoton requested a review from hanna-skryl January 7, 2026 22:24
hanna-skryl
hanna-skryl reviewed Jan 9, 2026
View reviewed changes
tools/zod2md-jsdocs/docs/zod2md-jsdocs-nx-plugin.md
Comment on lines +81 to +86
## Options

| Name | type | description |
| --------------------------- | ---------------------------------- | ------------------------------------------------------------------- |
| **docsTargetName** | `string` (DEFAULT 'generate-docs') | The name of the docs generation target. |
| **jsDocsTypesAugmentation** | `boolean` (DEFAULT `true`) | Whether to enable TypeScript transformer integration with ts-patch. |
Copy link
Collaborator

@hanna-skryl hanna-skryl Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The plugin doesn't accept these options, or am I missing something?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hanna-skryl hanna-skryl hanna-skryl left review comments

@matejchalk matejchalk Awaiting requested review from matejchalk

Requested changes must be addressed to merge this pull request.

Assignees

@BioPhoton BioPhoton

Labels

🧹 maintenance 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🛠️ tooling

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@BioPhoton @matejchalk @hanna-skryl