Markdown CI rule issues

[MeltyBot]

Migrated from GitLab: https://gitlab.com/meltano/handbook/-/issues/87

Originally created by @aaronsteers on 2022-04-06 23:56:34

---

I discovered a couple small issues related to the the markdown lint rules:

1. The VS Code extension for prettier appears to also require manual npm install in addition to installing the extension: npm install --save-dev --save-exact prettier.
2. The CI failure doesn't point to a line number or reason code. I'm not sure if this is configurable or not, but would be helpful. In my case, prettier wanted carrot brackets around my link, which was hard to identify without an install and execution locally. For ref, this was the commit that resolved it: https://gitlab.com/meltano/handbook/-/merge_requests/114/diffs?commit_id=462165eb9e3e4b02a2c1eeca613ae24adde0141c
3. The "prettier.proseWrap": "never" setting actually forces removal of line breaks within paragraphs, which is not what we wanted. I couldn't find a setting to allow sentence-level line breaks but "prettier.proseWrap": "preserve" will leave those alone without modification.
4. I didn't realize this but prettier is a formatter, but not a linter. Meaning, you can get autoformatting (like black) but no "red squigglies" about what is needing to be changed. (Markdownlint has an extension that gives linting hints, but not the same ruleset as prettier uses.)

We may want to temporarily disable or loosen the CI test while we improve/smoothen the path to resolving lint issues.

@cjohnhanson - Any thoughts about us perhaps loosening or disabling the lint check for a bit?

Other options could include allowing the CI pipeline to physically format the files, perhaps print a diff to CI output and/or upload the linted output file(s) as artifacts in CI.

[MeltyBot]

View 3 previous comments from the original issue on GitLab