Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lark-org/eslint-config-lark
ESLint configuration for any projects
https://github.com/lark-org/eslint-config-lark
airbnb airbnb-eslint emotion eslint eslint-config node prettier promise react typescript
Last synced: 3 days ago
JSON representation
ESLint configuration for any projects
- Host: GitHub
- URL: https://github.com/lark-org/eslint-config-lark
- Owner: lark-org
- License: gpl-3.0
- Created: 2017-09-29T13:24:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-09T21:13:12.000Z (about 1 year ago)
- Last Synced: 2024-12-12T03:27:58.627Z (28 days ago)
- Topics: airbnb, airbnb-eslint, emotion, eslint, eslint-config, node, prettier, promise, react, typescript
- Language: JavaScript
- Homepage:
- Size: 1.33 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# ESLINT-CONFIG-LARK
主要 fork 自 [eslint-config-welly](https://www.npmjs.com/package/eslint-config-welly)，做了一些改动，适应普通、react、node 项目
## Installation
requires [eslint](https://github.com/eslint/eslint) and [typescript](https://github.com/microsoft/TypeScript).
Install the correct version of each package, which are listed by the command:
```sh
npm info "eslint-config-lark@latest" peerDependencies
```
If using **npm 5+**, use this shortcut:
```sh
npx install-peerdeps --dev eslint-config-lark
```
Or install each package by yourself:
```sh
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`:
```js
module.exports = {
extends: 'lark',
rules: {
// your overrides
}
}
```
## Eliminate Prettier Conflicts for You
[Prettier](https://prettier.io) is a great code formatter, I highly recommend you guys give it a try. This package built-ins the [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) for you, all you need to do is setup the [Prettier CLI](https://prettier.io/docs/en/cli.html) to use it.
```json
// 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](https://github.com/typescript-eslint/typescript-eslint) | Monorepo for all the tooling which enables ESLint to support [TypeScript](https://github.com/microsoft/TypeScript). | |
| [eslint-config-airbnb-base](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) | This package provides Airbnb's .eslintrc as an extensible shared config. | |
| [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import) | ESLint plugin with rules that help validate proper imports. | |
| [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise) | Enforce best practices for JavaScript promises. | |
| [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat) | Lint the browser compatibility of your code. | |
| [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) | ESLint plugin for [Jest](https://jestjs.io). | ✅ |
| [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react) | React specific linting rules for ESLint. | ✅ |
| [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks) | This ESLint plugin enforces the [Rules of Hooks](https://reactjs.org/docs/hooks-rules.html). | ✅ |
| [eslint-plugin-jest-dom](https://github.com/testing-library/eslint-plugin-jest-dom) | ESLint rules for use with [jest-dom](https://testing-library.com/docs/ecosystem-jest-dom). | ✅ |
| [eslint-plugin-testing-library](https://github.com/testing-library/eslint-plugin-testing-library) | ESLint plugin for [Testing Library](https://testing-library.com/docs/react-testing-library/intro). | ✅ |
| [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) | Turns off all rules that are unnecessary or might conflict with Prettier. | ✅ |
| [@emotion/eslint-plugin](https://github.com/emotion-js/emotion/blob/master/packages/eslint-plugin/README.md) | ESLint rules for [emotion](https://emotion.sh). | ✅ |
## Thanks
[eslint-config-welly](https://www.npmjs.com/package/eslint-config-welly)