Add JSDoc @deprecated annotations for contrib re-exports #1345
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
Replace simple `// DEPRECATED - use original` comments with proper JSDoc @deprecated tags. The annotations clearly indicate that: 1. The re-export location is deprecated (not the class/type itself) 2. Users should import from the new Contrib namespace instead 3. The exported classes/types themselves are NOT deprecated This makes deprecation visible in IDEs and documentation tools. Co-authored-by: jkowalleck <2765863+jkowalleck@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add code annotation for deprecated re-exports
Add JSDoc @deprecated annotations for contrib re-exports
Nov 26, 2025
Copilot finished work on behalf of
jkowalleck
November 26, 2025 13:16
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.
Replace
// DEPRECATED - use originalcomments with proper JSDoc@deprecatedtags so IDEs and documentation tools surface the deprecation warning. The annotations clarify that the import path is deprecated, not the exported classes themselves.Changes
src/builders/index.node.ts-FromNodePackageJsonre-exportsrc/factories/index.common.ts-LicenseFactory,PackageUrlFactoryre-exportssrc/factories/index.node.ts-FromNodePackageJsonre-exportsrc/types/index.ts-NodePackageJsontypes re-exportsrc/utils/index.node.ts-NpmjsUtility,LicenseUtilityre-exportsExample
Includes merged changes from PR #1343 (contrib namespace refactor).
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.