feat: config improvment (#47)

Author: thibaultleouay

.gitignore

@@ -1,2 +1,4 @@
 build
-scratch/
+scratch/
+# This file is generated by the runreal CLI during the test
+.runreal/dist/script.esm.js

src/cmd.ts

@@ -1,23 +1,21 @@
 import { Command, EnumType, ulid } from './deps.ts'
 
-import { config } from './lib/config.ts'
+import { Config } from './lib/config.ts'
 import { logger, LogLevel } from './lib/logger.ts'
 
+const LogLevelType = new EnumType(LogLevel)
+
 export const cmd = new Command()
 	.globalOption('--session-id <sessionId:string>', 'Session Id', {
 		default: ulid() as string,
 		// action: ({ sessionId }) => logger.setSessionId(sessionId),
 	})
-	.globalType('log-level', new EnumType(LogLevel))
+	.globalType('log-level', LogLevelType)
 	.globalOption('--log-level <level:log-level>', 'Log level', {
-		default: LogLevel.DEBUG,
+		default: LogLevelType.values().at(LogLevelType.values().indexOf(LogLevel.DEBUG)),
 		action: ({ logLevel }) => logger.setLogLevel(logLevel),
 	})
-	.globalOption('-c, --config-path <configPath:string>', 'Path to config file', {
-		action: async ({ configPath }) => {
-			if (configPath) { const cfg = await config.mergeConfig(configPath) }
-		},
-	})
+	.globalOption('-c, --config-path <configPath:string>', 'Path to config file')
 	.globalEnv('RUNREAL_ENGINE_PATH=<enginePath:string>', 'Overide path to engine folder', { prefix: 'RUNREAL_' })
 	.globalOption('--engine-path <enginePath:string>', 'Path to engine folder')
 	.globalEnv('RUNREAL_PROJECT_PATH=<projectPath:string>', 'Overide path to project folder', { prefix: 'RUNREAL_' })
@@ -26,3 +24,7 @@ export const cmd = new Command()
 	.globalOption('--build-id <buildId:string>', 'Overide build ID')
 	.globalEnv('RUNREAL_BUILD_PATH=<buildPath:string>', 'Overide path to build output folder', { prefix: 'RUNREAL_' })
 	.globalOption('--build-path <buildPath:string>', 'Path to save build outputs')
+	.globalAction(async (options) => {
+		// We load the config here so that the singleton should be instantiated before any command is run
+		await Config.create({ path: options.configPath })
+	})

src/commands/build.ts

@@ -2,15 +2,16 @@ import { Command, EnumType, ValidationError } from '../deps.ts'
 
 import { createEngine, Engine, EngineConfiguration, EnginePlatform, EngineTarget } from '../lib/engine.ts'
 import { findProjectFile, getProjectName } from '../lib/utils.ts'
-import { config } from '../lib/config.ts'
-import { CliOptions, GlobalOptions } from '../lib/types.ts'
+import type { GlobalOptions } from '../lib/types.ts'
+import { Config } from '../lib/config.ts'
 
 const TargetError = (target: string, targets: string[]) => {
 	return new ValidationError(`Invalid Target: ${target}
 Valid Targets: ${targets.join(', ')}
 	`)
 }
-export type BuildOptions = typeof build extends Command<any, any, infer Options, any, any> ? Options
+export type BuildOptions = typeof build extends Command<void, void, infer Options, infer Argument, GlobalOptions>
+	? Options
 	: never
 
 export const build = new Command<GlobalOptions>()
@@ -23,9 +24,12 @@ export const build = new Command<GlobalOptions>()
 	})
 	.option('-d, --dry-run', 'Dry run')
 	.arguments('<target:string>')
-	.action(async (options: unknown, target = EngineTarget.Editor) => {
+	.action(async (options, target = EngineTarget.Editor) => {
 		const { platform, configuration, dryRun } = options as BuildOptions
-		const { engine: { path: enginePath }, project: { path: projectPath } } = config.get(options as CliOptions)
+		const config = Config.getInstance()
+		const { engine: { path: enginePath }, project: { path: projectPath } } = config.mergeConfigCLIConfig({
+			cliOptions: options,
+		})
 
 		const engine = createEngine(enginePath)
 		const validTargets = await engine.parseEngineTargets()

src/commands/buildgraph/index.ts

@@ -1,8 +1,11 @@
 import { Command } from '../../deps.ts'
-import { GlobalOptions } from '../../lib/types.ts'
+import type { GlobalOptions } from '../../lib/types.ts'
 
 import { run } from './run.ts'
 
 export const buildgraph = new Command<GlobalOptions>()
 	.description('buildgraph')
+	.action((function () {
+		this.showHelp()
+	}))
 	.command('run', run)

src/commands/buildgraph/run.ts

@@ -1,9 +1,9 @@
 import { Command, path, readNdjson } from '../../deps.ts'
-import { config } from '../../lib/config.ts'
-import { CliOptions, GlobalOptions } from '../../lib/types.ts'
+import { Config } from '../../lib/config.ts'
+import type { GlobalOptions } from '../../lib/types.ts'
 import { createEngine } from '../../lib/engine.ts'
 
-export type RunOptions = typeof run extends Command<any, any, infer Options, any, any> ? Options
+export type RunOptions = typeof run extends Command<void, void, infer Options, infer Argument, GlobalOptions> ? Options
 	: never
 
 interface AutomationToolLogs {
@@ -30,12 +30,16 @@ export const run = new Command<GlobalOptions>()
 	.arguments('<buildGraphScript:file> <buildGraphArgs...>')
 	.stopEarly()
 	.action(async (options, buildGraphScript: string, ...buildGraphArgs: Array<string>) => {
-		const { engine: { path: enginePath } } = config.get(options as CliOptions)
+		const config = Config.getInstance()
+		const { engine: { path: enginePath } } = config.mergeConfigCLIConfig({ cliOptions: options })
 		const engine = createEngine(enginePath)
 		const { success, code } = await engine.runBuildGraph(buildGraphScript, buildGraphArgs)
 		if (!success) {
 			const logs = await getAutomationToolLogs(enginePath)
-			logs.filter(({ level }) => level === 'Error').forEach(({ message }) => console.log(`[BUILDGRAPH RUN] ${message}`))
+
+			for (const message of logs.filter(({ level }) => level === 'Error')) {
+				console.log(`[BUILDGRAPH RUN] ${message}`)
+			}
 			Deno.exit(code)
 		}
 	})

src/commands/clean.ts

@@ -3,6 +3,7 @@ import { Command } from '../deps.ts'
 
 export const clean = new Command()
 	.option('--dry-run', 'Dry run', { default: false })
+	.description('clean')
 	.action(async (options) => {
 		await Engine.runClean(options)
 	})

src/commands/debug/debug-config.ts

@@ -1,16 +1,18 @@
 import { Command } from '../../deps.ts'
-import { config } from '../../lib/config.ts'
-import { CliOptions, GlobalOptions } from '../../lib/types.ts'
+import { Config } from '../../lib/config.ts'
+import type { GlobalOptions } from '../../lib/types.ts'
 
-export type DebugConfigOptions = typeof debugConfig extends Command<any, any, infer Options, any, any> ? Options
+export type DebugConfigOptions = typeof debugConfig extends
+	Command<void, void, infer Options extends Record<string, unknown>, [], GlobalOptions> ? Options
 	: never
 
 export const debugConfig = new Command<GlobalOptions>()
 	.option('-r, --render', 'Render the config with substitutions')
 	.description('debug config')
 	.action((options) => {
-		const { render } = options as DebugConfigOptions & GlobalOptions
-		const cfg = config.get(options as CliOptions)
+		const { render } = options
+		const config = Config.getInstance()
+		const cfg = config.mergeConfigCLIConfig({ cliOptions: options })
 
 		if (render) {
 			const rendered = config.renderConfig(cfg)

src/commands/debug/index.ts

@@ -1,8 +1,11 @@
 import { Command } from '../../deps.ts'
-import { GlobalOptions } from '../../lib/types.ts'
+import type { GlobalOptions } from '../../lib/types.ts'
 
 import { debugConfig } from './debug-config.ts'
 
 export const debug = new Command<GlobalOptions>()
 	.description('debug')
+	.action((function () {
+		this.showHelp()
+	}))
 	.command('config', debugConfig)

src/commands/engine/index.ts

@@ -1,13 +1,16 @@
 import { Command } from '../../deps.ts'
 
-import { GlobalOptions } from '../../lib/types.ts'
+import type { GlobalOptions } from '../../lib/types.ts'
 import { install } from './install.ts'
 import { update } from './update.ts'
 import { setup } from './setup.ts'
 import { version } from './version.ts'
 
 export const engine = new Command<GlobalOptions>()
 	.description('engine')
+	.action(function () {
+		this.showHelp()
+	})
 	.command('install', install)
 	.command('update', update)
 	.command('setup', setup)

src/commands/engine/install.ts

@@ -1,12 +1,13 @@
 import { Command, ValidationError } from '../../deps.ts'
 import { cloneRepo, runEngineSetup } from '../../lib/utils.ts'
-import { CliOptions } from '../../lib/types.ts'
-import { config } from '../../lib/config.ts'
+import type { GlobalOptions } from '../../lib/types.ts'
+import { Config } from '../../lib/config.ts'
 
-export type InstallOptions = typeof install extends Command<any, any, infer Options, any, any> ? Options
+export type InstallOptions = typeof install extends Command<void, void, infer Options, infer Argument, GlobalOptions>
+	? Options
 	: never
 
-export const install = new Command()
+export const install = new Command<GlobalOptions>()
 	.description('install engine from a source repository')
 	.option('-b, --branch <branch:string>', 'git checkout (branch | tag)')
 	.option('-f, --force', 'force overwrite of destination', { default: false })
@@ -39,7 +40,8 @@ export const install = new Command()
 			dryRun,
 			setup,
 		} = options as InstallOptions
-		const cfg = config.get(options as CliOptions)
+
+		const cfg = Config.getInstance().mergeConfigCLIConfig({ cliOptions: options })
 		source = source || cfg.engine.gitSource
 		destination = destination || cfg.engine.path