aboutsummaryrefslogtreecommitdiff
path: root/scripts/generatePluginList.ts
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/generatePluginList.ts')
-rw-r--r--scripts/generatePluginList.ts191
1 files changed, 191 insertions, 0 deletions
diff --git a/scripts/generatePluginList.ts b/scripts/generatePluginList.ts
new file mode 100644
index 0000000..1f66c3d
--- /dev/null
+++ b/scripts/generatePluginList.ts
@@ -0,0 +1,191 @@
+/*
+ * Vencord, a modification for Discord's desktop app
+ * Copyright (c) 2023 Vendicated and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+import { Dirent, readdirSync, readFileSync, writeFileSync } from "fs";
+import { access, readFile } from "fs/promises";
+import { join } from "path";
+import { BigIntLiteral, createSourceFile, Identifier, isArrayLiteralExpression, isCallExpression, isExportAssignment, isIdentifier, isObjectLiteralExpression, isPropertyAccessExpression, isPropertyAssignment, isStringLiteral, isVariableStatement, NamedDeclaration, NodeArray, ObjectLiteralExpression, ScriptTarget, StringLiteral, SyntaxKind } from "typescript";
+
+interface Dev {
+ name: string;
+ id: string;
+}
+
+interface PluginData {
+ name: string;
+ description: string;
+ authors: Dev[];
+ dependencies: string[];
+ hasPatches: boolean;
+ hasCommands: boolean;
+ required: boolean;
+ enabledByDefault: boolean;
+ target: "desktop" | "web" | "dev";
+}
+
+const devs = {} as Record<string, Dev>;
+
+function getName(node: NamedDeclaration) {
+ return node.name && isIdentifier(node.name) ? node.name.text : undefined;
+}
+
+function hasName(node: NamedDeclaration, name: string) {
+ return getName(node) === name;
+}
+
+function getObjectProp(node: ObjectLiteralExpression, name: string) {
+ const prop = node.properties.find(p => hasName(p, name));
+ if (prop && isPropertyAssignment(prop)) return prop.initializer;
+ return prop;
+}
+
+function parseDevs() {
+ const file = createSourceFile("constants.ts", readFileSync("src/utils/constants.ts", "utf8"), ScriptTarget.Latest);
+
+ for (const child of file.getChildAt(0).getChildren()) {
+ if (!isVariableStatement(child)) continue;
+
+ const devsDeclaration = child.declarationList.declarations.find(d => hasName(d, "Devs"));
+ if (!devsDeclaration?.initializer || !isCallExpression(devsDeclaration.initializer)) continue;
+
+ const value = devsDeclaration.initializer.arguments[0];
+
+ if (!isObjectLiteralExpression(value)) return;
+
+ for (const prop of value.properties) {
+ const name = (prop.name as Identifier).text;
+ const value = isPropertyAssignment(prop) ? prop.initializer : prop;
+
+ if (!isObjectLiteralExpression(value)) throw new Error(`Failed to parse devs: ${name} is not an object literal`);
+
+ devs[name] = {
+ name: (getObjectProp(value, "name") as StringLiteral).text,
+ id: (getObjectProp(value, "id") as BigIntLiteral).text.slice(0, -1)
+ };
+ }
+
+ return;
+ }
+
+ throw new Error("Could not find Devs constant");
+}
+
+async function parseFile(fileName: string) {
+ const file = createSourceFile(fileName, await readFile(fileName, "utf8"), ScriptTarget.Latest);
+
+ const fail = (reason: string) => {
+ return new Error(`Invalid plugin ${fileName}, because ${reason}`);
+ };
+
+ for (const node of file.getChildAt(0).getChildren()) {
+ if (!isExportAssignment(node) || !isCallExpression(node.expression)) continue;
+
+ const call = node.expression;
+ if (!isIdentifier(call.expression) || call.expression.text !== "definePlugin") continue;
+
+ const pluginObj = node.expression.arguments[0];
+ if (!isObjectLiteralExpression(pluginObj)) throw fail("no object literal passed to definePlugin");
+
+ const data = {
+ hasPatches: false,
+ hasCommands: false,
+ enabledByDefault: false,
+ required: false,
+ } as PluginData;
+
+ for (const prop of pluginObj.properties) {
+ const key = getName(prop);
+ const value = isPropertyAssignment(prop) ? prop.initializer : prop;
+
+ switch (key) {
+ case "name":
+ case "description":
+ if (!isStringLiteral(value)) throw fail(`${key} is not a string literal`);
+ data[key] = value.text;
+ break;
+ case "patches":
+ data.hasPatches = true;
+ break;
+ case "commands":
+ data.hasCommands = true;
+ break;
+ case "authors":
+ if (!isArrayLiteralExpression(value)) throw fail("authors is not an array literal");
+ data.authors = value.elements.map(e => {
+ if (!isPropertyAccessExpression(e)) throw fail("authors array contains non-property access expressions");
+ return devs[getName(e)!];
+ });
+ break;
+ case "dependencies":
+ if (!isArrayLiteralExpression(value)) throw fail("dependencies is not an array literal");
+ const { elements } = value;
+ if (elements.some(e => !isStringLiteral(e))) throw fail("dependencies array contains non-string elements");
+ data.dependencies = (elements as NodeArray<StringLiteral>).map(e => e.text);
+ break;
+ case "required":
+ case "enabledByDefault":
+ data[key] = value.kind === SyntaxKind.TrueKeyword;
+ if (!data[key] && value.kind !== SyntaxKind.FalseKeyword) throw fail(`${key} is not a boolean literal`);
+ break;
+ }
+ }
+
+ if (!data.name || !data.description || !data.authors) throw fail("name, description or authors are missing");
+
+ const fileBits = fileName.split(".");
+ if (fileBits.length > 2 && ["ts", "tsx"].includes(fileBits.at(-1)!)) {
+ const mod = fileBits.at(-2)!;
+ if (!["web", "desktop", "dev"].includes(mod)) throw fail(`invalid target ${fileBits.at(-2)}`);
+ data.target = mod as any;
+ }
+
+ return data;
+ }
+
+ throw fail("no default export called 'definePlugin' found");
+}
+
+async function getEntryPoint(dirent: Dirent) {
+ const base = join("./src/plugins", dirent.name);
+ if (!dirent.isDirectory()) return base;
+
+ for (const name of ["index.ts", "index.tsx"]) {
+ const full = join(base, name);
+ try {
+ await access(full);
+ return full;
+ } catch { }
+ }
+
+ throw new Error(`${dirent.name}: Couldn't find entry point`);
+}
+
+(async () => {
+ parseDevs();
+ const plugins = readdirSync("./src/plugins", { withFileTypes: true }).filter(d => d.name !== "index.ts");
+
+ const promises = plugins.map(async dirent => parseFile(await getEntryPoint(dirent)));
+
+ const data = JSON.stringify(await Promise.all(promises));
+
+ if (process.argv.length > 2) {
+ writeFileSync(process.argv[2], data);
+ } else {
+ console.log(data);
+ }
+})();