@orxataguy/tyr 1.5.0 → 1.6.2

package/src/lib/ShellManager.ts

@@ -1,118 +1,118 @@
-import { execa } from 'execa';
-import { resolve } from 'path';
-import { homedir } from 'os';
-import inquirer from 'inquirer';
-
-import { TyrError } from '../core/TyrError.js';
-
-/**
- * @class ShellManager
- * @description Terminal command executor. Maintains the working directory (CWD) state to chain commands in specific folders.
- */
-export class ShellManager {
-    private cwd: string;
-
-    constructor() {
-        this.cwd = process.cwd();
-    }
-
-    /**
-     * @method exec
-     * @description Executes a command in the system shell and returns the standard output.
-     * @param {string} command - The full command to execute.
-     * @returns {Promise<string>} The command output (stdout) trimmed of extra whitespace.
-     * @example
-     * const version = await shell.exec('node -v');
-     */
-    public async exec(command: string): Promise<string> {
-        try {
-            const result = await execa(command, { shell: true, cwd: this.cwd });
-            return result.stdout.trim();
-        } catch (e) {
-            throw new TyrError(`An error occurred while executing the command: ${command}`, e);
-        }
-    }
-
-    /**
-    * @method showLoader
-    * @description Displays a spinner loader in the terminal.
-    * @param {string} message - Informational text to show alongside the spinner.
-    * @returns {void}
-    * @example
-    * shell.showLoader('Loading...');
-    */
-    public showLoader = (message: string): { stop: () => void } => {
-        const frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
-        let i = 0;
-        let stopped = false;
-
-        const interval = setInterval(() => {
-            if (!stopped) {
-                process.stdout.write(`\r${frames[i]} ${message}`);
-                i = (i + 1) % frames.length;
-            }
-        }, 80);
-
-        return {
-            stop: () => {
-                stopped = true;
-                clearInterval(interval);
-                process.stdout.write('\r');
-            }
-        };
-    };
-
-    /**
-     * @method input
-     * @description Prompts the user for a value via CLI.
-     * @param {string} question - Informational text shown as the prompt.
-     * @returns {Promise<string>} The value entered by the user.
-     * @example
-     * const name = await shell.input("What's your name?");
-     */
-    public async input(question: string): Promise<string> {
-        try {
-            const result = await inquirer.prompt([
-                {
-                    type: 'input',
-                    name: 'value',
-                    message: question,
-                },
-            ]);
-
-            return result.value.trim();
-        } catch (e) {
-            throw new TyrError(`An error occurred while prompting the question: ${question}`, e);
-        }
-    }
-
-    /**
-     * @method cd
-     * @description Changes the internal working directory for subsequent commands executed by this instance.
-     * @param {string} path - Absolute or relative path to change to.
-     * @example
-     * shell.cd('./backend');
-     * await shell.exec('npm install'); // Runs inside /backend
-     */
-    public cd(path: string): void {
-        let expandedPath = path;
-        if (path.startsWith('~/')) {
-            expandedPath = path.replace('~', homedir());
-        } else if (path === '~') {
-            expandedPath = homedir();
-        }
-
-        this.cwd = resolve(this.cwd, expandedPath);
-    }
-}
-
-/**
- * @object ShellManagerTests
- * @description Test parameters to validate ShellManager functionality.
- */
-export const ShellManagerTests = {
-    exec: { command: 'node -v' },
-    cd: { path: '/tmp' },
-    input: { question: 'Enter a test value:' },
-    showLoader: { message: 'Loading test...' }
+import { execa } from 'execa';
+import { resolve } from 'path';
+import { homedir } from 'os';
+import inquirer from 'inquirer';
+
+import { TyrError } from '../core/TyrError.js';
+
+/**
+ * @class ShellManager
+ * @description Terminal command executor. Maintains the working directory (CWD) state to chain commands in specific folders.
+ */
+export class ShellManager {
+    private cwd: string;
+
+    constructor() {
+        this.cwd = process.cwd();
+    }
+
+    /**
+     * @method exec
+     * @description Executes a command in the system shell and returns the standard output.
+     * @param {string} command - The full command to execute.
+     * @returns {Promise<string>} The command output (stdout) trimmed of extra whitespace.
+     * @example
+     * const version = await shell.exec('node -v');
+     */
+    public async exec(command: string): Promise<string> {
+        try {
+            const result = await execa(command, { shell: true, cwd: this.cwd });
+            return result.stdout.trim();
+        } catch (e) {
+            throw new TyrError(`An error occurred while executing the command: ${command}`, e);
+        }
+    }
+
+    /**
+    * @method showLoader
+    * @description Displays a spinner loader in the terminal.
+    * @param {string} message - Informational text to show alongside the spinner.
+    * @returns {void}
+    * @example
+    * shell.showLoader('Loading...');
+    */
+    public showLoader = (message: string): { stop: () => void } => {
+        const frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
+        let i = 0;
+        let stopped = false;
+
+        const interval = setInterval(() => {
+            if (!stopped) {
+                process.stdout.write(`\r${frames[i]} ${message}`);
+                i = (i + 1) % frames.length;
+            }
+        }, 80);
+
+        return {
+            stop: () => {
+                stopped = true;
+                clearInterval(interval);
+                process.stdout.write('\r');
+            }
+        };
+    };
+
+    /**
+     * @method input
+     * @description Prompts the user for a value via CLI.
+     * @param {string} question - Informational text shown as the prompt.
+     * @returns {Promise<string>} The value entered by the user.
+     * @example
+     * const name = await shell.input("What's your name?");
+     */
+    public async input(question: string): Promise<string> {
+        try {
+            const result = await inquirer.prompt([
+                {
+                    type: 'input',
+                    name: 'value',
+                    message: question,
+                },
+            ]);
+
+            return result.value.trim();
+        } catch (e) {
+            throw new TyrError(`An error occurred while prompting the question: ${question}`, e);
+        }
+    }
+
+    /**
+     * @method cd
+     * @description Changes the internal working directory for subsequent commands executed by this instance.
+     * @param {string} path - Absolute or relative path to change to.
+     * @example
+     * shell.cd('./backend');
+     * await shell.exec('npm install'); // Runs inside /backend
+     */
+    public cd(path: string): void {
+        let expandedPath = path;
+        if (path.startsWith('~/')) {
+            expandedPath = path.replace('~', homedir());
+        } else if (path === '~') {
+            expandedPath = homedir();
+        }
+
+        this.cwd = resolve(this.cwd, expandedPath);
+    }
+}
+
+/**
+ * @object ShellManagerTests
+ * @description Test parameters to validate ShellManager functionality.
+ */
+export const ShellManagerTests = {
+    exec: { command: 'node -v' },
+    cd: { path: '/tmp' },
+    input: { question: 'Enter a test value:' },
+    showLoader: { message: 'Loading test...' }
 };

package/src/lib/SystemManager.ts

@@ -1,83 +1,83 @@
-import { ShellManager } from './ShellManager.js';
-import { Logger } from '../core/Logger.js';
-import { TyrError } from '../core/TyrError.js';
-
-/**
- * @class SystemManager
- * @description General OS maintenance and cleanup utilities.
- */
-export class SystemManager {
-    private shell: ShellManager;
-    private logger: Logger;
-
-    constructor(shell: ShellManager, logger: Logger) {
-        this.shell = shell;
-        this.logger = logger;
-    }
-
-    /**
-     * @method killPort
-     * @description Identifies which process is occupying a port and force-kills it.
-     * @param {number|string} port - The port to free (e.g. 3000).
-     * @returns {Promise<boolean>} True if a process was killed, False if the port was already free.
-     * @example
-     * await sys.killPort(8080);
-     */
-    public async killPort(port: number | string): Promise<boolean> {
-        try {
-            let pid: string | null = null;
-
-            if (process.platform === 'win32') {
-                const result = await this.shell.exec(`netstat -ano | findstr :${port}`).catch(() => null);
-                if (!result?.trim()) return false;
-                const lines = result.trim().split('\n').filter(l => l.includes(`LISTENING`));
-                if (!lines.length) return false;
-                pid = lines[0].trim().split(/\s+/).pop() ?? null;
-            } else {
-                pid = await this.shell.exec(`lsof -t -i:${port}`).catch(() => null);
-            }
-
-            if (!pid?.trim()) return false;
-
-            this.logger.warn(`Port ${port} blocked by PID ${pid.trim()}. Killing...`);
-
-            if (process.platform === 'win32') {
-                await this.shell.exec(`taskkill /F /PID ${pid.trim()}`);
-            } else {
-                await this.shell.exec(`kill -9 ${pid.trim()}`);
-            }
-
-            this.logger.success(`Port ${port} freed.`);
-            return true;
-        } catch (e) {
-            throw new TyrError(`Could not free port: ${port}`, e, 'Check that you have the necessary permissions.');
-        }
-    }
-
-    /**
-     * @method nukeNodeModules
-     * @description Removes node_modules and package-lock.json from the current directory.
-     * Useful for fixing corrupted NPM installations.
-     * @example
-     * await sys.nukeNodeModules();
-     */
-    public async nukeNodeModules(): Promise<void> {
-        this.logger.info('Cleaning up dependencies...');
-        try {
-            if (process.platform === 'win32') {
-                await this.shell.exec('if exist node_modules rmdir /s /q node_modules');
-                await this.shell.exec('if exist package-lock.json del /f /q package-lock.json');
-            } else {
-                await this.shell.exec('rm -rf node_modules package-lock.json');
-            }
-            this.logger.success('node_modules and package-lock.json removed.');
-        } catch (e) {
-            if (e instanceof TyrError) throw e;
-            throw new TyrError('Could not remove node_modules.', e, 'Check write permissions on the current directory.');
-        }
-    }
-}
-
-export const SystemManagerTests = {
-    killPort: { port: 3000 },
-};
+import { ShellManager } from './ShellManager.js';
+import { Logger } from '../core/Logger.js';
+import { TyrError } from '../core/TyrError.js';
+
+/**
+ * @class SystemManager
+ * @description General OS maintenance and cleanup utilities.
+ */
+export class SystemManager {
+    private shell: ShellManager;
+    private logger: Logger;
+
+    constructor(shell: ShellManager, logger: Logger) {
+        this.shell = shell;
+        this.logger = logger;
+    }
+
+    /**
+     * @method killPort
+     * @description Identifies which process is occupying a port and force-kills it.
+     * @param {number|string} port - The port to free (e.g. 3000).
+     * @returns {Promise<boolean>} True if a process was killed, False if the port was already free.
+     * @example
+     * await sys.killPort(8080);
+     */
+    public async killPort(port: number | string): Promise<boolean> {
+        try {
+            let pid: string | null = null;
+
+            if (process.platform === 'win32') {
+                const result = await this.shell.exec(`netstat -ano | findstr :${port}`).catch(() => null);
+                if (!result?.trim()) return false;
+                const lines = result.trim().split('\n').filter(l => l.includes(`LISTENING`));
+                if (!lines.length) return false;
+                pid = lines[0].trim().split(/\s+/).pop() ?? null;
+            } else {
+                pid = await this.shell.exec(`lsof -t -i:${port}`).catch(() => null);
+            }
+
+            if (!pid?.trim()) return false;
+
+            this.logger.warn(`Port ${port} blocked by PID ${pid.trim()}. Killing...`);
+
+            if (process.platform === 'win32') {
+                await this.shell.exec(`taskkill /F /PID ${pid.trim()}`);
+            } else {
+                await this.shell.exec(`kill -9 ${pid.trim()}`);
+            }
+
+            this.logger.success(`Port ${port} freed.`);
+            return true;
+        } catch (e) {
+            throw new TyrError(`Could not free port: ${port}`, e, 'Check that you have the necessary permissions.');
+        }
+    }
+
+    /**
+     * @method nukeNodeModules
+     * @description Removes node_modules and package-lock.json from the current directory.
+     * Useful for fixing corrupted NPM installations.
+     * @example
+     * await sys.nukeNodeModules();
+     */
+    public async nukeNodeModules(): Promise<void> {
+        this.logger.info('Cleaning up dependencies...');
+        try {
+            if (process.platform === 'win32') {
+                await this.shell.exec('if exist node_modules rmdir /s /q node_modules');
+                await this.shell.exec('if exist package-lock.json del /f /q package-lock.json');
+            } else {
+                await this.shell.exec('rm -rf node_modules package-lock.json');
+            }
+            this.logger.success('node_modules and package-lock.json removed.');
+        } catch (e) {
+            if (e instanceof TyrError) throw e;
+            throw new TyrError('Could not remove node_modules.', e, 'Check write permissions on the current directory.');
+        }
+    }
+}
+
+export const SystemManagerTests = {
+    killPort: { port: 3000 },
+};

package/src/lib/WebManager.ts

@@ -1,62 +1,62 @@
-import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
-import * as cheerio from 'cheerio';
-
-import { Logger } from '../core/Logger.js';
-import { TyrError } from '../core/TyrError.js';
-
-/**
- * @class WebManager
- * @description Utilities for accessing APIs and the Internet.
- */
-export class WebManager {
-    private logger: Logger;
-
-    constructor(logger: Logger) {
-        this.logger = logger;
-    }
-
-    private async fetch(url: string, config?: AxiosRequestConfig): Promise<cheerio.CheerioAPI> {
-        try {
-            const response: AxiosResponse<string> = await axios.get(url, config);
-            return cheerio.load(response.data);
-        } catch (e) {
-            throw new TyrError(`Could not fetch URL: ${url}`, e, 'Check your internet connection and that the URL is valid.');
-        }
-    }
-
-    /**
-     * @method selectFromWeb
-     * @description Selects elements from a web page using a CSS selector.
-     * @param {string} url - URL of the page to scrape.
-     * @param {Function} selector - CSS selector function.
-     * @returns {Promise<string[]>} List of extracted text values.
-     * @example
-     * const titles = await web.selectFromWeb('https://example.com', ($) => $('h1'));
-     */
-    public async selectFromWeb(url: string, selector: ($: cheerio.CheerioAPI) => cheerio.Cheerio<any>): Promise<string[]> {
-        try {
-            const $ = await this.fetch(url);
-            const results: string[] = [];
-            const selection = selector($);
-
-            if (typeof selection === 'string') return [selection];
-
-            selection.each((_, element) => {
-                const text = $(element).text().trim();
-                if (text) results.push(text);
-            });
-
-            return results;
-        } catch (e) {
-            if (e instanceof TyrError) throw e;
-            throw new TyrError(`Could not select content from: ${url}`, e);
-        }
-    }
-}
-
-export const WebManagerTests = {
-    selectFromWeb: {
-        url: 'https://www.w3schools.com/',
-        selector: ($: any) => $('title'),
-    },
-};
+import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
+import * as cheerio from 'cheerio';
+
+import { Logger } from '../core/Logger.js';
+import { TyrError } from '../core/TyrError.js';
+
+/**
+ * @class WebManager
+ * @description Utilities for accessing APIs and the Internet.
+ */
+export class WebManager {
+    private logger: Logger;
+
+    constructor(logger: Logger) {
+        this.logger = logger;
+    }
+
+    private async fetch(url: string, config?: AxiosRequestConfig): Promise<cheerio.CheerioAPI> {
+        try {
+            const response: AxiosResponse<string> = await axios.get(url, config);
+            return cheerio.load(response.data);
+        } catch (e) {
+            throw new TyrError(`Could not fetch URL: ${url}`, e, 'Check your internet connection and that the URL is valid.');
+        }
+    }
+
+    /**
+     * @method selectFromWeb
+     * @description Selects elements from a web page using a CSS selector.
+     * @param {string} url - URL of the page to scrape.
+     * @param {Function} selector - CSS selector function.
+     * @returns {Promise<string[]>} List of extracted text values.
+     * @example
+     * const titles = await web.selectFromWeb('https://example.com', ($) => $('h1'));
+     */
+    public async selectFromWeb(url: string, selector: ($: cheerio.CheerioAPI) => cheerio.Cheerio<any>): Promise<string[]> {
+        try {
+            const $ = await this.fetch(url);
+            const results: string[] = [];
+            const selection = selector($);
+
+            if (typeof selection === 'string') return [selection];
+
+            selection.each((_, element) => {
+                const text = $(element).text().trim();
+                if (text) results.push(text);
+            });
+
+            return results;
+        } catch (e) {
+            if (e instanceof TyrError) throw e;
+            throw new TyrError(`Could not select content from: ${url}`, e);
+        }
+    }
+}
+
+export const WebManagerTests = {
+    selectFromWeb: {
+        url: 'https://www.w3schools.com/',
+        selector: ($: any) => $('title'),
+    },
+};