fix ts errors in launchpad package

Author: claytercek

packages/dashboard/package.json

@@ -4,7 +4,7 @@
   "description": "",
   "type": "module",
   "main": "index.js",
-  "types": "types/index.d.ts",
+  "types": "dist/index.d.ts",
   "bin": "index.js",
 
   "scripts": {

packages/launchpad/index.js

@@ -21,6 +21,11 @@ export class StartupCommands {
 	static SCAFFOLD = 'scaffold';
 }
 
+/**
+ * @param {import('yargs').Argv} argv
+ * @param {string|string[]} commands
+ * @param {string} description
+ */
 const addCommand = (argv, commands, description) => {
 	if (!Array.isArray(commands)) {
 		commands = [commands];

packages/launchpad/lib/command-center.js

@@ -1,7 +1,7 @@
 import chalk from 'chalk';
 import autoBind from 'auto-bind';
 import { LogManager, Logger, TaskQueue, TaskQueueOptions, execScript } from '@bluecadet/launchpad-utils';
-import CommandHooks from './command-hooks.js';
+import CommandHooks, { ExecHook } from './command-hooks.js';
 
 export class CommandOptions {
 	constructor({
@@ -16,23 +16,23 @@ export class CommandOptions {
 
 export class CommandCenter {
 	/** @type {CommandOptions} */
-	_config = {};
+	_config;
 
 	/** @type {Logger} */
-	_logger = null;
+	_logger;
 
 	/** @type {Map<string, Command>} */
 	_commands = new Map();
 
 	/** @type {TaskQueue} */
-	_tasks = null;
+	_tasks;
 
 	/**
 	 * 
-	 * @param {CommandOptions|Object} config 
-	 * @param {*} logger 
+	 * @param {CommandOptions|Object} [config] 
+	 * @param {Logger} [logger]
 	 */
-	constructor(config = null, logger = null) {
+	constructor(config, logger) {
 		autoBind(this);
 		this._config = new CommandOptions(config);
 		this._logger = logger || LogManager.getInstance().getLogger();
@@ -54,15 +54,17 @@ export class CommandCenter {
 	/**
 	 * 
 	 * @param {string} commandName The name of the command to run
-	 * @returns {Promise} The promise returned by the command function
+	 * @param {unknown[]} args
+	 * @returns {Promise<void | null>} The promise returned by the command function
 	 */
 	async run(commandName, ...args) {
-		if (!this._commands.has(commandName)) {
+		const command = this._commands.get(commandName);
+
+		if (!command) {
 			return Promise.reject(new Error(`Command not found: '${commandName}'`));
 		}
 
 		this._logger.info(`Running command: ${chalk.blue(commandName)}`);
-		const command = this._commands.get(commandName);
 
 		if (command.queued) {
 			return this._tasks.add(command.run, command.name, ...args);
@@ -72,22 +74,27 @@ export class CommandCenter {
 	}
 
 	/**
-	 * @param {CommandHooks} hooks 
+	 * @param {CommandHooks} commandHooks 
 	 */
 	addCommandHooks(commandHooks) {
+		/**
+		 * 
+		 * @param {ExecHook[]} hooks 
+		 * @param {boolean} isPre 
+		 */
 		const add = (hooks, isPre) => {
 			const label = isPre ? 'pre' : 'post';
 			for (const hook of hooks) {
 				try {
 					this._logger.info(`Adding ${label}-hook for ${chalk.blue(hook.command)}: '${hook.script}'`);
 					const fn = async () => {
 						this._logger.info(`Running ${chalk.magenta(`${label}-hook`)} for ${chalk.blue(hook.command)}: '${hook.script}'`);
-						return execScript(hook.script, null, this._logger);
+						await execScript(hook.script, undefined, this._logger);
 					};
 					this.addHook(hook.command, isPre ? fn : null, isPre ? null : fn);
 				} catch (err) {
 					this._logger.error(`Can't add ${label}-hook '${hook.script}' for '${chalk.blue(hook.command)}':`, err);
-					execScript(hook.command, null, this._logger);
+					execScript(hook.command, undefined, this._logger);
 				}
 			}
 		};
@@ -98,14 +105,16 @@ export class CommandCenter {
 	/**
 	 * 
 	 * @param {string} commandName 
-	 * @param {function():Promise} before Called before the command is run
-	 * @param {function():Promise} after Called after the command was run
+	 * @param {(() => Promise<void>)?} before Called before the command is run
+	 * @param {(() => Promise<void>)?} after Called after the command was run
 	 */
 	addHook(commandName, before = null, after = null) {
-		if (!this._commands.has(commandName)) {
+		const command = this._commands.get(commandName);
+
+		if (!command) {
 			throw new Error(`Command not found: '${commandName}'`);
 		}
-		const command = this._commands.get(commandName);
+
 		if (before) {
 			command.preHooks.push(before);
 			this._logger.debug(`Added pre-hook for: ${chalk.blue(commandName)}`);
@@ -117,14 +126,25 @@ export class CommandCenter {
 	}
 }
 
+/**
+ * @template {(...args: any[]) => Promise<unknown>} [F=(...args: any[]) => Promise<void>]
+ */
 export class Command {
+	/**
+	 * @param {object} options
+	 * @param {string} options.name
+	 * @param {F} options.callback
+	 * @param {string} [options.help]
+	 * @param {boolean} [options.queued]
+	 * @param {Logger | null} [options.logger]
+	 */
 	constructor({
 		name,
 		callback,
 		help = '',
 		queued = true,
 		logger = null
-	} = {}) {
+	}) {
 		autoBind(this);
 		/**
 		 * The name of the command used for running.
@@ -133,7 +153,7 @@ export class Command {
 		this.name = name;
 		/**
 		 * The callback to trigger. Will receives args passed via run().
-		 * @type {function():Promise}
+		 * @type {F}
 		 */
 		this.callback = callback;
 		/**
@@ -148,24 +168,24 @@ export class Command {
 		this.queued = queued;
 		/**
 		 * Callbacks that will be triggered before the command is executed.
-		 * @type {Array<function():Promise>}
+		 * @type {Array<(...args: Parameters<F>)=>Promise<void>>}
 		 */
 		this.preHooks = [];
 		/**
 		* Callbacks that will be triggered after the command was executed.
-		* @type {Array<function():Promise>}
+		* @type {Array<(...args: Parameters<F>)=>Promise<void>>}
 		*/
 		this.postHooks = [];
 		/**
-		 * @type {Logger}
+		 * @type {Logger | null}
 		 */
 		this.logger = logger;
 	}
 
 	/**
 	 * Runs a command with optional pre- and post-command hooks.
-	 * @param  {...any} args 
-	 * @returns {*} Results of this command's callback function, if any
+	 * @param  {Parameters<F>} args 
+	 * @returns {Promise<ReturnType<F> | null>} Results of this command's callback function, if any
 	 */
 	async run(...args) {
 		const logger = this.logger || console;
@@ -176,8 +196,12 @@ export class Command {
 				logger.error(`Could not run pre-hook for command ${chalk.blue(this.name)}:`, err);
 			}
 		}
+		/**
+		 * @type {ReturnType<F> | null}
+		 */
 		let result = null;
 		try {
+			// @ts-expect-error - no clue why TS is complaining here... 
 			result = await this.callback(...args);
 		} catch (err) {
 			logger.error(`Could not run command ${chalk.blue(this.name)}:`, err);

packages/launchpad/lib/command-hooks.js

@@ -13,7 +13,7 @@
 
 export class CommandHooks {
 	/**
-	 * @param {Array<HookMapping>} hooks 
+	 * @param {Record<string, HookMapping>} hooks 
 	 */
 	constructor(hooks = {}) {
 		/**
@@ -33,7 +33,7 @@ export class CommandHooks {
 	}
 
 	/**
-	 * @param {Object<string, HookMapping>} hooks 
+	 * @param {Record<string, HookMapping>} hooks 
 	 */
 	parse(hooks = {}) {
 		if (!hooks) {
@@ -43,11 +43,9 @@ export class CommandHooks {
 			key = (key + '').toLowerCase();
 			const command = key.replace('pre-', '').replace('post-', '');
 
-			if (!Array.isArray(scripts)) {
-				scripts = [scripts];
-			}
+			const scriptArray = Array.isArray(scripts) ? scripts : [scripts];
 
-			for (const script of scripts) {
+			for (const script of scriptArray) {
 				if ((typeof script) !== 'string') {
 					continue;
 				}
@@ -63,10 +61,15 @@ export class CommandHooks {
 }
 
 export class ExecHook {
+	/**
+	 * @param {object} options
+	 * @param {string} options.command
+	 * @param {string} options.script
+	 */
 	constructor({
 		command,
 		script
-	} = {}) {
+	}) {
 		/**
 		 * @type {string}
 		 */

packages/launchpad/lib/launchpad-core.js

@@ -15,19 +15,19 @@ import CommandCenter, { Command } from './command-center.js';
  */
 export class LaunchpadCore {
 	/** @type {LaunchpadOptions} */
-	_config = null;
+	_config;
 
 	/** @type {Logger} */
-	_logger = null;
+	_logger;
 
 	/** @type {LaunchpadContent} */
-	_content = null;
+	_content;
 
 	/** @type {LaunchpadMonitor} */
-	_monitor = null;
+	_monitor;
 
 	/** @type {CommandCenter} */
-	_commands = null;
+	_commands;
 
 	/** @type {boolean} */
 	_isShuttingDown = false;
@@ -73,10 +73,10 @@ export class LaunchpadCore {
 	 * Stops launchpad and exits this process.
 	 * This function is queued and waits until the queue is empty before it executes.
 	 * 
-	 * @param @type {number|string|Error} eventOrExitCode 
+	 * @param {number|string|Error} [eventOrExitCode] 
 	 */
 	async shutdown(eventOrExitCode = undefined) {
-		return this._commands.run('shutdown', eventOrExitCode);
+		await this._commands.run('shutdown', eventOrExitCode);
 	}
 
 	/**
@@ -116,7 +116,7 @@ export class LaunchpadCore {
 	/**
 	 * @private
 	 */
-	async _runShutdown(eventOrExitCode = 0, ...args) {
+	async _runShutdown(eventOrExitCode = 0) {
 		try {
 			this._logger.info('Launchpad exiting... 👋');
 

packages/launchpad/lib/launchpad-options.js

@@ -12,6 +12,9 @@ import { CommandHooks } from './command-hooks.js';
  * Combined options to initialize Launchpad.
  */
 export class LaunchpadOptions {
+	/**
+	 * @param {any} options
+	 */
 	constructor({
 		content = new ContentOptions(),
 		monitor = new MonitorOptions(),

packages/launchpad/package.json

@@ -8,7 +8,7 @@
   },
   "type": "module",
   "main": "./index.js",
-  "types": "types/index.d.ts",
+  "types": "dist/index.d.ts",
   "bin": {
     "launchpad": "./index.js"
   },

packages/utils/lib/exec-script.js

@@ -3,8 +3,8 @@ import { exec } from 'child_process';
 /**
  * Executes a scripts and pipes output and error to a logger
  * @param {string} script 
- * @param {string} cwd 
- * @param {*} logger 
+ * @param {string} [cwd] 
+ * @param {import("./log-manager").Logger | Console} logger 
  * @returns {Promise<number | null>} A promise with the exit code passed on close
  */
 export const execScript = async (script, cwd, logger = console) => {