chore: improve dead links check (#3040)

* chore: remove unused check-docs.ts

* chore: update check-docs script

* also check relative links and achors using markdown-link-check
  (we didn't use it before because of the issue below,
  see: tcort/markdown-link-check#91)
* actually check for achor and relative link errors
  (previously the errors were ignored in the script)
* add else statement that logs if nothing was checked due to no changes

* chore: remove remark

now we check all the links with markdown-link-check

markdown-link-check-config.json

@@ -13,14 +13,6 @@
     {
       "pattern": "^https://docs\\.github\\.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads$",
       "reason": "Ignore this particular GitHub URL, it fails consistently with HTTP 403 code despite the link works fine"
-    },
-    {
-      "pattern": "^[^\/]+\/[^\/].*$|^\/[^\/].*$",
-      "reason": "Ignore relative paths. Those are handled by another tool due to: https://github.com/tcort/markdown-link-check/issues/65"
-    },
-    {
-      "pattern": "^#",
-      "reason": "Ignore relative paths. Those are handled by another tool due to: https://github.com/tcort/markdown-link-check/issues/65"
     }
   ]
 }

package.json

@@ -42,11 +42,9 @@
     "markdown-link-check": "^3.9.3",
     "minimatch": "^3.0.4",
     "minimist": "^1.2.6",
-    "npm-license-crawler": "^0.2.1",
     "node-jsonl": "^0.1.0",
+    "npm-license-crawler": "^0.2.1",
     "prettier": "^2.1.1",
-    "remark-cli": "^8.0.0",
-    "remark-validate-links": "^10.0.0",
     "replace-in-file": "^6.0.0",
     "semver": "^7.3.2",
     "shx": "^0.3.2",

scripts/check-docs.sh

@@ -9,20 +9,15 @@ git diff --quiet HEAD -- docs/ || (echo 'generated docs are not up-to-date! run
 modified_docs=$(git diff --name-status master docs README.md) || true
 modified_examples=$(git diff --name-status master examples | grep "examples.*\README.md$") || true
 
-check_relative_links() {
-  ./node_modules/.bin/remark --use validate-links --frail --quiet --no-stdout "$@"
-}
-
-error_in_external_links=false
-check_external_links() {
+found_dead_links=false
+check_links() {
   for file in $@; do
     # markdown-link-check is configured to ignore relative links
-    ./node_modules/.bin/markdown-link-check --config markdown-link-check-config.json $file || error_in_external_links=true
+    ./node_modules/.bin/markdown-link-check --config markdown-link-check-config.json $file || found_dead_links=true
   done
 }
 
-export -f check_relative_links
-export -f check_external_links
+export -f check_links
 
 # Only check links if docs or examples were modified
 if !([ -z "$modified_docs" ] && [ -z "$modified_examples" ]); then
@@ -31,18 +26,16 @@ if !([ -z "$modified_docs" ] && [ -z "$modified_examples" ]); then
   examples=$(find examples -name 'README.md' -type f -not -path "*/.garden/*" -not -path "*/node_modules/*" | xargs)
   readme="./README.md"
 
-  check_relative_links $docs
-  check_relative_links $examples
-  check_relative_links $readme
-
-  check_external_links $docs
-  check_external_links $examples
-  check_external_links $readme
+  check_links $readme
+  check_links $docs
+  check_links $examples
 
-  if $error_in_external_links; then
+  if $found_dead_links; then
     echo ""
     echo "Error: Dead links found. See the output above for details."
     echo ""
     exit 1
   fi
+else
+  echo "Skipping dead link check as docs or examples were not modified"
 fi