Chore: Replace the inquirer dependency with enquirer #13254
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ | |
|
|
||
| const util = require("util"), | ||
| path = require("path"), | ||
| enquirer = require("enquirer"), | ||
| ProgressBar = require("progress"), | ||
| semver = require("semver"), | ||
| espree = require("espree"), | ||
|
|
@@ -146,7 +146,7 @@ function getModulesList(config, installESLint) { | |
| * | ||
| * Note: This clones the config object and returns a new config to avoid mutating | ||
| * the original config parameter. | ||
| * @param {Object} answers answers received from enquirer | ||
| * @param {Object} config config object | ||
| * @returns {Object} config object with configured rules | ||
| */ | ||
|
|
@@ -253,7 +253,7 @@ function configureRules(answers, config) { | |
|
|
||
| /** | ||
| * process user's answers and create config object | ||
| * @param {Object} answers answers received from enquirer | ||
| * @returns {Object} config object | ||
| */ | ||
| function processAnswers(answers) { | ||
|
|
@@ -412,7 +412,7 @@ function installModules(modules) { | |
| npmUtils.installSyncSaveDev(modules); | ||
| } | ||
|
|
||
| /* istanbul ignore next: no need to test enquirer */ | ||
| /** | ||
| * Ask user to install modules. | ||
| * @param {string[]} modules Array of modules to be installed. | ||
|
|
@@ -428,14 +428,17 @@ function askInstallModules(modules, packageJsonExists) { | |
|
|
||
| log.info("The config that you've selected requires the following dependencies:\n"); | ||
| log.info(modules.join(" ")); | ||
| return enquirer.prompt([ | ||
| { | ||
| type: "confirm", | ||
| name: "executeInstallation", | ||
| message: "Would you like to install them now with npm?", | ||
| initial: () => true, | ||
| skip() { | ||
| return !(modules.length && packageJsonExists); | ||
| }, | ||
| result(input) { | ||
| return this.skip ? null : input; | ||
| } | ||
| } | ||
| ]).then(({ executeInstallation }) => { | ||
|
|
@@ -445,110 +448,115 @@ function askInstallModules(modules, packageJsonExists) { | |
| }); | ||
| } | ||
|
|
||
| /* istanbul ignore next: no need to test enquirer */ | ||
| /** | ||
| * Ask use a few questions on command prompt | ||
| * @returns {Promise} The promise with the result of the prompt | ||
| */ | ||
| function promptUser() { | ||
|
|
||
| return enquirer.prompt([ | ||
| { | ||
| type: "select", | ||
| name: "purpose", | ||
| message: "How would you like to use ESLint?", | ||
| initial: 1, | ||
|
There was a problem hiding this comment. The returned number matches the There was a problem hiding this comment. @Siilwyn can you add this as a comment in the file? There was a problem hiding this comment. Yes 👍 |
||
| choices: [ | ||
| { message: "To check syntax only", name: "syntax" }, | ||
| { message: "To check syntax and find problems", name: "problems" }, | ||
| { message: "To check syntax, find problems, and enforce code style", name: "style" } | ||
| ] | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "moduleType", | ||
| message: "What type of modules does your project use?", | ||
| initial: 0, | ||
| choices: [ | ||
| { message: "JavaScript modules (import/export)", name: "esm" }, | ||
| { message: "CommonJS (require/exports)", name: "commonjs" }, | ||
| { message: "None of these", name: "none" } | ||
| ] | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "framework", | ||
| message: "Which framework does your project use?", | ||
| initial: 0, | ||
| choices: [ | ||
| { message: "React", name: "react" }, | ||
| { message: "Vue.js", name: "vue" }, | ||
| { message: "None of these", name: "none" } | ||
| ] | ||
| }, | ||
| { | ||
| type: "confirm", | ||
| name: "typescript", | ||
| message: "Does your project use TypeScript?", | ||
| initial: () => false | ||
| }, | ||
| { | ||
| type: "multiselect", | ||
nzakas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| name: "env", | ||
| message: "Where does your code run?", | ||
| initial: 0, | ||
| choices: [ | ||
| { message: "Browser", name: "browser" }, | ||
| { message: "Node", name: "node" } | ||
| ] | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "source", | ||
| message: "How would you like to define a style for your project?", | ||
| choices: [ | ||
| { message: "Use a popular style guide", name: "guide" }, | ||
| { message: "Answer questions about your style", name: "prompt" }, | ||
| { message: "Inspect your JavaScript file(s)", name: "auto" } | ||
| ], | ||
| skip() { | ||
| return this.state.answers.purpose !== "style"; | ||
| }, | ||
|
Comment on lines
+521
to
+523
There was a problem hiding this comment. The |
||
| result(input) { | ||
| return this.skip ? null : input; | ||
|
There was a problem hiding this comment. @Siilwyn
It seems the
There was a problem hiding this comment. Good catch! That was a typo sorry about that. I was testing it on one question with |
||
| } | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "styleguide", | ||
| message: "Which style guide do you want to follow?", | ||
| choices: [ | ||
| { message: "Airbnb: https://github.com/airbnb/javascript", name: "airbnb" }, | ||
| { message: "Standard: https://github.com/standard/standard", name: "standard" }, | ||
| { message: "Google: https://github.com/google/eslint-config-google", name: "google" } | ||
| ], | ||
| skip() { | ||
| this.state.answers.packageJsonExists = npmUtils.checkPackageJson(); | ||
| return !(this.state.answers.source === "guide" && this.state.answers.packageJsonExists); | ||
| }, | ||
| result(input) { | ||
| return this.skip ? null : input; | ||
| } | ||
| }, | ||
| { | ||
| type: "input", | ||
| name: "patterns", | ||
| message: "Which file(s), path(s), or glob(s) should be examined?", | ||
| skip() { | ||
| return this.state.answers.source !== "auto"; | ||
| }, | ||
| validate(input) { | ||
| if (!this.skip && input.trim().length === 0 && input.trim() !== ",") { | ||
| return "You must tell us what code to examine. Try again."; | ||
| } | ||
| return true; | ||
| } | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "format", | ||
| message: "What format do you want your config file to be in?", | ||
| initial: 0, | ||
| choices: ["JavaScript", "YAML", "JSON"] | ||
| }, | ||
| { | ||
|
|
@@ -561,9 +569,12 @@ function promptUser() { | |
|
|
||
| return `The style guide "${answers.styleguide}" requires eslint@${answers.requiredESLintVersionRange}. You are currently using eslint@${answers.localESLintVersion}.\n Do you want to ${verb}?`; | ||
| }, | ||
| initial: () => true, | ||
| skip() { | ||
| return !(this.state.answers.source === "guide" && this.state.answers.packageJsonExists && hasESLintVersionConflict(this.state.answers)); | ||
| }, | ||
| result(input) { | ||
| return this.skip ? null : input; | ||
| } | ||
| } | ||
| ]).then(earlyAnswers => { | ||
|
|
@@ -616,33 +627,33 @@ function promptUser() { | |
| } | ||
|
|
||
| // continue with the style questions otherwise... | ||
| return enquirer.prompt([ | ||
| { | ||
| type: "select", | ||
| name: "indent", | ||
| message: "What style of indentation do you use?", | ||
| initial: 0, | ||
| choices: [{ message: "Tabs", name: "tab" }, { message: "Spaces", name: 4 }] | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "quotes", | ||
| message: "What quotes do you use for strings?", | ||
| initial: 0, | ||
| choices: [{ message: "Double", name: "double" }, { message: "Single", name: "single" }] | ||
| }, | ||
| { | ||
| type: "select", | ||
| name: "linebreak", | ||
| message: "What line endings do you use?", | ||
| initial: 0, | ||
| choices: [{ message: "Unix", name: "unix" }, { message: "Windows", name: "windows" }] | ||
| }, | ||
| { | ||
| type: "confirm", | ||
| name: "semi", | ||
| message: "Do you require semicolons?", | ||
| initial: () => true | ||
| } | ||
| ]).then(answers => { | ||
| const totalAnswers = Object.assign({}, earlyAnswers, answers); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This result method is needed since enquirer will even return the initial value when the question is skipped, unlike inquirer.