V3: [ALL] can we use prettier to enforce consistent markdown formatting?

Created on 9 Apr 2020  路  3Comments  路  Source: exercism/v3

the problem

The flexible nature of Markdown means each contributor will write it slightly differently. This creates a cognitive load on maintainers reviewing pull requests. I originally wanted to nudge users using editorconfig but discussing with @ErikSchierboom he mentioned prettier. Prettier is a JavaScript tool that automatically applies "opinionated formatting".

possible implementation approaches

  • use prettier in a GitHub action to rewrite staged markdown file changes
  • use prettier as a linter

alternatives

  • editorconfig #863, #1150

How would you feel about doing this? Do thumbs up or down to vote. And certainly chime in with discussion to cover other angles or share some experience.

statuhelp-wanted typdiscussion

Most helpful comment

Agreed. I missed the other issue.

All 3 comments

Discussion of #863 should continue in a single issue rather than being split amongst multiple issues.

Agreed. I missed the other issue.

Thank you!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

valentin-p picture valentin-p  路  5Comments

TheLostLambda picture TheLostLambda  路  3Comments

tehsphinx picture tehsphinx  路  4Comments

ErikSchierboom picture ErikSchierboom  路  5Comments

tehsphinx picture tehsphinx  路  4Comments