59 lines
No EOL
3 KiB
JavaScript
59 lines
No EOL
3 KiB
JavaScript
const collections = require("./collections.js");
|
|
const logger = require("./logger.js");
|
|
const fs = require("fs");
|
|
|
|
module.exports = async (output) => {
|
|
const template = `# <img src="https://raw.githubusercontent.com/esmBot/esmBot/master/esmbot.png" width="64"> esmBot${process.env.NODE_ENV === "development" ? " Dev" : ""} Command List
|
|
${process.env.NODE_ENV === "development" ? "\n**You are currently using esmBot Dev! Things may change at any time without warning and there will be bugs. Many bugs. If you find one, [report it here](https://github.com/esmBot/esmBot/issues) or in the esmBot Support server.**\n" : ""}
|
|
This page was last generated on \`${new Date().toString()}\`.
|
|
|
|
\`[]\` means an argument is required, \`{}\` means an argument is optional.
|
|
|
|
Default prefix is \`&\`.
|
|
|
|
**Want to help support esmBot's development? Consider donating on Patreon!** https://patreon.com/TheEssem
|
|
|
|
> Tip: You can get more info about a command by using \`help [command]\`.
|
|
|
|
## Table of Contents
|
|
+ [**General**](#💻-general)
|
|
+ [**Tags**](#🏷️-tags)
|
|
+ [**Fun**](#👌-fun)
|
|
+ [**Image Editing**](#🖼️-image-editing)
|
|
+ [**Soundboard**](#🔊-soundboard)
|
|
+ [**Music**](#🎤-music)
|
|
`;
|
|
const commands = collections.commands;
|
|
const categories = {
|
|
general: ["## 💻 General"],
|
|
tags: ["## 🏷️ Tags"],
|
|
fun: ["## 👌 Fun"],
|
|
images: ["## 🖼️ Image Editing", "> These commands support the PNG, JPEG, WEBP, and GIF formats.\n"],
|
|
soundboard: ["## 🔊 Soundboard"],
|
|
music: ["## 🎤 Music"]
|
|
};
|
|
for (const [command] of commands) {
|
|
const category = collections.info.get(command).category;
|
|
const description = collections.info.get(command).description;
|
|
const params = collections.info.get(command).params;
|
|
if (category === 1) {
|
|
categories.general.push(`+ **${command}**${params ? ` ${params}` : ""} - ${description}`);
|
|
} else if (category === 3) {
|
|
const subCommands = [...Object.keys(description)];
|
|
for (const subCommand of subCommands) {
|
|
categories.tags.push(`+ **tags${subCommand !== "default" ? ` ${subCommand}` : ""}**${params[subCommand] ? ` ${params[subCommand]}` : ""} - ${description[subCommand]}`);
|
|
}
|
|
} else if (category === 4) {
|
|
categories.fun.push(`+ **${command}**${params ? ` ${params}` : ""} - ${description}`);
|
|
} else if (category === 5) {
|
|
categories.images.push(`+ **${command}**${params ? ` ${params}` : ""} - ${description}`);
|
|
} else if (category === 6) {
|
|
categories.soundboard.push(`+ **${command}**${params ? ` ${params}` : ""} - ${description}`);
|
|
} else if (category === 7) {
|
|
categories.music.push(`+ **${command}**${params ? ` ${params}` : ""} - ${description}`);
|
|
}
|
|
}
|
|
fs.writeFile(output, `${template}\n${categories.general.join("\n")}\n\n${categories.tags.join("\n")}\n\n${categories.fun.join("\n")}\n\n${categories.images.join("\n")}\n\n${categories.soundboard.join("\n")}\n\n${categories.music.join("\n")}`, () => {
|
|
logger.log("The help docs have been generated.");
|
|
});
|
|
}; |