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 63 commits into
base: main
Choose a base branch
from
Open

chore: add zod2md-nx-plugin #1162

BioPhoton wants to merge 63 commits into from
+510 −127

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 a03d9b6

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 13m 5s View ↗
nx run-many -t unit-test,int-test ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2026-01-18 18:53:41 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/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/core

npm i https://pkg.pr.new/code-pushup/cli/@code-pushup/core@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: a03d9b6

@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 419a7e7 with previous commit 270b474.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 37 🔴 36 ↓ −0.9
Code style 🟢 99 🟢 100 ↑ +0.4
Code coverage 🟢 93 🟢 92 ↓ −0.1
Bug prevention 🟡 75 🟡 75 ↓ −0.1
Axe Accessibility 🟡 88 🟡 88 ↓ −0.1
Security 🟡 51 🟡 51 –
Updates 🟡 78 🟡 78 –
Type Safety 🟡 67 🟡 67 –
Miscellaneous 🟡 67 🟡 67 –
Documentation 🔴 42 🔴 42 –
Accessibility 🟢 92 🟢 92 –
Best Practices 🟢 100 🟢 100 –
SEO 🟢 92 🟢 92 –
👍 2 groups improved, 👎 2 groups regressed, 👍 2 audits improved, 👎 6 audits regressed, 15 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
ESLint Style guide (import) 🟡 80 🟢 100 ↑ +20
Lighthouse Performance 🔴 37 🔴 36 ↓ −0.9
ESLint Suggestions 🟢 99 🟢 100 ↑ +0.4
Code coverage Code coverage metrics 🟢 93 🟢 92 ↓ −0.1

30 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Initial server response time was short 🟩 Root document took 540 ms 🟥 Root document took 610 ms ↑ +14.1 %
ESLint Forbid unassigned imports 🟥 1 warning 🟩 passed ↓ −100 %
Lighthouse Speed Index 🟥 6.0 s 🟥 6.5 s ↑ +7.2 %
Lighthouse First Contentful Paint 🟥 3.1 s 🟥 3.2 s ↑ +5.3 %
Lighthouse Total Blocking Time 🟥 1,890 ms 🟥 1,740 ms ↓ −7.8 %
Code coverage Line coverage 🟩 92.7 % 🟩 92.3 % ↓ −0.4 %
Code coverage Function coverage 🟩 94.4 % 🟩 94.3 % ↓ −0.1 %
Code coverage Branch coverage 🟨 89 % 🟨 89 % ↓ −0.1 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 2,104 KiB 🟩 Total size was 2,106 KiB ↑ +0.1 %
Lighthouse Minimizes main-thread work 🟥 9.2 s 🟥 9.8 s ↑ +5.9 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.1 %
Lighthouse JavaScript execution time 🟥 4.3 s 🟥 4.6 s ↑ +8.8 %
Lighthouse Largest Contentful Paint 🟥 11.5 s 🟥 11.8 s ↑ +2.7 %
Lighthouse Max Potential First Input Delay 🟥 980 ms 🟥 1,250 ms ↑ +27.6 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 224 KiB 🟥 Potential savings of 225 KiB ↓ −11.7 %
Lighthouse Server Backend Latencies 🟩 1,200 ms 🟩 1,140 ms ↓ −5 %
Lighthouse Time to Interactive 🟥 13.0 s 🟥 13.1 s ↑ +0.4 %
Lighthouse Metrics 🟩 100% 🟩 100% ↑ +0.4 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 95 KiB 🟥 Potential savings of 95 KiB ↓ −1.6 %
Lighthouse Remove duplicate modules in JavaScript bundles 🟥 Potential savings of 93 KiB 🟥 Potential savings of 90 KiB ↓ −2.2 %
Lighthouse Network Round Trip Times 🟩 10 ms 🟩 20 ms ↑ +112.5 %
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 %
JS packages Outdated npm dev dependencies. 🟨 56 outdated package versions (29 major, 19 minor, 8 patch) 🟨 55 outdated package versions (29 major, 18 minor, 8 patch) ↓ −1.8 %

656 other audits are unchanged.

@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 419a7e7 with previous commit 270b474.

💼 Project create-cli

🥳 Code PushUp report has improved.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Code coverage 🟢 96 🟢 96 ↑ +0.2

5 other categories are unchanged.

👍 1 group improved, 👍 1 audit improved

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Code coverage Code coverage metrics 🟢 96 🟢 96 ↑ +0.2

14 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Code coverage Branch coverage 🟨 87.5 % 🟨 88.2 % ↑ +0.8 %

443 other audits are unchanged.

💼 Project utils

😟 Code PushUp report has regressed.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Documentation 🔴 45 🔴 45 ↓ −0.1

5 other categories are unchanged.

👎 1 group regressed

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
JSDocs coverage Documentation coverage 🔴 45 🔴 45 ↓ −0.1

14 other groups are unchanged.

🛡️ Audits

All of 444 audits are unchanged.

12 other 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
BioPhoton and others added 7 commits December 3, 2025 16:20
@BioPhoton @matejchalk
Update tools/zod2md-nx-plugin/eslint.config.js
8253323 
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
@BioPhoton @matejchalk
Update tools/zod2md-nx-plugin/README.md
670b232 
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
refactor: wip
a4cf4b9
refactor: wip
b02a6a0
refactor: wip
4d6c335
refactor: wip
ce500c7
Merge branch 'main' into chore/add-zod2md-nx-plugin
1a158f1
matejchalk
matejchalk reviewed Dec 4, 2025
View reviewed changes
@BioPhoton BioPhoton mentioned this pull request Dec 4, 2025
Merged
@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
matejchalk
matejchalk requested changes Jan 13, 2026
View reviewed changes
@BioPhoton BioPhoton requested a review from matejchalk January 18, 2026 18:40
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