From 7b7fdc709257afb0e7c54706fed9643291ad473d Mon Sep 17 00:00:00 2001 From: teidesu <86301490+teidesu@users.noreply.github.com> Date: Sun, 28 Aug 2022 17:56:56 +0300 Subject: [PATCH] docs: removed typedoc-plugin-coverage it works like shit --- package.json | 1 - packages/core/README.md | 2 -- packages/crypto-node/README.md | 2 -- packages/dispatcher/README.md | 2 -- packages/file-id/README.md | 2 -- packages/http-proxy/README.md | 2 -- packages/i18n/README.md | 2 -- packages/markdown-parser/README.md | 2 -- packages/mtproxy/README.md | 2 -- packages/node/README.md | 2 -- packages/socks-proxy/README.md | 2 -- packages/sqlite/README.md | 2 -- packages/tl-runtime/README.md | 2 -- packages/tl-utils/README.md | 2 -- pnpm-lock.yaml | 11 ----------- typedoc.js | 3 +-- 16 files changed, 1 insertion(+), 40 deletions(-) diff --git a/package.json b/package.json index 3d0bc6ea..d91a60aa 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,6 @@ "prettier": "^2.6.2", "ts-node": "^10.8.1", "typedoc": "^0.23.10", - "typedoc-plugin-coverage": "^2.0.0", "typescript": "^4.7.4", "nyc": "^15.1.0", "rimraf": "^3.0.2", diff --git a/packages/core/README.md b/packages/core/README.md index 56e93d47..83ffd449 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,7 +1,5 @@ # `@mtcute/core` -![](./coverage.svg) - Core functions and MTProto implementation. You can learn more in [the guide](/guide/index.html). diff --git a/packages/crypto-node/README.md b/packages/crypto-node/README.md index 70630307..ffde5f12 100644 --- a/packages/crypto-node/README.md +++ b/packages/crypto-node/README.md @@ -1,7 +1,5 @@ # `@mtcute/crypto-node` -![](./coverage.svg) - Native extension for NodeJS that improves performance of the most used cryptographic mode in Telegram (IGE), which is not implemented by OpenSSL. diff --git a/packages/dispatcher/README.md b/packages/dispatcher/README.md index b6abb1f0..269972f3 100644 --- a/packages/dispatcher/README.md +++ b/packages/dispatcher/README.md @@ -1,7 +1,5 @@ # `@mtcute/dispatcher` -![](./coverage.svg) - Dispatcher and bot framework for mtcute. You can learn more in [the guide](/guide/index.html). diff --git a/packages/file-id/README.md b/packages/file-id/README.md index 1bc5ccd9..fba05cec 100644 --- a/packages/file-id/README.md +++ b/packages/file-id/README.md @@ -1,7 +1,5 @@ # `@mtcute/file-id` -![](./coverage.svg) - A package that is used internally by `@mtcute/client` to parse, serialize and manipulate TDLib and Bot API compatible File IDs, but can also be used for any other purposes. diff --git a/packages/http-proxy/README.md b/packages/http-proxy/README.md index 3da159bf..923d4342 100644 --- a/packages/http-proxy/README.md +++ b/packages/http-proxy/README.md @@ -1,7 +1,5 @@ # @mtcute/http-proxy -![](./coverage.svg) - HTTP(s) proxy transport for mtcute. ## Usage diff --git a/packages/i18n/README.md b/packages/i18n/README.md index 08c6e1ec..cb5dcdaf 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -1,7 +1,5 @@ # @mtcute/i18n -![](./coverage.svg) - This package implements utility for i18n functionality in `@mtcute/client` based apps. Documentation is TBA. diff --git a/packages/markdown-parser/README.md b/packages/markdown-parser/README.md index 885ea391..1002e3f1 100644 --- a/packages/markdown-parser/README.md +++ b/packages/markdown-parser/README.md @@ -1,7 +1,5 @@ # @mtcute/markdown-parser -![](./coverage.svg) - > Markdown entities parser for MTCute This package implements formatting syntax similar to Markdown (CommonMark) but slightly adjusted and simplified. diff --git a/packages/mtproxy/README.md b/packages/mtproxy/README.md index 834ff666..fc778ecb 100644 --- a/packages/mtproxy/README.md +++ b/packages/mtproxy/README.md @@ -1,7 +1,5 @@ # @mtcute/mtproxy -![](./coverage.svg) - MTProto proxy (MTProxy) transport for mtcute. ## Usage diff --git a/packages/node/README.md b/packages/node/README.md index 667545c5..b1e051ef 100644 --- a/packages/node/README.md +++ b/packages/node/README.md @@ -1,7 +1,5 @@ # @mtcute/node -![](./coverage.svg) - All-in-one package for NodeJS. Includes support for native crypto addon (must be installed separately, `@mtcute/crypto-node`), terminal I/O via `readline` and comes with pre-installed HTML and Markdown parsers. diff --git a/packages/socks-proxy/README.md b/packages/socks-proxy/README.md index d80b8cd1..da320daf 100644 --- a/packages/socks-proxy/README.md +++ b/packages/socks-proxy/README.md @@ -1,7 +1,5 @@ # @mtcute/socks-proxy -![](./coverage.svg) - Socks4/5 proxy transport for mtcute. ## Usage diff --git a/packages/sqlite/README.md b/packages/sqlite/README.md index 56f48668..a731928e 100644 --- a/packages/sqlite/README.md +++ b/packages/sqlite/README.md @@ -1,7 +1,5 @@ # @mtcute/sqlite -![](./coverage.svg) - SQLite backed storage for mtcute. ## Usage diff --git a/packages/tl-runtime/README.md b/packages/tl-runtime/README.md index 86c94326..7a78a8dc 100644 --- a/packages/tl-runtime/README.md +++ b/packages/tl-runtime/README.md @@ -1,7 +1,5 @@ # @mtcute/tl-runtime -![](./coverage.svg) - This package contains runtime for TL (de-)serialization. It only contains binary reader and writer implementations, and is used by `@mtcute/core`. diff --git a/packages/tl-utils/README.md b/packages/tl-utils/README.md index 8bc42a13..df53f058 100644 --- a/packages/tl-utils/README.md +++ b/packages/tl-utils/README.md @@ -1,5 +1,3 @@ # @mtcute/tl-utils -![](./coverage.svg) - This package contains utilities for TL schema parsing and manipulation. diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7008ca16..2f8c1cd2 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -25,7 +25,6 @@ importers: semver: ^7.3.7 ts-node: ^10.8.1 typedoc: ^0.23.10 - typedoc-plugin-coverage: ^2.0.0 typescript: ^4.7.4 dependencies: node-gyp: 9.0.0 @@ -50,7 +49,6 @@ importers: semver: 7.3.7 ts-node: 10.8.1_6f1a4dd4ae850373230f71a3bf15e349 typedoc: 0.23.10_typescript@4.7.4 - typedoc-plugin-coverage: 2.0.0_typedoc@0.23.10 typescript: 4.7.4 packages/client: @@ -3404,15 +3402,6 @@ packages: is-typedarray: 1.0.0 dev: true - /typedoc-plugin-coverage/2.0.0_typedoc@0.23.10: - resolution: {integrity: sha512-IJsYW0SvV2RUWfUBWuCG2cXTv+FiPDlls9+JlUlct3N41c1hV01ZOLKmZpEVelrvNSU3SnxxA8mkct3BQm2v0g==} - engines: {node: '>= 14'} - peerDependencies: - typedoc: ^0.22.12 || 0.23.x - dependencies: - typedoc: 0.23.10_typescript@4.7.4 - dev: true - /typedoc/0.23.10_typescript@4.7.4: resolution: {integrity: sha512-03EUiu/ZuScUBMnY6p0lY+HTH8SwhzvRE3gImoemdPDWXPXlks83UGTx++lyquWeB1MTwm9D9Ca8RIjkK3AFfQ==} engines: {node: '>= 14.14'} diff --git a/typedoc.js b/typedoc.js index eaf506fd..29c8e189 100644 --- a/typedoc.js +++ b/typedoc.js @@ -5,13 +5,12 @@ module.exports = { validation: { notExported: true, invalidLink: true, - notDocumented: false, + notDocumented: true, }, excludePrivate: true, excludeExternals: true, exclude: ['**/*/dist', '**/*/node_modules'], plugin: [ - 'typedoc-plugin-coverage', path.join(__dirname, 'scripts/totally-great-typedoc-plugin.js'), ], }