@codifycli/plugin-core 1.0.0-beta1

package/dist/utils/codify-spawn.js

@@ -0,0 +1,136 @@
+import { Ajv } from 'ajv';
+import { MessageCmd, SudoRequestResponseDataSchema } from 'codify-schemas';
+import { nanoid } from 'nanoid';
+import { spawn } from 'node:child_process';
+import stripAnsi from 'strip-ansi';
+import { VerbosityLevel } from './utils.js';
+import { SudoError } from '../errors.js';
+const ajv = new Ajv({
+    strict: true,
+});
+const validateSudoRequestResponse = ajv.compile(SudoRequestResponseDataSchema);
+export var SpawnStatus;
+(function (SpawnStatus) {
+    SpawnStatus["SUCCESS"] = "success";
+    SpawnStatus["ERROR"] = "error";
+})(SpawnStatus || (SpawnStatus = {}));
+/**
+ *
+ * @param cmd Command to run. Ex: `rm -rf`
+ * @param opts Standard options for node spawn. Additional argument:
+ * throws determines if a shell will throw a JS error. Defaults to true
+ *
+ * @see promiseSpawn
+ * @see spawn
+ *
+ * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
+ */
+export async function codifySpawn(cmd, opts) {
+    const throws = opts?.throws ?? true;
+    console.log(`Running command: ${cmd}` + (opts?.cwd ? `(${opts?.cwd})` : ''));
+    try {
+        // TODO: Need to benchmark the effects of using sh vs zsh for shell.
+        //  Seems like zsh shells run slower
+        const result = await (opts?.requiresRoot
+            ? externalSpawnWithSudo(cmd, opts)
+            : internalSpawn(cmd, opts ?? {}));
+        if (result.status !== SpawnStatus.SUCCESS) {
+            throw new Error(result.data);
+        }
+        return result;
+    }
+    catch (error) {
+        if (isDebug()) {
+            console.error(`CodifySpawn error for command ${cmd}`, error);
+        }
+        // @ts-ignore
+        if (error.message?.startsWith('sudo:')) {
+            throw new SudoError(cmd);
+        }
+        if (throws) {
+            throw error;
+        }
+        if (error instanceof Error) {
+            return {
+                status: SpawnStatus.ERROR,
+                data: error.message,
+            };
+        }
+        return {
+            status: SpawnStatus.ERROR,
+            data: String(error),
+        };
+    }
+}
+async function internalSpawn(cmd, opts) {
+    return new Promise((resolve) => {
+        const output = [];
+        // If TERM_PROGRAM=Apple_Terminal is set then ANSI escape characters may be included
+        // in the response.
+        const env = { ...process.env, ...opts.env, TERM_PROGRAM: 'codify', COMMAND_MODE: 'unix2003', COLORTERM: 'truecolor' };
+        const shell = getDefaultShell();
+        const rcFile = shell === 'zsh' ? '~/.zshrc' : '~/.bashrc';
+        // Source start up shells to emulate a users environment vs. a non-interactive non-login shell script
+        // Ignore all stdin
+        // If tty is requested then we'll need to sleep 1 to avoid race conditions. This is because if the terminal updates async after the tty message is
+        // displayed then it'll disappear. By adding sleep 1 it'll allow ink.js to finish all the updates before the tty message is shown
+        const _process = spawn(`source ${rcFile}; ${opts.requestsTTY ? 'sleep 1;' : ''}${cmd}`, [], {
+            ...opts,
+            stdio: ['ignore', 'pipe', 'pipe'],
+            shell,
+            env
+        });
+        const { stdout, stderr, stdin } = _process;
+        stdout.setEncoding('utf8');
+        stderr.setEncoding('utf8');
+        stdout.on('data', (data) => {
+            output.push(data.toString());
+        });
+        stderr.on('data', (data) => {
+            output.push(data.toString());
+        });
+        _process.on('error', (data) => { });
+        // please node that this is not a full replacement for 'inherit'
+        // the child process can and will detect if stdout is a pty and change output based on it
+        // the terminal context is lost & ansi information (coloring) etc will be lost
+        if (stdout && stderr && VerbosityLevel.get() > 0) {
+            stdout.pipe(process.stdout);
+            stderr.pipe(process.stderr);
+        }
+        _process.on('close', (code) => {
+            resolve({
+                status: code === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
+                data: stripAnsi(output.join('\n')),
+            });
+        });
+    });
+}
+async function externalSpawnWithSudo(cmd, opts) {
+    return new Promise((resolve) => {
+        const requestId = nanoid(8);
+        const listener = (data) => {
+            if (data.requestId === requestId) {
+                process.removeListener('message', listener);
+                if (!validateSudoRequestResponse(data.data)) {
+                    throw new Error(`Invalid response for sudo request: ${JSON.stringify(validateSudoRequestResponse.errors, null, 2)}`);
+                }
+                resolve(data.data);
+            }
+        };
+        process.on('message', listener);
+        process.send({
+            cmd: MessageCmd.SUDO_REQUEST,
+            data: {
+                command: cmd,
+                options: opts ?? {},
+            },
+            requestId
+        });
+    });
+}
+export function isDebug() {
+    return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
+}
+function getDefaultShell() {
+    return process.platform === 'darwin' ? 'zsh' : 'bash';
+}

package/dist/utils/debug.d.ts

@@ -0,0 +1,2 @@
+export declare function debugLog(message: any): void;
+export declare function debugWrite(message: any): void;

package/dist/utils/debug.js

@@ -0,0 +1,10 @@
+export function debugLog(message) {
+    if (process.env.DEBUG) {
+        console.log(message);
+    }
+}
+export function debugWrite(message) {
+    if (process.env.DEBUG) {
+        process.stdout.write(message);
+    }
+}

package/dist/utils/file-utils.d.ts

@@ -0,0 +1,23 @@
+export declare class FileUtils {
+    static downloadFile(url: string, destination: string): Promise<void>;
+    static addToShellRc(line: string): Promise<void>;
+    static addAllToShellRc(lines: string[]): Promise<void>;
+    /**
+     * This method adds a directory path to the shell rc file if it doesn't already exist.
+     *
+     * @param value - The directory path to add.
+     * @param prepend - Whether to prepend the path to the existing PATH variable.
+     */
+    static addPathToShellRc(value: string, prepend: boolean): Promise<void>;
+    static removeFromFile(filePath: string, search: string): Promise<void>;
+    static removeLineFromFile(filePath: string, search: RegExp | string): Promise<void>;
+    static removeLineFromShellRc(search: RegExp | string): Promise<void>;
+    static removeAllLinesFromShellRc(searches: Array<RegExp | string>): Promise<void>;
+    static appendToFileWithSpacing(file: string, textToInsert: string): string;
+    static dirExists(path: string): Promise<boolean>;
+    static fileExists(path: string): Promise<boolean>;
+    static exists(path: string): Promise<boolean>;
+    static checkDirExistsOrThrowIfFile(path: string): Promise<boolean>;
+    static createDirIfNotExists(path: string): Promise<void>;
+    private static calculateEndingNewLines;
+}

package/dist/utils/file-utils.js

@@ -0,0 +1,186 @@
+import * as fsSync from 'node:fs';
+import * as fs from 'node:fs/promises';
+import path from 'node:path';
+import { Readable } from 'node:stream';
+import { finished } from 'node:stream/promises';
+import { Utils } from './index.js';
+const SPACE_REGEX = /^\s*$/;
+export class FileUtils {
+    static async downloadFile(url, destination) {
+        console.log(`Downloading file from ${url} to ${destination}`);
+        const { body } = await fetch(url);
+        const dirname = path.dirname(destination);
+        if (!await fs.stat(dirname).then((s) => s.isDirectory()).catch(() => false)) {
+            await fs.mkdir(dirname, { recursive: true });
+        }
+        const ws = fsSync.createWriteStream(destination);
+        // Different type definitions here for readable stream (NodeJS vs DOM). Small hack to fix that
+        await finished(Readable.fromWeb(body).pipe(ws));
+        console.log(`Finished downloading to ${destination}`);
+    }
+    static async addToShellRc(line) {
+        const lineToInsert = addLeadingSpacer(addTrailingSpacer(line));
+        await fs.appendFile(Utils.getPrimaryShellRc(), lineToInsert);
+        function addLeadingSpacer(line) {
+            return line.startsWith('\n')
+                ? line
+                : '\n' + line;
+        }
+        function addTrailingSpacer(line) {
+            return line.endsWith('\n')
+                ? line
+                : line + '\n';
+        }
+    }
+    static async addAllToShellRc(lines) {
+        const formattedLines = '\n' + lines.join('\n') + '\n';
+        const shellRc = Utils.getPrimaryShellRc();
+        console.log(`Adding to ${path.basename(shellRc)}:
+${lines.join('\n')}`);
+        await fs.appendFile(shellRc, formattedLines);
+    }
+    /**
+     * This method adds a directory path to the shell rc file if it doesn't already exist.
+     *
+     * @param value - The directory path to add.
+     * @param prepend - Whether to prepend the path to the existing PATH variable.
+     */
+    static async addPathToShellRc(value, prepend) {
+        if (await Utils.isDirectoryOnPath(value)) {
+            return;
+        }
+        const shellRc = Utils.getPrimaryShellRc();
+        console.log(`Saving path: ${value} to ${shellRc}`);
+        if (prepend) {
+            await fs.appendFile(shellRc, `\nexport PATH=$PATH:${value};`, { encoding: 'utf8' });
+            return;
+        }
+        await fs.appendFile(shellRc, `\nexport PATH=${value}:$PATH;`, { encoding: 'utf8' });
+    }
+    static async removeFromFile(filePath, search) {
+        const contents = await fs.readFile(filePath, 'utf8');
+        const newContents = contents.replaceAll(search, '');
+        await fs.writeFile(filePath, newContents, 'utf8');
+    }
+    static async removeLineFromFile(filePath, search) {
+        const file = await fs.readFile(filePath, 'utf8');
+        const lines = file.split('\n');
+        let searchRegex;
+        let searchString;
+        if (typeof search === 'object') {
+            const startRegex = /^([\t ]*)?/;
+            const endRegex = /([\t ]*)?/;
+            // Augment regex with spaces criteria to make sure this function is not deleting lines that are comments or has other content.
+            searchRegex = search
+                ? new RegExp(startRegex.source + search.source + endRegex.source, search.flags)
+                : search;
+        }
+        if (typeof search === 'string') {
+            searchString = search;
+        }
+        for (let counter = lines.length; counter >= 0; counter--) {
+            if (!lines[counter]) {
+                continue;
+            }
+            if (searchString && lines[counter].includes(searchString)) {
+                lines.splice(counter, 1);
+                continue;
+            }
+            if (searchRegex && lines[counter].search(searchRegex) !== -1) {
+                lines.splice(counter, 1);
+            }
+        }
+        await fs.writeFile(filePath, lines.join('\n'));
+        console.log(`Removed line: ${search} from ${filePath}`);
+    }
+    static async removeLineFromShellRc(search) {
+        return FileUtils.removeLineFromFile(Utils.getPrimaryShellRc(), search);
+    }
+    static async removeAllLinesFromShellRc(searches) {
+        for (const search of searches) {
+            await FileUtils.removeLineFromFile(Utils.getPrimaryShellRc(), search);
+        }
+    }
+    // Append the string to the end of a file ensuring at least 1 lines of space between.
+    // Ex result:
+    // something something;
+    //
+    // newline;
+    static appendToFileWithSpacing(file, textToInsert) {
+        const lines = file.trimEnd().split(/\n/);
+        if (lines.length === 0) {
+            return textToInsert;
+        }
+        const endingNewLines = FileUtils.calculateEndingNewLines(lines);
+        const numNewLines = endingNewLines === -1
+            ? 0
+            : Math.max(0, 2 - endingNewLines);
+        return lines.join('\n') + '\n'.repeat(numNewLines) + textToInsert;
+    }
+    static async dirExists(path) {
+        let stat;
+        try {
+            stat = await fs.stat(path);
+            return stat.isDirectory();
+        }
+        catch {
+            return false;
+        }
+    }
+    static async fileExists(path) {
+        let stat;
+        try {
+            stat = await fs.stat(path);
+            return stat.isFile();
+        }
+        catch {
+            return false;
+        }
+    }
+    static async exists(path) {
+        try {
+            await fs.stat(path);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    static async checkDirExistsOrThrowIfFile(path) {
+        let stat;
+        try {
+            stat = await fs.stat(path);
+        }
+        catch {
+            return false;
+        }
+        if (stat.isDirectory()) {
+            return true;
+        }
+        throw new Error(`Directory ${path} already exists and is a file`);
+    }
+    static async createDirIfNotExists(path) {
+        if (!fsSync.existsSync(path)) {
+            await fs.mkdir(path, { recursive: true });
+        }
+    }
+    // This is overly complicated but it can be used to insert into any
+    // position in the future
+    static calculateEndingNewLines(lines) {
+        let counter = 0;
+        while (true) {
+            const line = lines.at(-counter - 1);
+            if (!line) {
+                return -1;
+            }
+            if (!SPACE_REGEX.test(line)) {
+                return counter;
+            }
+            counter++;
+            // Short circuit here because we don't need to check over 2;
+            if (counter > 2) {
+                return counter;
+            }
+        }
+    }
+}

package/dist/utils/functions.d.ts

@@ -0,0 +1,12 @@
+import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+export declare function splitUserConfig<T extends StringIndexedObject>(config: ResourceConfig & T): {
+    parameters: T;
+    coreParameters: ResourceConfig;
+};
+export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
+export declare function untildify(pathWithTilde: string): string;
+export declare function tildify(pathWithTilde: string): string;
+export declare function resolvePathWithVariables(pathWithVariables: string): string;
+export declare function addVariablesToPath(pathWithoutVariables: string): string;
+export declare function unhome(pathWithHome: string): string;
+export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;

package/dist/utils/functions.js

@@ -0,0 +1,74 @@
+import os from 'node:os';
+import path from 'node:path';
+export function splitUserConfig(config) {
+    const coreParameters = {
+        type: config.type,
+        ...(config.name ? { name: config.name } : {}),
+        ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
+        ...(config.os ? { os: config.os } : {}),
+    };
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { type, name, dependsOn, os, ...parameters } = config;
+    return {
+        parameters: parameters,
+        coreParameters,
+    };
+}
+export function setsEqual(set1, set2) {
+    return set1.size === set2.size && [...set1].every((v) => set2.has(v));
+}
+const homeDirectory = os.homedir();
+export function untildify(pathWithTilde) {
+    return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
+}
+export function tildify(pathWithTilde) {
+    return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
+}
+export function resolvePathWithVariables(pathWithVariables) {
+    return pathWithVariables.replace(/\$([A-Z_]+[A-Z0-9_]*)|\${([A-Z0-9_]*)}/ig, (_, a, b) => process.env[a || b]);
+}
+export function addVariablesToPath(pathWithoutVariables) {
+    let result = pathWithoutVariables;
+    for (const [key, value] of Object.entries(process.env)) {
+        if (!value || !path.isAbsolute(value) || value === '/' || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
+            continue;
+        }
+        result = result.replaceAll(value, `$${key}`);
+    }
+    return result;
+}
+export function unhome(pathWithHome) {
+    return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
+}
+export function areArraysEqual(isElementEqual, desired, current) {
+    if (!desired || !current) {
+        return false;
+    }
+    if (!Array.isArray(desired) || !Array.isArray(current)) {
+        throw new Error(`A non-array value:
+          
+Desired: ${JSON.stringify(desired, null, 2)}
+
+Current: ${JSON.stringify(desired, null, 2)}
+
+Was provided even though type array was specified.
+`);
+    }
+    if (desired.length !== current.length) {
+        return false;
+    }
+    const desiredCopy = [...desired];
+    const currentCopy = [...current];
+    // Algorithm for to check equality between two un-ordered; un-hashable arrays using
+    // an isElementEqual method. Time: O(n^2)
+    for (let counter = desiredCopy.length - 1; counter >= 0; counter--) {
+        const idx = currentCopy.findIndex((e2) => (isElementEqual
+            ?? ((a, b) => a === b))(desiredCopy[counter], e2));
+        if (idx === -1) {
+            return false;
+        }
+        desiredCopy.splice(counter, 1);
+        currentCopy.splice(idx, 1);
+    }
+    return currentCopy.length === 0;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,46 @@
+import { LinuxDistro, OS } from 'codify-schemas';
+export declare function isDebug(): boolean;
+export declare enum Shell {
+    ZSH = "zsh",
+    BASH = "bash",
+    SH = "sh",
+    KSH = "ksh",
+    CSH = "csh",
+    FISH = "fish"
+}
+export interface SystemInfo {
+    os: OS;
+    shell: Shell;
+}
+export declare const Utils: {
+    getUser(): string;
+    getSystemInfo(): {
+        os: string;
+        shell: Shell | undefined;
+    };
+    isMacOS(): boolean;
+    isLinux(): boolean;
+    isArmArch(): Promise<boolean>;
+    isHomebrewInstalled(): Promise<boolean>;
+    isRosetta2Installed(): Promise<boolean>;
+    getShell(): Shell | undefined;
+    getPrimaryShellRc(): string;
+    getShellRcFiles(): string[];
+    isDirectoryOnPath(directory: string): Promise<boolean>;
+    assertBrewInstalled(): Promise<void>;
+    /**
+     * Installs a package via the system package manager. This will use Homebrew on macOS and apt on Ubuntu/Debian or dnf on Fedora.
+     * @param packageName
+     */
+    installViaPkgMgr(packageName: string): Promise<void>;
+    uninstallViaPkgMgr(packageName: string): Promise<boolean>;
+    getLinuxDistro(): Promise<LinuxDistro | undefined>;
+    isUbuntu(): Promise<boolean>;
+    isDebian(): Promise<boolean>;
+    isArch(): Promise<boolean>;
+    isCentOS(): Promise<boolean>;
+    isFedora(): Promise<boolean>;
+    isRHEL(): Promise<boolean>;
+    isDebianBased(): boolean;
+    isRedhatBased(): boolean;
+};