Skip to content

feat(utils): export loose autocomplete type helper #1118

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

Merged
merged 1 commit into from
Sep 24, 2025
Merged

feat(utils): export loose autocomplete type helper #1118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion packages/utils/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ export {
} from './lib/reports/generate-md-reports-diff.js';
export { loadReport } from './lib/reports/load-report.js';
export { logStdoutSummary } from './lib/reports/log-stdout-summary.js';
export { scoreReport, scoreAuditsWithTarget } from './lib/reports/scoring.js';
export { scoreAuditsWithTarget, scoreReport } from './lib/reports/scoring.js';
export { sortReport } from './lib/reports/sorting.js';
export type {
ScoredCategoryConfig,
Expand Down Expand Up @@ -142,6 +142,7 @@ export type {
ExtractArray,
ExtractArrays,
ItemOrArray,
LooseAutocomplete,
Prettify,
WithRequired,
} from './lib/types.js';
Expand Down
11 changes: 11 additions & 0 deletions packages/utils/src/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,14 @@ export type KebabCaseToCamelCase<T extends string> =
T extends `${infer First}-${infer Rest}`
? `${First}${Capitalize<KebabCaseToCamelCase<Rest>>}`
: T;

/**
* Autocompletes string from union, while allowing any other string to be assigned.
*
* @example
* let color: LooseAutocomplete< 'red' | 'green' | 'blue'>;
*
* color = 'green'; // IDE autocompletes 'red', 'green', 'blue'
* color = '#516bc6'; // any string passes type check
*/
export type LooseAutocomplete<T extends string> = T | (string & {});
Loading