Considering using Prettier and research on setup via CL and Plugin

[MicahBear]

Dependency

• Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248

Overview

We need to consider implementing a solution like Prettier to prevent developers from pushing additional file changes due to formatting preferences in their IDE. This helps to reduce 50+ line changes when a simple alt text is changed due to a developer’s auto-format save.

Details

The discussion from Thursday (02-23-23) Office hours, considering the use of Prettier (opinionated code formatter) on website repo because many devs use it and have to remember to disable Prettier or it is forgotten, especially by just onboarded devs. The consensus was there is a need to research what that looks like and if it would be beneficial/easy.

Action Items

• Invite other devs to comment on issue
  • questions to ask:
    • Do you use it?
    • Do you like it?
    • If you don't use it, why don't you?
• Research the process use and install Prettier locally -per project.
• Research the process of using Prettier via editor.
• Present and discuss with Website team.

Reservations & Concerns

• What if people don't want to install prettier?
• How does this impact PR reviews
• What would we need to do to existing code in the repo

Resources/Instructions

• Prettier Docs
• Prettier VScode

[ExperimentsInHonesty]

@MicahBear we think this issue will need to be more thought out. Thanks for making the issue. Things to include in the planning are

• What would we need to do to existing code in the repo
• How does this impact PR reviews
• What if people don't want to install prettier ?
• etc.

Please also invite devs to leave comments on this issue
Do you use it?
Do you like it?
Why don't you use it? Reservations & Concerns

[ronaldpaek]

@ExperimentsInHonesty I am not an expert on prettier and formatting, but I had some formatting issues. I thought it was my computer, but it's cause the site doesn't have any linter or config files to make the spacing and syntax uniform. Those issues arise from some people having trailing white space on save, where it removes white space, and others leaving it on. I thought we use docker as our container, so we don't have to worry about things being different on other's computers, but usually, when I use prettier, I have it installed. It formats on save, but if we were to apply prettier for the site, it would be a GitHub action where it would check/format the code before it lets you make a PR.

I don't know how to do all this 100%, but it's possible, and from what I can tell, we already have an SCSS Linter. All this can be done incrementally, meaning. Per file type of thing, that could potentially be a lot of small issues; of course, there is the format of every file, but I don't think that's feasible, and that is what you don't sure. 😄