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.

Sign up for GitHub

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

Jump to bottom

Update: Behavior of --init (fixes #11105) #11332

Merged
merged 7 commits into from Feb 14, 2019
Merged

Update: Behavior of --init (fixes #11105) #11332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aaceefb
Update: Reorder init menu (fixes #11105)
nzakas Jan 16, 2019
eee3b16
Update: Behavior of --init (fixes #11105)
nzakas Jan 29, 2019
ea36bf9
Update Vue settings
nzakas Feb 5, 2019
ea51339
Add missing globals
nzakas Feb 6, 2019
86a5e71
Update names of module options
nzakas Feb 6, 2019
d3b5a00
false -> readonly
nzakas Feb 13, 2019
eae4d1e
Fix package.json merge conflict
nzakas Feb 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
293 changes: 150 additions & 143 deletions lib/config/config-initializer.js
View file
Open in desktop
Expand Up @@ -3,6 +3,7 @@
* @author Ilya Volodin
*/


"use strict";

//------------------------------------------------------------------------------
Expand All @@ -28,6 +29,8 @@ const debug = require("debug")("eslint:config-initializer");
// Private
//------------------------------------------------------------------------------

const DEFAULT_ECMA_VERSION = 2018;

/* istanbul ignore next: hard to test fs function */
/**
* Create .eslintrc file in the current working directory
Expand Down Expand Up @@ -239,43 +242,65 @@ function configureRules(answers, config) {
* @returns {Object} config object
*/
function processAnswers(answers) {
let config = { rules: {}, env: {}, parserOptions: {} };
let config = {
rules: {},
env: {},
parserOptions: {},
extends: []
};

config.parserOptions.ecmaVersion = answers.ecmaVersion;
if (answers.ecmaVersion >= 2015) {
if (answers.modules) {
config.parserOptions.sourceType = "module";
}
config.env.es6 = true;
}
// set the latest ECMAScript version
config.parserOptions.ecmaVersion = DEFAULT_ECMA_VERSION;
config.env.es6 = true;
nzakas marked this conversation as resolved.
Show resolved Hide resolved
config.globals = {
Atomics: "readonly",
SharedArrayBuffer: "readonly"
};

if (answers.commonjs) {
// set the module type
if (answers.moduleType === "esm") {
config.parserOptions.sourceType = "module";
} else if (answers.moduleType === "commonjs") {
config.env.commonjs = true;
}

// add in browser and node environments if necessary
answers.env.forEach(env => {
config.env[env] = true;
});
if (answers.jsx) {
config.parserOptions = config.parserOptions || {};
config.parserOptions.ecmaFeatures = config.parserOptions.ecmaFeatures || {};
config.parserOptions.ecmaFeatures.jsx = true;
if (answers.react) {
config.plugins = ["react"];
config.parserOptions.ecmaVersion = 2018;
}

// add in library information
if (answers.framework === "react") {
config.parserOptions.ecmaFeatures = {
jsx: true
};
config.plugins = ["react"];
} else if (answers.framework === "vue") {
config.plugins = ["vue"];
nzakas marked this conversation as resolved.
Show resolved Hide resolved
config.extends.push("plugin:vue/essential");
}

if (answers.source === "prompt") {
config.extends = "eslint:recommended";
config.rules.indent = ["error", answers.indent];
config.rules.quotes = ["error", answers.quotes];
config.rules["linebreak-style"] = ["error", answers.linebreak];
config.rules.semi = ["error", answers.semi ? "always" : "never"];
// setup rules based on problems/style enforcement preferences
if (answers.purpose === "problems") {
config.extends.unshift("eslint:recommended");
} else if (answers.purpose === "style") {
if (answers.source === "prompt") {
config.extends.unshift("eslint:recommended");
config.rules.indent = ["error", answers.indent];
config.rules.quotes = ["error", answers.quotes];
config.rules["linebreak-style"] = ["error", answers.linebreak];
config.rules.semi = ["error", answers.semi ? "always" : "never"];
} else if (answers.source === "auto") {
config = configureRules(answers, config);
config = autoconfig.extendFromRecommended(config);
}
}

if (answers.source === "auto") {
config = configureRules(answers, config);
config = autoconfig.extendFromRecommended(config);
// normalize extends
if (config.extends.length === 0) {
delete config.extends;
} else if (config.extends.length === 1) {
config.extends = config.extends[0];
}

ConfigOps.normalizeToStrings(config);
Expand Down Expand Up @@ -324,7 +349,7 @@ function getLocalESLintVersion() {
* @returns {string} The shareable config name.
*/
function getStyleGuideName(answers) {
if (answers.styleguide === "airbnb" && !answers.airbnbReact) {
if (answers.styleguide === "airbnb" && answers.framework !== "react") {
return "airbnb-base";
}
return answers.styleguide;
Expand Down Expand Up @@ -417,16 +442,62 @@ function askInstallModules(modules, packageJsonExists) {
function promptUser() {

return inquirer.prompt([
{
type: "list",
name: "purpose",
message: "How would you like to use ESLint?",
default: "problems",
choices: [
{ name: "To check syntax only", value: "syntax" },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the "check syntax only" option is a fairly niche use case -- most projects would benefit from at least using eslint:recommended. Additionally, some users might not understand what "check syntax" means (it means "only report syntax errors" rather than "report bug-prone syntactic patterns"), or they might not have a clear understanding of how syntax errors differ from semantic errors.

In your view, is this preference sufficiently common that it's worth having an option for? I don't feel very strongly about it, but I'd prefer either:

  • Removing it from the --init options, or
  • Moving it to the bottom of the three options here (if we wanted to retain ordering consistency, we could also just reverse the order of these options entirely).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We got some direct feedback a while ago that it wasn't clear ESLint could be used just for syntax checking. While it may be a niche case, I don't think it hurts anything to include it here. This way, new users can easily see that ESLint can be used for a number of different purposes.

I don't see the purpose of reversing the order of the options. Right now, there is a logical progression of options that include more functionality, and either way the common case is in the middle and the default.

As it is, the default selection in this menu is to check syntax and find problems

{ name: "To check syntax and find problems", value: "problems" },
{ name: "To check syntax, find problems, and enforce code style", value: "style" }
]
},
{
type: "list",
name: "moduleType",
message: "What type of modules does your project use?",
default: "esm",
choices: [
{ name: "JavaScript modules (import/export)", value: "esm" },
{ name: "CommonJS (require/exports)", value: "commonjs" },
{ name: "None of these", value: "none" }
]
},
{
type: "list",
name: "framework",
message: "Which framework does your project use?",
not-an-aardvark marked this conversation as resolved.
Show resolved Hide resolved
default: "react",
choices: [
{ name: "React", value: "react" },
{ name: "Vue.js", value: "vue" },
{ name: "None of these", value: "none" }
]
},
{
type: "checkbox",
name: "env",
message: "Where does your code run?",
default: ["browser"],
choices: [
{ name: "Browser", value: "browser" },
{ name: "Node", value: "node" }
not-an-aardvark marked this conversation as resolved.
Show resolved Hide resolved
]
},
{
type: "list",
name: "source",
message: "How would you like to configure ESLint?",
default: "prompt",
message: "How would you like to define a style for your project?",
default: "guide",
choices: [
{ name: "Use a popular style guide", value: "guide" },
{ name: "Answer questions about your style", value: "prompt" },
{ name: "Inspect your JavaScript file(s)", value: "auto" }
]
],
when(answers) {
return answers.purpose === "style";
}
},
{
type: "list",
Expand All @@ -442,15 +513,6 @@ function promptUser() {
return answers.source === "guide" && answers.packageJsonExists;
}
},
{
type: "confirm",
name: "airbnbReact",
message: "Do you use React?",
default: false,
when(answers) {
return answers.styleguide === "airbnb";
}
},
{
type: "input",
name: "patterns",
Expand All @@ -470,10 +532,7 @@ function promptUser() {
name: "format",
message: "What format do you want your config file to be in?",
default: "JavaScript",
choices: ["JavaScript", "YAML", "JSON"],
when(answers) {
return ((answers.source === "guide" && answers.packageJsonExists) || answers.source === "auto");
}
choices: ["JavaScript", "YAML", "JSON"]
},
{
type: "confirm",
Expand All @@ -492,6 +551,15 @@ function promptUser() {
}
]).then(earlyAnswers => {

// early exit if no style guide is necessary
if (earlyAnswers.purpose !== "style") {
const config = processAnswers(earlyAnswers);
const modules = getModulesList(config);

return askInstallModules(modules, earlyAnswers.packageJsonExists)
.then(() => writeFile(config, earlyAnswers.format));
}

// early exit if you are using a style guide
if (earlyAnswers.source === "guide") {
if (!earlyAnswers.packageJsonExists) {
Expand All @@ -501,130 +569,69 @@ function promptUser() {
if (earlyAnswers.installESLint === false && !semver.satisfies(earlyAnswers.localESLintVersion, earlyAnswers.requiredESLintVersionRange)) {
log.info(`Note: it might not work since ESLint's version is mismatched with the ${earlyAnswers.styleguide} config.`);
}
if (earlyAnswers.styleguide === "airbnb" && !earlyAnswers.airbnbReact) {
if (earlyAnswers.styleguide === "airbnb" && earlyAnswers.framework !== "react") {
earlyAnswers.styleguide = "airbnb-base";
}

const config = getConfigForStyleGuide(earlyAnswers.styleguide);
const config = ConfigOps.merge(processAnswers(earlyAnswers), getConfigForStyleGuide(earlyAnswers.styleguide));
const modules = getModulesList(config);

return askInstallModules(modules, earlyAnswers.packageJsonExists)
.then(() => writeFile(config, earlyAnswers.format));

}

// continue with the questions otherwise...
if (earlyAnswers.source === "auto") {
const combinedAnswers = Object.assign({}, earlyAnswers);
const config = processAnswers(combinedAnswers);
const modules = getModulesList(config);

return askInstallModules(modules).then(() => writeFile(config, earlyAnswers.format));
}

// continue with the style questions otherwise...
return inquirer.prompt([
{
type: "list",
name: "ecmaVersion",
message: "Which version of ECMAScript do you use?",
choices: [
{ name: "ES3", value: 3 },
{ name: "ES5", value: 5 },
{ name: "ES2015", value: 2015 },
{ name: "ES2016", value: 2016 },
{ name: "ES2017", value: 2017 },
{ name: "ES2018", value: 2018 }
],
default: 1 // This is the index in the choices list
name: "indent",
message: "What style of indentation do you use?",
default: "tab",
choices: [{ name: "Tabs", value: "tab" }, { name: "Spaces", value: 4 }]
},
{
type: "confirm",
name: "modules",
message: "Are you using ES6 modules?",
default: false,
when(answers) {
return answers.ecmaVersion >= 2015;
}
},
{
type: "checkbox",
name: "env",
message: "Where will your code run?",
default: ["browser"],
choices: [{ name: "Browser", value: "browser" }, { name: "Node", value: "node" }]
type: "list",
name: "quotes",
message: "What quotes do you use for strings?",
default: "double",
choices: [{ name: "Double", value: "double" }, { name: "Single", value: "single" }]
},
{
type: "confirm",
name: "commonjs",
message: "Do you use CommonJS?",
default: false,
when(answers) {
return answers.env.some(env => env === "browser");
}
type: "list",
name: "linebreak",
message: "What line endings do you use?",
default: "unix",
choices: [{ name: "Unix", value: "unix" }, { name: "Windows", value: "windows" }]
},
{
type: "confirm",
name: "jsx",
message: "Do you use JSX?",
default: false
name: "semi",
message: "Do you require semicolons?",
default: true
},
{
type: "confirm",
name: "react",
message: "Do you use React?",
default: false,
when(answers) {
return answers.jsx;
}
}
]).then(secondAnswers => {

// early exit if you are using automatic style generation
if (earlyAnswers.source === "auto") {
const combinedAnswers = Object.assign({}, earlyAnswers, secondAnswers);

const config = processAnswers(combinedAnswers);

const modules = getModulesList(config);

return askInstallModules(modules).then(() => writeFile(config, earlyAnswers.format));
type: "list",
name: "format",
message: "What format do you want your config file to be in?",
default: "JavaScript",
choices: ["JavaScript", "YAML", "JSON"]
}
]).then(answers => {
const totalAnswers = Object.assign({}, earlyAnswers, answers);

// continue with the style questions otherwise...
return inquirer.prompt([
{
type: "list",
name: "indent",
message: "What style of indentation do you use?",
default: "tab",
choices: [{ name: "Tabs", value: "tab" }, { name: "Spaces", value: 4 }]
},
{
type: "list",
name: "quotes",
message: "What quotes do you use for strings?",
default: "double",
choices: [{ name: "Double", value: "double" }, { name: "Single", value: "single" }]
},
{
type: "list",
name: "linebreak",
message: "What line endings do you use?",
default: "unix",
choices: [{ name: "Unix", value: "unix" }, { name: "Windows", value: "windows" }]
},
{
type: "confirm",
name: "semi",
message: "Do you require semicolons?",
default: true
},
{
type: "list",
name: "format",
message: "What format do you want your config file to be in?",
default: "JavaScript",
choices: ["JavaScript", "YAML", "JSON"]
}
]).then(answers => {
const totalAnswers = Object.assign({}, earlyAnswers, secondAnswers, answers);

const config = processAnswers(totalAnswers);
const modules = getModulesList(config);
const config = processAnswers(totalAnswers);
const modules = getModulesList(config);

return askInstallModules(modules).then(() => writeFile(config, answers.format));
});
return askInstallModules(modules).then(() => writeFile(config, answers.format));
});
});
}
Expand Down