Skip to content

chore: properly use @alias tag in deprecated utilities #741

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: properly use @alias tag in deprecated utilities #741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2248b6
chore: properly use `@alias` tag in deprecated utilities
JoshuaKGoldberg Mar 24, 2025
1d7025d
Merge branch 'main' into utilities-deprecated-alias-tags
JoshuaKGoldberg Sep 25, 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
1 change: 0 additions & 1 deletion knip.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"$schema": "https://unpkg.com/knip@5/schema-jsonc.json",
"entry": ["src/index.ts!"],
"ignore": ["src/types/utilities.ts"], // https://github.com/webpro-nl/knip/issues/996
"ignoreExportsUsedInFile": { "interface": true, "type": true },
"ignoreMembers": ["finish"], // https://github.com/webpro/knip/issues/414
"include": ["classMembers"],
Expand Down
3 changes: 3 additions & 0 deletions src/types/utilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
}

/**
* @alias {@link intersectionConstituents}

Check failure on line 47 in src/types/utilities.ts

View workflow job for this annotation

GitHub Actions / lint 

Syntax error in type: @link intersectionConstituents
* @deprecated Use {@link intersectionConstituents} instead.
* @category Types - Utilities
* ```
Expand Down Expand Up @@ -294,6 +295,7 @@
}

/**
* @alias {@link typeConstituents}

Check failure on line 298 in src/types/utilities.ts

View workflow job for this annotation

GitHub Actions / lint 

Syntax error in type: @link typeConstituents
* @deprecated Use {@link typeConstituents} instead.
* @category Types - Utilities
*/
Expand All @@ -318,6 +320,7 @@
}

/**
* @alias {@link unionConstituents}

Check failure on line 323 in src/types/utilities.ts

View workflow job for this annotation

GitHub Actions / lint 

Syntax error in type: @link unionConstituents
* @deprecated Use {@link unionConstituents} instead.
* @category Types - Utilities
*/
Expand Down
Loading