Color string utility migration#62
Merged
blwatkins merged 5 commits intoJul 16, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR deprecates the ColorStringUtility API in @blwatkins/utils as part of migrating that functionality to the separate @blwatkins/color-utils package, and updates linting + published docs to surface deprecation status.
Changes:
- Added
@deprecatedTSDoc annotations toColorStringUtility(class + members) to mark the migration/removal timeline. - Updated TypeScript ESLint configuration to warn on deprecated API usage and to recognize/sort the
@deprecatedtag in JSDoc rules. - Updated package metadata keywords and refreshed the committed release docs output (TypeDoc HTML + search/nav assets) to reflect the deprecation.
Reviewed changes
Copilot reviewed 24 out of 26 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/string/color-string-utility.ts | Adds @deprecated annotations to the color-string validation utility API. |
| package.json | Removes keywords related to color/hex and “validator”. |
| eslint.config.ts.mjs | Enables deprecated-usage warnings and adds deprecated to JSDoc tag sorting/allow-list. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/variables/random.weightedElementSchema.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/variables/discriminator.discriminatedSchema.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/types/random.WeightedList.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/types/discriminator.TypeGuard.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/types/discriminator.Discriminated.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/modules/string.html | Updates module page to mark ColorStringUtility as deprecated. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/interfaces/random.WeightedElement.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/interfaces/random.SeedVersion.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/interfaces/discriminator.DiscriminatorRegistration.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/index.html | Updates the release doc landing text. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/enums/discriminator.Discriminators.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/string.StringUtility.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/string.ColorStringUtility.html | Updates class page to show deprecation tag + styling. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/random.WeightedElementUtility.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/random.SeedVersions.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/random.SeededRandomNumberGenerator.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/random.RandomNumberGeneratorFactory.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/random.Random.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/number.NumberUtility.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/classes/discriminator.DiscriminatorRegistry.html | Regenerated TypeDoc output (source links updated). |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/search.js | Updates the bundled search index data for the release docs. |
| docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/navigation.js | Updates the bundled navigation data for the release docs. |
Files not reviewed (2)
- docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/navigation.js: Generated file
- docs/releases/v0.x/v0.1.x/v0.1.0-alpha.x/v0.1.0-alpha.2/doc/assets/search.js: Generated file
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
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.
Deprecate
ColorStringUtility.ColorStringUtilityis being migrated to@blwatkins/color-utilsand will be available in itsv0.1.0-alpha.0release.