exercism / problem-specifications

Shared metadata for exercism exercises.
MIT License
326 stars 541 forks source link

Format admonitions #2327

Closed ErikSchierboom closed 11 months ago

ErikSchierboom commented 11 months ago
ErikSchierboom commented 11 months ago

CC @exercism/reviewers

iHiD commented 11 months ago

So, should tracks that format files with prettier also do this?

Yes. And Erik's going to do a big PR for it I believe.

ErikSchierboom commented 11 months ago

So, should tracks that format files with prettier also do this?

Ideally, yes I think. We could also bake this check into configlet maybe?

ee7 commented 11 months ago

We could also bake this check into configlet maybe?

That's possible. But I think it'd be better to have an org-wide workflow that runs markdownlint, checks admonitions, and performs any other Exercism-specific markdown linting. One reason: configlet lint only runs in track repos, and not every repo that may contain an admonition is a track repo.

Thoughts?

Related: https://github.com/exercism/configlet/issues/562 Related: https://github.com/exercism/configlet/issues/741

ErikSchierboom commented 11 months ago

That's possible. But I think it'd be better to have an org-wide workflow that runs markdownlint, checks admonitions, and performs any other Exercism-specific markdown linting. Thoughts?

That's a nice idea

ee7 commented 11 months ago

I previously created a tracking issue for it: https://github.com/exercism/org-wide-files/issues/214

ErikSchierboom commented 11 months ago

CC @exercism/reviewers Once this PR is merged, I can do the cross-repo PR.