Plugin Page: add indicator for excluded plugins

2024-06-20 19:48:37 +02:00 · 2024-06-20 19:48:37 +02:00 · a43d5d595a
parent ceaaf9ab8a
commit a43d5d595a
7 changed files with 156 additions and 84 deletions
--- a/scripts/build/build.mjs
+++ b/scripts/build/build.mjs
@ -21,7 +21,7 @@ import esbuild from "esbuild";
 import { readdir } from "fs/promises";
 import { join } from "path";

-import { BUILD_TIMESTAMP, commonOpts, exists, globPlugins, IS_DEV, IS_REPORTER, IS_STANDALONE, IS_UPDATER_DISABLED, VERSION, watch } from "./common.mjs";
+import { BUILD_TIMESTAMP, commonOpts, exists, globPlugins, IS_DEV, IS_REPORTER, IS_STANDALONE, IS_UPDATER_DISABLED, resolvePluginName, VERSION, watch } from "./common.mjs";

 const defines = {
    IS_STANDALONE,
@ -76,22 +76,20 @@ const globNativesPlugin = {
            for (const dir of pluginDirs) {
                const dirPath = join("src", dir);
                if (!await exists(dirPath)) continue;
-                const plugins = await readdir(dirPath);
-                for (const p of plugins) {
-                    const nativePath = join(dirPath, p, "native.ts");
-                    const indexNativePath = join(dirPath, p, "native/index.ts");
+                const plugins = await readdir(dirPath, { withFileTypes: true });
+                for (const file of plugins) {
+                    const fileName = file.name;
+                    const nativePath = join(dirPath, fileName, "native.ts");
+                    const indexNativePath = join(dirPath, fileName, "native/index.ts");

                    if (!(await exists(nativePath)) && !(await exists(indexNativePath)))
                        continue;

-                    const nameParts = p.split(".");
-                    const namePartsWithoutTarget = nameParts.length === 1 ? nameParts : nameParts.slice(0, -1);
-                    // pluginName.thing.desktop -> PluginName.thing
-                    const cleanPluginName = p[0].toUpperCase() + namePartsWithoutTarget.join(".").slice(1);
+                    const pluginName = await resolvePluginName(dirPath, file);

                    const mod = `p${i}`;
-                    code += `import * as ${mod} from "./${dir}/${p}/native";\n`;
-                    natives += `${JSON.stringify(cleanPluginName)}:${mod},\n`;
+                    code += `import * as ${mod} from "./${dir}/${fileName}/native";\n`;
+                    natives += `${JSON.stringify(pluginName)}:${mod},\n`;
                    i++;
                }
            }
--- a/scripts/build/common.mjs
+++ b/scripts/build/common.mjs
@ -53,6 +53,32 @@ export const banner = {
 `.trim()
 };

+const PluginDefinitionNameMatcher = /definePlugin\(\{\s*(["'])?name\1:\s*(["'`])(.+?)\2/;
+/**
+ * @param {string} base
+ * @param {import("fs").Dirent} dirent
+ */
+export async function resolvePluginName(base, dirent) {
+    const fullPath = join(base, dirent.name);
+    const content = dirent.isFile()
+        ? await readFile(fullPath, "utf-8")
+        : await (async () => {
+            for (const file of ["index.ts", "index.tsx"]) {
+                try {
+                    return await readFile(join(fullPath, file), "utf-8");
+                } catch {
+                    continue;
+                }
+            }
+            throw new Error(`Invalid plugin ${fullPath}: could not resolve entry point`);
+        })();
+
+    return PluginDefinitionNameMatcher.exec(content)?.[3]
+        ?? (() => {
+            throw new Error(`Invalid plugin ${fullPath}: must contain definePlugin call with simple string name property as first property`);
+        })();
+}
+
 export async function exists(path) {
    return await access(path, FsConstants.F_OK)
        .then(() => true)
@ -88,14 +114,16 @@ export const globPlugins = kind => ({
        build.onLoad({ filter, namespace: "import-plugins" }, async () => {
            const pluginDirs = ["plugins/_api", "plugins/_core", "plugins", "userplugins"];
            let code = "";
-            let plugins = "\n";
-            let meta = "\n";
+            let pluginsCode = "\n";
+            let metaCode = "\n";
+            let excludedCode = "\n";
            let i = 0;
            for (const dir of pluginDirs) {
                const userPlugin = dir === "userplugins";

-                if (!await exists(`./src/${dir}`)) continue;
-                const files = await readdir(`./src/${dir}`, { withFileTypes: true });
+                const fullDir = `./src/${dir}`;
+                if (!await exists(fullDir)) continue;
+                const files = await readdir(fullDir, { withFileTypes: true });
                for (const file of files) {
                    const fileName = file.name;
                    if (fileName.startsWith("_") || fileName.startsWith(".")) continue;
@ -104,23 +132,30 @@ export const globPlugins = kind => ({
                    const target = getPluginTarget(fileName);

                    if (target && !IS_REPORTER) {
-                        if (target === "dev" && !watch) continue;
-                        if (target === "web" && kind === "discordDesktop") continue;
-                        if (target === "desktop" && kind === "web") continue;
-                        if (target === "discordDesktop" && kind !== "discordDesktop") continue;
-                        if (target === "vencordDesktop" && kind !== "vencordDesktop") continue;
+                        const excluded =
+                            (target === "dev" && !IS_DEV) ||
+                            (target === "web" && kind === "discordDesktop") ||
+                            (target === "desktop" && kind === "web") ||
+                            (target === "discordDesktop" && kind !== "discordDesktop") ||
+                            (target === "vencordDesktop" && kind !== "vencordDesktop");
+
+                        if (excluded) {
+                            const name = await resolvePluginName(fullDir, file);
+                            excludedCode += `${JSON.stringify(name)}:${JSON.stringify(target)},\n`;
+                            continue;
+                        }
                    }

                    const folderName = `src/${dir}/${fileName}`.replace(/^src\/plugins\//, "");

                    const mod = `p${i}`;
                    code += `import ${mod} from "./${dir}/${fileName.replace(/\.tsx?$/, "")}";\n`;
-                    plugins += `[${mod}.name]:${mod},\n`;
-                    meta += `[${mod}.name]:${JSON.stringify({ folderName, userPlugin })},\n`; // TODO: add excluded plugins to display in the UI?
+                    pluginsCode += `[${mod}.name]:${mod},\n`;
+                    metaCode += `[${mod}.name]:${JSON.stringify({ folderName, userPlugin })},\n`; // TODO: add excluded plugins to display in the UI?
                    i++;
                }
            }
-            code += `export default {${plugins}};export const PluginMeta={${meta}};`;
+            code += `export default {${pluginsCode}};export const PluginMeta={${metaCode}};export const ExcludedPlugins={${excludedCode}};`;
            return {
                contents: code,
                resolveDir: "./src"
--- a/scripts/generatePluginList.ts
+++ b/scripts/generatePluginList.ts
@ -39,7 +39,7 @@ interface PluginData {
    hasCommands: boolean;
    required: boolean;
    enabledByDefault: boolean;
-    target: "discordDesktop" | "vencordDesktop" | "web" | "dev";
+    target: "discordDesktop" | "vencordDesktop" | "desktop" | "web" | "dev";
    filePath: string;
 }

--- a/src/components/PluginSettings/index.tsx
+++ b/src/components/PluginSettings/index.tsx
@ -35,9 +35,9 @@ import { openModalLazy } from "@utils/modal";
 import { useAwaiter } from "@utils/react";
 import { Plugin } from "@utils/types";
 import { findByPropsLazy } from "@webpack";
-import { Alerts, Button, Card, Forms, lodash, Parser, React, Select, Text, TextInput, Toasts, Tooltip } from "@webpack/common";
+import { Alerts, Button, Card, Forms, lodash, Parser, React, Select, Text, TextInput, Toasts, Tooltip, useMemo } from "@webpack/common";

-import Plugins from "~plugins";
+import Plugins, { ExcludedPlugins } from "~plugins";

 // Avoid circular dependency
 const { startDependenciesRecursive, startPlugin, stopPlugin } = proxyLazy(() => require("../../plugins"));
@ -177,6 +177,37 @@ const enum SearchStatus {
    NEW
 }

+function ExcludedPluginsList({ search }: { search: string; }) {
+    const matchingExcludedPlugins = Object.entries(ExcludedPlugins)
+        .filter(([name]) => name.toLowerCase().includes(search));
+
+    const ExcludedReasons: Record<"web" | "discordDesktop" | "vencordDesktop" | "desktop" | "dev", string> = {
+        desktop: "Discord Desktop app or Vesktop",
+        discordDesktop: "Discord Desktop app",
+        vencordDesktop: "Vesktop app",
+        web: "Vesktop app and the Web version of Discord",
+        dev: "Developer version of Vencord"
+    };
+
+    return (
+        <Text variant="text-md/normal" className={Margins.top16}>
+            {matchingExcludedPlugins.length
+                ? <>
+                    <Forms.FormText>Are you looking for:</Forms.FormText>
+                    <ul>
+                        {matchingExcludedPlugins.map(([name, reason]) => (
+                            <li key={name}>
+                                <b>{name}</b>: Only available on the {ExcludedReasons[reason]}
+                            </li>
+                        ))}
+                    </ul>
+                </>
+                : "No plugins meet the search criteria."
+            }
+        </Text>
+    );
+}
+
 export default function PluginSettings() {
    const settings = useSettings();
    const changes = React.useMemo(() => new ChangeList<string>(), []);
@ -215,26 +246,27 @@ export default function PluginSettings() {
        return o;
    }, []);

-    const sortedPlugins = React.useMemo(() => Object.values(Plugins)
+    const sortedPlugins = useMemo(() => Object.values(Plugins)
        .sort((a, b) => a.name.localeCompare(b.name)), []);

    const [searchValue, setSearchValue] = React.useState({ value: "", status: SearchStatus.ALL });

+    const search = searchValue.value.toLowerCase();
    const onSearch = (query: string) => setSearchValue(prev => ({ ...prev, value: query }));
    const onStatusChange = (status: SearchStatus) => setSearchValue(prev => ({ ...prev, status }));

    const pluginFilter = (plugin: typeof Plugins[keyof typeof Plugins]) => {
-        const enabled = settings.plugins[plugin.name]?.enabled;
-        if (enabled && searchValue.status === SearchStatus.DISABLED) return false;
-        if (!enabled && searchValue.status === SearchStatus.ENABLED) return false;
-        if (searchValue.status === SearchStatus.NEW && !newPlugins?.includes(plugin.name)) return false;
-        if (!searchValue.value.length) return true;
+        const { status } = searchValue;
+        const enabled = Vencord.Plugins.isPluginEnabled(plugin.name);
+        if (enabled && status === SearchStatus.DISABLED) return false;
+        if (!enabled && status === SearchStatus.ENABLED) return false;
+        if (status === SearchStatus.NEW && !newPlugins?.includes(plugin.name)) return false;
+        if (!search.length) return true;

-        const v = searchValue.value.toLowerCase();
        return (
-            plugin.name.toLowerCase().includes(v) ||
-            plugin.description.toLowerCase().includes(v) ||
-            plugin.tags?.some(t => t.toLowerCase().includes(v))
+            plugin.name.toLowerCase().includes(search) ||
+            plugin.description.toLowerCase().includes(search) ||
+            plugin.tags?.some(t => t.toLowerCase().includes(search))
        );
    };

@ -255,54 +287,48 @@ export default function PluginSettings() {
        return lodash.isEqual(newPlugins, sortedPluginNames) ? [] : newPlugins;
    }));

-    type P = JSX.Element | JSX.Element[];
-    let plugins: P, requiredPlugins: P;
-    if (sortedPlugins?.length) {
-        plugins = [];
-        requiredPlugins = [];
+    const plugins = [] as JSX.Element[];
+    const requiredPlugins = [] as JSX.Element[];

-        const showApi = searchValue.value === "API";
-        for (const p of sortedPlugins) {
-            if (p.hidden || (!p.options && p.name.endsWith("API") && !showApi))
-                continue;
+    const showApi = searchValue.value.includes("API");
+    for (const p of sortedPlugins) {
+        if (p.hidden || (!p.options && p.name.endsWith("API") && !showApi))
+            continue;

-            if (!pluginFilter(p)) continue;
+        if (!pluginFilter(p)) continue;

-            const isRequired = p.required || depMap[p.name]?.some(d => settings.plugins[d].enabled);
+        const isRequired = p.required || depMap[p.name]?.some(d => settings.plugins[d].enabled);

-            if (isRequired) {
-                const tooltipText = p.required
-                    ? "This plugin is required for Vencord to function."
-                    : makeDependencyList(depMap[p.name]?.filter(d => settings.plugins[d].enabled));
-
-                requiredPlugins.push(
-                    <Tooltip text={tooltipText} key={p.name}>
-                        {({ onMouseLeave, onMouseEnter }) => (
-                            <PluginCard
-                                onMouseLeave={onMouseLeave}
-                                onMouseEnter={onMouseEnter}
-                                onRestartNeeded={name => changes.handleChange(name)}
-                                disabled={true}
-                                plugin={p}
-                            />
-                        )}
-                    </Tooltip>
-                );
-            } else {
-                plugins.push(
-                    <PluginCard
-                        onRestartNeeded={name => changes.handleChange(name)}
-                        disabled={false}
-                        plugin={p}
-                        isNew={newPlugins?.includes(p.name)}
-                        key={p.name}
-                    />
-                );
-            }
+        if (isRequired) {
+            const tooltipText = p.required
+                ? "This plugin is required for Vencord to function."
+                : makeDependencyList(depMap[p.name]?.filter(d => settings.plugins[d].enabled));

+            requiredPlugins.push(
+                <Tooltip text={tooltipText} key={p.name}>
+                    {({ onMouseLeave, onMouseEnter }) => (
+                        <PluginCard
+                            onMouseLeave={onMouseLeave}
+                            onMouseEnter={onMouseEnter}
+                            onRestartNeeded={name => changes.handleChange(name)}
+                            disabled={true}
+                            plugin={p}
+                            key={p.name}
+                        />
+                    )}
+                </Tooltip>
+            );
+        } else {
+            plugins.push(
+                <PluginCard
+                    onRestartNeeded={name => changes.handleChange(name)}
+                    disabled={false}
+                    plugin={p}
+                    isNew={newPlugins?.includes(p.name)}
+                    key={p.name}
+                />
+            );
        }
-    } else {
-        plugins = requiredPlugins = <Text variant="text-md/normal">No plugins meet search criteria.</Text>;
    }

    return (
@ -333,9 +359,18 @@ export default function PluginSettings() {

            <Forms.FormTitle className={Margins.top20}>Plugins</Forms.FormTitle>

-            <div className={cl("grid")}>
-                {plugins}
-            </div>
+            {plugins.length || requiredPlugins.length
+                ? (
+                    <div className={cl("grid")}>
+                        {plugins.length
+                            ? plugins
+                            : <Text variant="text-md/normal">No plugins meet the search criteria.</Text>
+                        }
+                    </div>
+                )
+                : <ExcludedPluginsList search={search} />
+            }
+

            <Forms.FormDivider className={Margins.top20} />

@ -343,7 +378,10 @@ export default function PluginSettings() {
                Required Plugins
            </Forms.FormTitle>
            <div className={cl("grid")}>
-                {requiredPlugins}
+                {requiredPlugins.length
+                    ? requiredPlugins
+                    : <Text variant="text-md/normal">No plugins meet the search criteria.</Text>
+                }
            </div>
        </SettingsTab >
    );
--- a/src/modules.d.ts
+++ b/src/modules.d.ts
@ -26,6 +26,7 @@ declare module "~plugins" {
        folderName: string;
        userPlugin: boolean;
    }>;
+    export const ExcludedPlugins: Record<string, "web" | "discordDesktop" | "vencordDesktop" | "desktop" | "dev">;
 }

 declare module "~pluginNatives" {
--- a/src/plugins/appleMusic.desktop/index.tsx
+++ b/src/plugins/appleMusic.desktop/index.tsx
@ -9,7 +9,7 @@ import { Devs } from "@utils/constants";
 import definePlugin, { OptionType, PluginNative, ReporterTestable } from "@utils/types";
 import { ApplicationAssetUtils, FluxDispatcher, Forms } from "@webpack/common";

-const Native = VencordNative.pluginHelpers.AppleMusic as PluginNative<typeof import("./native")>;
+const Native = VencordNative.pluginHelpers.AppleMusicRichPresence as PluginNative<typeof import("./native")>;

 interface ActivityAssets {
    large_image?: string;
--- a/src/plugins/xsOverlay.desktop/index.ts
+++ b/src/plugins/xsOverlay.desktop/index.ts
@ -136,7 +136,7 @@ const settings = definePluginSettings({
    },
 });

-const Native = VencordNative.pluginHelpers.XsOverlay as PluginNative<typeof import("./native")>;
+const Native = VencordNative.pluginHelpers.XSOverlay as PluginNative<typeof import("./native")>;

 export default definePlugin({
    name: "XSOverlay",