Skip to content

Commit

Permalink
chore: improve markdown-link-checker speed (cloudspannerecosystem#329)
Browse files Browse the repository at this point in the history
ignore CHANGELOG.md file and links to console.cloud.google.com
  • Loading branch information
nielm authored Jun 27, 2024
1 parent 803fe1b commit 79efaea
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
16 changes: 16 additions & 0 deletions markdown-link-checker.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"ignorePatterns": [
{
"pattern": "^https://console.cloud.google.com/"
},
{
"pattern": "^https://example.org"
}
],
"replacementPatterns": [
{
"pattern": "^([./].*)/(#.*)?$",
"replacement": "$1/__LOCAL_URL_MUST_END_IN_FILENAME_NOT_RAW_PATH__$2"
}
]
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"eslint-fix": "eslint --fix .",
"format": "prettier --write .",
"install-all": "npm install --save",
"markdown-link-check": "find . -name '*.md' -not \\( -path './node_modules/*' -o -path '*/.terraform/*' -prune \\) -print0 | xargs --null -n1 markdown-link-check --quiet",
"markdown-link-check": "find . -name '*.md' -not \\( -path './node_modules/*' -o -path '*/.terraform/*' -o -path './CHANGELOG.md' -prune \\) -print0 | xargs --null markdown-link-check --config markdown-link-checker.json --quiet",
"mdlint": "markdownlint '**/*.md' --config .mdl.json --ignore '**/node_modules/**' --ignore 'code-of-conduct.md' --ignore 'CHANGELOG.md'",
"poller-job": "node -e \"require('./src/poller/index').main()\"",
"prepare": "{ git rev-parse --is-inside-work-tree >/dev/null 2>/dev/null && test \"$NODE_ENV\" != production -a \"$CI\" != true && husky ; } || true",
Expand Down
2 changes: 1 addition & 1 deletion terraform/gke/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,7 @@ following the instructions above.
<!-- LINKS: https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[architecture-gke]: ../../resources/architecture-gke.png
[autoscaler-poller]: ../../src/poller/README.md
[autoscaler-config-params]: ../../src/poller/#configuration-parameters
[autoscaler-config-params]: ../../src/poller/README.md#configuration-parameters
[cron-frequent]: ../../kubernetes/decoupled/autoscaler-pkg/poller/poller.yaml
[cron-hourly]: ../../kubernetes/decoupled/autoscaler-pkg/poller/poller-hourly.yaml
[margins]: ../../src/poller/README.md#margins
Expand Down

0 comments on commit 79efaea

Please sign in to comment.