Merge pull request #268 from proto-kit/feature/typedoc

Introduce typedoc into the repository

Author: maht0rz

.github/workflows/pull-request-develop.yml

@@ -29,7 +29,7 @@ jobs:
 
       # install dependencies from the package-lock.json
       - name: Install dependencies
-        run: npm ci --workspaces
+        run: npm ci --workspaces --force
 
   # builds all packages
   build:
@@ -43,7 +43,7 @@ jobs:
           cache: npm
 
       - name: "Install dependencies"
-        run: npm ci --workspaces --include-workspace-root
+        run: npm ci --workspaces --include-workspace-root --force
 
       - name: "Build"
         run: npm run build
@@ -61,7 +61,7 @@ jobs:
           cache: npm
 
       - name: "Install dependencies"
-        run: npm ci --workspaces --include-workspace-root
+        run: npm ci --workspaces --include-workspace-root --force
 
       - name: "Build"
         run: npm run build
@@ -84,7 +84,7 @@ jobs:
           cache: npm
 
       - name: "Install dependencies"
-        run: npm ci --workspaces --include-workspace-root
+        run: npm ci --workspaces --include-workspace-root --force
 
       - name: "Build"
         run: npm run build
@@ -139,7 +139,7 @@ jobs:
           cache: npm
 
       - name: "Install dependencies"
-        run: npm ci --workspaces --include-workspace-root
+        run: npm ci --workspaces --include-workspace-root --force
 
       - name: "Build"
         run: npm run build

.gitignore

@@ -4,6 +4,7 @@
 dist
 tmp
 /out-tsc
+docs
 
 # dependencies
 node_modules

docs/common/DependencyFactory.md

@@ -17,6 +17,15 @@ module.exports = {
     "^(\\.{1,2}/.*)\\.js$": "$1",
   },
 
+  collectCoverage: true,
+  coverageReporters: ["json", "text", "text-summary"],
+  // TODO: enable
+  // coverageThreshold: {
+  //   branches: 70,
+  //   functions: 70,
+  //   lines: 70,
+  //   statements: 70,
+  // },
   transform: {
     // '^.+\\.[tj]sx?$' to process js/ts with `ts-jest`
     // '^.+\\.m?[tj]sx?$' to process js/ts/mjs/mts with `ts-jest`