Blame view
node_modules/eslint/lib/cli.js
6.29 KB
f7563de62
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
/** * @fileoverview Main CLI object. * @author Nicholas C. Zakas */ "use strict"; /* * The CLI object should *not* call process.exit() directly. It should only return * exit codes. This allows other programs to use the CLI object and still control * when the program exits. */ //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ const fs = require("fs"), path = require("path"), shell = require("shelljs"), options = require("./options"), CLIEngine = require("./cli-engine"), mkdirp = require("mkdirp"), log = require("./logging"); const debug = require("debug")("eslint:cli"); //------------------------------------------------------------------------------ // Helpers //------------------------------------------------------------------------------ /** * Translates the CLI options into the options expected by the CLIEngine. * @param {Object} cliOptions The CLI options to translate. * @returns {CLIEngineOptions} The options object for the CLIEngine. * @private */ function translateOptions(cliOptions) { return { envs: cliOptions.env, extensions: cliOptions.ext, rules: cliOptions.rule, plugins: cliOptions.plugin, globals: cliOptions.global, ignore: cliOptions.ignore, ignorePath: cliOptions.ignorePath, ignorePattern: cliOptions.ignorePattern, configFile: cliOptions.config, rulePaths: cliOptions.rulesdir, useEslintrc: cliOptions.eslintrc, parser: cliOptions.parser, parserOptions: cliOptions.parserOptions, cache: cliOptions.cache, cacheFile: cliOptions.cacheFile, cacheLocation: cliOptions.cacheLocation, fix: cliOptions.fix, allowInlineConfig: cliOptions.inlineConfig }; } /** * Outputs the results of the linting. * @param {CLIEngine} engine The CLIEngine to use. * @param {LintResult[]} results The results to print. * @param {string} format The name of the formatter to use or the path to the formatter. * @param {string} outputFile The path for the output file. * @returns {boolean} True if the printing succeeds, false if not. * @private */ function printResults(engine, results, format, outputFile) { let formatter; try { formatter = engine.getFormatter(format); } catch (e) { log.error(e.message); return false; } const output = formatter(results); if (output) { if (outputFile) { const filePath = path.resolve(process.cwd(), outputFile); if (shell.test("-d", filePath)) { log.error("Cannot write to output file path, it is a directory: %s", outputFile); return false; } try { mkdirp.sync(path.dirname(filePath)); fs.writeFileSync(filePath, output); } catch (ex) { log.error("There was a problem writing the output file: %s", ex); return false; } } else { log.info(output); } } return true; } //------------------------------------------------------------------------------ // Public Interface //------------------------------------------------------------------------------ /** * Encapsulates all CLI behavior for eslint. Makes it easier to test as well as * for other Node.js programs to effectively run the CLI. */ const cli = { /** * Executes the CLI based on an array of arguments that is passed in. * @param {string|Array|Object} args The arguments to process. * @param {string} [text] The text to lint (used for TTY). * @returns {int} The exit code for the operation. */ execute(args, text) { let currentOptions; try { currentOptions = options.parse(args); } catch (error) { log.error(error.message); return 1; } const files = currentOptions._; if (currentOptions.version) { // version from package.json log.info(`v${require("../package.json").version}`); } else if (currentOptions.printConfig) { if (files.length) { log.error("The --print-config option must be used with exactly one file name."); return 1; } else if (text) { log.error("The --print-config option is not available for piped-in code."); return 1; } const engine = new CLIEngine(translateOptions(currentOptions)); const fileConfig = engine.getConfigForFile(currentOptions.printConfig); log.info(JSON.stringify(fileConfig, null, " ")); return 0; } else if (currentOptions.help || (!files.length && !text)) { log.info(options.generateHelp()); } else { debug(`Running on ${text ? "text" : "files"}`); // disable --fix for piped-in code until we know how to do it correctly if (text && currentOptions.fix) { log.error("The --fix option is not available for piped-in code."); return 1; } const engine = new CLIEngine(translateOptions(currentOptions)); const report = text ? engine.executeOnText(text, currentOptions.stdinFilename, true) : engine.executeOnFiles(files); if (currentOptions.fix) { debug("Fix mode enabled - applying fixes"); CLIEngine.outputFixes(report); } if (currentOptions.quiet) { debug("Quiet mode enabled - filtering out warnings"); report.results = CLIEngine.getErrorResults(report.results); } if (printResults(engine, report.results, currentOptions.format, currentOptions.outputFile)) { const tooManyWarnings = currentOptions.maxWarnings >= 0 && report.warningCount > currentOptions.maxWarnings; if (!report.errorCount && tooManyWarnings) { log.error("ESLint found too many warnings (maximum: %s).", currentOptions.maxWarnings); } return (report.errorCount || tooManyWarnings) ? 1 : 0; } return 1; } return 0; } }; module.exports = cli; |