Skip to content

Considering using Prettier and research on setup via CL and Plugin #4059

@MicahBear

Description

@MicahBear

Dependency

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Complexity: MediumDependencyAn issue is blocking the completion or starting of another issueDiscussionStarting point for gathering further information and/or feedbackFeature: Board/GitHub MaintenanceProject board maintenance that we have to do repeatedlyrole: dev leadsTasks for technical leadssize: 1ptCan be done in 4-6 hours

    Type

    No type

    Projects

    Status

    Ice box

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions