ci: link checker but skips examples

forcedotcom · Apr 2, 2024 · d0f2239 · d0f2239 · svc-cli-bot · Apr 2, 2024
1 parent 32411f6
commit d0f2239
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/.sfdevrc.json b/.sfdevrc.json
@@ -8,6 +8,11 @@
       "files": ["src/**/*.ts", "tsconfig.json", "messages", "messageTransformer"],
       "output": ["lib/**", "*.tsbuildinfo"],
       "clean": "if-file-deleted"
+    },
+    "link-check": {
+      "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"./*.md\" --skip \"examples/README.md|CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": ["./*.md", "./examples/**/*.md", "./messages/**/*.md", "./!(CHANGELOG).md"],
+      "output": []
     }
   }
 }
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "compile": "wireit",
     "docs": "sf-docs",
     "format": "wireit",
+    "link-check": "wireit",
     "lint": "wireit",
     "lint-fix": "yarn sf-lint --fix",
     "postcompile": "tsc -p typedocExamples",
@@ -146,8 +147,19 @@
     "test": {
       "dependencies": [
         "test:only",
-        "test:compile"
+        "test:compile",
+        "link-check"
       ]
+    },
+    "link-check": {
+      "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"./*.md\" --skip \"examples/README.md|CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": [
+        "./*.md",
+        "./examples/**/*.md",
+        "./messages/**/*.md",
+        "./!(CHANGELOG).md"
+      ],
+      "output": []
     }
   }
 }
diff --git a/yarn.lock b/yarn.lock
@@ -603,14 +603,7 @@
   dependencies:
     tslib "^2.6.2"
 
-"@sinonjs/commons@^1", "@sinonjs/commons@^1.3.0":
-  version "1.8.3"
-  resolved "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz"
-  integrity sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ==
-  dependencies:
-    type-detect "4.0.8"
-
-"@sinonjs/commons@^1.6.0", "@sinonjs/commons@^1.7.0", "@sinonjs/commons@^1.8.1":
+"@sinonjs/commons@^1", "@sinonjs/commons@^1.3.0", "@sinonjs/commons@^1.6.0", "@sinonjs/commons@^1.7.0", "@sinonjs/commons@^1.8.1":
   version "1.8.6"
   resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-1.8.6.tgz#80c516a4dc264c2a69115e7578d62581ff455ed9"
   integrity sha512-Ky+XkAkqPZSm3NLBeUng77EBQl3cmeJhITaGHdYH8kjVB+aun3S4XBRti2zt17mtt0mIUDiNxYeoJm6drVvBJQ==
@@ -694,12 +687,7 @@
   dependencies:
     "@types/chai" "*"
 
-"@types/chai@*":
-  version "4.3.10"
-  resolved "https://registry.npmjs.org/@types/chai/-/chai-4.3.10.tgz"
-  integrity sha512-of+ICnbqjmFCiixUnqRulbylyXQrPqIGf/B3Jax1wIF3DvSheysQxAWvqHhZiW3IQrycvokcLcFQlveGp+vyNg==
-
-"@types/chai@^4.3.11":
+"@types/chai@*", "@types/chai@^4.3.11":
   version "4.3.14"
   resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.3.14.tgz#ae3055ea2be43c91c9fd700a36d67820026d96e6"
   integrity sha512-Wj71sXE4Q4AkGdG9Tvq1u/fquNz9EdG4LIJMwVVII7ashjD/8cf8fyIfJAjRr6YcsXnSE8cOGQPq1gqeR8z+3w==
@@ -4325,16 +4313,11 @@ pump@^3.0.0:
     end-of-stream "^1.1.0"
     once "^1.3.1"
 
-punycode@^2.1.0:
+punycode@^2.1.0, punycode@^2.1.1:
   version "2.3.1"
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5"
   integrity sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==
 
-punycode@^2.1.1:
-  version "2.1.1"
-  resolved "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz"
-  integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==
-
 querystringify@^2.1.1:
   version "2.2.0"
   resolved "https://registry.npmjs.org/querystringify/-/querystringify-2.2.0.tgz"
Benchmark suite	Current: `d0f2239`	Previous: `ad320e0`	Ratio
`Child logger creation`	`468664` ops/sec (`±0.70%`)	`482047` ops/sec (`±3.48%`)	`1.03`
`Logging a string on root logger`	`789526` ops/sec (`±6.90%`)	`830754` ops/sec (`±7.08%`)	`1.05`
`Logging an object on root logger`	`602368` ops/sec (`±7.67%`)	`675451` ops/sec (`±5.29%`)	`1.12`
`Logging an object with a message on root logger`	`8969` ops/sec (`±203.81%`)	`4452` ops/sec (`±228.23%`)	`0.50`
`Logging an object with a redacted prop on root logger`	`495148` ops/sec (`±6.04%`)	`489569` ops/sec (`±11.85%`)	`0.99`
`Logging a nested 3-level object on root logger`	`368162` ops/sec (`±6.90%`)	`381382` ops/sec (`±7.82%`)	`1.04`
Benchmark suite	Current: `d0f2239`	Previous: `ad320e0`	Ratio
`Child logger creation`	`342302` ops/sec (`±0.64%`)	`314512` ops/sec (`±0.64%`)	`0.92`
`Logging a string on root logger`	`828857` ops/sec (`±5.94%`)	`777401` ops/sec (`±7.76%`)	`0.94`
`Logging an object on root logger`	`613209` ops/sec (`±8.95%`)	`583568` ops/sec (`±6.85%`)	`0.95`
`Logging an object with a message on root logger`	`4064` ops/sec (`±215.26%`)	`8614` ops/sec (`±199.62%`)	`2.12`
`Logging an object with a redacted prop on root logger`	`485028` ops/sec (`±5.96%`)	`443794` ops/sec (`±11.24%`)	`0.91`
`Logging a nested 3-level object on root logger`	`329493` ops/sec (`±5.10%`)	`322276` ops/sec (`±5.83%`)	`0.98`