sc4/lib/cli/commands/interactive-command.js

A command line utility for automating SimCity 4 modding tasks & modifying savegames

// # interactive.js
import fs from 'node:fs';
import path from 'node:path';
import chalk from 'chalk';
import * as commands from '#cli/commands';
import * as prompts from '#cli/prompts';
import * as flows from '#cli/flows';
import config from '#cli/config.js';
import args from '#cli/args.js';
import version from '#cli/version.js';
// The default command when the program is used without any options. In this 
// case we fire up an inquirer session to ask the user what they want to do. 
// This way, when hitting the .exe, something useful appears at leat.
export async function interactive() {
    let error = true;
    while (error) {
        error = null;
        try {
            let i = 0;
            while (await start(i++))
                ;
        }
        catch (e) {
            if (e.name !== 'ExitPromptError') {
                console.error(chalk.red('ERROR'), e);
                error = e;
            }
            else {
                exit();
            }
        }
    }
}
// # start()
async function start(n) {
    // Default commands.
    let choices = [
        {
            name: 'Growify RCI',
            type: 'city',
            async value() {
                let args = await flows.growify();
                if (!args)
                    return;
                await commands.growify(...args);
            },
        },
        {
            name: 'Make buildings historical',
            type: 'city',
            async value() {
                let args = await flows.historical();
                if (!args)
                    return;
                await commands.historical(...args);
            },
        },
        {
            name: 'Create an optimal pipe layout',
            type: 'city',
            async value() {
                let args = await flows.pipes();
                if (!args)
                    return;
                await commands.pipes(...args);
            },
        },
        {
            name: 'Add lots to a submenu',
            type: 'dat',
            async value() {
                await commands.submenu(...await flows.submenu());
            },
        },
        {
            name: 'Create a new submenu',
            type: 'png',
            async value() {
                let args = await flows.newSubmenu();
                let { button } = await commands.newSubmenu(...args);
                // Store the newly generate button in the config.
                let menus = config.get('menus') || [];
                menus.push(button);
                config.set('menus', menus);
            },
        },
        {
            name: 'Scan plugins for submenus',
            async value() {
                await commands.scanForMenus(...await flows.scanForMenus());
            },
        },
        {
            name: 'Change a menu icon',
            type: 'dat',
            async value() {
                await flows.changeIcon();
            },
        },
        {
            name: 'Track dependencies',
            type: 'dat',
            async value() {
                await flows.pluginsTrack();
            },
        },
        {
            name: 'Datpack sc4pac plugins',
            async value() {
                let args = await flows.datpack();
                if (!args)
                    return;
                await commands.pluginsDatpack(...args);
            },
        },
        {
            name: 'Plop all lots of a collection',
            type: 'city',
            async value() {
                let args = await flows.plopAll();
                if (!args)
                    return;
                await commands.plopAll(...args);
            },
        },
        {
            name: 'Edit sc4 configuration file',
            async value() {
                await commands.config();
            },
        },
    ];
    // If the program was called with an existing SimCity 4 savegame, we'll 
    // limit the possible options shown to the city related commands.
    let message = 'What do you want to do?';
    let [file] = args;
    if (file && fs.existsSync(file)) {
        let ext = path.extname(file);
        if (ext === '.sc4') {
            choices = choices.filter(choice => choice.type === 'city');
            message = `What do you want to do with ${chalk.cyan(path.basename(file))}?`;
        }
        else if (ext === '.png') {
            choices = choices.filter(choice => choice.type === 'png');
            message = `What do you want to do with ${chalk.cyan(path.basename(file))}?`;
        }
        else if (ext.match(/^\.(dat|sc4.*)/i)) {
            choices = choices.filter(choice => choice.type === 'dat');
            message = `What do you want to do with ${chalk.cyan(path.basename(file))}?`;
        }
    }
    if (n === 0) {
        console.log(chalk.greenBright(`sc4 ${version}`) + '\n');
        choices.push(new prompts.Separator());
        choices.push({ name: 'Quit', value: 'quit' });
    }
    else {
        choices.unshift(new prompts.Separator());
        choices.unshift({ name: 'Quit', value: 'quit' });
    }
    let action = await prompts.select({
        message,
        choices,
        pageSize: choices.length,
    });
    // Perform the action and then return to start. If we want to quit, return 
    // false to break the loop.
    if (action === 'quit') {
        exit();
        return false;
    }
    await action();
    return true;
}
async function exit() {
    console.log(chalk.cyan('Bye'));
}