Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create-discord-bot #9420

Merged
merged 55 commits into from
May 7, 2023
Merged
Show file tree
Hide file tree
Changes from 53 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
eae784a
feat: basic initialisation
Jiralite Apr 19, 2023
61df478
fix: no scope
Jiralite Apr 19, 2023
4d4af0f
chore: add options for issues
Jiralite Apr 19, 2023
cd1c5bb
feat: good word, Monbrey
Jiralite Apr 19, 2023
0f79789
feat: basic README.md
Jiralite Apr 19, 2023
e374965
fix: no documentation for this
Jiralite Apr 19, 2023
57c0625
feat: install for them
Jiralite Apr 19, 2023
9d35a15
chore: update licencing
Jiralite Apr 19, 2023
d261e16
chore: fix year
Jiralite Apr 19, 2023
46cdbc2
fix: build tsup
Jiralite Apr 19, 2023
e21a366
feat: add TypeScript option
Jiralite Apr 19, 2023
62d0276
feat: add `name` option
Jiralite Apr 19, 2023
84901df
chore: ignore annoying errors
Jiralite Apr 19, 2023
44c0dcd
chore: add tsconfig.json
Jiralite Apr 19, 2023
e75a430
refactor: remove name
Jiralite Apr 19, 2023
aa905a0
chore: update cliff jumper rc
Jiralite Apr 19, 2023
34132cc
chore: bump dependencies
Jiralite Apr 24, 2023
957a6b4
chore: bump dependencies
Jiralite May 2, 2023
fd0ed49
fix: build in prepack
Jiralite May 2, 2023
90595ae
fix: configure ESLint correctly
Jiralite May 2, 2023
0eee8db
feat: infer package manager
Jiralite May 2, 2023
be0c222
docs(packageManager): document `install()`
Jiralite May 2, 2023
82bdcdb
fix(packageManager): do not emit a warning for `npm`
Jiralite May 2, 2023
dc7f344
refactor: change project name colour to yellow
Jiralite May 2, 2023
62b9a77
docs(constants): basic documentation
Jiralite May 2, 2023
6a22a0f
feat: add link
Jiralite May 2, 2023
3645594
Merge branch 'main' into feat/create-discord-bot
Jiralite May 2, 2023
f631358
chore: add `verbatimModuleSyntax`
Jiralite May 2, 2023
76234ec
chore: bump discord.js
Jiralite May 2, 2023
7d8a020
refactor: switch to @sapphire/ts-config
Jiralite May 2, 2023
b22e045
refactor: file name changes
Jiralite May 2, 2023
b263f3c
refactor: tweak description
Jiralite May 2, 2023
ddd224f
chore: update yarn.lock
Jiralite May 2, 2023
c4ccc2d
fix: add .env
Jiralite May 2, 2023
cd8b202
Merge branch 'main' into feat/create-discord-bot
Jiralite May 6, 2023
27dff24
chore: bump dependencies
Jiralite May 6, 2023
22aa36f
feat: event handler
Jiralite May 6, 2023
030e5b6
refactor: use `default`
Jiralite May 7, 2023
176d573
Merge branch 'main' into feat/create-discord-bot
Jiralite May 7, 2023
f8ca752
refactor: simpler event
Jiralite May 7, 2023
68a5b56
Merge branch 'main' into feat/create-discord-bot
Jiralite May 7, 2023
f1312e8
chore: bump discord.js
Jiralite May 7, 2023
0699b7f
fix: add release script and reorder
Jiralite May 7, 2023
2158af2
style: reorder package.json
Jiralite May 7, 2023
aa20275
chore: remove unneeded ignores
Jiralite May 7, 2023
935c18f
chore: bump minimum Node.js version
Jiralite May 7, 2023
9240383
chore: add @types/node to TypeScript package.json
Jiralite May 7, 2023
3c88500
chore: apply requested changes
Jiralite May 7, 2023
cf998ba
Merge branch 'main' into feat/create-discord-bot
Jiralite May 7, 2023
df3d8d9
style: run ESLint + Prettier
Jiralite May 7, 2023
174e597
refactor: prefer "the"
Jiralite May 7, 2023
f64800a
refactor: remove some comments
Jiralite May 7, 2023
03182dc
feat: add ESLint + Prettier
Jiralite May 7, 2023
0835df2
chore: requested changes
Jiralite May 7, 2023
b08758c
chore: more requested changes
Jiralite May 7, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ yarn create-package <package-name> [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.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/01-package_bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ body:
- builders
- collection
- core
- create-discord-bot
- formatters
- next
- proxy
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/03-feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ body:
- builders
- collection
- core
- create-discord-bot
- formatters
- next
- proxy
Expand Down
3 changes: 3 additions & 0 deletions .github/issue-labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
9 changes: 6 additions & 3 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/**/*
Expand Down
14 changes: 8 additions & 6 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -23,7 +23,7 @@
- name: dependencies
color: 276bd1
- name: discord
color: '5663e9'
color: 5663e9
- name: discussion
color: b6b1f9
- name: documentation
Expand All @@ -41,7 +41,7 @@
- name: has PR
color: 4b1f8e
- name: help wanted
color: '008672'
color: 008672
- name: in progress
color: ffccd7
- name: in review
Expand All @@ -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
Expand Down
5 changes: 5 additions & 0 deletions packages/create-discord-bot/.cliff-jumperrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"name": "create-discord-bot",
"packagePath": "packages/create-discord-bot",
"tagTemplate": "{{new-version}}"
}
1 change: 1 addition & 0 deletions packages/create-discord-bot/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist/
3 changes: 3 additions & 0 deletions packages/create-discord-bot/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "../../.eslintrc.json"
}
23 changes: 23 additions & 0 deletions packages/create-discord-bot/.gitignore
Original file line number Diff line number Diff line change
@@ -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/
1 change: 1 addition & 0 deletions packages/create-discord-bot/.lintstagedrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('../../.lintstagedrc.json');
8 changes: 8 additions & 0 deletions packages/create-discord-bot/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Autogenerated
CHANGELOG.md
.turbo
dist/
docs/**/*
!docs/index.yml
!docs/README.md
coverage/
1 change: 1 addition & 0 deletions packages/create-discord-bot/.prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('../../.prettierrc.json');
190 changes: 190 additions & 0 deletions packages/create-discord-bot/LICENSE
Original file line number Diff line number Diff line change
@@ -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.
43 changes: 43 additions & 0 deletions packages/create-discord-bot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<div align="center">
<br />
<p>
<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
</p>
<br />
<p>
<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
</p>
<p>
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
</p>
</div>

## 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
Loading