Documentation on IValidation type + prettier on JSDoc.
#188
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.
|
There was a problem hiding this comment.
Pull Request Overview
This PR enhances project documentation by introducing detailed JSDoc for the new IValidation type and applies consistent Prettier formatting to existing JSDoc comments.
- Added comprehensive documentation for the
IValidationdiscriminated union and its member interfaces. - Applied one-line formatting to multi-line
@internalcomments across multiple files for consistency. - Adjusted JSDoc links, spacing, and punctuation throughout utility and composer modules.
Reviewed Changes
Copilot reviewed 52 out of 54 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/structures/IValidation.ts | Added full JSDoc for IValidation, ISuccess, IFailure, and IError. |
| src/utils/LlmDataMerger.ts | Reformatted JSDoc and updated references in LlmDataMerger.parameters. |
| src/composers/migrate/HttpMigrateRouteComposer.ts | Added missing @param connection tag in route composer comments. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (3)
src/utils/LlmDataMerger.ts:29
- The JSDoc reference
{@link IOpenAiFunction.separated}below is incorrect for this module. It should reference the LLM function separated interface, e.g.,{@link ILlmFunction.ISeparated}.
*
src/utils/LlmDataMerger.ts:54
- [nitpick] The sentence
Otherwise, returns the latter value if it's not null, otherwise the former valueis missing proper punctuation and could be clearer. Consider:Otherwise, returns the latter value if it's not null; otherwise, returns the former value.
* value
src/composers/migrate/HttpMigrateRouteComposer.ts:340
- You've added
@param connectionto the JSDoc but no description is provided. Please include a brief description, e.g.,@param connection - HTTP connection details for the migration.
add("@param connection");
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 introduces updates to the project's dependencies, focusing on adding new packages and plugins to enhance functionality, particularly around JSDoc formatting and markdown processing. Below is a summary of the most significant changes:
Dependency Additions and Updates:
Prettier Plugin for JSDoc:
prettier-plugin-jsdocto thepackage.jsonandpnpm-lock.yamlfiles, enabling better formatting for JSDoc comments. [1] [2] [3]Type Definitions:
debug,mdast, andms, improving TypeScript support for these libraries. [1] [2] [3] [4]Markdown Utilities:
mdast-util-from-markdown,mdast-util-to-string, andmicromarkpackages, enhancing markdown parsing and processing capabilities. [1] [2] [3] [4]New Packages for Parsing and Searching:
binary-searching,character-entities,comment-parser, anddecode-named-character-referenceto support various parsing and searching functionalities. [1] [2] [3] [4] [5]Deprecated Package Warning:
multer@1.4.5-lts.2, recommending an upgrade to version 2.x due to known vulnerabilities.