docs: bootstrap typedoc

Vonage · Nov 2, 2023 · 602e7bc · 602e7bc
1 parent d069e28
commit 602e7bc
Show file tree

Hide file tree

Showing 5 changed files with 129 additions and 119 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -62,10 +62,11 @@
             "error",
             {
                 "code": 80,
+                "comments": 120,
                 "ignoreUrls": true,
                 "ignoreTemplateLiterals": true,
                 "ignoreRegExpLiterals": true,
-                "ignorePattern": "^import.+|test"
+                "ignorePattern": "^import.+|test|@"
             }
         ]
     }

diff --git a/package.json b/package.json
@@ -1,90 +1,97 @@
 {
-    "name": "@vonage/server-sdk-monorepo",
-    "private": true,
-    "description": "Vonage Server SDK for Node.js. API support for SMS, Voice Calls, Text-to-Speech, Numbers, Verify (2FA) and more.",
-    "keywords": [
-        "sms",
-        "voice",
-        "vonage",
-        "verify",
-        "2fa",
-        "phone numbers"
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@vonage/server-sdk-monorepo",
+  "private": true,
+  "description": "Vonage Server SDK for Node.js. API support for SMS, Voice Calls, Text-to-Speech, Numbers, Verify (2FA) and more.",
+  "keywords": [
+    "sms",
+    "voice",
+    "vonage",
+    "verify",
+    "2fa",
+    "phone numbers"
+  ],
+  "homepage": "https://github.com/vonage/vonage-node-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/vonage/vonage-node-sdk.git"
+  },
+  "license": "Apache 2.0",
+  "author": "vonage",
+  "contributors": [
+    "kellyjandrews"
+  ],
+  "workspaces": [
+    "packages/*"
+  ],
+  "scripts": {
+    "bootstrap": "npx lerna bootstrap",
+    "build": "lerna run build",
+    "clean": "lerna run clean",
+    "compile": "lerna run compile",
+    "depcheck": "lerna exec --no-bail --stream --prefix npx depcheck -- --ignore-dirs=dist",
+    "eslint": "eslint",
+    "format": "prettier -- -w",
+    "jest": "jest",
+    "lerna": "lerna",
+    "lint": "eslint .",
+    "lint:fix": "eslint -- . --fix",
+    "prepare": "is-ci || husky install",
+    "publish": "lerna publish",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "tsc": "tsc"
+  },
+  "lint-staged": {
+    "package.json": [
+      "npx sort-package-json"
     ],
-    "homepage": "https://github.com/vonage/vonage-node-sdk",
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/vonage/vonage-node-sdk.git"
-    },
-    "license": "Apache 2.0",
-    "author": "vonage",
-    "contributors": [
-        "kellyjandrews"
+    "*.js": [
+      "prettier -w",
+      "eslint --fix"
     ],
-    "workspaces": [
-        "packages/*"
-    ],
-    "scripts": {
-        "bootstrap": "npx lerna bootstrap",
-        "build": "lerna run build",
-        "clean": "lerna run clean",
-        "compile": "lerna run compile",
-        "depcheck": "lerna exec --no-bail --stream --prefix npx depcheck -- --ignore-dirs=dist",
-        "eslint": "eslint",
-        "format": "prettier -- -w",
-        "jest": "jest",
-        "lerna": "lerna",
-        "lint": "eslint .",
-        "lint:fix": "eslint -- . --fix",
-        "prepare": "is-ci || husky install",
-        "publish": "lerna publish",
-        "test": "jest",
-        "test:watch": "jest --watch",
-        "tsc": "tsc"
-    },
-    "lint-staged": {
-        "package.json": [
-            "npx sort-package-json"
-        ],
-        "*.js": [
-            "prettier -w",
-            "eslint --fix"
-        ],
-        "*.ts": [
-            "prettier -w",
-            "eslint --fix"
-        ]
-    },
-    "devDependencies": {
-        "@babel/core": "7.23.2",
-        "@babel/plugin-transform-modules-commonjs": "^7.23.0",
-        "@babel/plugin-transform-typescript": "7.22.15",
-        "@babel/preset-env": "7.23.2",
-        "@babel/preset-typescript": "7.23.2",
-        "@babel/types": "^7.23.0",
-        "@types/jest": "^29.5.5",
-        "@types/node": "^20.8.4",
-        "@typescript-eslint/eslint-plugin": "6.7.5",
-        "@typescript-eslint/parser": "6.7.5",
-        "babel-jest": "29.7.0",
-        "babel-plugin-module-resolver": "5.0.0",
-        "eslint": "8.51.0",
-        "eslint-config-google": "0.14.0",
-        "eslint-config-prettier": "9.0.0",
-        "eslint-plugin-deprecation": "2.0.0",
-        "eslint-plugin-jest": "27.4.2",
-        "eslint-plugin-jest-extended": "2.0.0",
-        "eslint-plugin-jest-formatting": "3.1.0",
-        "eslint-plugin-prettier": "5.0.1",
-        "husky": "^8.0.3",
-        "is-ci": "3.0.1",
-        "jest": "^29.7.0",
-        "lerna": "^7.3.1",
-        "lerna-changelog": "^2.2.0",
-        "lint-staged": "14.0.1",
-        "nock": "^13.3.4",
-        "prettier": "3.0.3",
-        "prettier-eslint": "15.0.1",
-        "ts-node-dev": "^2.0.0",
-        "typescript": "^5.2.2"
-    }
+    "*.ts": [
+      "prettier -w",
+      "eslint --fix"
+    ]
+  },
+  "devDependencies": {
+    "@babel/core": "7.22.5",
+    "@babel/plugin-transform-modules-commonjs": "^7.22.5",
+    "@babel/plugin-transform-typescript": "7.22.15",
+    "@babel/preset-env": "7.22.5",
+    "@babel/preset-typescript": "7.22.5",
+    "@babel/types": "^7.22.5",
+    "@tsconfig/node16": "16.1.1",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^20.8.4",
+    "@typescript-eslint/eslint-plugin": "6.7.5",
+    "@typescript-eslint/parser": "6.7.5",
+    "babel-jest": "29.7.0",
+    "babel-plugin-module-resolver": "5.0.0",
+    "eslint": "8.51.0",
+    "eslint-config-google": "0.14.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-deprecation": "2.0.0",
+    "eslint-plugin-jest": "27.4.2",
+    "eslint-plugin-jest-extended": "2.0.0",
+    "eslint-plugin-jest-formatting": "3.1.0",
+    "eslint-plugin-prettier": "5.0.1",
+    "husky": "^8.0.3",
+    "is-ci": "3.0.1",
+    "jest": "^29.7.0",
+    "lerna": "^7.3.1",
+    "lerna-changelog": "^2.2.0",
+    "lint-staged": "14.0.1",
+    "nock": "^13.3.4",
+    "prettier": "3.0.3",
+    "prettier-eslint": "15.0.1",
+    "ts-node-dev": "^2.0.0",
+    "typedoc": "0.25.2",
+    "typedoc-plugin-merge-modules": "5.1.0",
+    "typescript": "^5.1.3"
+  },
+  "dependencies": {
+    "@droppedcode/typedoc-plugin-copy-assets": "1.0.10"
+  }
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,37 +1,14 @@
 {
-    "compilerOptions": {
-        "sourceMap": true,
-        "removeComments": false,
-        "lib": [
-            "ES2022"
-        ],
+  "$schema": "https://json.schemastore.org/tsconfig",
 
-        "strict": false,
-        "target": "ES2022",
-        "module": "CommonJS",
-        "moduleResolution": "node",
-        "esModuleInterop": true,
-        "skipLibCheck": true,
-        "allowJs": true,
-        "pretty": true,
-        "preserveSymlinks": true,
-        "resolveJsonModule": true,
+  "extends": "@tsconfig/node16/tsconfig.json",
 
-        "types": [
-            "jest",
-            "node"
-        ],
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "composite": true
+  },
 
-        "noImplicitAny": false,
-        "noUnusedLocals": false,
-
-        "declaration": true,
-        "composite": true,
-        "noEmit": false,
-        "baseUrl": "."
-    },
-
-    "ts-node": {
-        "esm": true
-    }
+  "ts-node": {
+      "esm": true
+  }
 }
diff --git a/typedoc.base.json b/typedoc.base.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+  "cleanOutputDir": true,
+  "categorizeByGroup": true,
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": false
+  },
+  "groupOrder": ["Client"]
+}
diff --git a/typedoc.json b/typedoc.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+  "entryPointStrategy": "packages",
+  "entryPoints": [
+    "packages/*"
+  ],
+  "out": "doc",
+  "logLevel": "Verbose",
+  "copyAssets": {
+    "onlyImages": false,
+    "include": [".(md)\\)$"]
+  }
+}