All files / standard-engine index.js

98.3% Statements 116/118
41.66% Branches 5/12
100% Functions 4/4
98.3% Lines 116/118

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 1192x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x     2x 2x 2x 2x 2x 2x 2x 2x 2x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 2x 2x 2x 2x  
/*! standard-engine. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
 
const os = require('os')
const path = require('path')
 
const CACHE_HOME = require('xdg-basedir').cache || os.tmpdir()
 
const { resolveEslintConfig } = require('./lib/resolve-eslint-config')
 
/** @typedef {import('eslint').ESLint.Options} EslintOptions */
/** @typedef {Omit<import('./lib/resolve-eslint-config').ResolveOptions, 'cmd'|'cwd'>} BaseLintOptions */
 
/**
 * @typedef StandardEngineOptions
 * @property {string} cmd
 * @property {import('eslint')} eslint
 * @property {string} [cwd]
 * @property {EslintOptions} [eslintConfig]
 * @property {import('./lib/resolve-eslint-config').CustomEslintConfigResolver} [resolveEslintConfig]
 * @property {string} [version]
 */
 
class StandardEngine {
  /**
   * @param {StandardEngineOptions} opts
   */
  constructor (opts) {
    if (!opts || !opts.cmd) throw new Error('opts.cmd option is required')
    if (!opts.eslint) throw new Error('opts.eslint option is required')
 
    /** @type {string} */
    this.cmd = opts.cmd
    /** @type {import('eslint')} */
    this.eslint = opts.eslint
    /** @type {string} */
    this.cwd = opts.cwd || process.cwd()
    this.customEslintConfigResolver = opts.resolveEslintConfig
 
    const m = opts.version && opts.version.match(/^(\d+)\./)
    const majorVersion = (m && m[1]) || '0'
 
    // Example cache location: ~/.cache/standard/v12/
    const cacheLocation = path.join(CACHE_HOME, this.cmd, `v${majorVersion}/`)
 
    /** @type {EslintOptions} */
    this.eslintConfig = {
      cache: true,
      cacheLocation,
      fix: false,
      extensions: [],
      useEslintrc: false,
      ...(opts.eslintConfig || {})
    }
 
    if (this.eslintConfig.overrideConfigFile != null) {
      this.eslintConfig.resolvePluginsRelativeTo = path.dirname(
        this.eslintConfig.overrideConfigFile
      )
    }
  }
 
  /**
   * Lint text to enforce JavaScript Style.
   *
   * @param {string} text file text to lint
   * @param {Omit<BaseLintOptions, 'ignore'|'noDefaultIgnore'> & { filename?: string }} [opts] base options + path of file containing the text being linted
   * @returns {Promise<import('eslint').ESLint.LintResult[]>}
   */
  async lintText (text, { filename: filePath, ...opts } = {}) {
    const eslintConfig = this.resolveEslintConfig(opts)
    const engine = new this.eslint.ESLint(eslintConfig)
    return engine.lintText(text, { filePath })
  }
 
  /**
   * Lint files to enforce JavaScript Style.
   *
   * @param {Array<string>} files file globs to lint
   * @param {BaseLintOptions & { cwd?: string }} [opts] base options + file globs to ignore (has sane defaults) + current working directory (default: process.cwd())
   * @returns {Promise<import('eslint').ESLint.LintResult[]>}
   */
  async lintFiles (files, opts) {
    const eslintConfig = this.resolveEslintConfig(opts)
 
    if (typeof files === 'string') files = [files]
    if (files.length === 0) files = ['.']
 
    const eslintInstance = new this.eslint.ESLint(eslintConfig)
    const result = await eslintInstance.lintFiles(files)
 
    if (eslintConfig.fix) {
      this.eslint.ESLint.outputFixes(result)
    }
 
    return result
  }
 
  /**
   * @param {BaseLintOptions & { cwd?: string }} [opts]
   * @returns {EslintOptions}
   */
  resolveEslintConfig (opts) {
    const eslintConfig = resolveEslintConfig(
      {
        cwd: this.cwd,
        ...opts,
        cmd: this.cmd
      },
      this.eslintConfig,
      this.customEslintConfigResolver
    )
 
    return eslintConfig
  }
}
 
module.exports.cli = require('./bin/cmd')
module.exports.StandardEngine = StandardEngine