Some quality of life changes #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis pull request introduces several quality of life improvements, including a new console log message in File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @Bikoil - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider removing the ASCII art from main.ts or moving it to a separate file/function to keep the main code clean and focused.
- Good job on improving the README. The typo fixes and formatting changes enhance its readability and usefulness.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| \\______/ | ||
|
|
||
|
|
||
| Always free, Always open source`); |
There was a problem hiding this comment.
suggestion (performance): Consider moving ASCII art to a separate file and optimize logging
While the ASCII art is creative, it might be better to move it to a separate configuration or constants file to keep the main file clean and focused on core functionality. Additionally, logging such a large string on every run could impact startup performance. Consider logging it only in debug mode or on first run to optimize the bot's startup time.
Suggested change
| Always free, Always open source`); | |
| import { IntentsBitField, ActivityType } from "discord.js"; | |
| import { Client } from "discordx"; | |
| import { asciiArt } from "./constants"; | |
| if (process.env.DEBUG_MODE === "true") { | |
| console.log(asciiArt); | |
| } |
README.md
Outdated
| @@ -43,7 +43,7 @@ __NOTE THAT MOST OF THESE FEATURES HAVE NOT BEEN IMPLEMENTED YET__ | |||
|
|
|||
| # How to setup the bot | |||
| > [!IMPORTANT] | |||
| > Before setting up the bot, you must have at least some javascript skill or are familliar with the language, do not open issues on learning javascript/typescript or "where do i begin from", please look at [Discord.js guide](https://discordjs.guide) and [Discordx guide](https://discordx.js.org/docs/discordx/getting-started/) for more information about discord typescript, you may also learn javascript at the [JavaScript website](https://www.javascript.com/) and typescript at [Typescript website](https://www.typescriptlang.org/docs/), Also, you may need to have some knowledge about the terminal and how to use it including bash and other shells. | |||
| > Before setting up the bot, you must have at least some javascript skill or are familiar with the language, do not open issues on learning javascript/typescript or "where do i begin from", please look at [Discord.js guide](https://discordjs.guide) and [Discordx guide](https://discordx.js.org/docs/discordx/getting-started/) for more information about discord typescript, you may also learn javascript at the [JavaScript website](https://www.javascript.com/) and typescript at [Typescript website](https://www.typescriptlang.org/docs/), Also, you may need to have some knowledge about the terminal and how to use it including bash and other shells. | |||
There was a problem hiding this comment.
suggestion (documentation): Capitalize 'JavaScript' and 'TypeScript'.
For consistency, 'javascript' and 'typescript' should be capitalized as 'JavaScript' and 'TypeScript'.
Suggested change
| > Before setting up the bot, you must have at least some javascript skill or are familiar with the language, do not open issues on learning javascript/typescript or "where do i begin from", please look at [Discord.js guide](https://discordjs.guide) and [Discordx guide](https://discordx.js.org/docs/discordx/getting-started/) for more information about discord typescript, you may also learn javascript at the [JavaScript website](https://www.javascript.com/) and typescript at [Typescript website](https://www.typescriptlang.org/docs/), Also, you may need to have some knowledge about the terminal and how to use it including bash and other shells. | |
| > Before setting up the bot, you must have at least some JavaScript skill or are familiar with the language, do not open issues on learning JavaScript/TypeScript or "where do I begin from", please look at [Discord.js guide](https://discordjs.guide) and [Discordx guide](https://discordx.js.org/docs/discordx/getting-started/) for more information about Discord TypeScript, you may also learn JavaScript at the [JavaScript website](https://www.javascript.com/) and TypeScript at [TypeScript website](https://www.typescriptlang.org/docs/), Also, you may need to have some knowledge about the terminal and how to use it including bash and other shells. |
| ``` | ||
|
|
||
| - **Linux/BSD/MacOS/GitBash** | ||
| ``` | ||
| ```sh |
There was a problem hiding this comment.
suggestion (documentation): Specify shell type for code block.
Adding 'sh' to the code block for Linux/BSD/MacOS/GitBash improves clarity.
Suggested change
| ```sh | |
| ```sh | |
| export BOT_TOKEN=YourBotToken |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
This pull request introduces an ASCII art banner to the console output for better visibility and corrects several typos and syntax issues in the README.md file to improve documentation clarity.