Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup Markdown linter #39

Open
5 tasks
nkrkv opened this issue Jul 27, 2018 · 0 comments
Open
5 tasks

Setup Markdown linter #39

nkrkv opened this issue Jul 27, 2018 · 0 comments

Comments

@nkrkv
Copy link
Member

nkrkv commented Jul 27, 2018

Rationale

XOD docs in this repository is a code that should be formatted properly. We have Prettier, but formatting with it is not enforced. We can’t actually make pretty-printing check a part of PR validation because it is too strict, thus it will confuse people who just want to fix a typo involving a slight paragraph reflow. Such PRs should not trigger a CI error.

So, a linter should be more relaxed than the prettier check. Here is a possible solution: https://github.com/markdownlint/markdownlint

Acceptance criteria

  • I can yarn lint to check everything with the linter
  • Max line length is set to 100
  • All existing content is tweaked to pass the linter check
  • After doing yarn prettier:all the yart lint produces no errors
  • CircleCI is set up and invokes the linter on PRs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant