feat(github): Add pre-commit config. (#19)

* feat: Add .pre-commit-config.yaml

* chore: Run pre-commit

* chore: Run workflow on all branches

* chore: Cache npm dependencies

* chore: Don't keep gh-pages branch history on deploy

* chore: Run pre-commit in GitHub workflow

Author: shiftinv

.editorconfig

@@ -10,4 +10,4 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.mdx]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false

.gitattributes

@@ -1 +1 @@
-*.mdx linguist-language=javascript
+*.mdx linguist-language=javascript

.github/ISSUE_TEMPLATE/config.yaml

@@ -5,4 +5,4 @@ contact_links:
     url: https://discord.gg/gJDbCw8aQy
   - name: disnake issues
     about: Issue tracker for the disnake library.
-    url: https://github.com/DisnakeDev/disnake/issues/new/choose
+    url: https://github.com/DisnakeDev/disnake/issues/new/choose

.github/ISSUE_TEMPLATE/page_addition.yaml

@@ -37,4 +37,4 @@ body:
         - Yes, I will be contributing this addition.
         - No, I am only suggesting this addition.
     validations:
-      required: true
+      required: true

.github/ISSUE_TEMPLATE/typo_grammar.yaml

@@ -40,4 +40,4 @@ body:
   - type: textarea
     attributes:
       label: Additional context
-      description: If any extra information is required, mention the same here.
+      description: If any extra information is required, mention the same here.

.github/pull_request_template.md

@@ -12,4 +12,4 @@ We highly recommend linking to an issue that has been approved by a maintainer,
 This is important, as a topic that is not approved by a maintainer may not be added.
 
 Link the issue by typing: "Closes #<number>" (e.g. "Closes #0" to close issue 0).
--->
+-->

.github/workflows/site-deploy.yml

@@ -2,7 +2,6 @@ name: Deploy to GitHub Pages
 
 on:
   push:
-    branches: [master]
     paths:
       - guide/**
       - package*.json
@@ -18,15 +17,28 @@ jobs:
         with:
           node-version: 14.x
           cache: npm
+      - name: Run pre-commit
+        uses: pre-commit/[email protected]
+
+      - name: Cache npm
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
       - name: Build website
         working-directory: guide
         run: |
           npm ci
           npm run build
+
       - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/master'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./guide/build
           user_name: 'github-actions[bot]'
           user_email: 'github-actions[bot]@users.noreply.github.com'
+          force_orphan: true

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-case-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: ['--markdown-linebreak-ext=md,mdx']
+  # for code in .md files
+  # (patched with support for codeblock options and `py` shortcodes)
+  - repo: https://github.com/shiftinv/blacken-docs
+    rev: 161c8eff80b7e1dc388151974aa5ab9010741e09
+    hooks:
+    - id: blacken-docs
+      additional_dependencies: [black==21.12b0]
+      files: '\.(rst|md|markdown|mdx|py|tex)$'
+      args: [--line-length=100]
+  # for code samples
+  - repo: https://github.com/psf/black
+    rev: 21.12b0
+    hooks:
+    - id: black
+      args: [--line-length=100]
+  # for markdown formatting
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.5.1
+    hooks:
+    - id: prettier
+      types_or: [html, css, javascript, markdown, mdx]
+      args: [--print-width=120, --tab-width=4, --prose-wrap=always, --single-quote]

README.md

@@ -41,4 +41,4 @@ For more info on development/contributions, see [CONTRIBUTING.md](./CONTRIBUTING
     ⁕
     <a href="https://discord.gg/discord-api">Discord API</a>
 </p>
-<br />
+<br />

guide/babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  	presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+	presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
 };

guide/docs/faq/good-practices.mdx

@@ -6,6 +6,7 @@ keywords: [disnake, bot, guide, tutorial, good practices, python]
 # Good practices
 
 <!-- Imports for content tabs -->
+
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 

guide/docs/getting-started/creating-commands.mdx

@@ -6,6 +6,7 @@ keywords: [disnake, bot, guide, tutorial, creating, commands, python]
 # Creating commands
 
 <!-- Import Discord components -->
+
 import {
 	DiscordButton,
 	DiscordButtons,
@@ -25,13 +26,16 @@ import isDarkTheme from '../../src/hooks/isDarkTheme';
 
 :::info
 
-This page is a follow-up, and the base code used is from the previous page ([Initial files](./initial-files.mdx)). The code can be found on the GitHub repository [here](https://github.com/DisnakeDev/guide/tree/master/docs/extra-code-samples/code-intial-files).
+This page is a follow-up, and the base code used is from the previous page ([Initial files](./initial-files.mdx)). The
+code can be found on the GitHub repository
+[here](https://github.com/DisnakeDev/guide/tree/master/docs/extra-code-samples/code-intial-files).
 
 :::
 
-Discord also allows developers to register [slash commands](https://discord.com/developers/docs/interactions/application-commands), which
-provides users a first-class way of interacting directly with your application. These slash commands shall be covered by
-the guide [here](../interactions/application-commands.mdx), in the **Interactions** section.
+Discord also allows developers to register
+[slash commands](https://discord.com/developers/docs/interactions/application-commands), which provides users a
+first-class way of interacting directly with your application. These slash commands shall be covered by the guide
+[here](../interactions/application-commands.mdx), in the **Interactions** section.
 
 ## A note on prefix commands
 
@@ -40,7 +44,9 @@ Bot commands that are initiated when a keyword is used along with a specified pr
 
 :::caution Message Intent - Privileged
 
-It is to be noted that handling prefix commands require the **message intent**, which allows the bot to get content and data of messages sent by users. This intent has recently been privileged, i.e., it needs to be manually enabled for the bot application, and its requirement will eventually be reviewed if your bot is in over 100 servers.
+It is to be noted that handling prefix commands require the **message intent**, which allows the bot to get content and
+data of messages sent by users. This intent has recently been privileged, i.e., it needs to be manually enabled for the
+bot application, and its requirement will eventually be reviewed if your bot is in over 100 servers.
 
 You can read more about the message intent [here][message-intent-article].
 
@@ -53,8 +59,8 @@ be covered in the [**Interactions**](../interactions/application-commands.mdx) s
 ## Registering commands
 
 This section covers the bare minimum to get you started with registering slash commands. Once again, you can refer to
-[this page](../interactions/application-commands.mdx) for an in-depth coverage of topics, including guild
-commands, global commands, options, option types, autocomplete and choices.
+[this page](../interactions/application-commands.mdx) for an in-depth coverage of topics, including guild commands,
+global commands, options, option types, autocomplete and choices.
 
 Now, we shall continue with the base code used in the previous section.
 
@@ -103,7 +109,11 @@ necessary for replying to the use of the command.
 
 :::note Using `ctx` vs. `inter`
 
-If you have experience with coding bots with [`discord.py`](https://discordpy.readthedocs.io/en/latest), you would be familiar with using `ctx` as an abbreviation for passing context into the function. This guide will primarily be using `inter`, as it is short for `interaction` and refers to [`disnake.ApplicationCommandInteraction`](https://docs.disnake.dev/en/latest/api.html#applicationcommandinteraction). Of course, you're open to using your preferred abbreviation in code.
+If you have experience with coding bots with [`discord.py`](https://discordpy.readthedocs.io/en/latest), you would be
+familiar with using `ctx` as an abbreviation for passing context into the function. This guide will primarily be using
+`inter`, as it is short for `interaction` and refers to
+[`disnake.ApplicationCommandInteraction`](https://docs.disnake.dev/en/latest/api.html#applicationcommandinteraction). Of
+course, you're open to using your preferred abbreviation in code.
 
 :::
 
@@ -141,9 +151,11 @@ bot.run("YOUR_BOT_TOKEN")
 
 :::tip Using `test_guilds` in `commands.Bot()`
 
-When you have multiple commands registered under the same test guilds, it is convenient to only have your `guild_ids` defined once. Therefore, you can use the `test_guilds` argument in the `commands.Bot()` instance instead of passing `guild_ids` to every single command -
+When you have multiple commands registered under the same test guilds, it is convenient to only have your `guild_ids`
+defined once. Therefore, you can use the `test_guilds` argument in the `commands.Bot()` instance instead of passing
+`guild_ids` to every single command -
 
-``` python
+```python
 bot = commands.Bot(test_guilds=[1234, 5678])
 ```
 
@@ -178,21 +190,23 @@ bot.run("YOUR_BOT_TOKEN")
 ```
 
 <br />
-<DiscordMessages  lightTheme={!isDarkTheme()}>
-    <DiscordMessage author="Disnake Bot" avatar="/public/disnake-logo.png" bot="true">
-        <div slot="interactions">
-            <DiscordInteraction author="AbhigyanTrips" avatar="https://i.imgur.com/8xd9SHa.png" command="true">ping</DiscordInteraction>
-        </div>
-        Pong!
-    </DiscordMessage>
+<DiscordMessages lightTheme={!isDarkTheme()}>
+	<DiscordMessage author="Disnake Bot" avatar="/public/disnake-logo.png" bot="true">
+		<div slot="interactions">
+			<DiscordInteraction author="AbhigyanTrips" avatar="https://i.imgur.com/8xd9SHa.png" command="true">
+				ping
+			</DiscordInteraction>
+		</div>
+		Pong!
+	</DiscordMessage>
 </DiscordMessages>
 <br />
 
 ### Server info command
 
 `inter.guild` refers to the guild the interaction was sent in (a
-[`Guild`](https://docs.disnake.dev/en/latest/api.html#disnake.Guild) instance), which exposes properties such as `.name` or
-`.member_count`.
+[`Guild`](https://docs.disnake.dev/en/latest/api.html#disnake.Guild) instance), which exposes properties such as `.name`
+or `.member_count`.
 
 ```python title="main.py" {12-16}
 import disnake
@@ -217,20 +231,23 @@ bot.run("YOUR_BOT_TOKEN")
 ```
 
 <br />
-<DiscordMessages  lightTheme={!isDarkTheme()}>
-    <DiscordMessage author="Disnake Bot" avatar="/public/disnake-logo.png" bot="true">
-        <div slot="interactions">
-            <DiscordInteraction author="AbhigyanTrips" avatar="https://i.imgur.com/8xd9SHa.png" command="true">server</DiscordInteraction>
-        </div>
-        Server name: Disnake Guide <br />
-        Total members: 2
-    </DiscordMessage>
+<DiscordMessages lightTheme={!isDarkTheme()}>
+	<DiscordMessage author="Disnake Bot" avatar="/public/disnake-logo.png" bot="true">
+		<div slot="interactions">
+			<DiscordInteraction author="AbhigyanTrips" avatar="https://i.imgur.com/8xd9SHa.png" command="true">
+				server
+			</DiscordInteraction>
+		</div>
+		Server name: Disnake Guide <br />
+		Total members: 2
+	</DiscordMessage>
 </DiscordMessages>
 <br />
 
 :::tip
 
-Refer to the [Guild](https://docs.disnake.dev/en/latest/api.html#disnake.Guild) documentation for a list of all the available properties and methods.
+Refer to the [Guild](https://docs.disnake.dev/en/latest/api.html#disnake.Guild) documentation for a list of all the
+available properties and methods.
 
 :::
 
@@ -241,8 +258,8 @@ same manner - use `inter.guild.created_at` or `inter.guild.verification_level`,
 
 A "user" refers to a Discord user. `inter.author` refers to the user the interaction was sent by (a
 [User instance](https://docs.disnake.dev/en/latest/api.html#disnake.User) in DM contexts, or a
-[Member instance](https://docs.disnake.dev/en/latest/api.html#disnake.Member) in server contexts), which exposes properties
-such as `.name` or `.id`. (Using just `inter.author` will give the user's full tag.)
+[Member instance](https://docs.disnake.dev/en/latest/api.html#disnake.Member) in server contexts), which exposes
+properties such as `.name` or `.id`. (Using just `inter.author` will give the user's full tag.)
 
 ```python title="main.py" {12-14}
 import disnake
@@ -265,20 +282,24 @@ bot.run("YOUR_BOT_TOKEN")
 ```
 
 <br />
-<DiscordMessages  lightTheme={!isDarkTheme()}>
-    <DiscordMessage author="Disnake Bot" avatar="/public/disnake-logo.png" bot="true">
-        <div slot="interactions">
-            <DiscordInteraction author="AbhigyanTrips" avatar="https://i.imgur.com/8xd9SHa.png" command="true">server</DiscordInteraction>
-        </div>
-        Your tag: AbhigyanTrips#1234 <br />
-        Your ID: 123456789012345678
-    </DiscordMessage>
+<DiscordMessages lightTheme={!isDarkTheme()}>
+	<DiscordMessage author="Disnake Bot" avatar="/public/disnake-logo.png" bot="true">
+		<div slot="interactions">
+			<DiscordInteraction author="AbhigyanTrips" avatar="https://i.imgur.com/8xd9SHa.png" command="true">
+				server
+			</DiscordInteraction>
+		</div>
+		Your tag: AbhigyanTrips#1234 <br />
+		Your ID: 123456789012345678
+	</DiscordMessage>
 </DiscordMessages>
 <br />
 
 :::tip
 
-Refer to the [`User`](https://docs.disnake.dev/en/latest/api.html#disnake.User) and [`Member`](https://docs.disnake.dev/en/latest/api.html#disnake.Member) documentation for a list of all the available properties and methods.
+Refer to the [`User`](https://docs.disnake.dev/en/latest/api.html#disnake.User) and
+[`Member`](https://docs.disnake.dev/en/latest/api.html#disnake.Member) documentation for a list of all the available
+properties and methods.
 
 :::