https://github.com/vikiboss/eslint-config

Viki's shareable opinionated eslint config monorepo
https://github.com/vikiboss/eslint-config

eslint eslint-config prettier-eslint typescript

Last synced: about 2 months ago
JSON representation

Viki's shareable opinionated eslint config monorepo

• Host: GitHub
• URL: https://github.com/vikiboss/eslint-config
• Owner: vikiboss
• Created: 2022-11-04T02:14:40.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-06T07:48:06.000Z (over 1 year ago)
• Last Synced: 2024-11-14T20:48:12.349Z (about 2 months ago)
• Topics: eslint, eslint-config, prettier-eslint, typescript
• Language: JavaScript
• Homepage: https://npm.im/@vmoe/eslint-config
• Size: 161 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @vmoe/eslint-config

Viki's shareable opinionated [ESLint](https://eslint.org) config monorepo.

**Features:**

- base on [standard](https://github.com/standard/eslint-config-standard)

- support `React` & `Vanilla JS/TS`

**Packages:**

- `@vmoe/eslint-config`: rules for `TypeScript` (fallback to vanilla JS if no TS module detected)

- `@vmoe/eslint-config-vanilla`: rules for base `JavaScript`

- `@vmoe/eslint-config-ts`: rules for `TypeScript` and `JavaScript`

- `@vmoe/eslint-config-react`: rules for `React` (`TypeScript` by defaults)

## Usage

Install these dev dependencies via package manager of your choice.

```shell

pnpm add -D eslint prettier @vmoe/eslint-config @vmoe/prettier-config

```

```shell

npm i -D eslint prettier @vmoe/eslint-config @vmoe/prettier-config

```

```shell

yarn add -D eslint prettier @vmoe/eslint-config @vmoe/prettier-config

```

Config your `.eslintrc`

```json

{

  "extends": "@vmoe"

}

```

Config your `.prettierrc`

```json

"@vmoe/prettier-config"

```

Add following scripts to `package.json`

```json

{

  "scripts": {

    "lint": "eslint .",

    "lint:fix": "eslint . --fix"

  }

}

```

Run the script via package manager of your choice

```shell

npm run lint  # npm

yarn run lint # yarn

pnpm run lint # pnpm

```