Refactoring - Githubissues

mathiasvr / bluejay-configurator

Cross-platform application for Bluejay firmware flashing and configuration

https://github.com/mathiasvr/bluejay

GNU General Public License v3.0

38 stars 5 forks source link

Refactoring #6

Open stylesuxx opened 3 years ago

stylesuxx commented 3 years ago

There is a lot of potential for refactoring.

instead of requiring functionality locally it has been added globally fetchJSON for example is included in the main.html and is used all over the place without properly including it
In the JSX files a lot of promises are used instead of using the much more readable async/await
libraries have been committed into the projects source instead of listing them as dependencies

This is just a couple of things that crossed my eye. Refactoring this will be a lot of work and definitely should be done in multiple steps. I would start be removing the libraries from the source and instead include them "properly" via dependencies and then move on from there.

stylesuxx commented 3 years ago

OK, I gave it a shot at refactoring the statically included libs as proper dependencies - it is dependency hell. IMHO this is not worth the time at all.

If our goal is to have a PWA in the end, we should start from scratch, I am sure we can re-use a fair amount of code.

Further it is also a bit mix and match in regards to frameworks - the bigger components use React, but then again we have a lot of stuff that is updated and manipulated via jQuery.

freshollie commented 2 years ago

Hey @stylesuxx, you may find my current attempt at a rewrite of the main configurator useful for inspiration on architecture. Thought I see you've already rewritten this as esc-configurator.

Really cool to see that web-serial can be used, definitely going to consider also supporting this!

stylesuxx commented 2 years ago

@freshollie - very nice, I'll give it a deep dive at some point.

Web serial is really nice, but due to the limitations on which browsers it will work, I don't necessarily think it is the way to go. It doesn't seem to be easy to convince users to use Chromium based browsers, especially since some vendors disable this great functionality (like Brave browser for example).