USWDS-Next - CI: Create a GH action to test code formatting - Githubissues

uswds / web-components

Work on the next version of USWDS will happen here

https://federalist-c7964e49-2db7-4585-85f1-49d23b9329cb.sites.pages.cloud.gov/site/uswds/uswds-next/

23 stars 4 forks source link

USWDS-Next - CI: Create a GH action to test code formatting #32

Closed mejiaj closed 1 month ago

mejiaj commented 2 months ago

Closes #33.

A new CI test that runs prettier on push.

Before	After

Major changes

GitHub actions npm caching: For performance, I've added global npm caching to GitHub actions.
Added prettier config: Added .prettierrc and .prettierignore as best practice.
Added formatting tests: New tests for testing JS [npm runprettier:js] and MDX [npm run prettier:md] files. Formatting fixes included.

How to test

Run npm run prettier:js && npm run prettier:md.
There should be zero errors.
Modify a JS file to add an error like ${ this.href }.
You should see a code style issue.
Modify an MDX file to add an error like { Readme }.
You should see a code style issue.
Run npm run prettier:js:fix && npm run prettier:md:fix to fix issues.
Styles should match after re-running npm run prettier:js:fix && npm run prettier:md:fix.

mejiaj commented 2 months ago

@heymatthenry thanks for the suggestions.

Changes were minor, so I've added them and updated the PR description to include the new info.