@nu-art/commando/tools.js

Shell command execution framework with interactive sessions, CLI parameter resolution, and plugin system for building and executing shell scripts programmatically

/*
 * commando provides shell command execution framework with interactive sessions and plugin system
 *
 * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as path from 'path';
/**
 * Removes ANSI escape codes from a string.
 *
 * Strips color codes and formatting sequences (e.g., `\x1B[31m` for red text)
 * from shell command output. Useful for processing command output that
 * contains terminal formatting.
 *
 * **Regex**: Matches ANSI escape sequences starting with `\x1B[` followed by
 * digits, optional semicolon, more digits, and ending with `m`.
 *
 * @param text - Text containing ANSI escape codes
 * @returns Text with all ANSI codes removed
 */
export function removeAnsiCodes(text) {
    // This regular expression matches the escape codes and removes them
    return text.replace(/\x1B\[\d+;?\d*m/g, '');
}
/**
 * Converts a relative or absolute path to a full absolute path.
 *
 * **Behavior**:
 * - Removes leading slashes (normalizes paths like `/path/to/file`)
 * - Resolves relative to `assetParentPath` (defaults to `process.cwd()`)
 * - Returns a branded `AbsolutePath` type
 *
 * **Note**: The commented-out validation that checks if the resolved path
 * is within `assetParentPath` is disabled. This could be a security concern
 * if used with user-provided paths.
 *
 * @param pathToFile - Path to convert (relative or absolute)
 * @param assetParentPath - Base path for resolution (default: `process.cwd()`)
 * @returns Absolute path as branded type
 * @throws Error if path is not provided or is empty
 */
export function convertToFullPath(pathToFile, assetParentPath = process.cwd()) {
    if (!pathToFile)
        throw new Error('Path not provided');
    if (pathToFile === '')
        throw new Error('Empty path not allowed');
    while (pathToFile.startsWith('/'))
        pathToFile = pathToFile.substring(1);
    const absolutePath = path.resolve(assetParentPath, pathToFile);
    // if (!absolutePath.startsWith(assetParentPath))
    // 	throw new Error(`Found path: '${absolutePath}' which is out of the scope of the assert directory: '${assetParentPath}'`);
    return absolutePath;
}