Setup prettier-plugin-jsdoc for comment level styling.
#1650
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
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
commit: |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request sets up the prettier-plugin-jsdoc package to enable Prettier formatting of JSDoc comments. The change adds the plugin to development dependencies and configures it to automatically format comment-level styling throughout the codebase.
Key changes:
- Added
prettier-plugin-jsdocplugin configuration to format JSDoc comments - Applied consistent JSDoc formatting across numerous TypeScript files
- Updated package dependencies to include the new plugin
Reviewed Changes
Copilot reviewed 129 out of 130 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| test/package.json | Added prettier-plugin-jsdoc to devDependencies |
| test/prettier.config.js | Added prettier-plugin-jsdoc to plugins array |
| Multiple test/src files | Applied consistent JSDoc formatting (single-line for simple comments, multi-line for complex ones) |
| Multiple src files | Applied consistent JSDoc formatting throughout source code |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
This pull request adds the
prettier-plugin-jsdocpackage as a development dependency, along with all of its required dependencies and type definitions. The changes update bothpackage.jsonandpnpm-lock.yamlto ensure the plugin and its ecosystem are correctly installed and resolved.Dependency additions and updates:
prettier-plugin-jsdoctodevDependenciesinpackage.json, enabling Prettier to format JSDoc comments.pnpm-lock.yamlto includeprettier-plugin-jsdocand all of its direct and transitive dependencies, such asbinary-searching,comment-parser,mdast-util-from-markdown,micromark, and related utility packages. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16]Type definitions:
@types/debug,@types/mdast,@types/ms, and@types/unist. [1] [2] [3] [4] [5] [6]These changes ensure that JSDoc formatting is supported in the codebase and that all necessary dependencies are properly managed.