Skip to content

lark-org/eslint-config-lark

Repository files navigation

ESLINT-CONFIG-LARK

主要 fork 自 eslint-config-welly,做了一些改动,适应普通、react、node 项目

Installation

requires eslint and typescript.

Install the correct version of each package, which are listed by the command:

npm info "eslint-config-lark@latest" peerDependencies

If using npm 5+, use this shortcut:

npx install-peerdeps --dev eslint-config-lark

Or install each package by yourself:

npm install --save-dev eslint-config-lark eslint@^x.x.x typescript@^x.x.x
# or
yarn add --dev eslint-config-lark eslint@^x.x.x typescript@^x.x.x

Usage

Add the extends to your .eslintrc.js:

module.exports = {
  extends: 'lark',
  rules: {
    // your overrides
  }
}

Eliminate Prettier Conflicts for You

Prettier is a great code formatter, I highly recommend you guys give it a try. This package built-ins the eslint-config-prettier for you, all you need to do is setup the Prettier CLI to use it.

// package.json

"format": "prettier --check ."
// or
"format": "prettier --write ."

What's Inside?

This configuration contains the following cool packages.

Package Description Auto Enabled
typescript-eslint Monorepo for all the tooling which enables ESLint to support TypeScript.
eslint-config-airbnb-base This package provides Airbnb's .eslintrc as an extensible shared config.
eslint-plugin-import ESLint plugin with rules that help validate proper imports.
eslint-plugin-promise Enforce best practices for JavaScript promises.
eslint-plugin-compat Lint the browser compatibility of your code.
eslint-plugin-jest ESLint plugin for Jest.
eslint-plugin-react React specific linting rules for ESLint.
eslint-plugin-react-hooks This ESLint plugin enforces the Rules of Hooks.
eslint-plugin-jest-dom ESLint rules for use with jest-dom.
eslint-plugin-testing-library ESLint plugin for Testing Library.
eslint-config-prettier Turns off all rules that are unnecessary or might conflict with Prettier.
@emotion/eslint-plugin ESLint rules for emotion.

Thanks

eslint-config-welly