Skip to content

Commit 3d05352

Browse files
committed
update prettier config
1 parent f43d487 commit 3d05352

File tree

75 files changed

+1902
-771
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+1902
-771
lines changed

.prettierrc.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,14 @@
77
"semi": true,
88
"endOfLine": "lf",
99
"useTabs": false,
10-
"jsxSingleQuote": false
10+
"jsxSingleQuote": false,
11+
"overrides": [
12+
{
13+
"files": ["*.md", "*.mdx"],
14+
"options": {
15+
"proseWrap": "always",
16+
"printWidth": 70
17+
}
18+
}
19+
]
1120
}

CODE_OF_CONDUCT.md

Lines changed: 82 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -2,131 +2,139 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our
6-
community a harassment-free experience for everyone, regardless of age, body
7-
size, visible or invisible disability, ethnicity, sex characteristics, gender
8-
identity and expression, level of experience, education, socio-economic status,
9-
nationality, personal appearance, race, caste, color, religion, or sexual
10-
identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation
6+
in our community a harassment-free experience for everyone, regardless
7+
of age, body size, visible or invisible disability, ethnicity, sex
8+
characteristics, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance,
10+
race, caste, color, religion, or sexual identity and orientation.
1111

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
12+
We pledge to act and interact in ways that contribute to an open,
13+
welcoming, diverse, inclusive, and healthy community.
1414

1515
## Our Standards
1616

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
17+
Examples of behavior that contributes to a positive environment for
18+
our community include:
1919

2020
- Demonstrating empathy and kindness toward other people
2121
- Being respectful of differing opinions, viewpoints, and experiences
2222
- Giving and gracefully accepting constructive feedback
23-
- Accepting responsibility and apologizing to those affected by our mistakes,
24-
and learning from the experience
25-
- Focusing on what is best not just for us as individuals, but for the overall
26-
community
23+
- Accepting responsibility and apologizing to those affected by our
24+
mistakes, and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
- The use of sexualized language or imagery, and sexual attention or advances of
31-
any kind
32-
- Trolling, insulting or derogatory comments, and personal or political attacks
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or
33+
political attacks
3334
- Public or private harassment
34-
- Publishing others' private information, such as a physical or email address,
35-
without their explicit permission
36-
- Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
35+
- Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
- Other conduct which could reasonably be considered inappropriate in
38+
a professional setting
3839

3940
## Enforcement Responsibilities
4041

41-
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
44-
or harmful.
42+
Community leaders are responsible for clarifying and enforcing our
43+
standards of acceptable behavior and will take appropriate and fair
44+
corrective action in response to any behavior that they deem
45+
inappropriate, threatening, offensive, or harmful.
4546

46-
Community leaders have the right and responsibility to remove, edit, or reject
47-
comments, commits, code, wiki edits, issues, and other contributions that are
48-
not aligned to this Code of Conduct, and will communicate reasons for moderation
49-
decisions when appropriate.
47+
Community leaders have the right and responsibility to remove, edit,
48+
or reject comments, commits, code, wiki edits, issues, and other
49+
contributions that are not aligned to this Code of Conduct, and will
50+
communicate reasons for moderation decisions when appropriate.
5051

5152
## Scope
5253

53-
This Code of Conduct applies within all community spaces, and also applies when
54-
an individual is officially representing the community in public spaces.
55-
Examples of representing our community include using an official email address,
56-
posting via an official social media account, or acting as an appointed
57-
representative at an online or offline event.
54+
This Code of Conduct applies within all community spaces, and also
55+
applies when an individual is officially representing the community in
56+
public spaces. Examples of representing our community include using an
57+
official email address, posting via an official social media account,
58+
or acting as an appointed representative at an online or offline
59+
event.
5860

5961
## Enforcement
6062

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at
63-
64-
All complaints will be reviewed and investigated promptly and fairly.
63+
Instances of abusive, harassing, or otherwise unacceptable behavior
64+
may be reported to the community leaders responsible for enforcement
65+
at [email protected]. All complaints will be reviewed and
66+
investigated promptly and fairly.
6567

66-
All community leaders are obligated to respect the privacy and security of the
67-
reporter of any incident.
68+
All community leaders are obligated to respect the privacy and
69+
security of the reporter of any incident.
6870

6971
## Enforcement Guidelines
7072

71-
Community leaders will follow these Community Impact Guidelines in determining
72-
the consequences for any action they deem in violation of this Code of Conduct:
73+
Community leaders will follow these Community Impact Guidelines in
74+
determining the consequences for any action they deem in violation of
75+
this Code of Conduct:
7376

7477
### 1. Correction
7578

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
77-
unprofessional or unwelcome in the community.
79+
**Community Impact**: Use of inappropriate language or other behavior
80+
deemed unprofessional or unwelcome in the community.
7881

79-
**Consequence**: A private, written warning from community leaders, providing
80-
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
82+
**Consequence**: A private, written warning from community leaders,
83+
providing clarity around the nature of the violation and an
84+
explanation of why the behavior was inappropriate. A public apology
85+
may be requested.
8286

8387
### 2. Warning
8488

85-
**Community Impact**: A violation through a single incident or series of
86-
actions.
89+
**Community Impact**: A violation through a single incident or series
90+
of actions.
8791

88-
**Consequence**: A warning with consequences for continued behavior. No
89-
interaction with the people involved, including unsolicited interaction with
90-
those enforcing the Code of Conduct, for a specified period of time. This
91-
includes avoiding interactions in community spaces as well as external channels
92-
like social media. Violating these terms may lead to a temporary or permanent
93-
ban.
92+
**Consequence**: A warning with consequences for continued behavior.
93+
No interaction with the people involved, including unsolicited
94+
interaction with those enforcing the Code of Conduct, for a specified
95+
period of time. This includes avoiding interactions in community
96+
spaces as well as external channels like social media. Violating these
97+
terms may lead to a temporary or permanent ban.
9498

9599
### 3. Temporary Ban
96100

97-
**Community Impact**: A serious violation of community standards, including
98-
sustained inappropriate behavior.
101+
**Community Impact**: A serious violation of community standards,
102+
including sustained inappropriate behavior.
99103

100-
**Consequence**: A temporary ban from any sort of interaction or public
101-
communication with the community for a specified period of time. No public or
102-
private interaction with the people involved, including unsolicited interaction
103-
with those enforcing the Code of Conduct, is allowed during this period.
104-
Violating these terms may lead to a permanent ban.
104+
**Consequence**: A temporary ban from any sort of interaction or
105+
public communication with the community for a specified period of
106+
time. No public or private interaction with the people involved,
107+
including unsolicited interaction with those enforcing the Code of
108+
Conduct, is allowed during this period. Violating these terms may lead
109+
to a permanent ban.
105110

106111
### 4. Permanent Ban
107112

108-
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
110-
individual, or aggression toward or disparagement of classes of individuals.
113+
**Community Impact**: Demonstrating a pattern of violation of
114+
community standards, including sustained inappropriate behavior,
115+
harassment of an individual, or aggression toward or disparagement of
116+
classes of individuals.
111117

112-
**Consequence**: A permanent ban from any sort of public interaction within the
113-
community.
118+
**Consequence**: A permanent ban from any sort of public interaction
119+
within the community.
114120

115121
## Attribution
116122

117-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.1, available at
123+
This Code of Conduct is adapted from the [Contributor
124+
Covenant][homepage], version 2.1, available at
119125
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120126

121-
Community Impact Guidelines were inspired by
122-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
127+
Community Impact Guidelines were inspired by [Mozilla's code of
128+
conduct enforcement ladder][Mozilla CoC].
123129

124-
For answers to common questions about this code of conduct, see the FAQ at
125-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
130+
For answers to common questions about this code of conduct, see the
131+
FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations
132+
are available at
126133
[https://www.contributor-covenant.org/translations][translations].
127134

128135
[homepage]: https://www.contributor-covenant.org
129-
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
136+
[v2.1]:
137+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130138
[Mozilla CoC]: https://github.com/mozilla/diversity
131139
[FAQ]: https://www.contributor-covenant.org/faq
132140
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Contributing to CommandKit
22

3-
Firstly, thank you for considering contributing to CommandKit! Whether you're looking to fix bugs, add new features, or just ask questions, your input is valuable to us. Before actually opening a pull request, we recommend that you first open an issue (or check existing ones) to discuss the feature/bug you intend to add/fix.
3+
Firstly, thank you for considering contributing to CommandKit! Whether
4+
you're looking to fix bugs, add new features, or just ask questions,
5+
your input is valuable to us. Before actually opening a pull request,
6+
we recommend that you first open an issue (or check existing ones) to
7+
discuss the feature/bug you intend to add/fix.
48

59
## Setup
610

@@ -21,7 +25,8 @@ git clone https://github.com/underctrl-io/commandkit.git
2125

2226
### Installing Dependencies
2327

24-
Since we use `pnpm` workspaces, it's essential to use `pnpm` for installing dependencies.
28+
Since we use `pnpm` workspaces, it's essential to use `pnpm` for
29+
installing dependencies.
2530

2631
```bash
2732
cd commandkit
@@ -36,14 +41,26 @@ pnpm install # Make sure to run this from the root directory
3641
git checkout -b your-feature-or-bugfix
3742
```
3843

39-
2. Make your changes. Please make sure to use the [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extension for consistent formatting and comments wherever necessary.
44+
2. Make your changes. Please make sure to use the
45+
[Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
46+
extension for consistent formatting and comments wherever
47+
necessary.
4048

41-
3. Ensure that your changes don't break any existing functionality. You can test the functionality of your code depending on where you've made changes:
49+
3. Ensure that your changes don't break any existing functionality.
50+
You can test the functionality of your code depending on where
51+
you've made changes:
4252

43-
1. If you've made changes to the CommandKit package, you can use the "apps/test-bot" project to test your own bot. Just make sure to create a new `.env` file with the template from the `.env.example` file provided. This also requires you to build the commandkit package locally (after you make your changes) because it's symlinked with pnpm workspaces.
44-
2. If you've made changes to the docs, you can run `pnpm dev` inside "apps/website" to spin up a local development server.
53+
1. If you've made changes to the CommandKit package, you can use
54+
the "apps/test-bot" project to test your own bot. Just make sure
55+
to create a new `.env` file with the template from the
56+
`.env.example` file provided. This also requires you to build
57+
the commandkit package locally (after you make your changes)
58+
because it's symlinked with pnpm workspaces.
59+
2. If you've made changes to the docs, you can run `pnpm dev`
60+
inside "apps/website" to spin up a local development server.
4561

46-
4. Run `pnpm lint` from the root directory to ensure all lint scripts and formatting is valid.
62+
4. Run `pnpm lint` from the root directory to ensure all lint scripts
63+
and formatting is valid.
4764

4865
5. Commit your changes:
4966

@@ -57,12 +74,16 @@ git commit -m "Describe your change here"
5774
git push origin your-feature-or-bugfix
5875
```
5976

60-
7. Open a pull request in the main project repository (main branch). Describe your changes and any relevant information.
77+
7. Open a pull request in the main project repository (main branch).
78+
Describe your changes and any relevant information.
6179

6280
## Submitting Issues
6381

64-
When submitting a new issue, please provide a detailed description of the problem, steps to reproduce it, and any relevant screenshots or error messages.
82+
When submitting a new issue, please provide a detailed description of
83+
the problem, steps to reproduce it, and any relevant screenshots or
84+
error messages.
6585

6686
---
6787

68-
Thank you for making CommandKit better! We appreciate your effort and look forward to collaborating with you.
88+
Thank you for making CommandKit better! We appreciate your effort and
89+
look forward to collaborating with you.

apps/website/docs/guide.old/01-getting-started/01-introduction.mdx

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ description: A brief intro to CommandKit
4040
</div>
4141
</div>
4242

43-
CommandKit is a powerful meta-framework for building Discord bots with [discord.js](https://discord.js.org/). It provides a simple and intuitive API for creating commands, handling interactions, and managing events. With CommandKit, you can focus on building your bot's features without worrying about the underlying complexities.
43+
CommandKit is a powerful meta-framework for building Discord bots with
44+
[discord.js](https://discord.js.org/). It provides a simple and
45+
intuitive API for creating commands, handling interactions, and
46+
managing events. With CommandKit, you can focus on building your bot's
47+
features without worrying about the underlying complexities.
4448

4549
## Key Features
4650

@@ -53,18 +57,25 @@ CommandKit is a powerful meta-framework for building Discord bots with [discord.
5357
- Plugin system to extend functionality 🔌
5458
- Built-in command line interface for easy development 🖥️
5559
- Out-of-the-box support for TypeScript and JavaScript 📜
56-
- Built-in customizable cache system for speedy data storage and retrieval 🗄️
60+
- Built-in customizable cache system for speedy data storage and
61+
retrieval 🗄️
5762
- User installable/guild scoped commands 🔧
5863
- Custom events support 🔔
59-
- JSX support for declaring Discord interaction components and modals 🎨
60-
- Easy to use interaction components and modals system (forget about collectors) 🧩
64+
- JSX support for declaring Discord interaction components and modals
65+
🎨
66+
- Easy to use interaction components and modals system (forget about
67+
collectors) 🧩
6168
- Less boilerplate code, more productivity 💪
6269
- and much more...
6370

6471
## Documentation
6572

66-
You can start with the [setting up CommandKit](./02-setup-commandkit.mdx) guide to get your bot up and running quickly. The documentation covers everything from installation to advanced features.
73+
You can start with the
74+
[setting up CommandKit](./02-setup-commandkit.mdx) guide to get your
75+
bot up and running quickly. The documentation covers everything from
76+
installation to advanced features.
6777

6878
## Support and Suggestions
6979

70-
Submit any queries or suggestions in our [Discord community](https://ctrl.lol/discord).
80+
Submit any queries or suggestions in our
81+
[Discord community](https://ctrl.lol/discord).

0 commit comments

Comments
 (0)