smartsh/dist/index.d.mts

Cross-shell command runner enabling Unix-style syntax on any OS.

declare function lintCommand(cmd: string): {
    unsupported: string[];
    suggestions: string[];
};
type ShellType = "bash" | "powershell" | "cmd" | "ash" | "dash" | "zsh" | "fish" | "ksh" | "tcsh";
interface ShellInfo {
    type: ShellType;
    /**
     * Whether this shell natively understands Unix-style conditional connectors (&&, ||).
     */
    supportsConditionalConnectors: boolean;
    /** Only set for PowerShell */
    version?: number | null;
    /**
     * Whether this shell needs Unix command translations
     */
    needsUnixTranslation: boolean;
    /**
     * The target shell for command translations
     */
    targetShell: "powershell" | "cmd" | "bash" | "ash" | "dash" | "zsh" | "fish" | "ksh" | "tcsh";
}
/**
 * Best-effort detection of the current interactive shell and its capabilities.
 * Users can override detection by setting SMARTSH_SHELL=cmd|powershell|bash.
 */
declare function detectShell(): ShellInfo;
/**
 * Translate a Unix-style command string (using && and ||) to something that
 * preserves conditional semantics on shells that *don’t* natively support them
 * (currently: legacy PowerShell < 7).
 */
declare function translateCommand(command: string, shell: ShellInfo): string;
type InputFormat = "unix" | "powershell" | "cmd";
interface InputInfo {
    format: InputFormat;
    command: string;
}
/**
 * Detect the input format of a command
 */
declare function detectInputFormat(command: string): InputFormat;
/**
 * Parse command into InputInfo
 */
declare function parseInput(command: string): InputInfo;

interface BidirectionalMapping {
    unix: string;
    powershell: string;
    cmd: string;
    flagMappings: {
        unix: Record<string, string>;
        powershell: Record<string, string>;
        cmd: Record<string, string>;
    };
    forceArgs?: boolean;
}
declare const POWERSHELL_TO_UNIX_MAPPINGS: BidirectionalMapping[];
declare function getBidirectionalMapping(command: string, sourceFormat: string): BidirectionalMapping | undefined;
declare function translateBidirectional(command: string, sourceFormat: string, targetShell: string, flagTokens: string[], argTokens: string[]): string;

export { type BidirectionalMapping, type InputFormat, type InputInfo, POWERSHELL_TO_UNIX_MAPPINGS, type ShellInfo, type ShellType, detectInputFormat, detectShell, getBidirectionalMapping, lintCommand, parseInput, translateBidirectional, translateCommand };