Skip to content
This repository has been archived by the owner on May 22, 2021. It is now read-only.

eslint-kit/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
risenforces
May 21, 2021
fcbb71b · May 21, 2021

History

88 Commits
May 15, 2021
May 15, 2021
May 15, 2021
May 13, 2021
May 15, 2021
Feb 8, 2020
Feb 8, 2020
Feb 9, 2020
Feb 9, 2020
Feb 8, 2020
Feb 9, 2020
Feb 8, 2020
Feb 8, 2020
Feb 8, 2020
May 21, 2021
Feb 8, 2020
Feb 9, 2020
May 15, 2021
Feb 13, 2020
May 15, 2021

Repository files navigation

ESLint Config Kit


The package was moved to @eslint-kit monorepo.


The ESLint Kit CLI is a command-line interface tool that helps you to setup ESLint for your project.

It can:

  • Setup configs from eslint-config-kit automatically.
    (JSON / YAML eslint config files are supported)

  • Install and manage required dependencies.
    (NPM / Yarn)

  • Add aliases support for eslint-plugin-import.
    (both JS and TS parsers are supported)

  • Create recommended .prettierrc for kit/prettier config.

Usage

Using npx (recommended):

npx @eslint-kit/cli

Installing globally (it's good in rare cases):

npm i -g @eslint-kit/cli
eslint-kit

Common options

  • -W, --workspace <name> - use the specified yarn workspace as the working directory.

    Currently, it installs all dependencies into the workspace's package.json. If you want to keep eslint/prettier packages in the root package.json - do it manually.

Commands

Manage configs

Select everything you want using convenient dialogs. CLI will do everything for you.

$ npx @eslint-kit/cli

or

$ npx @eslint-kit/cli config

Accepts all common options.

Setup aliases

Just enter aliases in JSON format and CLI will take care of it.

$ npx @eslint-kit/cli alias

Accepts all common options.

Check

Check packages for compatibility with ESLint Kit. If some versions are not ok, CLI will offer you a way to fix it.

$ npx @eslint-kit/cli check

or

$ npx @eslint-kit/cli check-versions

Learn more about eslint-kit here.

Accepts all common options.