@starship-ci/cli/esm/utils.js

Starship CLI

import { defaultStarshipContext } from '@starship-ci/client'; // Adjust the import path as necessary
import chalk from 'chalk';
import { readFileSync } from 'fs';
import * as yaml from 'js-yaml';
import { resolve } from 'path';
import { readAndParsePackageJson } from './package';
// Function to display the version information
export function displayVersion() {
    const pkg = readAndParsePackageJson();
    console.log(chalk.green(`Name: ${pkg.name}`));
    console.log(chalk.blue(`Version: ${pkg.version}`));
}
const resolvePath = (filename) => filename.startsWith('/') ? filename : resolve((process.cwd(), filename));
const loadYaml = (filename) => {
    const path = resolvePath(filename);
    const fileContents = readFileSync(path, 'utf8');
    return yaml.load(fileContents);
};
export const params = [
    'config',
    'name',
    'version',
    'repo',
    'repoUrl',
    'chart',
    'namespace',
    'timeout'
];
export const loadConfig = (argv) => {
    const context = {
        ...defaultStarshipContext
    };
    let starship = {};
    // Override context with command-line arguments dynamically based on StarshipContext keys
    params.forEach((key) => {
        if (argv[key] !== undefined) {
            console.log('argv:', key, ':', argv[key]);
            // @ts-expect-error - dynamic assignment
            context[key] = argv[key];
        }
    });
    if (context.config) {
        context.config = resolvePath(context.config);
        starship = loadYaml(context.config);
    }
    return { context, starship };
};
export const usageText = `
Usage: starship <command> [options]

Commands:
  start              Start the Starship services.
  stop               Remove all components related to the deployment.
  deploy             Deploy starship using specified options or configuration file.
  setup              Setup initial configuration and dependencies.
  start-ports        Start port forwarding for the deployed services.
  stop-ports         Stop port forwarding.
  delete             Delete a specific Helm release.
  get-pods           Get the list of pods for the Helm release.
  clean              Perform a clean operation to tidy up resources.
  version, -v        Display the version of the Starship Client.

Configuration File:
  --config <path>       Specify the path to the configuration file containing the actual config file. Required.
                        Command-line options will override settings from this file if both are provided.

Command-line Options:
  --name <name>     Specify the Helm release name, default: starship.
                        Will overide config file settings for name.
  --version <ver>   Specify the version of the Helm chart, default: v0.2.6.
                        Will overide config file settings for version.
  --timeout <time>  Specify the timeout for the Helm operations, default: 10m.
                        Will overide config file settings for timeout.

Examples:
  $ starship start --config ./config/two-chain.yaml
  $ starship stop --config ./config/two-chain.yaml

If you want to setup starship for the first time
  $ starship setup

If you want to run the deployment step by step
  $ starship deploy --config ./config/two-chain.yaml
  $ starship start-ports --config ./config/two-chain.yaml
  $ starship stop-ports --config ./config/two-chain.yaml
  $ starship delete --config ./config/two-chain.yaml

Additional Help:
  $ starship help          Display this help information.
`;
export function displayUsage() {
    console.log(usageText);
}