eslint/lib/options.js

/**
 * @fileoverview Options configuration for optionator.
 * @author George Zahariev
 */
"use strict";

//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------

var optionator = require("optionator");

//------------------------------------------------------------------------------
// Initialization and Public Interface
//------------------------------------------------------------------------------

// exports "parse(args)", "generateHelp()", and "generateHelpForOption(optionName)"
module.exports = optionator({
    prepend: "eslint [options] file.js [file.js] [dir]",
    concatRepeatedArrays: true,
    mergeRepeatedObjects: true,
    options: [{
        heading: "Options"
    }, {
        option: "help",
        alias: "h",
        type: "Boolean",
        description: "Show help."
    }, {
        option: "config",
        alias: "c",
        type: "path::String",
        description: "Load configuration data from this file."
    }, {
        option: "rulesdir",
        type: "[path::String]",
        description: "Load additional rules from this directory."
    }, {
        option: "format",
        alias: "f",
        type: "String",
        default: "stylish",
        description: "Use a specific output format."
    }, {
        option: "version",
        alias: "v",
        type: "Boolean",
        description: "Outputs the version number."
    }, {
        option: "reset",
        type: "Boolean",
        description: "Set all default rules to off."
    }, {
        option: "eslintrc",
        type: "Boolean",
        default: "true",
        description: "Enable loading .eslintrc configuration."
    }, {
        option: "env",
        type: "[String]",
        description: "Specify environments."
    }, {
        option: "plugin",
        type: "[String]",
        description: "Specify plugins."
    }, {
        option: "global",
        type: "[String]",
        description: "Define global variables."
    },{
        option: "rule",
        type: "Object",
        description: "Specify rules."
    },
    {
        option: "ignore-path",
        type: "path::String",
        description: "Specify the file that contains patterns of files to ignore."
    },
    {
        option: "ignore",
        type: "Boolean",
        default: "true",
        description: "Enable loading of .eslintignore."
    },
    {
        option: "color",
        type: "Boolean",
        default: "true",
        description: "Enable color in piped output."
    },
    {
        option: "output-file",
        alias: "o",
        type: "path::String",
        description: "Enable report to be written to a file."
    }]
});