使用JSON表示命令行参数的好方法是什么?

时间:2013-08-11 21:56:15

标签: javascript node.js npm gruntjs

我正在尝试对grunt-closure-linter npm项目进行改进(所以我实际上可以以高效的方式使用它),而现在我已经坚持使用它了:

我想指定一种方法将选项传递到命令行gjslint,这是Closure Linter的驱动程序。

USAGE: /usr/local/Cellar/python/2.7.5/Frameworks/Python.framework/Versions/2.7/bin/gjslint [flags]

flags:

closure_linter.checker:
  --closurized_namespaces: Namespace prefixes, used for testing ofgoog.provide/require
    (default: '')
    (a comma separated list)
  --ignored_extra_namespaces: Fully qualified namespaces that should be not be reported as extra
    by the linter.
    (default: '')
    (a comma separated list)

closure_linter.common.simplefileflags:
  -e,--exclude_directories: Exclude the specified directories (only applicable along with -r or
    --presubmit)
    (default: '_demos')
    (a comma separated list)
  -x,--exclude_files: Exclude the specified files
    (default: 'deps.js')
    (a comma separated list)
  -r,--recurse: Recurse in to the subdirectories of the given path;
    repeat this option to specify a list of values

closure_linter.ecmalintrules:
  --custom_jsdoc_tags: Extra jsdoc tags to allow
    (default: '')
    (a comma separated list)

closure_linter.error_check:
  --jslint_error: List of specific lint errors to check. Here is a list of accepted values:
    - all: enables all following errors.
    - blank_lines_at_top_level: validatesnum
...

正如你所看到的,这个东西有很多选择!

grunt任务非常简洁,所以我很快就能找到将其注入命令行的位置以完成此操作,但是我想知道如何最好地转换一个理智的JSON表示,如

{
    "max_line_length": '120',
    "summary": true
}

进入命令行选项字符串:

--max_line_length 120 --summary

甚至不清楚是否有任何标准方式用JSON表示它。我确实发现其他人可能不认为使用值true指定一个简单的无参数参数是合理的。

我想我想我可以回归到一个更明确但不太结构化的

[ "--max_line_length", "120", "--summary" ]

或者其他一些这样的东西,虽然这很难实际考虑我是多么想要避免使用逗号和引号并将其保留为普通字符串。

这应该如何定义?

1 个答案:

答案 0 :(得分:0)

我已经调整了我的模块dargs,它将一个选项对象转换为一个命令行参数数组,用于你的用例。

只需将一个带有camelCased键的对象传递给它,它将完成其余的工作。

function toArgs(options) {
    var args = [];

    Object.keys(options).forEach(function (key) {
        var flag;
        var val = options[key];

        flag = key.replace(/[A-Z]/g, '_$&').toLowerCase();

        if (val === true) {
            args.push('--' + flag);
        }

        if (typeof val === 'string') {
            args.push('--' + flag, val);
        }

        if (typeof val === 'number' && isNaN(val) === false) {
            args.push('--' + flag, '' + val);
        }

        if (Array.isArray(val)) {
            val.forEach(function (arrVal) {
                args.push('--' + flag, arrVal);
            });
        }
    });

    return args;
};

示例:

toArgs({ maxLineLength: 120 });

输出:

['--max_line_length', '120']