From eb7fb12694d155c33d42a209fe8710e39b8c9a32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20D=C3=ADaz=20Gonz=C3=A1lez?= Date: Thu, 4 Jan 2024 13:52:08 +0000 Subject: [PATCH] [web][doc] Add "rename-defaults" typedoc plugin To avoid having a log of "default" references. Visit below links to know more, * https://github.com/felipecrs/typedoc-plugin-rename-defaults#readme * https://github.com/TypeStrong/typedoc/issues/1521 --- web/package-lock.json | 25 +++++++++++++++++++++++++ web/package.json | 1 + web/typedoc.json | 1 + 3 files changed, 27 insertions(+) diff --git a/web/package-lock.json b/web/package-lock.json index 5f1bd8bfa7..1bdfa643a9 100644 --- a/web/package-lock.json +++ b/web/package-lock.json @@ -84,6 +84,7 @@ "tsconfig-paths-webpack-plugin": "^4.0.0", "typedoc": "^0.25.4", "typedoc-plugin-missing-exports": "^2.1.0", + "typedoc-plugin-rename-defaults": "^0.7.0", "typescript": "^5.3.3", "webpack": "^5.89.0", "webpack-cli": "^5.1.4", @@ -17871,6 +17872,30 @@ "typedoc": "0.24.x || 0.25.x" } }, + "node_modules/typedoc-plugin-rename-defaults": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-rename-defaults/-/typedoc-plugin-rename-defaults-0.7.0.tgz", + "integrity": "sha512-NudSQ1o/XLHNF9c4y7LzIZxfE9ltz09yCDklBPJpP5VMRvuBpYGIbQ0ZgmPz+EIV8vPx9Z/OyKwzp4HT2vDtfg==", + "dev": true, + "dependencies": { + "camelcase": "^8.0.0" + }, + "peerDependencies": { + "typedoc": "0.22.x || 0.23.x || 0.24.x || 0.25.x" + } + }, + "node_modules/typedoc-plugin-rename-defaults/node_modules/camelcase": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-8.0.0.tgz", + "integrity": "sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==", + "dev": true, + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", diff --git a/web/package.json b/web/package.json index 349c8076d0..bd24065f75 100644 --- a/web/package.json +++ b/web/package.json @@ -88,6 +88,7 @@ "tsconfig-paths-webpack-plugin": "^4.0.0", "typedoc": "^0.25.4", "typedoc-plugin-missing-exports": "^2.1.0", + "typedoc-plugin-rename-defaults": "^0.7.0", "typescript": "^5.3.3", "webpack": "^5.89.0", "webpack-cli": "^5.1.4", diff --git a/web/typedoc.json b/web/typedoc.json index ee4608b3c0..f744aeb395 100644 --- a/web/typedoc.json +++ b/web/typedoc.json @@ -12,6 +12,7 @@ "out": "jsdoc.out", "plugin": [ "typedoc-plugin-missing-exports", + "typedoc-plugin-rename-defaults" ], "sort": [ "source-order"