Function describeTable

src/utils/string.utils.ts:117–202

(options: {
	store: Store,
	table: SQLiteTable,
	tableLabel: string,
	entries: T[],
	hiddenProperties?: (string)[],
	propertyFormatters?: Record<string, (entry: any) => string>,
	color?: Color,
	// defaults to "queueId"
	queueIdProperty?: string,
} & (
	{ entryLabelProperty: string } | { entryLabel: string }
	))

const GLOBAL_HIDDEN_PROPERTIES = ["id", "guildId", "queueId", "isRole"];

export function describeTable<T extends object>(options: {
	store: Store,
	table: SQLiteTable,
	tableLabel: string,
	entries: T[],
	hiddenProperties?: (string)[],
	propertyFormatters?: Record<string, (entry: any) => string>,
	color?: Color,
	// defaults to "queueId"
	queueIdProperty?: string,
} & (
	{ entryLabelProperty: string } | { entryLabel: string }
	)) {
	const { store, table, tableLabel, color, entries } = options;
	const hiddenProperties = options.hiddenProperties ?? [];
	const propertyFormatters = options.propertyFormatters ?? {};
	const queueIdProperty = "queueIdProperty" in options ? options.queueIdProperty : "queueId";
	const entryLabelProperty = "entryLabelProperty" in options ? options.entryLabelProperty : null;
	const entryLabel = "entryLabel" in options ? options.entryLabel : null;

	function formatPropertyLabel(property: string, isDefaultValue: boolean): string {
		const label = convertCamelCaseToTitleCase(stripIdSuffix(property));
		return isDefaultValue ? label : bold(label);
	}

	function formatPropertyValue(entry: T, property: string): string {
		// handle mentionable properties
		if ("isRole" in entry) {
			const isRole = (entry as any).isRole;
			const subjectId = (entry as any).subjectId;
			return isRole ? roleMention(subjectId) : userMention(subjectId);
		}

		const value = (entry as any)[property];
		const valueFormatter = propertyFormatters[property];
		return valueFormatter ? valueFormatter(value) : inlineCode(String(value));
	}

	function formatDescriptionProperty(entry: T, property: string): string {
		const value = (entry as any)[property];
		const defaultValue = (table as any)[property]?.default;
		const isDefaultValue = value == defaultValue;

		if (isNil(value) && isNil(defaultValue)) return "";

		const formattedLabel = formatPropertyLabel(property, isDefaultValue);
		const formattedValue = formatPropertyValue(entry, property) ?? "";
		const formattedOverriddenDefaultValue =
			(property in table && !isDefaultValue) ? strikethrough(inlineCode(String(defaultValue))) : "";

		return `- ${formattedLabel} = ${formattedValue} ${formattedOverriddenDefaultValue}`;
	}

	function formatEntryDescription(entry: T): string {
		const descriptionProperties = omit(entry, [...GLOBAL_HIDDEN_PROPERTIES, ...hiddenProperties, entryLabelProperty]);
		const descriptionLines = Object.keys(descriptionProperties)
			.map(property => formatDescriptionProperty(entry, property as string))
			.filter(Boolean);