speccy.js

#!/usr/bin/env node

// @ts-check

'use strict';

const program = require('commander');
const { version } = require('./package.json');
const lint = require('./lint.js');
const resolve = require('./resolve.js');
const serve = require('./serve.js');

function collect(val, item) {
    item.push(val);
    return item;
}

function increaseVerbosity(v, total) {
    return total + 1;
}

program
    .version(version)
    .usage('<command>')
    .option('-c, --config [configFile]', 'config file (containing JSON/YAML). See README for potential values.');

program
    .command('lint [file-or-url]')
    .description('ensure specs are not just valid OpenAPI, but lint against specified rules. If no argument is passed, then standard input will be used (please note that in this case the provided spec must be fully resolved)')
    .option('-q, --quiet', 'reduce verbosity')
    .option('-r, --rules [ruleFile]', 'provide multiple rules files', collect, [])
    .option('-s, --skip [ruleName]', 'provide multiple rules to skip', collect, [])
    .option('-j, --json-schema', 'treat $ref like JSON Schema and convert to OpenAPI Schema Objects (default: false)')
    .option('-v, --verbose', 'increase verbosity', increaseVerbosity, 1)
    .action((specFile, cmd) => {
        lint.command(specFile, cmd)
            .then(() => { process.exit(0) })
            .catch((err) => {
                if (err) {
                    console.error(err.message);
                }
                process.exit(1);
            });
    });

program
    .command('resolve [file-or-url]')
    .description('pull in external $ref files to create one mega-file')
    .option('-o, --output <file>', 'file to output to')
    .option('-q, --quiet', 'reduce verbosity')
    .option('-j, --json-schema', 'treat $ref like JSON Schema and convert to OpenAPI Schema Objects (default: false)')
    .option('-i, --internal-refs', 'resolve internal references (default: false)')
    .option('-v, --verbose', 'increase verbosity', increaseVerbosity, 1)
    .action((specFile, cmd) => {
        resolve.command(specFile, cmd)
            .then(() => { process.exit(0) })
            .catch((err) => {
                if (err) {
                    console.error(err.message);
                }
                process.exit(1);
            });
    });

program
    .command('serve [file-or-url]')
    .description('view specifications in beautiful human readable documentation')
    .option('-p, --port [value]', 'port on which the server will listen (default: 5000)')
    .option('-q, --quiet', 'reduce verbosity')
    .option('-j, --json-schema', 'treat $ref like JSON Schema and convert to OpenAPI Schema Objects (default: false)')
    .option('-v, --verbose', 'increase verbosity', increaseVerbosity, 1)
    // TODO .option('-w, --watch', 'reloading browser on spec file changes')
    .action((specFile, cmd) => {
        serve.command(specFile, cmd)
            .catch((err) => {
                if (err) {
                    console.error(err.message);
                }
                process.exit(1);
            });
    });

program.parse(process.argv);

if (!process.argv.slice(2).length) {
    program.help();
}