openapi-filter.js

#!/usr/bin/env node

'use strict';

const fs = require('fs');
const yaml = require('yaml');
const openapiFilter = require('./index.js');

let argv = require('yargs')
    .usage('$0 <infile> [outfile]')
    .demand(1)
    .strict()
    .boolean('info')
    .describe('info','include complete info object with --valid')
    .boolean('inverse')
    .describe('inverse','output filtered elements only')
    .alias('inverse','i')
    .boolean('servers')
    .describe('servers','include complete servers object with --valid')
    .array('flags')
    .alias('flags','f')
    .describe('flags','flags to filter by')
    .default('flags',['x-internal'])
    .array('flagValues')
    .alias('flagValues', 'v')
    .describe('flagValues', 'flag string values to consider as a filter match (in addition to matching on boolean types)')
    .default('flagValues', [])
    .boolean('checkTags')
    .describe('checkTags', 'filter if flags given in --flags are in the tags array')
    .array('overrides')
    .alias('overrides','o')
    .default('overrides', [])
    .describe('overrides', 'prefixes used to override named properties')
    .boolean('valid')
    .describe('valid', 'try to ensure inverse output is valid')
    .boolean('strip')
    .alias('strip','s')
    .describe('strip','strip the flags from the finished product')
    .number('lineWidth')
    .alias('lineWidth','l')
    .describe('lineWidth','max line width of yaml output')
    .default('lineWidth',0)
    .number('maxAliasCount')
    .default('maxAliasCount',100)
    .describe('maxAliasCount','maximum YAML aliases allowed')
    .alias('configFile', 'c')
    .describe('configFile', 'The file & path for the filter options')
    .count('verbose')
    .describe('verbose', 'Output more details of the filter process.')
    .help()
    .version()
    .argv;

// Helper function to display info message, depending on the verbose level
function info(msg) {
    if (argv.verbose >= 1) {
        console.warn(msg);
    }
}

info('=== Document filtering started ===\n')

// apply options from config file if present
if (argv && argv.configFile) {
    info('Config File: ' + argv.configFile)
    try {
        let configFileOptions = {}
        if (argv.configFile.indexOf('.json')>=0) {
            configFileOptions = JSON.parse(fs.readFileSync(argv.configFile, 'utf8'));
        } else {
            configFileOptions = yaml.parse(fs.readFileSync(argv.configFile, 'utf8'), {schema:'core'});
        }
        argv = Object.assign({}, argv, configFileOptions);
    } catch (err) {
        console.error(err)
    }
}

const infile = argv._[0];
const outfile = argv._[1];
info('Input file: ' + infile)

let s = fs.readFileSync(infile,'utf8');
let obj = yaml.parse(s, {maxAliasCount: argv.maxAliasCount});
let res = openapiFilter.filter(obj,argv);
if (infile.indexOf('.json')>=0) {
    s = JSON.stringify(res,null,2);
}
else {
    s = yaml.stringify(res, {lineWidth: argv.lineWidth});
}
if (outfile) {
    fs.writeFileSync(outfile,s,'utf8');

    info('Output file: ' + outfile)
}
else {
    console.log(s);
}

info('\n✅ Document was filtered successfully')