[#1988] Added JSDoc for ESLint.#1990
Conversation
WalkthroughAdds a new devDependency, prettier-plugin-jsdoc@^1.3.3, to package.json. No other files or configuration fields were changed. Changes
Sequence Diagram(s)Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
package.json (1)
18-30: Enable eslint-plugin-jsdoc and extend lint-js file extensions
- In
/.eslintrc.jsonand/.vortex/docs/.eslintrc.js, add"plugin:jsdoc/recommended"to theextendsarray and include"jsdoc"inplugins.- In
package.json’sscripts.lint-js, change--ext .jsto--ext .js,.jsx,.mjs(or to match all JS module filetypes used).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ 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 (1)
- GitHub Check: build (0)
- GitHub Check: vortex-test-workflow (1)
- GitHub Check: vortex-test-workflow (4)
- GitHub Check: vortex-test-deployment (0)
- GitHub Check: vortex-test-deployment (1)
- GitHub Check: vortex-test-workflow (3)
- GitHub Check: vortex-test-common
- GitHub Check: vortex-test-workflow (2)
- GitHub Check: vortex-test-workflow (0)
- GitHub Check: vortex-test-installer (8.2)
- GitHub Check: vortex-test-installer (8.4)
- GitHub Check: vortex-test-installer (8.3)
- GitHub Check: vortex-test-docs
| "eslint-plugin-prettier": "^5.5.4", | ||
| "eslint-plugin-yml": "^1.16.0", | ||
| "prettier": "^3.6.2", | ||
| "prettier-plugin-jsdoc": "^1.3.3", |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
🛠️ Refactor suggestion
This change doesn’t meet the PR/issue objective (ESLint ES6 + JSDoc rules).
You added Prettier’s JSDoc formatting plugin, but:
- The linked issue asks to switch ESLint config from ES5 to ES6.
- The PR title mentions “JSDoc for ESLint,” which typically implies
eslint-plugin-jsdoc, notprettier-plugin-jsdoc.
Action:
- Update ESLint config to ES6 (e.g.,
env: { es2021: true },parserOptions: { ecmaVersion: "latest", sourceType: "module" }). - Add and configure
eslint-plugin-jsdocfor linting JSDoc. - Keep
prettier-plugin-jsdoconly if you want Prettier to auto-format JSDoc.
I can draft the ESLint config and rule set for ES6 + JSDoc if you prefer.
🧹 Nitpick (assertive)
Wire up the Prettier plugin; otherwise it likely has no effect.
With Prettier v3, plugins typically need explicit configuration. Ensure .prettierrc* or package.json "prettier" lists the plugin.
Suggested addition (only if you’re not using a separate .prettierrc):
{
"name": "your_site",
...
"private": true,
+ "prettier": {
+ "plugins": ["prettier-plugin-jsdoc"]
+ },
"engines": {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "prettier-plugin-jsdoc": "^1.3.3", | |
| { | |
| "name": "your_site", | |
| ... | |
| "private": true, | |
| "prettier": { | |
| "plugins": ["prettier-plugin-jsdoc"] | |
| }, | |
| "engines": { |
🤖 Prompt for AI Agents
In package.json around line 26, the prettier-plugin-jsdoc entry is present but
not wired into Prettier; add a "prettier" key in package.json (or update your
existing .prettierrc* file) to include "plugins": ["prettier-plugin-jsdoc"] so
Prettier v3 loads the plugin. If you already use a .prettierrc(.json/.js/.cjs)
instead of package.json, add the same plugins array there; after updating, run
your formatter to verify the plugin is applied.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1990 +/- ##
========================================
Coverage 77.68% 77.68%
========================================
Files 90 90
Lines 5549 5549
Branches 44 44
========================================
Hits 4311 4311
Misses 1238 1238 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
Closes #1988
Summary by CodeRabbit