Skip to content

Shall we auto-format our .md files with Prettier? #25148

@rsimha

Description

@rsimha

Today, we use Prettier to format and fix all our JS files and several non-JS files. The format checker has supported Markdown files for a while now.

Question: Shall we start auto-formatting our .md files with Prettier?

Pros:

Cons:

  • There might be some small changes to how .md files look when they are rendered

    • Attribute lists are changed to all-in-one-line if they all fit on one line
      image
    • Attribute lists are changed to one-per-line if they don't all fit on one line
      image
  • Failing gulp prettify checks can be annoying if an occasional contributor makes a badly formatted change

  • No easy way to auto-format code with Prettier if you edit code with the GitHub web-UI

@CrystalOnScript @mrjoro @pbakaus @ampproject/wg-outreach Thoughts?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions