feat(typescript-migration): Migrate Colorus-js codebase to TypeScript #23
Conversation
This file contains 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
…ons (#18) * refact!: remove old js files * feat!: major refactor and introduction of plugin system - refactor: restructure file organization for improved clarity and maintainability - feat: implement plugin system with enhanced TypeScript integration - refactor!: rename Colorus class to Color - feat: add defineColor helper function for simplified instance creation - refactor: rename functions and variables for better readability and maintainability - feat: expose ColorFormatter, parseColor, and isValidColor for public use - refactor: separate parsing and serialization logic into distinct modules - refactor: organize conversion functions into separate files based on color space - refactor: move grayscale, mix, and invert methods into plugins - feat: expose a few useful typescript types for public use * refact!: ensure code structure works with new tests * chore: update Jest config for TypeScript * test: add new unit test written in TypeScript * chore: clean up test files (remove unused comments and variables)
* chore: upload initial biome config * chore!: remove old .eslintrc.json config * lint: update files after running new lint config
#19) (#21) * refact!: remove built-in plugins Remove built-in plugins for the sake of improving separation of concerns, later we will add them as separate packages. * chore(tsconfig): upload initial tsconfig.json file * refact: fix issues reported by the new tsconfig.json * chore: update deps and configs in package.json * build: update build config Automatically generate types declaration file, and use esbuild to generate more optimized JS ESNext bundles. * refact!: clean and update types * chore: update NPM ignore config file * build(config): restruct the build process config * build(tsconfig): improve tsconfig.json * build: replace plugin to print bundle size Because of some bugs with the rollup-plugin-output-size, I've decided to go with a more simple alternative, the rollup-plugin-bundle-size.
- Improve type safety - Refact colorFormatter.ts - Rewrite unit tests - Add new helper functions
…22) * ci: update lint & format configs * fix: upload linter fixes * ci: add the Release workflow * ci: upload dependabout.yml workflow * ci: move dependabout.yml to .github/ folder
supitsdu
added
📚 Documentation
supitsdu
removed
the
👀 Under Review
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.
Description
This pull request marks the successful completion of the Colorus.js migration from JavaScript to TypeScript, as outlined in issue #19. The migration enhances code maintainability, readability, and developer experience by introducing static typing, improved tooling support, and a more structured codebase.
Branching Strategy and Merging
The migration followed the branching strategy outlined in issue #19:
mainbranch: Remains the production-ready branch, now containing the stable TypeScript version of the library.feat/typescript-migrationbranch: Served as the central integration point for all TypeScript migration changes.typescript-code-conversion: Handled the conversion of JavaScript files to TypeScript and the addition of type annotations.update-build-system: Addressed changes to the build configuration for TypeScript compilation.update-workflows: Updated automated workflows to accommodate TypeScript.migrate-to-biome: Replaced ESLint and Prettier with Biome.js for linting and formatting.Each sub-feature branch was merged into
feat/typescript-migrationafter thorough review and testing. This PR now represents the final merge offeat/typescript-migrationintomain, completing the TypeScript migration process.Key Changes and Benefits
new Colorus()todye(): The class-basednew Colorus()instantiation has been replaced with a more functional and type-safedye()function, simplifying the API and improving type inferenceAdditional Considerations
Related Issues/PRs
Closes #19, Closes #15