Skip to content

feat(plugin-jsdocs): add setup wizard binding#1279

Open
hanna-skryl wants to merge 1 commit intomainfrom
jsdocs-plugin-binding
Open

feat(plugin-jsdocs): add setup wizard binding#1279
hanna-skryl wants to merge 1 commit intomainfrom
jsdocs-plugin-binding

Conversation

@hanna-skryl
Copy link
Copy Markdown
Collaborator

Closes #1259

JSDocs plugin binding for the setup wizard. Prompts for source file patterns and category generation.

@hanna-skryl hanna-skryl self-assigned this Mar 27, 2026
@github-actions github-actions bot added 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests 🧩 create-cli 🧩 jsdocs-plugin labels Mar 27, 2026
@nx-cloud
Copy link
Copy Markdown

nx-cloud bot commented Mar 27, 2026

View your CI Pipeline Execution ↗ for commit 284d3b5

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 29s View ↗
nx run-many --targets=code-pushup --parallel=fa... ✅ Succeeded 14m 4s View ↗
nx run-many -t unit-test,int-test ✅ Succeeded 2m 4s View ↗

☁️ Nx Cloud last updated this comment at 2026-03-27 20:41:38 UTC

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Mar 27, 2026

Open in StackBlitz

@code-pushup/ci

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

@code-pushup/cli

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

@code-pushup/core

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

@code-pushup/create-cli

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

@code-pushup/models

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

@code-pushup/nx-plugin

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

@code-pushup/axe-plugin

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

@code-pushup/eslint-plugin

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

@code-pushup/coverage-plugin

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

@code-pushup/js-packages-plugin

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

@code-pushup/jsdocs-plugin

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

@code-pushup/lighthouse-plugin

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

@code-pushup/typescript-plugin

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

@code-pushup/utils

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

commit: 284d3b5

@github-actions
Copy link
Copy Markdown
Contributor

Code PushUp

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

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Categories

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Performance 🔴 34 🔴 37 ↑ +2.9
Documentation 🟡 51 🟡 51 ↓ −0.1
Code coverage 🟢 92 🟢 92 ↑ +0.1
Bug prevention 🟡 75 🟡 75 ↓ −0.1
Axe Accessibility 🟡 88 🟡 88 ↓ −0.1
Code style 🟢 100 🟢 100
Security 🔴 0 🔴 0
Updates 🟡 73 🟡 73
Type Safety 🟡 67 🟡 67
Miscellaneous 🟡 67 🟡 67
Accessibility 🟢 92 🟢 92
Best Practices 🟢 100 🟢 100
SEO 🟢 92 🟢 92
👍 2 groups improved, 👎 1 group regressed, 👍 6 audits improved, 👎 3 audits regressed, 17 audits changed without impacting score

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
Lighthouse Performance 🔴 34 🔴 37 ↑ +2.9
JSDocs coverage Documentation coverage 🟡 51 🟡 51 ↓ −0.1
Code coverage Code coverage metrics 🟢 92 🟢 92 ↑ +0.1

31 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
Lighthouse Total Blocking Time 🟥 2,680 ms 🟥 1,700 ms ↓ −36.5 %
Lighthouse First Contentful Paint 🟥 3.4 s 🟥 3.2 s ↓ −6.1 %
Lighthouse Speed Index 🟥 6.3 s 🟥 6.2 s ↓ −1.9 %
Lighthouse Max Potential First Input Delay 🟥 1,280 ms 🟥 690 ms ↓ −45.9 %
JSDocs coverage Variables coverage 🟥 330 undocumented variables 🟥 334 undocumented variables ↑ +1.2 %
JSDocs coverage Types coverage 🟥 291 undocumented types 🟥 292 undocumented types ↑ +0.3 %
JSDocs coverage Functions coverage 🟥 669 undocumented functions 🟥 671 undocumented functions ↑ +0.3 %
Code coverage Line coverage 🟩 92.3 % 🟩 92.3 % ↑ +0.1 %
Code coverage Function coverage 🟩 93.9 % 🟩 93.9 % ↑ +0.1 %
Lighthouse Avoids enormous network payloads 🟩 Total size was 2,463 KiB 🟩 Total size was 2,425 KiB ↓ −1.6 %
Lighthouse Minimizes main-thread work 🟥 12.3 s 🟥 8.8 s ↓ −28.3 %
Lighthouse Uses efficient cache policy on static assets 🟨 31 resources found 🟨 31 resources found ↑ +0.1 %
Lighthouse JavaScript execution time 🟥 3.3 s 🟥 2.9 s ↓ −12.7 %
Lighthouse Server Backend Latencies 🟩 760 ms 🟩 350 ms ↓ −54.2 %
Lighthouse Reduce unused JavaScript 🟥 Potential savings of 272 KiB 🟥 Potential savings of 272 KiB ↑ +22.5 %
Lighthouse Largest Contentful Paint 🟥 13.1 s 🟥 13.2 s ↑ +0.8 %
Lighthouse Metrics 🟩 100% 🟩 100% ↑ +0.7 %
Lighthouse Time to Interactive 🟥 14.6 s 🟥 14.7 s ↑ +0.7 %
Lighthouse Initial server response time was short 🟩 Root document took 440 ms 🟩 Root document took 420 ms ↓ −5.2 %
Lighthouse Reduce unused CSS 🟥 Potential savings of 110 KiB 🟥 Potential savings of 110 KiB ↓ −4.3 %
Lighthouse Remove duplicate modules in JavaScript bundles 🟥 Potential savings of 112 KiB 🟥 Potential savings of 99 KiB ↓ −4.3 %
Lighthouse Network Round Trip Times 🟩 50 ms 🟩 70 ms ↑ +24.2 %
JS packages Vulnerabilities for npm dev dependencies. 🟥 74 vulnerabilities (3 critical, 41 high, 23 moderate, 7 low) 🟥 75 vulnerabilities (4 critical, 43 high, 22 moderate, 6 low) ↑ +1.4 %
Lighthouse Avoids an excessive DOM size 🟥 2,348 elements 🟥 2,349 elements ↑ +0.1 %
Code coverage Branch coverage 🟨 89.2 % 🟨 89.2 % ↑ +0.1 %
Lighthouse Cumulative Layout Shift 🟩 0 🟩 0 ↑ +∞ %

652 other audits are unchanged.

@github-actions
Copy link
Copy Markdown
Contributor

Code PushUp

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

💼 Project plugin-jsdocs

🤨 Code PushUp report has both improvements and regressions.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Documentation 🟡 83 🟡 81 ↓ −2.4
Code coverage 🟢 97 🟢 97 ↓ −0.1

4 other categories are unchanged.

👎 2 groups regressed, 👍 1 audit improved, 👎 4 audits regressed

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
JSDocs coverage Documentation coverage 🟡 83 🟡 81 ↓ −2.4
Code coverage Code coverage metrics 🟢 97 🟢 97 ↓ −0.1

13 other groups are unchanged.

🛡️ Audits

🔌 Plugin 🛡️ Audit 📏 Previous value 📏 Current value 🔄 Value change
JSDocs coverage Types coverage 🟨 2 undocumented types 🟨 3 undocumented types ↑ +50 %
JSDocs coverage Functions coverage 🟨 5 undocumented functions 🟨 7 undocumented functions ↑ +40 %
JSDocs coverage Variables coverage 🟥 10 undocumented variables 🟥 14 undocumented variables ↑ +40 %
Code coverage Line coverage 🟩 96 % 🟩 96.6 % ↑ +0.6 %
Code coverage Branch coverage 🟩 92.5 % 🟩 92.3 % ↓ −0.2 %

439 other audits are unchanged.

💼 Project plugin-coverage

🥳 Code PushUp report has improved.

🕵️ See full comparison in Code PushUp portal 🔍

🏷️ Category ⭐ Previous score ⭐ Current score 🔄 Score change
Documentation 🟡 68 🟡 68 ↑ +0.1

5 other categories are unchanged.

👍 1 group improved

🗃️ Groups

🔌 Plugin 🗃️ Group ⭐ Previous score ⭐ Current score 🔄 Score change
JSDocs coverage Documentation coverage 🟡 68 🟡 68 ↑ +0.1

14 other groups are unchanged.

🛡️ Audits

All of 444 audits are unchanged.


12 other projects are unchanged.

@hanna-skryl hanna-skryl marked this pull request as ready for review March 27, 2026 21:11
@hanna-skryl hanna-skryl requested a review from matejchalk March 27, 2026 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🧩 create-cli 🧩 jsdocs-plugin 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JSDocs plugin setup wizard

1 participant