hackforla / hackforla/website

Considering using Prettier and research on setup via CL and Plugin

Open
#4,059 6 comments 0 reactions 0 assignees View on GitHub
Complexity: Medium Dependency Discussion Feature: Board/GitHub Maintenance role: dev leads size: 1pt
Dominant language
JavaScript
Stars
363
Forks
872
Avg merge
2d 21h
Merged PRs (30d)
18

Description

### Dependency
- https://github.com/hackforla/website/issues/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](https://prettier.io/docs/en/install.html)
- [Prettier VScode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.