lint: source location reporting, "watch", and VS Code tasks #17
Conversation
|
Would it make sense to include the Markdownlint extension for VS Code in our recommended setup? It helps catch common Markdown style issues and ensures consistency across the team. We could also suggest this setting in {
"markdownlint.run": "onSave"
}This way, formatting feedback is automatic and low-friction. |
|
If that works for you, then sure, why not. The workflow yaml would of course need to remain in place regardless. |
|
Pardon my ignorance, but could Markdownlint extension and our linting tasks highlight the same issues? Or might they be inconsistent with each other? |
|
I'm not sure either. I would hope that they agree, but I acknowledge that I have no guarantee of that. (FYI the lint workflow / script is markdownlint + prettier). |
adamblanchard
left a comment
adamblanchard
left a comment
There was a problem hiding this comment.
I'm approving because the markdown extension suggestion shouldn't block us merging this anyhow. Feel free to raise an issue/another pr to explore and add the markdown extension recommendation (only if they can match the same rules, i say).
|
Back to draft, because I'm not happy with the "watch" version. It has seemed unstable and I want to get to the bottom of why that is. |
rvedotrc
changed the title
adamblanchard
left a comment
adamblanchard
left a comment
There was a problem hiding this comment.
How about putting lint, ts files and "dist" into a subdirectory like e.g. "scripts" for now?
Done. Also, 'dist' is no longer committed. |
prettierandmarkdownlintThis means that, if you're using VS Code, you could use the
./lint (watch)task continuously to check for problems.If you prefer to let VS Code extensions do the
markdownlintandprettierparts, you might want to use the./lint validate-tasks (watch)task, to focus just on that part.