refactor: stricter typing for config parsing

Author: favna

src/commands/generate.ts

@@ -9,8 +9,9 @@ import { load } from 'js-yaml';
 import { readFile } from 'node:fs/promises';
 import { basename, join } from 'node:path';
 import { setTimeout as sleep } from 'node:timers/promises';
+import type { Config } from 'src/lib/types';
 
-async function createComponent(component: string, name: string, config: any, configLoc: string) {
+async function createComponent(component: string, name: string, config: Config, configLoc: string) {
 	const { projectLanguage } = config;
 
 	if (!projectLanguage) {
@@ -34,10 +35,10 @@ async function createComponent(component: string, name: string, config: any, con
 }
 
 async function fetchConfig() {
-	const a = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
+	const configFileAsJson = await Promise.race([findUp('.sapphirerc.json', { cwd: '.' }), sleep(5000)]);
 
-	if (a) {
-		return a;
+	if (configFileAsJson) {
+		return configFileAsJson;
 	}
 
 	return Promise.race([findUp('.sapphirerc.yml', { cwd: '.' }), sleep(5000)]);
@@ -71,7 +72,7 @@ export default async (component: string, name: string) => {
 		return fail("Can't find the Sapphire CLI config.");
 	}
 
-	const config = configLoc.endsWith('json') ? JSON.parse(await readFile(configLoc, 'utf8')) : load(await readFile(configLoc, 'utf8'));
+	const config: Config = configLoc.endsWith('json') ? JSON.parse(await readFile(configLoc, 'utf8')) : load(await readFile(configLoc, 'utf8'));
 
 	if (!config) {
 		return fail("Can't parse the Sapphire CLI config.");

src/functions/CreateFileFromTemplate.ts

@@ -2,11 +2,12 @@ import { templatesFolder } from '#constants';
 import { fileExists } from '#functions/FileExists';
 import { mkdir, readFile, writeFile } from 'node:fs/promises';
 import { dirname, resolve } from 'node:path';
+import type { Config } from 'src/lib/types';
 
 export async function CreateFileFromTemplate(
 	template: string,
 	target: string,
-	config: any,
+	config: Config | null,
 	params?: Record<string, string>,
 	custom = false,
 	component = false
@@ -25,7 +26,7 @@ export async function CreateFileFromTemplate(
 	output.templateContent ??= await readFile(location, 'utf8');
 
 	if (!output.templateContent) {
-		throw new Error(`Couldn't read the template file. Are you sure it exists, the name is correct, and the content is valid?`);
+		throw new Error("Couldn't read the template file. Are you sure it exists, the name is correct, and the content is valid?");
 	}
 
 	if (params) {
@@ -38,14 +39,14 @@ export async function CreateFileFromTemplate(
 		throw new Error('Invalid template.');
 	}
 
-	const dir = component ? config.locations[output.config!.category] : null;
-	const ta = component ? target.replace('%L%', dir) : target;
+	const directoryForOutput = component ? config?.locations[output.config!.category] : null;
+	const targetPath = component ? target.replace('%L%', directoryForOutput) : target;
 
-	if (await fileExists(ta)) {
+	if (await fileExists(targetPath)) {
 		throw new Error('Component already exists');
 	}
 
-	await writeFileRecursive(ta, output.templateContent);
+	await writeFileRecursive(targetPath, output.templateContent);
 
 	return true;
 }

src/lib/types.ts

@@ -0,0 +1,46 @@
+/**
+ * Scheme for Sapphire CLI Config (@sapphire/cli)
+ */
+export interface Config {
+	/**
+	 * Settings about custom component (piece) templates
+	 */
+	customFileTemplates: CustomFileTemplates;
+	/**
+	 * Categories and their locations
+	 */
+	locations: Locations;
+	/**
+	 * Project language (ts | js)
+	 */
+	projectLanguage: string;
+	[property: string]: any;
+}
+
+/**
+ * Settings about custom component (piece) templates
+ */
+interface CustomFileTemplates {
+	/**
+	 * Enable custom file templates
+	 */
+	enabled: boolean;
+	/**
+	 * Location of your custom file templates
+	 */
+	location: string;
+	[property: string]: any;
+}
+
+/**
+ * Categories and their locations
+ */
+interface Locations {
+	arguments: string;
+	base: string;
+	commands: string;
+	listeners: string;
+	preconditions: string;
+	routes?: string;
+	[property: string]: any;
+}