Skip to content
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.

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

Migrate to modern stack, including TS, new linting, updated APIs #255

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

janishutz
Copy link

What's new

  • Migrated to TS
  • All methods feature full JSDoc documentation
  • Add new APIs with Promise and other modern JS features
  • Test have been updated to work with the new APIs too
  • Updated ESLint config that also does code formatting

Why

I have used this project before, but only browser based, where the current stack was good enough, but now that I am using this project for a web-app with a bundler, where I like to use NPM packages, it simply wasn't enough any more.

@janishutz
Copy link
Author

Alright, I have finished this. I haven't bothered implementing tests for the new APIs, as they are the same as the old ones, but simply using modern browser APIs.

@janishutz janishutz marked this pull request as ready for review June 28, 2024 11:33
@janishutz
Copy link
Author

@lokesh Sorry for the large PR. It's a lot of changes in the package-lock.json and the built files

@janishutz
Copy link
Author

I would also like to suggest adding the wiki feature of GitHub. You can let me know when it is up, I can edit the Wiki for you and create docs. Alternatively, I could write some docs as a website

@janishutz
Copy link
Author

I might just publish my own version of this to npm, so both versions exist

@janishutz
Copy link
Author

I did publish my own package. npm i @janishutz/color-thief

@challet
Copy link

challet commented Sep 11, 2024

I did publish my own package. npm i @janishutz/color-thief

Your package is actually @janishutz/colorthief ;)

@janishutz
Copy link
Author

Ohh right... thanks for pointing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants