fix: add doc-check script

Uses tsc to attempt to compile any `typescript` code blocks in markdown files to ensure our examples don't get out of date.
ipfs · Sep 21, 2024 · f5d6f97 · f5d6f97
1 parent f5a03fc
commit f5d6f97
Show file tree

Hide file tree

Showing 21 changed files with 22 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,5 @@ node_modules
 package-lock.json
 yarn.lock
 .vscode
+.tmp-compiled-docs
+tsconfig-doc-check.aegir.json
diff --git a/benchmarks/add-dir/package.json b/benchmarks/add-dir/package.json
@@ -9,6 +9,7 @@
     "build": "aegir build --bundle false",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "start": "npm run build && node dist/src/index.js"
   },
   "dependencies": {

diff --git a/benchmarks/gc/package.json b/benchmarks/gc/package.json
@@ -7,6 +7,7 @@
     "build": "aegir build --bundle false",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "start": "npm run build && node dist/src/index.js"
   },
   "dependencies": {

diff --git a/benchmarks/pinning/package.json b/benchmarks/pinning/package.json
@@ -7,6 +7,7 @@
     "build": "aegir build --bundle false",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "start": "npm run build && node dist/src/index.js"
   },
   "dependencies": {

diff --git a/benchmarks/transfer/package.json b/benchmarks/transfer/package.json
@@ -9,6 +9,7 @@
     "build": "aegir build --bundle false",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "start": "npm run build && node dist/src/index.js"
   },
   "dependencies": {

diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "build": "aegir run build",
     "lint": "aegir run lint",
     "dep-check": "aegir run dep-check",
+    "doc-check": "aegir run doc-check",
     "release": "run-s build docs:no-publish npm:release docs",
     "npm:release": "aegir exec --bail false npm -- publish",
     "release:rc": "aegir release-rc",

diff --git a/packages/block-brokers/package.json b/packages/block-brokers/package.json
@@ -43,6 +43,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/car/package.json b/packages/car/package.json
@@ -128,6 +128,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/dag-cbor/package.json b/packages/dag-cbor/package.json
@@ -128,6 +128,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "docs": "aegir docs",
     "test": "aegir test",

diff --git a/packages/dag-json/package.json b/packages/dag-json/package.json
@@ -128,6 +128,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/helia/package.json b/packages/helia/package.json
@@ -43,6 +43,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/http/package.json b/packages/http/package.json
@@ -43,6 +43,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/interface/package.json b/packages/interface/package.json
@@ -67,6 +67,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build"
   },
   "dependencies": {

diff --git a/packages/interop/package.json b/packages/interop/package.json
@@ -47,6 +47,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/ipns/package.json b/packages/ipns/package.json
@@ -152,6 +152,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "docs": "aegir docs",
     "test": "aegir test",

diff --git a/packages/json/package.json b/packages/json/package.json
@@ -128,6 +128,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/mfs/package.json b/packages/mfs/package.json
@@ -128,6 +128,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/routers/package.json b/packages/routers/package.json
@@ -43,6 +43,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/strings/package.json b/packages/strings/package.json
@@ -129,6 +129,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "docs": "aegir docs",
     "test": "aegir test",

diff --git a/packages/unixfs/package.json b/packages/unixfs/package.json
@@ -148,6 +148,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -43,6 +43,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",