Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Clarify the CLIEngine options #10995

Merged
merged 1 commit into from Dec 8, 2018

Commits on Nov 24, 2018

  1. Docs: Clarify the CLIEngine options

    This aims to prevent some of the common pitfalls/points of confusion
    when configuring `CLIEngine`, such as:
    * it not being clear that `baseConfig` supports all of the options
      defined in the `.eslintrc.*` schema, and so can be used for options
      that are not supported as top-level `CLIEngine` arguments such as
      `extends` and `settings.
    * some of the CLIEngine options being named the same or almost the
      same as their `.eslintrc.*` equivalents, but being a different
      data type.
    * it not being clear that CLIEngine silently ignores invalid options
      (which will hopefully be fixed at some point by eslint#10272).
    
    Refs:
    eslint#4402
    eslint#5179
    eslint#6605
    eslint#7247
    eslint#7967
    eslint#10272
    webpack-contrib/eslint-loader#173
    webpack-contrib/eslint-loader#252
    neutrinojs/neutrino#1181
    edmorley committed Nov 24, 2018
    Copy the full SHA
    1a3d550 View commit details
    Browse the repository at this point in the history