neuroinformatics-unit/actions

Add an action to format text (particularly `.md`) files

Closed this issue · 5 comments

adamltyson commented

One option is using prettier, e.g. the .actions repo.

Could then use across many team repos.

adamltyson commented

Should also add spellcheck.

dstansby commented

For spell checking I've had success with https://github.com/codespell-project/codespell on other projects

  • 👍1
niksirbi commented

Some notes on this topic, from the "Tool the docs" session at FOSDEM 2024:

  • Link checking: mlc
  • Tips for link-checking:
    • on PR check only diff and internal links
    • run weekly "check all links"
  • markdownlint: make sure to configure (default config is very aggressive)
  • Prose linting: vale to define custom rules (e.g. capitalisation, UK vs US spelling) at 3 levels: suggestion, warning, error.
adamltyson commented

I think this can be closed now? We seem to have converged on a solution where tools like prettier, codespell etc are added to pre-commit on a per-repo basis. All this repo does is maintain the linting action that runs them.

Any disagreements, feel free to reopen.

  • 🎉1