standard-engine/index.js

Wrap your standards in a tortilla and cover it in special sauce.

/*! 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) {
      await 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