fix(docs): fix api docs pages, add plugin pub date

DuroCodes · DuroCodes · commit 040996994e25 · 2023-01-27T21:48:08.000-05:00
diff --git a/apps/docs/package.json b/apps/docs/package.json
@@ -10,7 +10,7 @@
     "lint": "next lint",
     "vercel-build": "prisma generate && next build",
     "prisma:generate": "prisma generate",
-    "docgen": "rm -rf src/pages/docs && node src/utils/docgen.mjs && node src/utils/docgen.mjs"
+    "docgen": "rm -rf src/pages/docs/api && node src/utils/docgen.mjs && node src/utils/docgen.mjs"
   },
   "author": "DuroCodes",
   "license": "MIT",
diff --git a/apps/docs/src/components/Plugin.tsx b/apps/docs/src/components/Plugin.tsx
@@ -12,6 +12,7 @@ interface PluginProps {
   name: string;
   id: string;
   author: Author;
+  createdAt: Date;
 }
 
 export function PluginCard({ plugin }: { plugin: PluginProps; }) {
@@ -29,7 +30,13 @@ export function PluginCard({ plugin }: { plugin: PluginProps; }) {
             objectFit="cover"
           />
         </div>
-        {plugin.author.name}
+        {plugin.author.name} • {
+          plugin.createdAt.toLocaleDateString('en-us', {
+            year: 'numeric',
+            month: 'short',
+            day: 'numeric',
+          })
+        }
       </div>
       <style jsx global>{`
       html.dark .icon-circle {
diff --git a/apps/docs/src/pages/docs/classes/SparkClient.mdx b/apps/docs/src/pages/docs/classes/SparkClient.mdx
diff --git a/apps/docs/src/pages/docs/classes/SparkCommand.mdx b/apps/docs/src/pages/docs/classes/SparkCommand.mdx
@@ -1,3 +1,7 @@
+---
+title: SparkCommand
+---
+
 ## SparkCommand implements BaseCommand
 
 The event class. Use this class to create new commands in your bot.
@@ -16,18 +20,18 @@ new SparkCommand(options)
 
 The description of the command. Will default to
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/structures/sparkCommand.ts#L42)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/structures/sparkCommand.ts#L42)
 
 ### public name: string
 
 The name of the command. Will default to the file's name without the shortcut.
 Example:
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/structures/sparkCommand.ts#L37)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/structures/sparkCommand.ts#L37)
 
 ### public type: CommandType
 
 The type of the command.
 You can use the
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/structures/sparkCommand.ts#L48)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/structures/sparkCommand.ts#L48)
diff --git a/apps/docs/src/pages/docs/classes/SparkEvent.mdx b/apps/docs/src/pages/docs/classes/SparkEvent.mdx
@@ -1,3 +1,7 @@
+---
+title: SparkEvent
+---
+
 ## SparkEvent implements EventOptions\<Key>
 
 The event class. Use this class to create new events in your bot.
@@ -16,16 +20,16 @@ new SparkEvent(options)
 
 The name of the event. (Such as
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/structures/sparkEvent.ts#L37)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/structures/sparkEvent.ts#L37)
 
 ### public once: boolean
 
 Whether the event should run once.
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/structures/sparkEvent.ts#L47)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/structures/sparkEvent.ts#L47)
 
 ### public run: EventRunner\<Key>
 
 The run function for the event.
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/structures/sparkEvent.ts#L42)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/structures/sparkEvent.ts#L42)
diff --git a/apps/docs/src/pages/docs/types/@spark.ts/handler/Command.mdx b/apps/docs/src/pages/docs/types/@spark.ts/handler/Command.mdx
diff --git a/apps/docs/src/pages/docs/types/@spark.ts/handler/EventRunner.mdx b/apps/docs/src/pages/docs/types/@spark.ts/handler/EventRunner.mdx
diff --git a/apps/docs/src/pages/docs/types/Command.mdx b/apps/docs/src/pages/docs/types/Command.mdx
@@ -0,0 +1,7 @@
+---
+title: Command
+---
+
+## Command
+
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/command.ts#L107)
diff --git a/apps/docs/src/pages/docs/types/CommandPlugin.mdx b/apps/docs/src/pages/docs/types/CommandPlugin.mdx
@@ -1,3 +1,7 @@
+---
+title: CommandPlugin
+---
+
 ## CommandPlugin
 
 Represents a plugin that is ran upon the command being used.
@@ -9,4 +13,4 @@ Good for guards, reusability.
 | name        | string                                                                     | N/A   | -           |
 | run         | (options: CommandPluginOptionsDefs\[T]) => Awaitable\<Result\<void, void>> | N/A   | -           |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/plugin.ts#L87)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/plugin.ts#L87)
diff --git a/apps/docs/src/pages/docs/types/CommandType.mdx b/apps/docs/src/pages/docs/types/CommandType.mdx
@@ -1,3 +1,7 @@
+---
+title: CommandType
+---
+
 ## CommandType
 
 | Property | Type    | Value | Description |
@@ -6,4 +10,4 @@
 | Slash    | 'slash' | N/A   | -           |
 | Text     | 'text'  | N/A   | -           |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/command.ts#L15)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/command.ts#L15)
diff --git a/apps/docs/src/pages/docs/types/Controller.mdx b/apps/docs/src/pages/docs/types/Controller.mdx
@@ -1,3 +1,7 @@
+---
+title: Controller
+---
+
 ## Controller
 
 Represents the controller object
@@ -7,4 +11,4 @@ Represents the controller object
 | next     | (...args: unknown\[]) => Ok\<void>  | N/A   | Continues plugin execution, runs the next plugin.    |
 | stop     | (...args: unknown\[]) => Err\<void> | N/A   | Stops plugin execution, doesn't run the next plugin. |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/plugin.ts#L19)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/plugin.ts#L19)
diff --git a/apps/docs/src/pages/docs/types/EventOptions.mdx b/apps/docs/src/pages/docs/types/EventOptions.mdx
@@ -1,3 +1,7 @@
+---
+title: EventOptions
+---
+
 ## EventOptions
 
 | Property | Type              | Value | Description                                             |
@@ -6,4 +10,4 @@
 | once     | boolean           | N/A   | Whether the event should be ran once or multiple times. |
 | run      | EventRunner\<Key> | N/A   | -                                                       |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/event.ts#L7)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/event.ts#L7)
diff --git a/apps/docs/src/pages/docs/types/EventRunner.mdx b/apps/docs/src/pages/docs/types/EventRunner.mdx
@@ -0,0 +1,7 @@
+---
+title: EventRunner
+---
+
+## EventRunner
+
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/event.ts#L3)
diff --git a/apps/docs/src/pages/docs/types/InitPlugin.mdx b/apps/docs/src/pages/docs/types/InitPlugin.mdx
@@ -1,3 +1,7 @@
+---
+title: InitPlugin
+---
+
 ## InitPlugin
 
 Represents a plugin that is ran upon the command being loaded.
@@ -9,4 +13,4 @@ Good for pre-processing, or doing something with the data of the command.
 | name        | string                                                                  | N/A   | -           |
 | run         | (options: InitPluginOptionsDefs\[T]) => Awaitable\<Result\<void, void>> | N/A   | -           |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/plugin.ts#L97)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/plugin.ts#L97)
diff --git a/apps/docs/src/pages/docs/types/SlashCommand.mdx b/apps/docs/src/pages/docs/types/SlashCommand.mdx
@@ -1,3 +1,7 @@
+---
+title: SlashCommand
+---
+
 ## SlashCommand
 
 | Property    | Type                                                                                                                                                        | Value | Description                                                         |
@@ -10,4 +14,4 @@
 | run         | (options: \{ args: CommandInteractionOptionResolver\<CacheType>,client: Client\<boolean>,interaction: ChatInputCommandInteraction\<CacheType> }) => unknown | N/A   | -                                                                   |
 | type        | Slash                                                                                                                                                       | N/A   | -                                                                   |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/command.ts#L62)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/command.ts#L62)
diff --git a/apps/docs/src/pages/docs/types/TextCommand.mdx b/apps/docs/src/pages/docs/types/TextCommand.mdx
@@ -1,3 +1,7 @@
+---
+title: TextCommand
+---
+
 ## TextCommand
 
 A text command. Ran with a prefix, and can have aliases.
@@ -13,4 +17,4 @@ A text command. Ran with a prefix, and can have aliases.
 | run                                                                       | (options: \{ args: Array\<string>,client: Client\<boolean>,message: Message\<boolean> }) => unknown | N/A   | -                                                                   |
 | type                                                                      | Text                                                                                                | N/A   | -                                                                   |
 
-- [Source](https://github.com/DuroCodes/spark/blob/d7098ec/packages/handler/src/types/command.ts#L44)
+- [Source](https://github.com/DuroCodes/spark/blob/43c6c21/packages/handler/src/types/command.ts#L44)
diff --git a/apps/docs/src/utils/docgen.mjs b/apps/docs/src/utils/docgen.mjs
@@ -2,67 +2,71 @@ import { createDocumentation } from 'typedoc-nextra';
 import glob from 'fast-glob';
 import fs from 'fs';
 
-await createDocumentation({
-  input: [`${process.cwd()}/../../packages/handler/src/index.ts`],
-  output: `${process.cwd()}/src/pages/docs`,
-  tsconfigPath: `${process.cwd()}/../../packages/handler/tsconfig-base.json`,
-  markdown: true,
-});
-
-const docFiles = await glob('src/pages/docs/**/*.mdx');
-
-const paths = docFiles.map((v) => ({
-  path: v,
-  name: v.split('/').at(-1),
-  folder: v.split('/').at(-4),
-}));
-
-paths.forEach(({ path, folder, name }) => {
-  fs.renameSync(path, `src/pages/docs/${folder}/${name}`);
-});
-
-const folders = [...new Set(paths.map(({ folder }) => folder))];
-folders.forEach((folder) => {
-  fs.rmdirSync(`src/pages/docs/${folder}/@spark.ts/handler`);
-  fs.rmdirSync(`src/pages/docs/${folder}/@spark.ts`);
-});
-
-const newFiles = await glob('src/pages/docs/**/*.mdx');
-
-newFiles.forEach((file) => {
-  const data = fs.readFileSync(file, 'utf-8');
-
-  const replacedData = data
-    .split('\n')
-    .map((v) => {
-      if (v.includes('node_modules/discord.js/typings/index.d.ts')) {
-        return '- [Source](https://github.com/discordjs/discord.js/blob/main/packages/discord.js/typings/index.d.ts)';
-      }
-
-      if (v.includes('node_modules/@types/node')) {
-        return '';
-      }
-
-      return v;
-    })
-    .join('\n');
-
-  const newData = `\
+async function main() {
+  const docFiles = (await glob('src/pages/docs/**/*.mdx')).filter((v) => !v.includes('index.mdx'));
+
+  if (!docFiles.length) {
+    return createDocumentation({
+      input: [`${process.cwd()}/../../packages/handler/src/index.ts`],
+      output: `${process.cwd()}/src/pages/docs`,
+      tsconfigPath: `${process.cwd()}/../../packages/handler/tsconfig-base.json`,
+      markdown: true,
+    });
+  }
+
+  const paths = docFiles.map((v) => ({
+    path: v,
+    name: v.split('/').at(-1),
+    folder: v.split('/').at(-4),
+  }));
+
+  paths.forEach(({ path, folder, name }) => {
+    fs.renameSync(path, `src/pages/docs/${folder}/${name}`);
+  });
+
+  const folders = [...new Set(paths.map(({ folder }) => folder))];
+
+  folders.forEach((folder) => {
+    fs.rmdirSync(`src/pages/docs/${folder}/@spark.ts/handler`);
+    fs.rmdirSync(`src/pages/docs/${folder}/@spark.ts`);
+  });
+
+  const newFiles = await glob('src/pages/docs/**/*.mdx');
+
+  newFiles.forEach((file) => {
+    const data = fs.readFileSync(file, 'utf-8');
+
+    const replacedData = data
+      .split('\n')
+      .map((v) => {
+        if (v.includes('node_modules/discord.js/typings/index.d.ts')) {
+          return '- [Source](https://github.com/discordjs/discord.js/blob/main/packages/discord.js/typings/index.d.ts)';
+        }
+
+        if (v.includes('node_modules/@types/node')) {
+          return '';
+        }
+
+        return v;
+      })
+      .join('\n');
+
+    const newData = `\
 ---
 title: ${file.split('/').at(-1).split('.')[0]}
 ---
 
 ${replacedData}`;
 
-  fs.writeFileSync(file, newData);
-});
+    fs.writeFileSync(file, newData);
+  });
 
-fs.writeFileSync('src/pages/docs/_meta.json', JSON.stringify({
-  classes: 'Classes',
-  types: 'Types',
-}, null, 2));
+  fs.writeFileSync('src/pages/docs/_meta.json', JSON.stringify({
+    classes: 'Classes',
+    types: 'Types',
+  }, null, 2));
 
-fs.writeFileSync('src/pages/docs/index.mdx', `---
+  fs.writeFileSync('src/pages/docs/index.mdx', `---
 title: API Docs
 description: View the Spark API Docs
 ---
@@ -78,3 +82,6 @@ In this section of the docs, you can view info on the classes and types, and vie
   For now, it's best to use the \`Guide\` section to learn more.
 </Callout>
 `);
+}
+
+await main();
