Skip to content

Conversation

@samchon
Copy link
Owner

@samchon samchon commented Jan 23, 2026

This pull request introduces enhancements to the JSDoc comment generation logic in HttpMigrateRouteComposer, making the generated documentation more comprehensive and extensible, especially for plugin properties. It also adds a new test to verify the correct inclusion and formatting of custom plugin fields in the route comments.

Enhancements to JSDoc comment generation:

  • Refactored the comment tag composition in HttpMigrateRouteComposer to include additional sections such as security, tags, deprecation status, and custom plugin properties (fields starting with x-). This ensures that any relevant OpenAPI extensions are now documented in the generated comments. [1] [2] [3]

Testing improvements:

  • Added a new test, test_http_migrate_route_plugin, to verify that custom plugin fields (e.g., x-autobe-specification) are correctly included in the generated route comments and formatted as expected.

Package version update:

  • Bumped the package version in package.json from 6.0.0 to 6.0.1 to reflect the new features and improvements.

@samchon samchon self-assigned this Jan 23, 2026
@samchon samchon added the enhancement New feature or request label Jan 23, 2026
Copilot AI review requested due to automatic review settings January 23, 2026 08:52
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances the JSDoc comment generation for migrated HTTP routes to surface more OpenAPI metadata (including custom plugin properties) and adds a targeted test, along with a patch version bump.

Changes:

  • Refactors HttpMigrateRouteComposer’s route comment composition to include security, tags, deprecation status, and x- plugin properties in a structured JSDoc-style format.
  • Adds test_http_migrate_route_plugin to validate that custom plugin fields (e.g., x-autobe-specification) are correctly serialized into route comments, including multi-line content.
  • Bumps the package version from 6.0.0 to 6.0.1 to reflect the added functionality.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/composers/HttpMigrateRouteComposer.ts Adjusts description assembly and extends comment tag composition to cover parameters, security, tags, deprecation, and primitive x- plugin properties before finalizing the route JSDoc comment.
test/src/features/migrate/test_http_migrate_route_plugin.ts Introduces a new test that builds an OpenAPI document with a custom x-autobe-specification plugin property and asserts that route.comment() includes and formats the plugin text as expected.
package.json Increments the package version to 6.0.1 to capture the new comment-generation behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@samchon samchon merged commit 6f72b89 into master Jan 23, 2026
4 checks passed
@samchon samchon deleted the feat/plugin branch January 23, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants