diff --git a/packages/builders/package.json b/packages/builders/package.json index fa7dfd34a..d3e795754 100644 --- a/packages/builders/package.json +++ b/packages/builders/package.json @@ -7,7 +7,7 @@ "test": "jest --pass-with-no-tests", "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts", "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix", - "docs": "typedoc --json docs/typedoc-out.json src/index.ts && node scripts/docs.mjs", + "docs": "typedoc --json docs/typedoc-out.json src/index.ts && ts-docgen -i docs/typedoc-out.json -c docs/index.yml -o docs/docs.json", "prepublishOnly": "yarn build && yarn lint && yarn test", "changelog": "git cliff --prepend ./CHANGELOG.md -l -c ./cliff.toml -r ../../ --include-path 'packages/builders/*'" }, @@ -64,7 +64,7 @@ "@babel/plugin-proposal-decorators": "^7.18.2", "@babel/preset-env": "^7.18.2", "@babel/preset-typescript": "^7.17.12", - "@discordjs/ts-docgen": "^0.4.1", + "@discordjs/scripts": "workspace:^", "@types/jest": "^28.1.0", "@types/node": "^16.11.38", "@typescript-eslint/eslint-plugin": "^5.27.0", diff --git a/packages/builders/scripts/docs.mjs b/packages/builders/scripts/docs.mjs deleted file mode 100644 index 3915377dc..000000000 --- a/packages/builders/scripts/docs.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import { runGenerator } from '@discordjs/ts-docgen'; - -runGenerator({ - existingOutput: 'docs/typedoc-out.json', - custom: 'docs/index.yml', - output: 'docs/docs.json', -}); diff --git a/packages/collection/package.json b/packages/collection/package.json index 7d7ad1dc7..e6b4cb23a 100644 --- a/packages/collection/package.json +++ b/packages/collection/package.json @@ -7,7 +7,7 @@ "build": "tsup", "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts", "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix", - "docs": "typedoc --json docs/typedoc-out.json src/index.ts && node scripts/docs.mjs", + "docs": "typedoc --json docs/typedoc-out.json src/index.ts && ts-docgen -i docs/typedoc-out.json -c docs/index.yml -o docs/docs.json", "prepublishOnly": "yarn build && yarn lint && yarn test", "changelog": "git cliff --prepend ./CHANGELOG.md -l -c ./cliff.toml -r ../../ --include-path 'packages/collection/*'" }, @@ -51,7 +51,7 @@ "@babel/core": "^7.18.2", "@babel/preset-env": "^7.18.2", "@babel/preset-typescript": "^7.17.12", - "@discordjs/ts-docgen": "^0.4.1", + "@discordjs/scripts": "workspace:^", "@types/jest": "^28.1.0", "@types/node": "^16.11.38", "@typescript-eslint/eslint-plugin": "^5.27.0", diff --git a/packages/collection/scripts/docs.mjs b/packages/collection/scripts/docs.mjs deleted file mode 100644 index 3915377dc..000000000 --- a/packages/collection/scripts/docs.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import { runGenerator } from '@discordjs/ts-docgen'; - -runGenerator({ - existingOutput: 'docs/typedoc-out.json', - custom: 'docs/index.yml', - output: 'docs/docs.json', -}); diff --git a/packages/proxy/package.json b/packages/proxy/package.json index fba067d3d..b3bba7f45 100644 --- a/packages/proxy/package.json +++ b/packages/proxy/package.json @@ -7,7 +7,7 @@ "test": "jest --pass-with-no-tests --collect-coverage", "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts", "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix", - "docs": "typedoc --json docs/typedoc-out.json src/index.ts && node scripts/docs.mjs", + "docs": "typedoc --json docs/typedoc-out.json src/index.ts && ts-docgen -i docs/typedoc-out.json -c docs/index.yml -o docs/docs.json", "prepublishOnly": "yarn build && yarn lint && yarn test", "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/proxy/*'" }, @@ -61,7 +61,7 @@ "@babel/plugin-proposal-decorators": "^7.18.2", "@babel/preset-env": "^7.18.2", "@babel/preset-typescript": "^7.17.12", - "@discordjs/ts-docgen": "^0.4.1", + "@discordjs/scripts": "workspace:^", "@types/jest": "^28.1.0", "@types/node": "^16.11.38", "@types/supertest": "^2.0.12", diff --git a/packages/proxy/scripts/docs.mjs b/packages/proxy/scripts/docs.mjs deleted file mode 100644 index 3915377dc..000000000 --- a/packages/proxy/scripts/docs.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import { runGenerator } from '@discordjs/ts-docgen'; - -runGenerator({ - existingOutput: 'docs/typedoc-out.json', - custom: 'docs/index.yml', - output: 'docs/docs.json', -}); diff --git a/packages/rest/package.json b/packages/rest/package.json index 23d6f6258..080f99d95 100644 --- a/packages/rest/package.json +++ b/packages/rest/package.json @@ -7,7 +7,7 @@ "test": "jest --pass-with-no-tests --collect-coverage", "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts", "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix", - "docs": "typedoc --json docs/typedoc-out.json src/index.ts && node scripts/docs.mjs", + "docs": "typedoc --json docs/typedoc-out.json src/index.ts && ts-docgen -i docs/typedoc-out.json -c docs/index.yml -o docs/docs.json", "prepublishOnly": "yarn build && yarn lint && yarn test", "changelog": "git cliff --prepend ./CHANGELOG.md -l -c ./cliff.toml -r ../../ --include-path 'packages/rest/*'" }, @@ -62,7 +62,7 @@ "@babel/plugin-proposal-decorators": "^7.18.2", "@babel/preset-env": "^7.18.2", "@babel/preset-typescript": "^7.17.12", - "@discordjs/ts-docgen": "^0.4.1", + "@discordjs/scripts": "workspace:^", "@types/jest": "^28.1.0", "@typescript-eslint/eslint-plugin": "^5.27.0", "@typescript-eslint/parser": "^5.27.0", diff --git a/packages/rest/scripts/docs.mjs b/packages/rest/scripts/docs.mjs deleted file mode 100644 index 3915377dc..000000000 --- a/packages/rest/scripts/docs.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import { runGenerator } from '@discordjs/ts-docgen'; - -runGenerator({ - existingOutput: 'docs/typedoc-out.json', - custom: 'docs/index.yml', - output: 'docs/docs.json', -}); diff --git a/packages/scripts/.eslintrc.json b/packages/scripts/.eslintrc.json new file mode 100644 index 000000000..0998f03ac --- /dev/null +++ b/packages/scripts/.eslintrc.json @@ -0,0 +1,12 @@ +{ + "root": true, + "extends": "marine/prettier/node", + "parserOptions": { + "project": "./tsconfig.eslint.json", + "extraFileExtensions": [".mjs"] + }, + "ignorePatterns": ["**/dist/*"], + "env": { + "jest": true + } +} diff --git a/packages/scripts/.gitignore b/packages/scripts/.gitignore new file mode 100644 index 000000000..69227d965 --- /dev/null +++ b/packages/scripts/.gitignore @@ -0,0 +1,29 @@ +# Packages +node_modules/ + +# Log files +logs/ +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Env +.env + +# Dist +dist/ +typings/ + +docs/**/* +!docs/index.yml +!docs/README.md +!docs/examples/ +!docs/examples/*.md + +# Miscellaneous +.tmp/ +coverage/ diff --git a/packages/scripts/.prettierignore b/packages/scripts/.prettierignore new file mode 100644 index 000000000..553e0ea6c --- /dev/null +++ b/packages/scripts/.prettierignore @@ -0,0 +1,8 @@ +# Autogenerated +CHANGELOG.md +.turbo +dist/ +docs/**/* +!docs/index.yml +!docs/README.md +coverage/ diff --git a/packages/scripts/.prettierrc.json b/packages/scripts/.prettierrc.json new file mode 100644 index 000000000..eba3f4077 --- /dev/null +++ b/packages/scripts/.prettierrc.json @@ -0,0 +1,8 @@ +{ + "printWidth": 120, + "useTabs": true, + "singleQuote": true, + "quoteProps": "as-needed", + "trailingComma": "all", + "endOfLine": "lf" +} diff --git a/packages/scripts/LICENSE b/packages/scripts/LICENSE new file mode 100644 index 000000000..cbe9c6540 --- /dev/null +++ b/packages/scripts/LICENSE @@ -0,0 +1,191 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2021 Noel Buechler + Copyright 2021 Vlad Frangu + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/scripts/README.md b/packages/scripts/README.md new file mode 100644 index 000000000..d1a9eca44 --- /dev/null +++ b/packages/scripts/README.md @@ -0,0 +1,31 @@ +
+
+

+ discord.js +

+
+

+ Discord server + Build status +

+
+ +## Links + +- [Website](https://discord.js.org/) ([source](https://github.com/discordjs/website)) +- [Documentation](https://discord.js.org/#/docs) +- [Guide](https://discordjs.guide/) ([source](https://github.com/discordjs/guide)) + See also the [Update Guide](https://discordjs.guide/additional-info/changes-in-v13.html), including updated and removed items in the library. +- [discord.js Discord server](https://discord.gg/djs) +- [Discord API Discord server](https://discord.gg/discord-api) +- [GitHub](https://github.com/discordjs/discord.js/tree/main/packages/scripts) +- [Related libraries](https://discord.com/developers/docs/topics/community-resources#libraries) + +## Contributing + +See [the contribution guide](https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md) if you'd like to submit a PR. + +## Help + +If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle +nudge in the right direction, please don't hesitate to join our official [discord.js Server](https://discord.gg/djs). diff --git a/packages/scripts/babel.config.js b/packages/scripts/babel.config.js new file mode 100644 index 000000000..7236fed9b --- /dev/null +++ b/packages/scripts/babel.config.js @@ -0,0 +1,18 @@ +/** + * @type {import('@babel/core').TransformOptions} + */ +module.exports = { + parserOpts: { strictMode: true }, + sourceMaps: 'inline', + presets: [ + [ + '@babel/preset-env', + { + targets: { node: 'current' }, + modules: 'commonjs', + }, + ], + '@babel/preset-typescript', + ], + plugins: ['babel-plugin-transform-typescript-metadata', ['@babel/plugin-proposal-decorators', { legacy: true }]], +}; diff --git a/packages/scripts/jest.config.js b/packages/scripts/jest.config.js new file mode 100644 index 000000000..ed6155a98 --- /dev/null +++ b/packages/scripts/jest.config.js @@ -0,0 +1,19 @@ +/** + * @type {import('@jest/types').Config.InitialOptions} + */ +module.exports = { + testMatch: ['**/+(*.)+(spec|test).+(ts|js)?(x)'], + testEnvironment: 'node', + collectCoverage: true, + collectCoverageFrom: ['src/**/*.ts'], + coverageDirectory: 'coverage', + coverageReporters: ['text', 'lcov', 'clover'], + coverageThreshold: { + global: { + branches: 70, + lines: 70, + statements: 70, + }, + }, + coveragePathIgnorePatterns: ['src/index.ts'], +}; diff --git a/packages/scripts/package.json b/packages/scripts/package.json new file mode 100644 index 000000000..fb932291c --- /dev/null +++ b/packages/scripts/package.json @@ -0,0 +1,75 @@ +{ + "name": "@discordjs/scripts", + "version": "0.1.0-dev", + "description": "A set of scripts that we use for our workflows", + "private": true, + "scripts": { + "build": "tsup", + "test": "jest --pass-with-no-tests", + "lint": "prettier --check . && eslint src --ext mjs,js,ts", + "format": "prettier --write . && eslint src --ext mjs,js,ts --fix" + }, + "bin": { + "ts-docgen": "./dist/docs.js" + }, + "main": "./dist/index.js", + "module": "./dist/index.mjs", + "types": "./dist/index.d.ts", + "exports": { + "import": "./dist/index.mjs", + "require": "./dist/index.js", + "types": "./dist/index.d.ts" + }, + "directories": { + "lib": "src" + }, + "files": [ + "dist" + ], + "contributors": [ + "Crawl " + ], + "license": "Apache-2.0", + "keywords": [ + "api", + "bot", + "client", + "node", + "discordjs" + ], + "repository": { + "type": "git", + "url": "https://github.com/discordjs/discord.js.git" + }, + "bugs": { + "url": "https://github.com/discordjs/discord.js/issues" + }, + "homepage": "https://discord.js.org", + "dependencies": { + "@discordjs/ts-docgen": "^0.4.1", + "commander": "^9.3.0", + "tslib": "^2.4.0" + }, + "devDependencies": { + "@babel/core": "^7.18.2", + "@babel/plugin-proposal-decorators": "^7.18.2", + "@babel/preset-env": "^7.18.2", + "@babel/preset-typescript": "^7.17.12", + "@types/jest": "^28.1.0", + "@types/node": "^16.11.38", + "@typescript-eslint/eslint-plugin": "^5.27.0", + "@typescript-eslint/parser": "^5.27.0", + "babel-plugin-transform-typescript-metadata": "^0.3.2", + "eslint": "^8.17.0", + "eslint-config-marine": "^9.4.1", + "eslint-config-prettier": "^8.5.0", + "eslint-plugin-import": "^2.26.0", + "jest": "^28.1.0", + "prettier": "^2.6.2", + "tsup": "^6.0.1", + "typescript": "^4.7.3" + }, + "engines": { + "node": ">=16.9.0" + } +} diff --git a/packages/scripts/src/docs.ts b/packages/scripts/src/docs.ts new file mode 100644 index 000000000..6f5e07b19 --- /dev/null +++ b/packages/scripts/src/docs.ts @@ -0,0 +1,25 @@ +#!/usr/bin/env node +import { runGenerator } from '@discordjs/ts-docgen'; +import { createCommand } from 'commander'; +import packageFile from '../package.json'; + +interface CLIOptions { + input: string; + custom: string; + output: string; +} + +const command = createCommand() + .version(packageFile.version) + .option('-i, --input ', 'Path to an existing TypeDoc JSON output file') + .option('-c, --custom ', 'Custom docs definition file to use') + .option('-o, --output ', 'Path to output file'); + +const program = command.parse(process.argv); +const options = program.opts(); + +runGenerator({ + existingOutput: options.input, + custom: options.custom, + output: options.output, +}); diff --git a/packages/scripts/tsconfig.eslint.json b/packages/scripts/tsconfig.eslint.json new file mode 100644 index 000000000..d04d4be3a --- /dev/null +++ b/packages/scripts/tsconfig.eslint.json @@ -0,0 +1,20 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "allowJs": true + }, + "include": [ + "**/*.ts", + "**/*.tsx", + "**/*.js", + "**/*.mjs", + "**/*.jsx", + "**/*.test.ts", + "**/*.test.js", + "**/*.test.mjs", + "**/*.spec.ts", + "**/*.spec.js", + "**/*.spec.mjs" + ], + "exclude": [] +} diff --git a/packages/scripts/tsconfig.json b/packages/scripts/tsconfig.json new file mode 100644 index 000000000..fd8b5e417 --- /dev/null +++ b/packages/scripts/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig.json", + "include": ["src/**/*.ts"] +} diff --git a/packages/scripts/tsup.config.ts b/packages/scripts/tsup.config.ts new file mode 100644 index 000000000..cb8bd7ecc --- /dev/null +++ b/packages/scripts/tsup.config.ts @@ -0,0 +1,12 @@ +import { defineConfig } from 'tsup'; + +export default defineConfig({ + clean: true, + dts: true, + entryPoints: ['src/docs.ts'], + format: ['esm', 'cjs'], + minify: true, + skipNodeModulesBundle: true, + sourcemap: true, + target: 'es2021', +}); diff --git a/packages/voice/package.json b/packages/voice/package.json index ff6d2fe23..9ec7357a5 100644 --- a/packages/voice/package.json +++ b/packages/voice/package.json @@ -7,7 +7,7 @@ "test": "jest --pass-with-no-tests --collect-coverage", "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts", "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix", - "docs": "typedoc --json docs/typedoc-out.json src/index.ts && node scripts/docs.mjs", + "docs": "typedoc --json docs/typedoc-out.json src/index.ts && ts-docgen -i docs/typedoc-out.json -c docs/index.yml -o docs/docs.json", "prepublishOnly": "yarn build && yarn lint && yarn test", "changelog": "git cliff --prepend ./CHANGELOG.md -l -c ./cliff.toml -r ../../ --include-path 'packages/voice/*'" }, @@ -61,7 +61,7 @@ "@babel/core": "^7.18.2", "@babel/preset-env": "^7.18.2", "@babel/preset-typescript": "^7.17.12", - "@discordjs/ts-docgen": "^0.4.1", + "@discordjs/scripts": "workspace:^", "@types/jest": "^28.1.0", "@types/node": "^16.11.38", "@typescript-eslint/eslint-plugin": "^5.27.0", diff --git a/packages/voice/scripts/docs.mjs b/packages/voice/scripts/docs.mjs deleted file mode 100644 index 3915377dc..000000000 --- a/packages/voice/scripts/docs.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import { runGenerator } from '@discordjs/ts-docgen'; - -runGenerator({ - existingOutput: 'docs/typedoc-out.json', - custom: 'docs/index.yml', - output: 'docs/docs.json', -}); diff --git a/packages/voice/scripts/postbuild.mjs b/packages/voice/scripts/postbuild.mjs deleted file mode 100644 index 6146e325b..000000000 --- a/packages/voice/scripts/postbuild.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import { readFile, writeFile } from 'node:fs/promises'; - -const data = await readFile('./dist/index.mjs', 'utf-8'); -await writeFile( - './dist/index.mjs', - `import{createRequire as topLevelCreateRequire}from"module";const require=topLevelCreateRequire(import.meta.url);${data}`, -); diff --git a/yarn.lock b/yarn.lock index 8d57cc034..855875017 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1914,7 +1914,7 @@ __metadata: "@babel/plugin-proposal-decorators": ^7.18.2 "@babel/preset-env": ^7.18.2 "@babel/preset-typescript": ^7.17.12 - "@discordjs/ts-docgen": ^0.4.1 + "@discordjs/scripts": "workspace:^" "@sapphire/shapeshift": ^3.1.0 "@sindresorhus/is": ^4.6.0 "@types/jest": ^28.1.0 @@ -1945,7 +1945,7 @@ __metadata: "@babel/core": ^7.18.2 "@babel/preset-env": ^7.18.2 "@babel/preset-typescript": ^7.17.12 - "@discordjs/ts-docgen": ^0.4.1 + "@discordjs/scripts": "workspace:^" "@types/jest": ^28.1.0 "@types/node": ^16.11.38 "@typescript-eslint/eslint-plugin": ^5.27.0 @@ -2000,7 +2000,7 @@ __metadata: "@babel/preset-env": ^7.18.2 "@babel/preset-typescript": ^7.17.12 "@discordjs/rest": "workspace:^" - "@discordjs/ts-docgen": ^0.4.1 + "@discordjs/scripts": "workspace:^" "@types/jest": ^28.1.0 "@types/node": ^16.11.38 "@types/supertest": ^2.0.12 @@ -2032,7 +2032,7 @@ __metadata: "@babel/preset-env": ^7.18.2 "@babel/preset-typescript": ^7.17.12 "@discordjs/collection": "workspace:^" - "@discordjs/ts-docgen": ^0.4.1 + "@discordjs/scripts": "workspace:^" "@sapphire/async-queue": ^1.3.1 "@sapphire/snowflake": ^3.2.2 "@types/jest": ^28.1.0 @@ -2055,7 +2055,7 @@ __metadata: languageName: unknown linkType: soft -"@discordjs/scripts@workspace:packages/scripts": +"@discordjs/scripts@workspace:^, @discordjs/scripts@workspace:packages/scripts": version: 0.0.0-use.local resolution: "@discordjs/scripts@workspace:packages/scripts" dependencies: @@ -2063,11 +2063,13 @@ __metadata: "@babel/plugin-proposal-decorators": ^7.18.2 "@babel/preset-env": ^7.18.2 "@babel/preset-typescript": ^7.17.12 + "@discordjs/ts-docgen": ^0.4.1 "@types/jest": ^28.1.0 "@types/node": ^16.11.38 "@typescript-eslint/eslint-plugin": ^5.27.0 "@typescript-eslint/parser": ^5.27.0 babel-plugin-transform-typescript-metadata: ^0.3.2 + commander: ^9.3.0 eslint: ^8.17.0 eslint-config-marine: ^9.4.1 eslint-config-prettier: ^8.5.0 @@ -2077,6 +2079,8 @@ __metadata: tslib: ^2.4.0 tsup: ^6.0.1 typescript: ^4.7.3 + bin: + ts-docgen: ./dist/docs.js languageName: unknown linkType: soft @@ -2097,7 +2101,7 @@ __metadata: "@babel/core": ^7.18.2 "@babel/preset-env": ^7.18.2 "@babel/preset-typescript": ^7.17.12 - "@discordjs/ts-docgen": ^0.4.1 + "@discordjs/scripts": "workspace:^" "@types/jest": ^28.1.0 "@types/node": ^16.11.38 "@types/ws": ^8.5.3 @@ -4196,6 +4200,13 @@ __metadata: languageName: node linkType: hard +"commander@npm:^9.3.0": + version: 9.3.0 + resolution: "commander@npm:9.3.0" + checksum: d421ce66fee25792a1470c69aa8d1b86434bf873a96483aa92c8267f81a6f20c6f7c426f5e82f88ac50a8ec4855d3f2787aebcdef8aa559e1080a2337a95a217 + languageName: node + linkType: hard + "common-sequence@npm:^2.0.0": version: 2.0.2 resolution: "common-sequence@npm:2.0.2"