peterthehan/create-discord-bot

A module-based Discord bot template.

Hi, I'm Peter 👋

create-discord-bot's Issues

Accessing Client from Handlers/Commands

I think it would be a good idea to add the ability to access the client variable from handlers or commands, so certain commands can display cached data and such.

Command categories | Suggestion

Hi there, I'm COÐΣ THΣΣÐAL ツᴮᴼᵀ#8126 and I would like to suggest an option or something that makes your commands in categories like Moderation, General, Fun, etc.

 bot-name
 |---src
      |---commands
            |--General
                  |---userinfo
                  |---serverinfo
            |---Fun
                  |---Memes
                  |--Kiss

Something like I did up there

NPX command Not working.

Hello. I just found this and was going through the steps and cant seem to get the NPX command to work. It doesn't make the utility nor does it make or edit anything. Am I missing anything or is this outdated?

TypeScript Support on the core bot files

Drop discord.js dependency in favor of manually fetching application ID

We installed discord.js in order to login in via the bot token in order to fetch the application ID needed for the invite url.

https://bundlephobia.com/[email protected],[email protected],[email protected],[email protected]

We can trim the dependency bloat due to discord.js by manually fetching the application ID ourselves.

Endpoint doc: https://discord.com/developers/docs/topics/oauth2#get-current-application-information
Endpoint: GET https://discordapp.com/api/oauth2/applications/@me

TypeScript Support on the command widget

Add Presence Support

Add support to have the bot display a status message.

discord.js documentation for client presence

Edit question flow to not ask for token if update

CONTRIBUTING.md to help and tell newcomers how to contribute

Improve README readability

Existing README assumes some technical knowledge of the user and is not layman-friendly. The target audience should be lowered considering the context of the project and/or there should be multiple versions of the README that expands/condenses the information appropriately from which the user can choose from.

Add eslint to project + actions

Rules pending.

Add code of conduct

npm ERR! enoent undefined ls-remote -h -t ssh://[email protected]/peterthehan/create-discord-bot.git

npm ERR! code ENOENT
npm ERR! syscall spawn git
npm ERR! path git
npm ERR! errno ENOENT
npm ERR! enoent Error while executing:
npm ERR! enoent undefined ls-remote -h -t ssh://[email protected]/peterthehan/create-discord-bot.git
npm ERR! enoent
npm ERR! enoent
npm ERR! enoent spawn git ENOENT
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

Add slash commands widget

https://discord.com/developers/docs/interactions/slash-commands, need to see if usecases are covered.

Install QOL dev dependencies on the bot

#20 some good ideas came from this PR. Prettier and nodemon would be nice.

Error message

Everytime I do npx peterthehan/create-discord-bot I get this error message:
npm ERR! code ENOENT
npm ERR! syscall spawn git
npm ERR! path git
npm ERR! errno -4058
npm ERR! enoent Error while executing:
npm ERR! enoent undefined ls-remote -h -t ssh://[email protected]/peterthehan/create-discord-bot.git
npm ERR! enoent
npm ERR! enoent
npm ERR! enoent spawn git ENOENT
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

npm ERR! A complete log of this run can be found in:
npm ERR! C:\Users\yasse\AppData\Roaming\npm-cache_logs\2021-04-21T20_35_32_703Z-debug.log

Issues with ESLint in app and utility script.

While I was working on #65, the git precommit hooks failed because ESLint doesn't know which @typescript-eslint plugin to use, or more of which .eslintrc.json file to use. I feel like this is an omen for more obstacles to come, and I think we should do something about it. One solution I can think of is moving the app folder into another GitHub repo, and having the utility script download that.

ERROR

JSDoc For Typescript

Currently, we commit dist files with compiled Typescript. Typescript has support for static typing using JSDoc comments which can allow us to not have to have any build process. An example of a project using that is SwordCSS.

Add logic to aggregate Intents from widgets to pass as args when initializing Client

Intents will be mandatory when discord.js switches from gateway v6 -> v8 and/or Discord kills v6. https://discord.com/developers/docs/topics/gateway#privileged-intents

Simple fix would be to initialize the client enabling all intents https://discord.js.org/#/docs/main/master/class/Intents?scrollTo=s-ALL

Better implementation would be to add a list of necessary intents as a configuration option for each widget so that we're receiving events for only the things each respective widget requires.

Remove intents in index once bot-level intents are configured

Add pipeline to check codebase follows prettier formatting

Run npx against the ts code instead of the compiled code

Today, we are pushing the compiled code (in dist/) to the repo so that npx can run this code using the shebang + bin value in package.json. It would be great to instead run the ts code directly with npx so we can stop pushing build files.

Error starting with nom start

Hi there, I'm trying to start the project but an error appeared in the console.
I let the error in the following link -> https://pastebin.com/sLf38GnB

Add status check for ts compile

Refactor message handler

Remove command chunking logic.

Utility creates an invite link

Not a QOL dev dependency but just a QOL feature would be to fetch the Client ID of the bot and create an invite link for it.

Originally posted by @shadowtime2000 in #27 (comment)

Add running tests to pipeline

Dependent on: #22

Background task

pm2 work this script in linux ?

Update demo animation

Documentation assets (demo gif and diagram png) could be moved under assets/. For rerecording the demo, several solutions seem to exist that output svg or gif (svg preferred):

• https://github.com/nbedos/termtosvg
• https://asciinema.org/
• https://github.com/faressoft/terminalizer

Readme refs should be updated.

Global Dependencies

Currently there is no way to have global dependencies that are only initialized once. I think we should have a deps.js file which has some global dependencies. It could be like this:

const dbORM = require("db-orm");

const connection = dbOrm("my-connection");

module.exports = {
  connection
};

So then only one connection is created which is reused through out the different widgets.

Fix creating boilerplate step not copying gitignore

Today, we have code in place to write a .gitignore file manually instead of just copying from app/. For some reason fs.copySync is not copying it correctly. Additionally, other dotfiles like .eslintignore and .eslintrc.json seem to copy fine.

You can recreate the issue by commenting out the manual write, pushing to a new branch, and running the script remotely npx <username>/create-discord-bot#<yourbranchname>.

Speed up npx command

On my machine today, the npx command takes ~16 seconds and installs 27 packages before loading the prompts. For reference, an older version of the script as seen in the demo gif took ~7 seconds and installed only 7 packages.

Some performance loss is unavoidable as we add features but we should look into speeding this command up.

Change copy/update logic in utility script to fetch from template repo

In an effort to decouple this repo's utility script from the template bot, a new repo was created https://github.com/peterthehan/discord-bot to house the template bot code.

We should delete the files under app/ from this repo, and update the copy/update logic in the utility to fetch the files from the new repo. We should delete the .git/ folder that will result from the clone.

Note: may get #53 for free

Add docs to README for updating core files

Add e2e tests for the cli utility

help

how i can stop the bot???