From f83a8a58c99532131848f9d89cec58ae5cd5d138 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Sun, 7 May 2023 17:05:26 +0100 Subject: [PATCH] feat: create-discord-bot (#9420) * feat: basic initialisation * fix: no scope * chore: add options for issues * feat: good word, Monbrey * feat: basic README.md * fix: no documentation for this * feat: install for them * chore: update licencing * chore: fix year * fix: build tsup * feat: add TypeScript option * feat: add `name` option * chore: ignore annoying errors * chore: add tsconfig.json * refactor: remove name We can just use the name of the directory instead. * chore: update cliff jumper rc * chore: bump dependencies * chore: bump dependencies * fix: build in prepack * fix: configure ESLint correctly * feat: infer package manager * docs(packageManager): document `install()` * fix(packageManager): do not emit a warning for `npm` * refactor: change project name colour to yellow * docs(constants): basic documentation * feat: add link * chore: add `verbatimModuleSyntax` * chore: bump discord.js * refactor: switch to @sapphire/ts-config * refactor: file name changes * refactor: tweak description * chore: update yarn.lock * fix: add .env * chore: bump dependencies * feat: event handler * refactor: use `default` * refactor: simpler event * chore: bump discord.js * fix: add release script and reorder * style: reorder package.json * chore: remove unneeded ignores * chore: bump minimum Node.js version * chore: add @types/node to TypeScript package.json * chore: apply requested changes Co-authored-by: Noel * style: run ESLint + Prettier * refactor: prefer "the" * refactor: remove some comments * feat: add ESLint + Prettier * chore: requested changes Co-authored-by: Noel * chore: more requested changes Co-authored-by: Noel --------- Co-authored-by: Noel --- .github/CODEOWNERS | 1 + .github/CONTRIBUTING.md | 2 +- .../ISSUE_TEMPLATE/01-package_bug_report.yml | 1 + .github/ISSUE_TEMPLATE/03-feature_request.yml | 1 + .github/issue-labeler.yml | 3 + .github/labeler.yml | 9 +- .github/labels.yml | 14 +- .../create-discord-bot/.cliff-jumperrc.json | 5 + packages/create-discord-bot/.eslintignore | 1 + packages/create-discord-bot/.eslintrc.json | 3 + packages/create-discord-bot/.gitignore | 23 +++ packages/create-discord-bot/.lintstagedrc.js | 1 + packages/create-discord-bot/.prettierignore | 8 + packages/create-discord-bot/.prettierrc.js | 1 + packages/create-discord-bot/LICENSE | 190 ++++++++++++++++++ packages/create-discord-bot/README.md | 43 ++++ .../create-discord-bot/api-extractor.json | 6 + packages/create-discord-bot/cliff.toml | 63 ++++++ packages/create-discord-bot/package.json | 72 +++++++ .../src/create-discord-bot.ts | 64 ++++++ .../src/helpers/packageManager.ts | 64 ++++++ .../create-discord-bot/src/util/constants.ts | 9 + .../template/JavaScript/.env | 1 + .../template/JavaScript/.eslintrc.json | 4 + .../template/JavaScript/.prettierrc.json | 8 + .../template/JavaScript/package.json | 21 ++ .../template/JavaScript/src/events/ready.js | 9 + .../template/JavaScript/src/index.js | 15 ++ .../template/TypeScript/.env | 1 + .../template/TypeScript/.eslintrc.json | 8 + .../template/TypeScript/.prettierrc.json | 8 + .../template/TypeScript/package.json | 25 +++ .../template/TypeScript/src/events/index.ts | 7 + .../template/TypeScript/src/events/ready.ts | 10 + .../template/TypeScript/src/index.ts | 19 ++ .../template/TypeScript/tsconfig.eslint.json | 8 + .../template/TypeScript/tsconfig.json | 11 + .../create-discord-bot/tsconfig.docs.json | 7 + .../create-discord-bot/tsconfig.eslint.json | 20 ++ packages/create-discord-bot/tsconfig.json | 4 + packages/create-discord-bot/tsup.config.ts | 9 + yarn.lock | 34 +++- 42 files changed, 802 insertions(+), 11 deletions(-) create mode 100644 packages/create-discord-bot/.cliff-jumperrc.json create mode 100644 packages/create-discord-bot/.eslintignore create mode 100644 packages/create-discord-bot/.eslintrc.json create mode 100644 packages/create-discord-bot/.gitignore create mode 100644 packages/create-discord-bot/.lintstagedrc.js create mode 100644 packages/create-discord-bot/.prettierignore create mode 100644 packages/create-discord-bot/.prettierrc.js create mode 100644 packages/create-discord-bot/LICENSE create mode 100644 packages/create-discord-bot/README.md create mode 100644 packages/create-discord-bot/api-extractor.json create mode 100644 packages/create-discord-bot/cliff.toml create mode 100644 packages/create-discord-bot/package.json create mode 100755 packages/create-discord-bot/src/create-discord-bot.ts create mode 100644 packages/create-discord-bot/src/helpers/packageManager.ts create mode 100644 packages/create-discord-bot/src/util/constants.ts create mode 100644 packages/create-discord-bot/template/JavaScript/.env create mode 100644 packages/create-discord-bot/template/JavaScript/.eslintrc.json create mode 100644 packages/create-discord-bot/template/JavaScript/.prettierrc.json create mode 100644 packages/create-discord-bot/template/JavaScript/package.json create mode 100644 packages/create-discord-bot/template/JavaScript/src/events/ready.js create mode 100644 packages/create-discord-bot/template/JavaScript/src/index.js create mode 100644 packages/create-discord-bot/template/TypeScript/.env create mode 100644 packages/create-discord-bot/template/TypeScript/.eslintrc.json create mode 100644 packages/create-discord-bot/template/TypeScript/.prettierrc.json create mode 100644 packages/create-discord-bot/template/TypeScript/package.json create mode 100644 packages/create-discord-bot/template/TypeScript/src/events/index.ts create mode 100644 packages/create-discord-bot/template/TypeScript/src/events/ready.ts create mode 100644 packages/create-discord-bot/template/TypeScript/src/index.ts create mode 100644 packages/create-discord-bot/template/TypeScript/tsconfig.eslint.json create mode 100644 packages/create-discord-bot/template/TypeScript/tsconfig.json create mode 100644 packages/create-discord-bot/tsconfig.docs.json create mode 100644 packages/create-discord-bot/tsconfig.eslint.json create mode 100644 packages/create-discord-bot/tsconfig.json create mode 100644 packages/create-discord-bot/tsup.config.ts diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 00639cc77..8b89a5e7f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,6 +13,7 @@ /packages/builders/ @discordjs/builders /packages/collection/ @discordjs/collection /packages/core/ @discordjs/core +/packages/create-discord-bot/ @discordjs/guide /packages/discord.js/ @discordjs/core /packages/docgen/ @iCrawl /packages/formatters/ @discordjs/formatters diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e70d26320..d5f208a81 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,4 +45,4 @@ yarn create-package [package-description] ``` This will create new package directory under `packages/` with the required configuration files. You can -begin to make changes within the `src/` directory. +begin to make changes within the `src/` directory. It may also be required to update the CODEOWNERS file. diff --git a/.github/ISSUE_TEMPLATE/01-package_bug_report.yml b/.github/ISSUE_TEMPLATE/01-package_bug_report.yml index 136d51b0d..69096b255 100644 --- a/.github/ISSUE_TEMPLATE/01-package_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01-package_bug_report.yml @@ -18,6 +18,7 @@ body: - builders - collection - core + - create-discord-bot - formatters - next - proxy diff --git a/.github/ISSUE_TEMPLATE/03-feature_request.yml b/.github/ISSUE_TEMPLATE/03-feature_request.yml index 2792eb588..5c2d330be 100644 --- a/.github/ISSUE_TEMPLATE/03-feature_request.yml +++ b/.github/ISSUE_TEMPLATE/03-feature_request.yml @@ -20,6 +20,7 @@ body: - builders - collection - core + - create-discord-bot - formatters - next - proxy diff --git a/.github/issue-labeler.yml b/.github/issue-labeler.yml index 0b294698c..ff7e027a8 100644 --- a/.github/issue-labeler.yml +++ b/.github/issue-labeler.yml @@ -16,6 +16,9 @@ packages:collection: packages:core: - "### Which (application|package|application or package) is this (bug report|feature request) for\\?\\n\\ncore\\n" +packages:create-discord-bot: + - "### Which (application|package|application or package) is this (bug + report|feature request) for\\?\\n\\ncreate-discord-bot\\n" packages:discord.js: - "### Which (application|package|application or package) is this (bug report|feature request) for\\?\\n\\ndiscord.js\\n" diff --git a/.github/labeler.yml b/.github/labeler.yml index bf404ed76..91c0c1e1f 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -16,18 +16,21 @@ packages:collection: packages:core: - packages/core/* - packages/core/**/* +packages:create-discord-bot: + - packages/create-discord-bot/* + - packages/create-discord-bot/**/* packages:discord.js: - packages/discord.js/* - packages/discord.js/**/* -packages:next: - - packages/next/* - - packages/next/**/* packages:docgen: - packages/docgen/* - packages/docgen/**/* packages:formatters: - packages/formatters/* - packages/formatters/**/* +packages:next: + - packages/next/* + - packages/next/**/* packages:proxy: - packages/proxy/* - packages/proxy/**/* diff --git a/.github/labels.yml b/.github/labels.yml index efe8c19cd..c053d9e39 100644 --- a/.github/labels.yml +++ b/.github/labels.yml @@ -1,7 +1,7 @@ - name: api changes - color: '5663e9' + color: 5663e9 - name: api support - color: '5663e9' + color: 5663e9 - name: apps:guide color: fbca04 - name: apps:website @@ -23,7 +23,7 @@ - name: dependencies color: 276bd1 - name: discord - color: '5663e9' + color: 5663e9 - name: discussion color: b6b1f9 - name: documentation @@ -41,7 +41,7 @@ - name: has PR color: 4b1f8e - name: help wanted - color: '008672' + color: 008672 - name: in progress color: ffccd7 - name: in review @@ -60,14 +60,16 @@ color: fbca04 - name: packages:core color: fbca04 -- name: packages:discord.js +- name: packages:create-discord-bot color: fbca04 -- name: packages:next +- name: packages:discord.js color: fbca04 - name: packages:docgen color: fbca04 - name: packages:formatters color: fbca04 +- name: packages:next + color: fbca04 - name: packages:proxy color: fbca04 - name: packages:proxy-container diff --git a/packages/create-discord-bot/.cliff-jumperrc.json b/packages/create-discord-bot/.cliff-jumperrc.json new file mode 100644 index 000000000..ebafd5739 --- /dev/null +++ b/packages/create-discord-bot/.cliff-jumperrc.json @@ -0,0 +1,5 @@ +{ + "name": "create-discord-bot", + "packagePath": "packages/create-discord-bot", + "tagTemplate": "{{new-version}}" +} diff --git a/packages/create-discord-bot/.eslintignore b/packages/create-discord-bot/.eslintignore new file mode 100644 index 000000000..849ddff3b --- /dev/null +++ b/packages/create-discord-bot/.eslintignore @@ -0,0 +1 @@ +dist/ diff --git a/packages/create-discord-bot/.eslintrc.json b/packages/create-discord-bot/.eslintrc.json new file mode 100644 index 000000000..99ef7cec8 --- /dev/null +++ b/packages/create-discord-bot/.eslintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "../../.eslintrc.json" +} diff --git a/packages/create-discord-bot/.gitignore b/packages/create-discord-bot/.gitignore new file mode 100644 index 000000000..475d98672 --- /dev/null +++ b/packages/create-discord-bot/.gitignore @@ -0,0 +1,23 @@ +# Packages +node_modules/ + +# Log files +logs/ +*.log +npm-debug.log* + +# Runtime data +pids +*.pid +*.seed + +# Env +.env +!template/JavaScript/.env +!template/TypeScript/.env + +# Dist +dist/ + +# Miscellaneous +.tmp/ diff --git a/packages/create-discord-bot/.lintstagedrc.js b/packages/create-discord-bot/.lintstagedrc.js new file mode 100644 index 000000000..dc17706a5 --- /dev/null +++ b/packages/create-discord-bot/.lintstagedrc.js @@ -0,0 +1 @@ +module.exports = require('../../.lintstagedrc.json'); diff --git a/packages/create-discord-bot/.prettierignore b/packages/create-discord-bot/.prettierignore new file mode 100644 index 000000000..553e0ea6c --- /dev/null +++ b/packages/create-discord-bot/.prettierignore @@ -0,0 +1,8 @@ +# Autogenerated +CHANGELOG.md +.turbo +dist/ +docs/**/* +!docs/index.yml +!docs/README.md +coverage/ diff --git a/packages/create-discord-bot/.prettierrc.js b/packages/create-discord-bot/.prettierrc.js new file mode 100644 index 000000000..f004026c7 --- /dev/null +++ b/packages/create-discord-bot/.prettierrc.js @@ -0,0 +1 @@ +module.exports = require('../../.prettierrc.json'); diff --git a/packages/create-discord-bot/LICENSE b/packages/create-discord-bot/LICENSE new file mode 100644 index 000000000..6b2a810a6 --- /dev/null +++ b/packages/create-discord-bot/LICENSE @@ -0,0 +1,190 @@ + 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 2023 Noel Buechler + + 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/create-discord-bot/README.md b/packages/create-discord-bot/README.md new file mode 100644 index 000000000..b2bc58af2 --- /dev/null +++ b/packages/create-discord-bot/README.md @@ -0,0 +1,43 @@ +
+
+

+ discord.js +

+
+

+ Discord server + Build status +

+

+ Vercel +

+
+ +## About + +`npx create-discord-bot ./your/chosen/directory/`. It's as easy as that to create a simple Discord bot to begin your journey with the Discord API. + +## Links + +- [Guide] ([source][guide-source]) + - Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library. +- [discord.js Discord server][discord] +- [Discord API Discord server][discord-api] +- [GitHub][source] + +## Contributing + +Before creating an issue, please ensure that it hasn't already been reported/suggested. +See [the contribution guide][contributing] if you'd like to submit a pull request. + +## 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][discord]. + +[guide]: https://discordjs.guide/ +[guide-source]: https://github.com/discordjs/guide +[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html +[discord]: https://discord.gg/djs +[discord-api]: https://discord.gg/discord-api +[source]: https://github.com/discordjs/discord.js/tree/main/packages/create-discord-bot +[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md diff --git a/packages/create-discord-bot/api-extractor.json b/packages/create-discord-bot/api-extractor.json new file mode 100644 index 000000000..5ddfb3668 --- /dev/null +++ b/packages/create-discord-bot/api-extractor.json @@ -0,0 +1,6 @@ +{ + "extends": "../../api-extractor.json", + "docModel": { + "projectFolderUrl": "https://github.com/discordjs/discord.js/tree/main/packages/create-discord-bot" + } +} diff --git a/packages/create-discord-bot/cliff.toml b/packages/create-discord-bot/cliff.toml new file mode 100644 index 000000000..143043f0a --- /dev/null +++ b/packages/create-discord-bot/cliff.toml @@ -0,0 +1,63 @@ +[changelog] +header = """ +# Changelog + +All notable changes to this project will be documented in this file.\n +""" +body = """ +{% if version %}\ + # [{{ version | trim_start_matches(pat="v") }}]\ + {% if previous %}\ + {% if previous.version %}\ + (https://github.com/discordjs/discord.js/compare/{{ previous.version }}...{{ version }})\ + {% else %}\ + (https://github.com/discordjs/discord.js/tree/{{ version }})\ + {% endif %}\ + {% endif %} \ + - ({{ timestamp | date(format="%Y-%m-%d") }}) +{% else %}\ + # [unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ## {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.scope %}\ + **{{commit.scope}}:** \ + {% endif %}\ + {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/discordjs/discord.js/commit/{{ commit.id }}))\ + {% if commit.breaking %}\ + {% for breakingChange in commit.footers %}\ + \n{% raw %} {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\ + {% endfor %}\ + {% endif %}\ + {% endfor %} +{% endfor %}\n +""" +trim = true +footer = "" + +[git] +conventional_commits = true +filter_unconventional = true +commit_parsers = [ + { message = "^feat", group = "Features"}, + { message = "^fix", group = "Bug Fixes"}, + { message = "^docs", group = "Documentation"}, + { message = "^perf", group = "Performance"}, + { message = "^refactor", group = "Refactor"}, + { message = "^typings", group = "Typings"}, + { message = "^types", group = "Typings"}, + { message = ".*deprecated", body = ".*deprecated", group = "Deprecation"}, + { message = "^revert", skip = true}, + { message = "^style", group = "Styling"}, + { message = "^test", group = "Testing"}, + { message = "^chore", skip = true}, + { message = "^ci", skip = true}, + { message = "^build", skip = true}, + { body = ".*security", group = "Security"}, +] +filter_commits = true +tag_pattern = "create-discord-bot@[0-9]*" +ignore_tags = "" +topo_order = true +sort_commits = "newest" diff --git a/packages/create-discord-bot/package.json b/packages/create-discord-bot/package.json new file mode 100644 index 000000000..3fb7c83f4 --- /dev/null +++ b/packages/create-discord-bot/package.json @@ -0,0 +1,72 @@ +{ + "name": "create-discord-bot", + "version": "0.1.0", + "description": "A simple way to create a startup Discord bot.", + "scripts": { + "build": "tsup", + "lint": "prettier --check . && cross-env TIMING=1 eslint src --ext .mjs,.js,.ts --format=pretty", + "format": "prettier --write . && cross-env TIMING=1 eslint src --ext .mjs,.js,.ts --fix --format=pretty", + "prepack": "yarn build && yarn lint", + "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/create-discord-bot/*'", + "release": "cliff-jumper" + }, + "bin": "./dist/create-discord-bot.mjs", + "directories": { + "lib": "src" + }, + "files": [ + "dist", + "template" + ], + "contributors": [ + "Crawl ", + "SpaceEEC ", + "Vlad Frangu ", + "Aura Román ", + "Jiralite " + ], + "license": "Apache-2.0", + "keywords": [ + "discord", + "discord-api", + "discord.js", + "create-bot", + "init-bot", + "init-discord", + "boilerplate" + ], + "repository": { + "type": "git", + "url": "git+https://github.com/discordjs/discord.js.git" + }, + "bugs": { + "url": "https://github.com/discordjs/discord.js/issues" + }, + "homepage": "https://discord.js.org", + "dependencies": { + "chalk": "^5.2.0", + "commander": "^10.0.1", + "validate-npm-package-name": "^5.0.0" + }, + "devDependencies": { + "@favware/cliff-jumper": "^2.0.0", + "@microsoft/api-extractor": "^7.34.8", + "@types/node": "16.18.25", + "@types/validate-npm-package-name": "^4.0.0", + "@vitest/coverage-c8": "^0.31.0", + "cross-env": "^7.0.3", + "eslint": "^8.39.0", + "eslint-config-neon": "^0.1.46", + "eslint-formatter-pretty": "^5.0.0", + "prettier": "^2.8.8", + "tsup": "^6.7.0", + "typescript": "^5.0.4", + "vitest": "^0.31.0" + }, + "engines": { + "node": ">=18.16.0" + }, + "publishConfig": { + "access": "public" + } +} diff --git a/packages/create-discord-bot/src/create-discord-bot.ts b/packages/create-discord-bot/src/create-discord-bot.ts new file mode 100755 index 000000000..6a1afaf40 --- /dev/null +++ b/packages/create-discord-bot/src/create-discord-bot.ts @@ -0,0 +1,64 @@ +#!/usr/bin/env node + +// eslint-disable-next-line n/shebang +import { cpSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs'; +import path from 'node:path'; +import process from 'node:process'; +import { URL } from 'node:url'; +import chalk from 'chalk'; +import { program } from 'commander'; +import validateProjectName from 'validate-npm-package-name'; +import { install, resolvePackageManager } from './helpers/packageManager.js'; +import { GUIDE_URL } from './util/constants.js'; + +program + .description('Create a basic discord.js bot.') + .option('--typescript', 'Whether to use the TypeScript template.') + .argument('', 'The directory where this will be created.') + .parse(); + +const { typescript } = program.opts(); +const [directory] = program.args; + +if (!directory) { + console.error(chalk.red('Please specify the project directory.')); + process.exit(1); +} + +const root = path.resolve(directory); +const directoryName = path.basename(root); + +// We'll use the directory name as the project name. Check npm name validity. +const validationResult = validateProjectName(directoryName); + +if (!validationResult.validForNewPackages) { + console.error( + chalk.red( + `Cannot create a project named ${chalk.yellow(`"${directoryName}"`)} due to npm naming restrictions.\n\nErrors:`, + ), + ); + + for (const error of [...(validationResult.errors ?? []), ...(validationResult.warnings ?? [])]) { + console.error(chalk.red(`- ${error}`)); + } + + console.error(chalk.red('\nSee https://docs.npmjs.com/cli/configuring-npm/package-json for more details.')); + process.exit(1); +} + +if (!existsSync(root)) { + mkdirSync(root, { recursive: true }); +} + +console.log(`Creating ${directoryName} in ${chalk.green(root)}.`); +cpSync(new URL(`../template/${typescript ? 'TypeScript' : 'JavaScript'}`, import.meta.url), root, { recursive: true }); + +process.chdir(root); + +const newPackageJSON = readFileSync('./package.json', { encoding: 'utf8' }).replace('[REPLACE-NAME]', directoryName); +writeFileSync('./package.json', newPackageJSON); + +const packageManager = resolvePackageManager(); +install(packageManager); +console.log(chalk.green('All done! Be sure to read through the discord.js guide for help on your journey.')); +console.log(`Link: ${chalk.cyan(GUIDE_URL)}`); diff --git a/packages/create-discord-bot/src/helpers/packageManager.ts b/packages/create-discord-bot/src/helpers/packageManager.ts new file mode 100644 index 000000000..c0db5e93d --- /dev/null +++ b/packages/create-discord-bot/src/helpers/packageManager.ts @@ -0,0 +1,64 @@ +import { execSync } from 'node:child_process'; +import process from 'node:process'; +import chalk from 'chalk'; +import { DEFAULT_PACKAGE_MANAGER } from '../util/constants.js'; + +/** + * A union of supported package managers. + */ +export type PackageManager = 'npm' | 'pnpm' | 'yarn'; + +/** + * Resolves the package manager from `npm_config_user_agent`. + */ +export function resolvePackageManager(): PackageManager { + const npmConfigUserAgent = process.env.npm_config_user_agent; + + // If this is not present, return the default package manager. + if (!npmConfigUserAgent) { + return DEFAULT_PACKAGE_MANAGER; + } + + if (npmConfigUserAgent.startsWith('npm')) { + return 'npm'; + } + + if (npmConfigUserAgent.startsWith('yarn')) { + return 'yarn'; + } + + if (npmConfigUserAgent.startsWith('pnpm')) { + return 'pnpm'; + } + + console.error( + chalk.yellow( + `Detected an unsupported package manager (${npmConfigUserAgent}). Falling back to ${DEFAULT_PACKAGE_MANAGER}.`, + ), + ); + + // Fallback to the default package manager. + return DEFAULT_PACKAGE_MANAGER; +} + +/** + * Installs with a provided package manager. + * + * @param packageManager - The package manager to use + */ +export function install(packageManager: PackageManager) { + let installCommand; + + switch (packageManager) { + case 'npm': + case 'pnpm': + installCommand = `${packageManager} install`; + break; + case 'yarn': + installCommand = packageManager; + break; + } + + console.log(`Installing dependencies with ${packageManager}...`); + execSync(installCommand); +} diff --git a/packages/create-discord-bot/src/util/constants.ts b/packages/create-discord-bot/src/util/constants.ts new file mode 100644 index 000000000..7366008df --- /dev/null +++ b/packages/create-discord-bot/src/util/constants.ts @@ -0,0 +1,9 @@ +/** + * The default package manager. + */ +export const DEFAULT_PACKAGE_MANAGER = 'npm' as const; + +/** + * The URL to the guide. + */ +export const GUIDE_URL = 'https://guide.discordjs.dev' as const; diff --git a/packages/create-discord-bot/template/JavaScript/.env b/packages/create-discord-bot/template/JavaScript/.env new file mode 100644 index 000000000..47b0cab27 --- /dev/null +++ b/packages/create-discord-bot/template/JavaScript/.env @@ -0,0 +1 @@ +DISCORD_TOKEN= diff --git a/packages/create-discord-bot/template/JavaScript/.eslintrc.json b/packages/create-discord-bot/template/JavaScript/.eslintrc.json new file mode 100644 index 000000000..d5666a755 --- /dev/null +++ b/packages/create-discord-bot/template/JavaScript/.eslintrc.json @@ -0,0 +1,4 @@ +{ + "root": true, + "extends": ["neon/common", "neon/node", "neon/prettier"] +} diff --git a/packages/create-discord-bot/template/JavaScript/.prettierrc.json b/packages/create-discord-bot/template/JavaScript/.prettierrc.json new file mode 100644 index 000000000..eba3f4077 --- /dev/null +++ b/packages/create-discord-bot/template/JavaScript/.prettierrc.json @@ -0,0 +1,8 @@ +{ + "printWidth": 120, + "useTabs": true, + "singleQuote": true, + "quoteProps": "as-needed", + "trailingComma": "all", + "endOfLine": "lf" +} diff --git a/packages/create-discord-bot/template/JavaScript/package.json b/packages/create-discord-bot/template/JavaScript/package.json new file mode 100644 index 000000000..62f763f8e --- /dev/null +++ b/packages/create-discord-bot/template/JavaScript/package.json @@ -0,0 +1,21 @@ +{ + "name": "[REPLACE-NAME]", + "version": "0.1.0", + "private": true, + "type": "module", + "scripts": { + "lint": "prettier --check . && eslint src --ext .js,.cjs --format=pretty", + "format": "prettier --write . && eslint src --ext .js,.cjs --fix --format=pretty", + "start": "node --require dotenv/config index.js" + }, + "dependencies": { + "discord.js": "^14.11.0", + "dotenv": "^16.0.3" + }, + "devDependencies": { + "eslint": "^8.40.0", + "eslint-config-neon": "^0.1.47", + "eslint-formatter-pretty": "^5.0.0", + "prettier": "^2.8.8" + } +} diff --git a/packages/create-discord-bot/template/JavaScript/src/events/ready.js b/packages/create-discord-bot/template/JavaScript/src/events/ready.js new file mode 100644 index 000000000..679048d90 --- /dev/null +++ b/packages/create-discord-bot/template/JavaScript/src/events/ready.js @@ -0,0 +1,9 @@ +import { Events } from 'discord.js'; + +export default { + name: Events.ClientReady, + once: true, + async execute(client) { + console.log(`Ready! Logged in as ${client.user.tag}`); + }, +}; diff --git a/packages/create-discord-bot/template/JavaScript/src/index.js b/packages/create-discord-bot/template/JavaScript/src/index.js new file mode 100644 index 000000000..edaad472e --- /dev/null +++ b/packages/create-discord-bot/template/JavaScript/src/index.js @@ -0,0 +1,15 @@ +import { readdir } from 'node:fs/promises'; +import { join } from 'node:path'; +import { fileURLToPath, URL } from 'node:url'; +import { Client, GatewayIntentBits } from 'discord.js'; + +const client = new Client({ intents: [GatewayIntentBits.Guilds] }); +const eventsPath = fileURLToPath(new URL('events', import.meta.url)); +const eventFiles = await readdir(eventsPath).then((files) => files.filter((file) => file.endsWith('.js'))); + +for (const file of eventFiles) { + const event = (await import(join(eventsPath, file))).default; + client[event.data.once ? 'once' : 'on'](event.data.name, async (...args) => event.data.execute(...args)); +} + +void client.login(); diff --git a/packages/create-discord-bot/template/TypeScript/.env b/packages/create-discord-bot/template/TypeScript/.env new file mode 100644 index 000000000..47b0cab27 --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/.env @@ -0,0 +1 @@ +DISCORD_TOKEN= diff --git a/packages/create-discord-bot/template/TypeScript/.eslintrc.json b/packages/create-discord-bot/template/TypeScript/.eslintrc.json new file mode 100644 index 000000000..f6842f3ba --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/.eslintrc.json @@ -0,0 +1,8 @@ +{ + "root": true, + "extends": ["neon/common", "neon/node", "neon/typescript", "neon/prettier"], + "parserOptions": { + "project": ["./tsconfig.eslint.json"] + }, + "ignorePatterns": ["dist/*"] +} diff --git a/packages/create-discord-bot/template/TypeScript/.prettierrc.json b/packages/create-discord-bot/template/TypeScript/.prettierrc.json new file mode 100644 index 000000000..eba3f4077 --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/.prettierrc.json @@ -0,0 +1,8 @@ +{ + "printWidth": 120, + "useTabs": true, + "singleQuote": true, + "quoteProps": "as-needed", + "trailingComma": "all", + "endOfLine": "lf" +} diff --git a/packages/create-discord-bot/template/TypeScript/package.json b/packages/create-discord-bot/template/TypeScript/package.json new file mode 100644 index 000000000..bd2bc5ac2 --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/package.json @@ -0,0 +1,25 @@ +{ + "name": "[REPLACE-NAME]", + "version": "0.1.0", + "private": true, + "type": "module", + "scripts": { + "test": "tsc", + "lint": "prettier --check . && eslint ./src --ext .ts --format=pretty", + "format": "prettier --write . && eslint ./src --ext .ts --fix --format=pretty", + "start": "node --require dotenv/config dist/index.js" + }, + "dependencies": { + "discord.js": "^14.11.0", + "dotenv": "^16.0.3" + }, + "devDependencies": { + "@sapphire/ts-config": "^4.0.0", + "@types/node": "^18.15.3", + "eslint": "^8.40.0", + "eslint-config-neon": "^0.1.47", + "eslint-formatter-pretty": "^5.0.0", + "prettier": "^2.8.8", + "typescript": "^5.0.4" + } +} diff --git a/packages/create-discord-bot/template/TypeScript/src/events/index.ts b/packages/create-discord-bot/template/TypeScript/src/events/index.ts new file mode 100644 index 000000000..c4c59332e --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/src/events/index.ts @@ -0,0 +1,7 @@ +import type { ClientEvents } from 'discord.js'; + +export interface Event { + execute(...parameters: ClientEvents[T]): Promise | void; + name: T; + once?: boolean; +} diff --git a/packages/create-discord-bot/template/TypeScript/src/events/ready.ts b/packages/create-discord-bot/template/TypeScript/src/events/ready.ts new file mode 100644 index 000000000..830fb3525 --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/src/events/ready.ts @@ -0,0 +1,10 @@ +import { Events } from 'discord.js'; +import type { Event } from './index.js'; + +export default { + name: Events.ClientReady, + once: true, + async execute(client) { + console.log(`Ready! Logged in as ${client.user.tag}`); + }, +} satisfies Event<'ready'>; diff --git a/packages/create-discord-bot/template/TypeScript/src/index.ts b/packages/create-discord-bot/template/TypeScript/src/index.ts new file mode 100644 index 000000000..2a88d8358 --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/src/index.ts @@ -0,0 +1,19 @@ +import { readdir } from 'node:fs/promises'; +import { join } from 'node:path'; +import { fileURLToPath, URL } from 'node:url'; +import { Client, GatewayIntentBits } from 'discord.js'; +import type { Event } from './events/index.js'; + +const client = new Client({ intents: [GatewayIntentBits.Guilds] }); +const eventsPath = fileURLToPath(new URL('events', import.meta.url)); + +const eventFiles = await readdir(eventsPath).then((files) => + files.filter((file) => file.endsWith('.js') && file !== 'index.js'), +); + +for (const file of eventFiles) { + const event: Event = (await import(join(eventsPath, file))).default; + client[event.once ? 'once' : 'on'](event.name, async (...args) => event.execute(...args)); +} + +void client.login(); diff --git a/packages/create-discord-bot/template/TypeScript/tsconfig.eslint.json b/packages/create-discord-bot/template/TypeScript/tsconfig.eslint.json new file mode 100644 index 000000000..11bd8eafe --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/tsconfig.eslint.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "allowJs": true + }, + "include": ["**/*.ts", "**/*.js", "**/*.test.ts", "**/*.test.js"], + "exclude": [] +} diff --git a/packages/create-discord-bot/template/TypeScript/tsconfig.json b/packages/create-discord-bot/template/TypeScript/tsconfig.json new file mode 100644 index 000000000..961c0d5b0 --- /dev/null +++ b/packages/create-discord-bot/template/TypeScript/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "@sapphire/ts-config/extra-strict", + "compilerOptions": { + "declaration": false, + "declarationMap": false, + "module": "ESNext", + "moduleResolution": "NodeNext", + "target": "ESNext", + "outDir": "dist" + } +} diff --git a/packages/create-discord-bot/tsconfig.docs.json b/packages/create-discord-bot/tsconfig.docs.json new file mode 100644 index 000000000..80a7fe18b --- /dev/null +++ b/packages/create-discord-bot/tsconfig.docs.json @@ -0,0 +1,7 @@ +{ + "extends": "../../tsconfig.docs.json", + "include": ["src/**/*.ts"], + "compilerOptions": { + "outDir": "dist-docs" + } +} diff --git a/packages/create-discord-bot/tsconfig.eslint.json b/packages/create-discord-bot/tsconfig.eslint.json new file mode 100644 index 000000000..d04d4be3a --- /dev/null +++ b/packages/create-discord-bot/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/create-discord-bot/tsconfig.json b/packages/create-discord-bot/tsconfig.json new file mode 100644 index 000000000..fd8b5e417 --- /dev/null +++ b/packages/create-discord-bot/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../../tsconfig.json", + "include": ["src/**/*.ts"] +} diff --git a/packages/create-discord-bot/tsup.config.ts b/packages/create-discord-bot/tsup.config.ts new file mode 100644 index 000000000..bf763be19 --- /dev/null +++ b/packages/create-discord-bot/tsup.config.ts @@ -0,0 +1,9 @@ +import { createTsupConfig } from '../../tsup.config.js'; + +export default createTsupConfig({ + entry: ['src/create-discord-bot.ts'], + dts: false, + format: 'esm', + minify: true, + sourcemap: false, +}); diff --git a/yarn.lock b/yarn.lock index 4cd90454c..924e4fe23 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6858,6 +6858,13 @@ __metadata: languageName: node linkType: hard +"@types/validate-npm-package-name@npm:^4.0.0": + version: 4.0.0 + resolution: "@types/validate-npm-package-name@npm:4.0.0" + checksum: 09efd659f4cce362931a57c7ee6d645855c7ecb346c6496ef31bab638e578472f779c77233adad8502e90a7d7a146a40a5029ff9c4739a38a4187ef1fe7187c3 + languageName: node + linkType: hard + "@types/webpack-env@npm:^1.17.0": version: 1.18.0 resolution: "@types/webpack-env@npm:1.18.0" @@ -9359,7 +9366,7 @@ __metadata: languageName: node linkType: hard -"chalk@npm:5.2.0": +"chalk@npm:5.2.0, chalk@npm:^5.2.0": version: 5.2.0 resolution: "chalk@npm:5.2.0" checksum: 03d8060277de6cf2fd567dc25fcf770593eb5bb85f460ce443e49255a30ff1242edd0c90a06a03803b0466ff0687a939b41db1757bec987113e83de89a003caa @@ -10600,6 +10607,31 @@ __metadata: languageName: node linkType: hard +"create-discord-bot@workspace:packages/create-discord-bot": + version: 0.0.0-use.local + resolution: "create-discord-bot@workspace:packages/create-discord-bot" + dependencies: + "@favware/cliff-jumper": ^2.0.0 + "@microsoft/api-extractor": ^7.34.8 + "@types/node": 16.18.25 + "@types/validate-npm-package-name": ^4.0.0 + "@vitest/coverage-c8": ^0.31.0 + chalk: ^5.2.0 + commander: ^10.0.1 + cross-env: ^7.0.3 + eslint: ^8.39.0 + eslint-config-neon: ^0.1.46 + eslint-formatter-pretty: ^5.0.0 + prettier: ^2.8.8 + tsup: ^6.7.0 + typescript: ^5.0.4 + validate-npm-package-name: ^5.0.0 + vitest: ^0.31.0 + bin: + create-discord-bot: ./dist/create-discord-bot.mjs + languageName: unknown + linkType: soft + "create-require@npm:^1.1.0": version: 1.1.1 resolution: "create-require@npm:1.1.1"