Interactive Questions

The CLI uses a structured set of interactive prompts to gather user preferences and generate appropriate ESLint configurations. This document outlines the question flow and available options.

Question Flow

1. Language Selection

Prompt: "What do you want to lint?"
Type: Multiple selection
Options:

• JavaScript
• JSON
• JSON with comments (JSONC)
• JSON5
• Markdown
• CSS

Default: JavaScript (pre-selected)

2. ESLint Purpose

Prompt: "How would you like to use ESLint?"
Type: Single selection
Options:

• To check syntax only
• To check syntax and find problems

Default: "To check syntax and find problems"

3. JavaScript Configuration (if JavaScript selected)

Module Type

Prompt: "What type of modules does your project use?"
Options:

• JavaScript modules (import/export)
• CommonJS (require/exports)
• None of these

Framework

Prompt: "Which framework does your project use?"
Options:

• React
• Vue.js
• None of these

TypeScript Usage

Prompt: "Does your project use TypeScript?"
Type: Yes/No toggle
Default: No

Environment

Prompt: "Where does your code run?"
Type: Multiple selection
Options:

• Browser
• Node

4. Markdown Configuration (if Markdown selected)

Prompt: "What flavor of Markdown do you want to lint?"
Options:

• CommonMark
• GitHub Flavored Markdown

Default: CommonMark

5. Configuration File Language

Prompt: "What format do you want your config file to be in?"
Options:

• JavaScript
• TypeScript

Default: JavaScript

6. Jiti Integration (if TypeScript config on Node < 18.19)

Prompt: "Would you like to add Jiti as a devDependency?"
Type: Yes/No toggle
Context: Appears when TypeScript config is chosen on Node.js versions that don't natively support TypeScript config files

7. Installation Preferences

Installation Confirmation

Prompt: "Would you like to install them now?"
Type: Yes/No toggle
Context: Shows list of packages to be installed Default: Yes

Package Manager Selection (if installation confirmed)

Prompt: "Which package manager do you want to use?"
Options:

• npm
• yarn
• pnpm
• bun

Default: Detected from lock files or npm if none found

Question Conditions

• JavaScript questions only appear if JavaScript is selected in language selection
• Markdown questions only appear if Markdown is selected in language selection
• TypeScript config question appears for all users regardless of TypeScript usage choice
• Jiti question only appears for TypeScript config on older Node.js versions
• Package manager selection only appears if user chooses to install dependencies

Example Question Sequence

? What do you want to lint? › JavaScript, JSON
? How would you like to use ESLint? › To check syntax and find problems
? What type of modules does your project use? › JavaScript modules (import/export)
? Which framework does your project use? › React
? Does your project use TypeScript? › Yes
? Where does your code run? › Browser, Node
? What format do you want your config file to be in? › JavaScript
? Would you like to install them now? › Yes
? Which package manager do you want to use? › npm

This sequence generates a React + TypeScript configuration with both browser and Node.js environments.