Skip to content

Add JSDoc @deprecated annotations for contrib re-exports #1345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add JSDoc @deprecated annotations for contrib re-exports #1345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71b5a31
Initial plan
Copilot Nov 26, 2025
51969f2
Merge branch 'pr-1343' into copilot/add-code-annotation-for-deprecation
Copilot Nov 26, 2025
c2e22d6
Add proper JSDoc @deprecated annotations for re-exports
Copilot Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/builders/index.node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,9 @@ SPDX-License-Identifier: Apache-2.0
Copyright (c) OWASP Foundation. All Rights Reserved.
*/

export * as FromNodePackageJson from '../contrib/fromNodePackageJson.node/builders' // DEPRECATED - use original
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.FromNodePackageJson.Builders` instead.
* The exported classes themselves are NOT deprecated - only this import path.
*/
export * as FromNodePackageJson from '../contrib/fromNodePackageJson.node/builders'
14 changes: 12 additions & 2 deletions src/factories/index.common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,15 @@ Copyright (c) OWASP Foundation. All Rights Reserved.

// not everything is public, yet

export * from '../contrib/license/factories' // DEPRECATED - use original
export * from '../contrib/packageUrl/factories' // DEPRECATED - use original
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.License.Factories` instead.
* The exported classes themselves are NOT deprecated - only this import path.
*/
export * from '../contrib/license/factories'
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.PackageUrl.Factories` instead.
* The exported classes themselves are NOT deprecated - only this import path.
*/
export * from '../contrib/packageUrl/factories'
7 changes: 6 additions & 1 deletion src/factories/index.node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ export * from './index.common'

// region node-specifics

export * as FromNodePackageJson from '../contrib/fromNodePackageJson.node/factories' // DEPRECATED - use original
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.FromNodePackageJson.Factories` instead.
* The exported classes themselves are NOT deprecated - only this import path.
*/
export * as FromNodePackageJson from '../contrib/fromNodePackageJson.node/factories'

// endregion node-specifics
7 changes: 6 additions & 1 deletion src/types/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,9 @@ export * from './integer'
export * from './mimeType'

// yes, this is node-specific, but who cares - these are just types
export * from '../contrib/fromNodePackageJson.node/types' // DEPRECATED - use original
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.FromNodePackageJson.Types` instead.
* The exported types themselves are NOT deprecated - only this import path.
*/
export * from '../contrib/fromNodePackageJson.node/types'
14 changes: 12 additions & 2 deletions src/utils/index.node.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ export * from './index.common'

// region node-specifics

export * as NpmjsUtility from '../contrib/fromNodePackageJson.node/utils' // DEPRECATED - use original
export * as LicenseUtility from '../contrib/license/utils.node' // DEPRECATED - use original
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.FromNodePackageJson.Utils` instead.
* The exported utilities themselves are NOT deprecated - only this import path.
*/
export * as NpmjsUtility from '../contrib/fromNodePackageJson.node/utils'
/**
* @deprecated This re-export location is deprecated.
* Import from `Contrib.License.Utils` instead.
* The exported utilities themselves are NOT deprecated - only this import path.
*/
export * as LicenseUtility from '../contrib/license/utils.node'

// endregion node-specifics
Loading