chore: add zod2md-nx-plugin #1162
Open
+18,080
−14,844
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
📖 Project documentation
|
View your CI Pipeline Execution ↗ for commit b2c3729
☁️ Nx Cloud last updated this comment at |
@code-pushup/ci
@code-pushup/cli
@code-pushup/core
@code-pushup/create-cli
@code-pushup/models
@code-pushup/nx-plugin
@code-pushup/axe-plugin
@code-pushup/coverage-plugin
@code-pushup/eslint-plugin
@code-pushup/js-packages-plugin
@code-pushup/jsdocs-plugin
@code-pushup/lighthouse-plugin
@code-pushup/typescript-plugin
@code-pushup/utils
commit: |
Contributor
Code PushUp🤨 Code PushUp report has both improvements and regressions – compared current commit e2d4ebf with previous commit 7b82402. 🕵️ See full comparison in Code PushUp portal 🔍 🏷️ Categories
👍 3 groups improved, 👎 7 groups regressed, 👍 7 audits improved, 👎 11 audits regressed, 40 audits changed without impacting score🗃️ Groups
24 other groups are unchanged. 🛡️ Audits
621 other audits are unchanged. |
Contributor
matejchalk
requested changes
Dec 3, 2025
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
matejchalk
reviewed
Dec 4, 2025
BioPhoton
added a commit
that referenced
this pull request
Dec 5, 2025
This PR moves the transformer logic into tools and makes it configurable Followup PR: #1162 --------- Co-authored-by: John Doe <john.doe@example.com> Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
matejchalk
requested changes
Dec 11, 2025
packages/models/project.json
Outdated
Comment on lines
10
to
11
| "generate-docs", | ||
| "ts-patch", |
Collaborator
There was a problem hiding this comment.
Why doesn't the plugin add these dependencies? The whole idea is that each project creates a config file (zod2md.config.ts), and the Nx plugin (zod2md-jsdocs) takes care of everything else.
Also, I wouldn't place the ts-patch here. The previous setup was simpler, as there was a single tspatch (actually called pre-build before) target in zod2md-jsdocs, and it was a dependency of zod2md-jsdocs's build target. This way, there's only 1 target in 1 project. Which makes sense, because installing ts-patch isn't something that needs to run per project, our development dependencies are installed globally.
| // nx.json | ||
| { | ||
| //... | ||
| "plugins": ["./tools/zod2md-jsdocs-nx-plugin/src/lib/plugin.js"], |
Collaborator
There was a problem hiding this comment.
The path ./tools/zod2md-jsdocs-nx-plugin/src/lib/plugin.js is incorrect; it's actually ./tools/zod2md-jsdocs/dist/src (as used in nx.json). It appears several times in this document.
Collaborator
Author
There was a problem hiding this comment.
A plugin cant depend on a dist folder as it would need to build with Nx first (or have our build manually replicated in a post install script or so).
I adjusted the plugin format to .ts and referenced it
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Followup of #1163
This PR includes:
zod2md-jsdocszod2md.config.tsA potential followup PR could implement a nx plugin for our
buildtarget and adddependsOnsettings 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