Function sshCommandToConfig

Extension/src/SSH/sshCommandToConfig.ts:126–168

(command: string, name?: string)

 * Attempts to convert an SSH command to an SSH config entry.
 */
export function sshCommandToConfig(command: string, name?: string): { [key: string]: string } {
    const parts: string[] = parse(command) as string[];

    // ignore 'ssh' if the user entered that as their first word
    if (parts[0] === 'ssh') {
        parts.shift();
    }

    // Once again following what OpenSSH does internally. libc getopt, and our library
    // here, stop when they reach the end of the flags. When that happens we pull
    // out the host if we can, and restart it to try to read any remaining flags.
    const entries: { [key: string]: string } = {};
    for (let offset: number = 0; offset < parts.length; offset++) {
        offset += parseFlags(parts.slice(offset), entries);

        // Only parse the first positional/non-flag argument. The SSH command
        // line allows trailing arguments as commands to execute, but we
        // don't care about those here.
        if (offset < parts.length && !entries.Host) {
            const { hostname, port, username } = parseConnectionString(parts[offset]);
            entries.Host = name || hostname;
            entries.HostName = hostname;

            // In OpenSSH, provided flags take precedence over options in the connection string:
            if (!entries.Port && port) {
                entries.Port = port;
            }
            if (!entries.User && username) {
                entries.User = username;
            }
        }
    }

    if (!entries.Host) {
        throw new CommandParseError('Missing host in SSH connection string');
    }

    // ssh-config requires that the "Host" be the first key in the object
    // in order to nest things correctly. Rewrite the object so that
    // this is the case.
    const { Host, HostName, ...options } = entries;
    return { Host, HostName, ...options };
}

/**
 * Parses flags from the given array of arguments, returning the index of the