typings for defaultless settings (#512)

* typings for defaultless settings

* fix other silly typings

* type guard utils

---------

Co-authored-by: Ven <vendicated@riseup.net>
This commit is contained in:
Justice Almanzar 2023-02-28 00:12:35 -05:00 committed by GitHub
parent cf56ad985b
commit 5ec517875e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 42 additions and 15 deletions

View file

@ -19,6 +19,7 @@
import { definePluginSettings } from "@api/settings"; import { definePluginSettings } from "@api/settings";
import { Link } from "@components/Link"; import { Link } from "@components/Link";
import { Devs } from "@utils/constants"; import { Devs } from "@utils/constants";
import { isTruthy } from "@utils/guards";
import { useAwaiter } from "@utils/misc"; import { useAwaiter } from "@utils/misc";
import definePlugin, { OptionType } from "@utils/types"; import definePlugin, { OptionType } from "@utils/types";
import { filters, findByCodeLazy, findByPropsLazy, mapMangledModuleLazy } from "@webpack"; import { filters, findByCodeLazy, findByPropsLazy, mapMangledModuleLazy } from "@webpack";
@ -56,11 +57,11 @@ interface ActivityAssets {
} }
interface Activity { interface Activity {
state: string; state?: string;
details?: string; details?: string;
timestamps?: { timestamps?: {
start?: Number; start?: number;
end?: Number; end?: number;
}; };
assets?: ActivityAssets; assets?: ActivityAssets;
buttons?: Array<string>; buttons?: Array<string>;
@ -70,7 +71,7 @@ interface Activity {
button_urls?: Array<string>; button_urls?: Array<string>;
}; };
type: ActivityType; type: ActivityType;
flags: Number; flags: number;
} }
enum ActivityType { enum ActivityType {
@ -93,13 +94,13 @@ const numOpt = (description: string) => ({
onChange: setRpc onChange: setRpc
}) as const; }) as const;
const choice = (label: string, value: any, _default?: Boolean) => ({ const choice = (label: string, value: any, _default?: boolean) => ({
label, label,
value, value,
default: _default default: _default
}) as const; }) as const;
const choiceOpt = (description: string, options) => ({ const choiceOpt = <T,>(description: string, options: T) => ({
type: OptionType.SELECT, type: OptionType.SELECT,
description, description,
onChange: setRpc, onChange: setRpc,
@ -173,13 +174,13 @@ async function createActivity(): Promise<Activity | undefined> {
activity.buttons = [ activity.buttons = [
buttonOneText, buttonOneText,
buttonTwoText buttonTwoText
].filter(Boolean); ].filter(isTruthy);
activity.metadata = { activity.metadata = {
button_urls: [ button_urls: [
buttonOneURL, buttonOneURL,
buttonTwoURL buttonTwoURL
].filter(Boolean) ].filter(isTruthy)
}; };
} }
@ -206,12 +207,10 @@ async function createActivity(): Promise<Activity | undefined> {
delete activity[k]; delete activity[k];
} }
// WHAT DO YOU WANT FROM ME
// eslint-disable-next-line consistent-return
return activity; return activity;
} }
async function setRpc(disable?: Boolean) { async function setRpc(disable?: boolean) {
const activity: Activity | undefined = await createActivity(); const activity: Activity | undefined = await createActivity();
FluxDispatcher.dispatch({ FluxDispatcher.dispatch({

View file

@ -34,7 +34,7 @@ interface Activity {
state: string; state: string;
details?: string; details?: string;
timestamps?: { timestamps?: {
start?: Number; start?: number;
}; };
assets?: ActivityAssets; assets?: ActivityAssets;
buttons?: Array<string>; buttons?: Array<string>;
@ -43,8 +43,8 @@ interface Activity {
metadata?: { metadata?: {
button_urls?: Array<string>; button_urls?: Array<string>;
}; };
type: Number; type: number;
flags: Number; flags: number;
} }
interface TrackData { interface TrackData {

25
src/utils/guards.ts Normal file
View file

@ -0,0 +1,25 @@
/*
* 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/>.
*/
export function isTruthy<T>(item: T): item is Exclude<T, 0 | "" | false | null | undefined> {
return Boolean(item);
}
export function isNonNullish<T>(item: T): item is Exclude<T, null | undefined> {
return item != null;
}

View file

@ -229,9 +229,12 @@ type PluginSettingType<O extends PluginSettingDef> = O extends PluginSettingStri
O extends PluginSettingSliderDef ? number : O extends PluginSettingSliderDef ? number :
O extends PluginSettingComponentDef ? any : O extends PluginSettingComponentDef ? any :
never; never;
type PluginSettingDefaultType<O extends PluginSettingDef> = O extends PluginSettingSelectDef ? (
O["options"] extends { default?: boolean; }[] ? O["options"][number]["value"] : undefined
) : O extends { default: infer T; } ? T : undefined;
type SettingsStore<D extends SettingsDefinition> = { type SettingsStore<D extends SettingsDefinition> = {
[K in keyof D]: PluginSettingType<D[K]>; [K in keyof D]: PluginSettingType<D[K]> | PluginSettingDefaultType<D[K]>;
}; };
/** An instance of defined plugin settings */ /** An instance of defined plugin settings */