ryanamay / pint Goto Github PK

this is planned, as it sucks to just rely on the generator provided by pint.

goes in tandem with issue #35

would be nice to have predefined themes, etc etc thats easily accessible within the popup window.

this issue goes in tandem with issues #38 and #36

see dependabot alert

Would be nice to be able to have a place to add custom user schemes or something.
My current plans for this is to add a json parser that parses a scheme json from fuwaa/pint-color-schemes.

Could be better though, but is definitely planned to be worked on.

would also be nice to export themes into json. that would be a requirement for this issue.

well it's a theming engine of course, would suck if you can't see other peoples profiles with their chosen design.

currently plans is to have them upload a pint.json file with their configuration on their username repository.

🌃 Pint Release Roadmap

🚀 Complete Refactoring Gitccentify

• Base Brand Redesign
• Base Popup UI Redesign
• Implement main functionality (Get Set)

🚀 Complete QuickScheme Implementation

• Implement accent color scheme generator
• fix quck change color scheme gen
• add hex setting override in quick change
• Add a text color switch for the doozeys who's crazy enough to use light mode

🕒 Todo Predefined Color Schemes

• Implement colorscheme feature
• Github Dark
• Github Light
• Solarized Dark
• #35

🕒 Todo Advanced Customisation

• Implement options UI base
• Implement options ui group based
• Implement options ui advanced (full customisation)

🕒 Todo Global Pints Implementation

• #36
• implement global pints (possibly via github dotfiles? or should i use my own framework?)

🕒 Todo Code Quality

• Refactor QuickScheme
• Refactor Pint Code because I suck at using typescript
• Fix DeepSource Issues
• Fix Linting Issues
• yeet the old code

🕒 Todo Branding/Marketing

• Create a website for Pint

🕒 Todo Documentation

• Add comments to code
• Update README

🕒 Todo QOL

• Add extension install page
• Port to Mozilla Firefox

🕒 Todo Release

• Update chrome extension page
• Update chrome extension itself

🕒 Todo Bugfixing:

• Inconsistent padding
• Color preview is broken on QuickScheme Fixed via #28

Bug Comment:
Removed on #11
Planned to reimplement due to new color scheming changes in #27

• QuickScheme hex override does not work if no hashtag is supplied Fixed via #22
• Options UI crashes when using paint tool. (probably related to paint tool) Fixed via #22
• Color picker not using grabbed value It's not a bug, it's a feature via #22

Bug Comment:
Nah it was better to use decafbad as a meme lmao
Nah c0ffee is better.

• Quirk: You need to add a # to set it properly. Fixed via #24
• header bug (to be fixed in next pr) Fixed via #27
  theres more in the backlog but this is the bare minimum before i can open contributions and push a release :)

apparently this version of pint doesn't comply with cws policy aka use of permissions.

• chrome.tabs permission isn't apparently needed for creating new stuff using the chrome.tabs api

by the looks of things github seems to be using ant-design, might be worth taking a look if we're planning to go with the github theme after all.

currently, pint is limited to chromium. it would be nice to have mozilla firefox addons support.

GitHub reports an Error in Fetching Resources when loading the image in documentation.

The current code quality is garbage, with documentation only covering 8.4% of the entire codebase.
In addition to this, inconsistencies are seen everywhere.

Some notable ones are:

• Tailwind CSS: Inconsistent padding, and it doesn't look clean.
• Code Inconsistency: JS and TS are mixed up (well mostly on src/methods as public/ are excusable because of chrome extension limitations) (also because project is currently being ported to TS)
• Code Inconsistency: Formatting
• Code Inconsistency: Linting errors as provided by GitHub actions
• Reusability: Some React Elements are Repetitive and can be turned into Reusable Components
• Too Much Magic: Too much magic-oriented JavaScript code is present.
• No Unit Tests: This project has no Tests.
• Documentation: This project currently has a code coverage of 8.4%

Things can be improved here a lot and I know it myself. While I'm currently working on this, if you want to help with this, please make a pull request and mention this issue (do not link it) :)