feat(api-markdown-documenter): Add preview API Model linting CLI
Also updates API Model linting APIs to capture more useful context that is leveraged by the CLI.
⯅ @fluid-example/bundle-size-tests: +245 Bytes
| Metric Name | Baseline Size | Compare Size | Size Diff |
|---|---|---|---|
| aqueduct.js | 460.47 KB | 460.5 KB | ⯅ +35 Bytes |
| azureClient.js | 557.45 KB | 557.5 KB | ⯅ +49 Bytes |
| connectionState.js | 724 Bytes | 724 Bytes | ■ No change |
| containerRuntime.js | 259.74 KB | 259.76 KB | ⯅ +14 Bytes |
| fluidFramework.js | 405.91 KB | 405.92 KB | ⯅ +14 Bytes |
| loader.js | 134.34 KB | 134.36 KB | ⯅ +14 Bytes |
| map.js | 42.46 KB | 42.46 KB | ⯅ +7 Bytes |
| matrix.js | 148.63 KB | 148.64 KB | ⯅ +7 Bytes |
| odspClient.js | 524.41 KB | 524.46 KB | ⯅ +49 Bytes |
| odspDriver.js | 97.84 KB | 97.86 KB | ⯅ +21 Bytes |
| odspPrefetchSnapshot.js | 42.81 KB | 42.82 KB | ⯅ +14 Bytes |
| sharedString.js | 164.82 KB | 164.83 KB | ⯅ +7 Bytes |
| sharedTree.js | 396.37 KB | 396.38 KB | ⯅ +7 Bytes |
| Total Size | 3.31 MB | 3.31 MB | ⯅ +245 Bytes |
Baseline commit: 9e1f6bf859f915d11b1f5982c045816d197da0d2
Generated by :no_entry_sign: dangerJS against 7fd6247363715264ceb06a3b67e7307f32f00802
🔗 No broken links found! ✅
Your attention to detail is admirable.
linkcheck output
> [email protected] ci:linkcheck /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test ci:start 1313 linkcheck:full
1: starting server using command "npm run ci:start"
and when url "[ 'http://127.0.0.1:1313' ]" is responding with HTTP status code 200
running tests using command "npm run linkcheck:full"
> [email protected] ci:start
> http-server ./public --port 1313 --silent
> [email protected] linkcheck:full
> npm run linkcheck:fast -- --external
> [email protected] linkcheck:fast
> linkcheck http://localhost:1313 --skip-file skipped-urls.txt --external
Crawling...
Stats:
421878 links
3264 destination URLs
2 URLs ignored
0 warnings
0 errors
Would be helpful updating the description on what oclif is and how it's being leveraged/ what useful context it's helping capture
I'm reconsidering this PR. I suspect we will integrate this functionality into fluid-build by calling the APIs in a node environment, so the CLI may not strictly be necessary. I'll keep the branch around in case we want to dust it off later, but I'm closing the PR for now.