From 04f62c2162cbd5a62377b19ae3e9bd1db17e4e0c Mon Sep 17 00:00:00 2001
From: Freeze455 <baptiste.parmantier.pro@gmail.com>
Date: Tue, 17 Aug 2021 21:35:00 +0200
Subject: [PATCH] :pencil: Write middleware docs

---
 src/templates/modules/documentation/Routes.ts |  2 +
 .../modules/documentation/base/Middleware.vue | 56 +++++++++++++++++++
 src/utils/Navigation.ts                       |  1 +
 3 files changed, 59 insertions(+)
 create mode 100644 src/templates/modules/documentation/base/Middleware.vue

diff --git a/src/templates/modules/documentation/Routes.ts b/src/templates/modules/documentation/Routes.ts
index fc1477e..45901c1 100644
--- a/src/templates/modules/documentation/Routes.ts
+++ b/src/templates/modules/documentation/Routes.ts
@@ -5,6 +5,7 @@ import Environment from './base/Environment.vue'
 import Structure from './base/Structure.vue'
 import Command from './base/Command.vue'
 import Event from './base/Event.vue'
+import Middleware from './base/Middleware.vue'
 
 const routes: RouteRecordRaw[] = [
   { path: '/documentation/getting-started', component: GettingStarted },
@@ -13,6 +14,7 @@ const routes: RouteRecordRaw[] = [
   { path: '/documentation/structure', component: Structure },
   { path: '/documentation/commands', component: Command },
   { path: '/documentation/events', component: Event },
+  { path: '/documentation/middlewares', component: Middleware },
 ]
 
 export default routes
\ No newline at end of file
diff --git a/src/templates/modules/documentation/base/Middleware.vue b/src/templates/modules/documentation/base/Middleware.vue
new file mode 100644
index 0000000..0b7aa14
--- /dev/null
+++ b/src/templates/modules/documentation/base/Middleware.vue
@@ -0,0 +1,56 @@
+<template>
+  <Documentation title="Middlewares">
+    <p>
+      When creating commands, it is very common to have to perform a check before the execution of the command in order to verify,
+      for example, if the executor of the command has a specific role, required permissions (non-exhaustive list).
+    </p>
+    <p>
+      These checks are usually recurring from command to command and must be duplicated which goes against the Don't Repeat Yourself principle.<br>
+      The role of middleware is to create a file that can be reused at will and used by any command that requires recurring checks.
+    </p>
+    <p>
+      Creating a command with the framework is very simple.
+    </p>
+
+    <div class="space-y-5">
+      <h2>Create new command from CLI</h2>
+      <p>
+        Open a new terminal in your project and write the following command :
+      </p>
+      <CodeHighlight class="w-min" code="$ factory make:file" />
+      <AlertInfo>
+        <template v-slot:label>
+          Info
+        </template>
+        <template v-slot:message>
+          Choose to create a middleware and then answer the questions you will be asked. It is important to note that when you define the file name, you can "place" the file in folders by specifying a path directory in addition to the file name as in the following example :
+        </template>
+      </AlertInfo>
+    </div>
+
+    <div class="space-y-5">
+      <h2>Default middleware file</h2>
+      <p>
+        A file will be created in the specified location otherwise in the root of your project with the following structure :
+      </p>
+      <CodeHighlight class="w-min" :code="file" />
+    </div>
+  </Documentation>
+</template>
+
+<script setup lang="ts">
+import Documentation from '../../../../components/Documentation.vue'
+import CodeHighlight from '../../../../components/CodeHighlight.vue'
+import Divider from '../../../../components/Divider.vue'
+import LinkExternal from '../../../../components/LinkExternal.vue'
+import AlertInfo from '../../../../components/AlertInfo.vue'
+const file = `
+import { Middleware, BaseMiddleware, MiddlewareContext } from '@discord-factory/core'
+
+@Middleware({ pattern: 'YourRegexPattern')}
+export default class FooMiddleware implements BaseMiddleware {
+  public async run(context: MiddlewareContext): Promise<void> {
+    // Your code here
+  }
+}`
+</script>
diff --git a/src/utils/Navigation.ts b/src/utils/Navigation.ts
index 9244b7f..9674f90 100644
--- a/src/utils/Navigation.ts
+++ b/src/utils/Navigation.ts
@@ -24,6 +24,7 @@ export const documentation = [
       { label: 'Structure', href: '/documentation/structure', isMenu: false },
       { label: 'Commands', href: '/documentation/commands', isMenu: false },
       { label: 'Events', href: '/documentation/events', isMenu: false },
+      { label: 'Middlewares', href: '/documentation/middlewares', isMenu: false },
     ]
   },
 ]