Added prettier-plugin-jsdoc to the root FE deps and updated other deps.
#2067
Conversation
WalkthroughAdded the Prettier JSDoc plugin to devDependencies and enabled it in Prettier config; adjusted JSDoc comment formatting in one JS file. No runtime logic or scripts changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro ⛔ Files ignored due to path filters (7)
📒 Files selected for processing (3)
🧰 Additional context used📓 Path-based instructions (1)web/modules/custom/**📄 CodeRabbit inference engine (CLAUDE.md)
Files:
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
🔇 Additional comments (3)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
.vortex/installer/tests/Fixtures/install/_baseline/package.jsonis excluded by!.vortex/installer/tests/Fixtures/**yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (1)
package.json(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: build (0)
- GitHub Check: build (1)
- GitHub Check: vortex-test-deployment (0)
- GitHub Check: vortex-test-workflow (4)
- GitHub Check: vortex-test-common
- GitHub Check: vortex-test-workflow (3)
- GitHub Check: vortex-test-deployment (1)
- GitHub Check: vortex-test-workflow (1)
- GitHub Check: vortex-test-workflow (2)
- GitHub Check: vortex-test-workflow (0)
- GitHub Check: vortex-test-installer (8.3)
- GitHub Check: vortex-test-installer (8.2)
- GitHub Check: vortex-test-installer (8.4)
- GitHub Check: vortex-test-docs
🔇 Additional comments (2)
package.json (2)
1-31: PR title mentions "updated other deps" but only one dependency is added.The PR title states: "Added
prettier-plugin-jsdocto the root FE deps and updated other deps" (emphasis added). However, the provided diff shows only the addition ofprettier-plugin-jsdoc@^1.5.0.Verify whether other dependencies were updated in this PR, or clarify the PR title if only this plugin was added.
1-31: Clarify scope: PR title mentions "updated other deps" but only one dependency is added.The PR title states: "Added
prettier-plugin-jsdocto the root FE deps and updated other deps," but the provided diff shows only the addition ofprettier-plugin-jsdoc.Either other dependencies were updated in this PR (but not shown in the diff), or the PR title should be revised for clarity.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2067 +/- ##
========================================
Coverage 64.05% 64.05%
========================================
Files 92 92
Lines 5692 5692
Branches 44 44
========================================
Hits 3646 3646
Misses 2046 2046 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
AlexSkrypnyk
force-pushed
the
feature/update-fe-deps
branch
from
d290036 to
e532337
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (7)
.vortex/installer/tests/Fixtures/install/_baseline/.prettierrc.jsonis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/_baseline/package.jsonis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/_baseline/web/modules/custom/sw_base/js/sw_base.jsis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/hosting_acquia/docroot/modules/custom/sw_base/js/sw_base.jsis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/hosting_project_name___acquia/docroot/modules/custom/sw_base/js/sw_base.jsis excluded by!.vortex/installer/tests/Fixtures/**.vortex/installer/tests/Fixtures/install/names/web/modules/custom/the_force_base/js/the_force_base.jsis excluded by!.vortex/installer/tests/Fixtures/**yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (3)
.prettierrc.json(1 hunks)package.json(1 hunks)web/modules/custom/ys_base/js/ys_base.js(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
web/modules/custom/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place all custom Drupal modules under web/modules/custom/[module_name]/.
Files:
web/modules/custom/ys_base/js/ys_base.js
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: build (0)
- GitHub Check: build (1)
- GitHub Check: vortex-test-deployment (1)
- GitHub Check: vortex-test-workflow (4)
- GitHub Check: vortex-test-deployment (0)
- GitHub Check: vortex-test-workflow (2)
- GitHub Check: vortex-test-workflow (3)
- GitHub Check: vortex-test-workflow (1)
- GitHub Check: vortex-test-workflow (0)
- GitHub Check: vortex-test-common
- GitHub Check: vortex-test-installer (8.4)
- GitHub Check: vortex-test-installer (8.3)
- GitHub Check: vortex-test-installer (8.2)
- GitHub Check: vortex-test-docs
🔇 Additional comments (3)
.prettierrc.json (1)
6-6: Plugin registration correctly configured.The
prettier-plugin-jsdocis now properly registered in the Prettier configuration and will be loaded at runtime. This aligns with the dependency addition and enables JSDoc formatting.web/modules/custom/ys_base/js/ys_base.js (2)
14-15: JSDoc parameter description reformatted by plugin.The
contextparameter description has been adjusted for line-break formatting. This is a documentation-only change with no impact on function behavior.
77-77: JSDoc parameter description consolidated to single line.The
elementparameter description has been reformatted to a single line. This is a documentation-only change with no impact on function behavior.
| "eslint-plugin-prettier": "^5.5.4", | ||
| "eslint-plugin-yml": "^1.16.0", | ||
| "prettier": "^3.6.2", | ||
| "prettier-plugin-jsdoc": "^1.5.0", |
There was a problem hiding this comment.
🧩 Analysis chain
Verify prettier-plugin-jsdoc version availability.
Previous review flagged version ^1.5.0 as potentially non-existent (suggesting 1.3.3 as the latest). Confirm that this version is currently available on npm and compatible with prettier@^3.6.2.
🌐 Web query:
What is the latest version of prettier-plugin-jsdoc available on npm?
💡 Result:
The latest version on npm is 1.3.3 (published 2 months ago, as of October 31, 2025). [1][2]
Sources:
[1] npm package page — prettier-plugin-jsdoc.
[2] jsDelivr/npm registry listing — prettier-plugin-jsdoc.
Update prettier-plugin-jsdoc to an available version.
The latest version available on npm is 1.3.3. Version 1.5.0 does not exist and will cause npm install to fail. Change to "prettier-plugin-jsdoc": "^1.3.3".
🤖 Prompt for AI Agents
In package.json around line 26, the dependency version for prettier-plugin-jsdoc
is incorrect (1.5.0 doesn't exist); update the version string to a valid
published version such as "^1.3.3" so npm install succeeds, then run npm install
(or yarn) and verify lockfile updates.
e532337 to
a9b855b
Compare
Summary by CodeRabbit