ashleystringer/add-prettier-formatter pull request

[ashleystringer]

This PR fixes...

• This PR adds a workflow file that adds automatic checking for if code in a branch is formatted according to Prettier rules (these appear in the .prettierrc file) and automatic application of Prettier for branches during pull requests using autofix.
• This PR uses the Husky library to automatically apply Prettier rules to code when you commit the code.

What I did...

• I created a .prettierrc file, a .prettierignore file (for telling Prettier which files or directories to avoid applying its rules to), and initialized a Husky project and added commands in the pre-commit file in the .husky directory to call the prettier write command as a pre-commit hook.
• I created the prettier.yml workflow file and added two jobs to the file.
• • The autofix job applies to non-feature branches in the case of a pull request, and it runs the prettier check command. If that prettier check fails, then it will run the prettier write command and automatically add a new commit with the reformatted code using the autofix app.
• • The prettier job applies to pull request events (for the main branch) and for push events and simply runs the prettier check command.
• • These jobs exist under the assumption that every branch going forward will have the Prettier and Husky files and the code will therefore be automatically formatted pre-commit, but I wanted the security of confirming that these are in fact being applied in time for pushes to the repo or for pull requests.

How to test...

Here is the set of steps for testing, with check boxes for clarification:

• Git pull or git fetch ashleystringer/TEST-add-prettier-formatter and switch to this branch.
• Initialize the Husky project with the following code in terminal/command line:
  npx husky init
• Find the .husky/pre-commit file in the branch and delete everything in the file add paste the following code:
  npm run prettier
git update-index --again
exit 1
• Make a commit using git commit -m "test" because of exit 1 in the pre-commit file, this prevents a commit from actually being performed while still allowing the pre-commit hook in Husky to run.
• Remove exit 1 from the .husky/pre-commit file
• Change "prepare": "husky" in package.json to "prepare": "husky || true"
• Make a commit using git commit -m "test" again. Because exit 1 is now removed, this will be a real commit for the branch.
• Push the code to ashleystringer/TEST-add-prettier-formatter on the repo. This will trigger the prettier job in the workflow file.
• Make a pull request for the ashleystringer/TEST-add-prettier-formatter branch. This will trigger the autofix job in the workflow file. Please do not merge this pull request into any branch. This is for testing purposes only.

Tests checklist

• Test 1 - Does Husky automatically apply Prettier formatting when the command git commit -m "test" is run? [ ]
• Test 2 - Does the code in ashleystringer/TEST-add-prettier-formatter pass the prettier job in the prettier.yml workflow file upon a push event? [ ]
• Test 3 - Does the code in ashleystringer/TEST-add-prettier-formatter pass the autofix job in the prettier.yml workflow file upon a pull_request event? [ ]

[netlify]

✅ Deploy Preview for cherry-on-tech-website-2 ready!

Name	Link
🔨 Latest commit	f3f9386
🔍 Latest deploy log	https://app.netlify.com/projects/cherry-on-tech-website-2/deploys/6a6539383ffa7000083ff034
😎 Deploy Preview	https://deploy-preview-5--cherry-on-tech-website-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[masuyama13]

Thanks for adding Prettier!
I confirmed that Husky works well locally.
I also tried testing the autofix workflow in this PR, but it didn't seem to run as expected?:
DO NOT MERGE: test prettier formatter by masuyama13 · Pull Request #9

Could you take a look when you have a chance? I may be missing something, but I wanted to confirm whether the autofix workflow is working as intended.

[masuyama13]

I don't think --frozen-lockfile is needed here.
npm ci is good enough.

[ashleystringer]

Okay I removed the --frozen-lockfile flag.

[masuyama13]

Can you recover this file?

[ashleystringer]

I'll try to find out how to recover it

[masuyama13]

Can you add a newline here?

[ashleystringer]

I added the newline, but upon pushing it to the repo, it seems to have gotten rid of the newline for some reason. This isn't a product of Prettier or Husky, since these didn't remove the newline when I ran them.

[masuyama13]

Can we use Node.js 24? We've got a warning.

https://github.com/cherryontech/website-v3.0/actions/runs/29125404337

[ashleystringer]

Changed it to Node version 24.

[ashleystringer]

Thanks for adding Prettier! I confirmed that Husky works well locally. I also tried testing the autofix workflow in this PR, but it didn't seem to run as expected?: DO NOT MERGE: test prettier formatter by masuyama13 · Pull Request #9

Could you take a look when you have a chance? I may be missing something, but I wanted to confirm whether the autofix workflow is working as intended.

It looks like I'd forgotten to install autofix on this repo (since I was originally working on this ticket on a forked repo). I'm not entirely sure why the test was passing for me on this repo, though it may have just been skipping the actual use of autofix in the autofix job since the Prettier check was passing for me. Sorry about that.