Add work on Configurator and add messageLexer todos

Author: VoxelMC

src/lib/configurator.ts

@@ -8,23 +8,28 @@ import path from "path";
 import fs from "fs";
 import consola from "consola";
 
-import Constants from "./util/constants";
+import Constants, { type ConfigPathResolvable } from "./util/constants";
 
-export interface MessageConfiguration {
-	emoji: string;
+export type MessageConfiguration = {
 	message: string;
+	emoji?: string;
 	insertAtIndex?: number;
 	replaceAtIndex?: number;
 }
 
+export type DefaultMessageOptions = {
+	emoji?: string;
+	fileName?: string;
+};
+
 class Configurator {
 	static getNearestConfigurationFilePath(
 		currentDirectory: string,
 		level: number = 0
 	): string {
 		const currentDir = fs.readdirSync(currentDirectory);
 		const query = currentDir.find((item) =>
-			Constants.ACCEPTED_CONFIG_FILENAMES.includes(item)
+			([...Constants.ACCEPTED_CONFIG_FILENAMES] as string[]).includes(item)
 		);
 		if (query) return path.join(currentDirectory, query);
 		else if (level <= Constants.CONFIG_FILE_MAX_DEPTH) {
@@ -41,12 +46,31 @@ class Configurator {
 		}
 	}
 
+	static getGitRootPath(currentDirectory: string, level: number = 0) {
+		// TODO: Recursive find for the nearest directory with a .git path
+		// Perhaps make this cacheable? Update at every change?
+		// Maybe ENV Vars?
+		currentDirectory; level;
+	}
+
 	static addMessageConfiguration(
-		filePath: string,
+		configFilePath: ConfigPathResolvable,
 		message: MessageConfiguration
 	): boolean {
 		if (message.insertAtIndex && message.replaceAtIndex)
 			throw new Error("You cannot insert and replace at the same time.");
+
+		loadFile(configFilePath)
+
+		return true;
+	}
+
+	static addDefaultMessageConfiguration(message: string, options: DefaultMessageOptions): boolean {
+		const newMessage = {
+			message,
+			...options,
+		}
+		newMessage
 		return true;
 	}
 }

src/lib/messageLexer.ts

@@ -0,0 +1,2 @@
+// TODO: Implement a lexer to replace the template strings with actual values.
+// Needs a context object to say what files and thus which folders the commit cares about, then needs to make choices about what to put where.

src/lib/util/constants.ts

@@ -2,18 +2,26 @@
  * Here, we will put important constant values for the project.
  */
 
+// Put not any leading dot modifiers (.labrc -> labrc)
+const ACCEPTED_CONFIG_FILENAMES = [
+	"labrc.mjs", // default
+	"labrc",
+	"labrc.json", // if we want to support a JSON config file.
+] as const;
+
 interface CONSTANTS {
-	ACCEPTED_CONFIG_FILENAMES: string[];
+	ACCEPTED_CONFIG_FILENAMES: typeof ACCEPTED_CONFIG_FILENAMES;
 	CONFIG_FILE_MAX_DEPTH: number;
 }
 
 const constants: CONSTANTS = {
-	ACCEPTED_CONFIG_FILENAMES: [
-		".labrc.mjs", // default
-		".labrc",
-		".labrc.json", // if we want to support a JSON config file.
-	],
+	ACCEPTED_CONFIG_FILENAMES,
 	CONFIG_FILE_MAX_DEPTH: 5,
 };
 
 export default constants;
+
+export type FileNameResolvable = (typeof ACCEPTED_CONFIG_FILENAMES)[number];
+export type DotOption = "" | ".";
+export type ConfigPathResolvable = `${string}${DotOption}${FileNameResolvable}`;
+

tsconfig.json

@@ -25,7 +25,7 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "nodenext" /* Specify what module code is generated. */,
+    "module": "commonjs" /* Specify what module code is generated. */,
     "rootDir": "./src" /* Specify the root folder within your source files. */,
     // "moduleResolution": "nodenext",                     /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */