yini-cli/dist/index.js

CLI for parsing and validating YINI config files: type-safe values, nested sections, comments, minimal syntax noise, and optional strict mode.

#!/usr/bin/env node
// (!) NOTE: Leave above shebang as first line!
// import pkg from '../package.json'
import { createRequire } from 'module';
import { Command } from 'commander';
import { printInfo } from './commands/info.js';
import { parseFile } from './commands/parse.js';
import { validateFile } from './commands/validate.js';
import { isDebug, isDev } from './config/env.js';
import { descriptions as descr } from './descriptions.js';
import { debugPrint, toPrettyJSON } from './utils/print.js';
const require = createRequire(import.meta.url);
const pkg = require('../package.json');
const program = new Command();
/*

Idea/suggestion
yini [parse] [--strict] [--pretty] [--output]

Current suggestion:
* yini parse config.yini
    JS-style object using printObject()
    to stdout
* yini parse config.yini --pretty
    Pretty JSON	using JSON.stringify(obj, null, 4)
    to stdout
* yini parse config.yini --output out.txt
    JS-style object
    to out.txt
* yini parse config.yini --pretty --output out.json
    Pretty JSON
    to out.json

New suggestion:
Current suggestion:
* yini parse config.yini
    JS-style object using printObject(obj) (using using util.inspect)
    to stdout
* yini parse config.yini --pretty
    Pretty JSON	using JSON.stringify(obj, null, 4) (formatted, readable)
    to stdout
* yini parse config.yini --log
    Intended for quick output using console.log (nested object may get compacted/abbreviate)
    to stdout
* yini parse config.yini --json
    Stringigies JSON using using JSON.stringify(obj) (compact, machine-parseable)
    to stdout
* yini parse config.yini --output out.txt
    JS-style object
    to out.txt
* yini parse config.yini --pretty --output out.json
    Pretty JSON
    to out.json

*/
// Display help for command
program
    .name('yini')
    .description(descr.yini)
    // Below will replace all auto-registered items (especially the descriptions starting with a capital and ending with a period).
    .version(pkg.version, '-v, --version', 'Output the version number.')
    .helpOption('-h, --help', 'Display help for command.')
    .helpCommand('help [command]', 'Display help for command.');
program.addHelpText('before', `YINI CLI (Yet another INI)

For parsing and validating YINI configuration files.
A config format, inspired by INI, with type-safe values, nested
sections, comments, minimal syntax noise, and optional strict mode.

Designed for clarity and consistency. :)\n`);
program.addHelpText('after', `
Examples:
  $ yini parse config.yini
  $ yini validate config.yini --strict
  $ yini parse config.yini --pretty --output out.json

Example of "config.yini":
    ^ App
    title = 'My App'
    items = 10
    debug = ON

    ^ Server
    host = 'localhost'
    port = 8080
    useTLS = OFF

        // Sub-section of Server.
        ^^ Login
        username = 'user'
        password = 'secret'

More info:
https://github.com/YINI-lang/yini-cli

Into to YINI Config:
https://github.com/YINI-lang/YINI-spec/blob/develop/Docs/Intro-to-YINI-Config-Format.md`);
//program.command('help [command]').description('Display help for command')
/**
 *
 * Maybe later, to as default command: parse <parse>
 */
// program
//     .argument('<file>', 'File to parse')
//     .option('--strict', 'Parse YINI in strict-mode')
//     .option('--pretty', 'Pretty-print output as JSON')
//     // .option('--log', 'Use console.log output format (compact, quick view)')
//     .option('--json', 'Compact JSON output using JSON.stringify')
//     .option('--output <file>', 'Write output to a specified file')
//     .action((file, options) => {
//         if (file) {
//             parseFile(file, options)
//         } else {
//             program.help()
//         }
//     })
// Explicit "parse" command
program
    .command('parse <file>')
    .description(descr['For-command-parse'])
    .option('--strict', 'Parse YINI in strict-mode.')
    .option('--pretty', 'Pretty-print output as JSON.')
    // .option('--log', 'Use console.log output format (compact, quick view)')
    .option('--json', 'Compact JSON output using JSON.stringify.')
    .option('--output <file>', 'Write output to a specified file.')
    .action((file, options) => {
    debugPrint('Run command "parse"');
    debugPrint('isDebug(): ' + isDebug());
    debugPrint('isDev()  : ' + isDev());
    debugPrint(`<file> = ${file}`);
    if (isDebug()) {
        console.log('options:');
        console.log(toPrettyJSON(options));
    }
    if (file) {
        parseFile(file, options);
    }
    else {
        program.help();
    }
});
/**
 * To handle command validate, e.g.:
 *      yini validate config.yini
 *      yini validate config.yini --strict
 *      yini validate config.yini --details
 *      yini validate config.yini --silent
 *
 * If details:
 * Details:
 * - YINI version: 1.0.0-beta.6
 * - Mode: strict
 * - Keys: 42
 * - Sections: 6
 * - Nesting depth: 3
 * - Has @yini: true
 */
program
    .command('validate <file>')
    .description(descr['For-command-validate'])
    .option('--strict', 'Enable parsing in strict-mode')
    .option('--details', 'Print detailed meta-data info (e.g., key count, nesting, etc.).')
    .option('--silent', 'Suppress output')
    .action((file, options) => {
    //@todo add debugPrint
    if (file) {
        validateFile(file, options);
    }
    else {
        program.help();
    }
});
// Command info
program
    .command('info')
    // .command('')
    .description(descr['For-command-info'])
    // .option('info')
    .action((options) => {
    debugPrint('Run command "info"');
    if (isDebug()) {
        console.log('options:');
        console.log(toPrettyJSON(options));
    }
    printInfo();
});
// NOTE: Converting YINI files to other formats than json and js.
// Other format should go into a new CLI-command called 'yini-convert'.
program.parseAsync();