[HOUSEKEEPING] Finding broken links in md files and fix them

[dennisseah]

1. created a simple tool to find broken links. ts-node tools/brokenLinks.ts
2. fixed some eslint issues in other tools
3. fixed the broken links. Cannot figure out this one though. https://github.com/CatalystCode/spk/blob/master/guides/infra/spk-terragrunt-overview.md, we have a reference to https://github.com/CatalystCode/spk/blob/master/SPK-Infra.md

closes microsoft/bedrock#1214

[andrebriggs]

Thank you @dennisseah for doing this

[bnookala]

I did a bit of searching and found a few existing packages/tools that do similar tasks - I would err on the side of using them.

https://github.com/tcort/markdown-link-check - this one integrates with github actions, so can be run in CI as well: https://github.com/marketplace/actions/markdown-link-check

There's also this plugin for remark: https://github.com/remarkjs/remark-validate-links

[bnookala]

let's try to use this tool instead, since it's being actively maintained and might fit our use cases: https://github.com/tcort/markdown-link-check

[dennisseah]

let's try to use this tool instead, since it's being actively maintained and might fit our use cases: https://github.com/tcort/markdown-link-check

ok. I will remove my tool. thanks

[bnookala]

I think this script file may be un-necessary:

See: https://github.com/tcort/markdown-link-check#check-links-from-a-local-markdown-folder-recursive

You can inline this into a package.json script instead of calling this custom script

[dennisseah]

i cannot because i need a status code 1 to stop the script. :-)
the inline approach always return 0

[evanlouie]

Sorry Dennis, not quite sure I understand what you're saying. Npm scripts will exit with 1 if if any of the commands fail:

  "scripts": {
    "i-will-fail": "false && true"
  },

npm run i-will-fail # will exit with code 1

are you thinking othewise?

[dennisseah]

maybe you can try it yourself and let me know what you get
add this to your package.json

  "md-lint": "find guides -name \\*.md -exec markdown-link-check {} \\",

or just ran (at the root of spk repo)

find guides -name \*.md -exec markdown-link-check {} \;

then

echo $?

there are errors reported by the tool and it is returning 0 status code.

[bnookala]

@dennisseah try the suggestion here: tcort/markdown-link-check#57 (comment)

find guides -name \*.md | xargs -n 1 markdown-link-check

[dennisseah]

@bnookala
and what about people using windows?

[bnookala]

@dennisseah this isn't a run-time requirement - just a development requirement. I expect that developers who are running windows who also want to contribute to spk development should do their work in a WSL environment.

[dennisseah]

ok then. We do not support windows runtime.