search

UW-Madison-DoIT / widget-creator

Web-based tool supporting developing widgets for uPortal-home. Documentation available at https://uw-madison-doit.github.io/widget-creator/
Apache License 2.0
2 stars 6 forks source link

Update Packages, Use Chrome to test, User Prettier to Format #25

Closed ChristianMurphy closed 6 years ago

ChristianMurphy commented 6 years ago

Updates all the dependencies package.json. Replace Phantom JS with Chrome/Puppeteer. Use ESLint Prettier to apply Prettier formatting and ESLint analysis together.

ChristianMurphy commented 6 years ago

Requested in https://github.com/uPortal-Project/uportal-app-framework/pull/580#issuecomment-337705746

ChristianMurphy commented 6 years ago

/reviewers @davidmsibley @vertein @thevoiceofzeke @apetro

ChristianMurphy commented 6 years ago

I'm still uneasy about things that are auto-formatting code built into the process.

I'd encourage giving it a try.

Take a look at the format commit 004225444f82a7532cf3393b8096300c4d7be52d. The code output is arguably very readable and an improvement over the existing code style, code that is written by competent, experienced, and intelligent people. A tool like prettier can provide that highly readable code experience not just to experienced developers, but to anyone who contributes to the project, with no friction of a broken build because of code style.

I would be in favor of having the script available, but not as part of the commit process.

the npm run format command is included in this PR. However relying on developers to manually run a formatter has proved problematic in the past. uPortal-home's build has been broken for 4 days ~and counting~ because of a code style issue.

Does this automatically re-format to use Google's code style or does this use a separate style that we would have to match to Google's?

https://github.com/uPortal-Project/uportal-app-framework/pull/580#issuecomment-337628739

This version will exactly follow Google code style. It passes code through prettier to handle graceful line breaks, then into the official Google ESLint formatter for additional tuning.

I think we can be way more open to experimental friction and risk in modules that we're less likely to need to release frequently for adoption by other teams. widget-creator is much lower risk, in that its audience is developers.

https://github.com/uPortal-Project/uportal-app-framework/pull/580#issuecomment-337705746

Widget creator was suggested as a proving ground for the uPortal-app-framework team to be able to try this process out and see if its a good fit for the team dynamic.

edit corrected typos edit 2 uPortal-home build has been fixed

ChristianMurphy commented 6 years ago

:bell: I don't have write access to this repo, if/when the team decides to merge this, someone other than me would need to click the merged button.