docs: added aegir doc-check command to compile Typescript in document…

…ation

.github/workflows/main.yml

@@ -19,6 +19,7 @@ jobs:
     - uses: ipfs/aegir/actions/cache-node-modules@master
     - run: npm run --if-present lint
     - run: npm run --if-present dep-check
+    - run: npm run --if-present doc-check
 
   test-node:
     needs: check

.gitignore

@@ -4,3 +4,6 @@ dist
 .coverage
 package-lock.json
 yarn.lock
+
+# IDE
+.DS_STORE

doc/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    /* Language and Environment */
+    "target": "ES2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    /* Modules */
+    "module": "ESNext" /* Specify what module code is generated. */,
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    /* Completeness */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */,
+    "noImplicitAny": false,
+    "isolatedModules": false
+  }
+}

package.json

@@ -76,6 +76,7 @@
     "clean": "aegir clean",
     "lint": "aegir lint",
     "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check --inputFiles doc/LIMITS.md --tsConfigPath doc/",
     "prepublishOnly": "node scripts/update-version.js",
     "build": "aegir build",
     "docs": "aegir docs",
@@ -187,7 +188,7 @@
     "@types/p-fifo": "^1.0.0",
     "@types/varint": "^6.0.0",
     "@types/xsalsa20": "^1.1.0",
-    "aegir": "^37.5.6",
+    "aegir": "^38.1.0",
     "cborg": "^1.8.1",
     "delay": "^5.0.0",
     "execa": "^6.1.0",