https://github.com/flitto/eslint-config-flitto-typescript

https://github.com/flitto/eslint-config-flitto-typescript

eslint linting typescript

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/flitto/eslint-config-flitto-typescript
• Owner: flitto
• Created: 2021-06-16T07:01:44.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T01:00:10.000Z (9 months ago)
• Last Synced: 2024-04-26T01:08:51.746Z (9 months ago)
• Topics: eslint, linting, typescript
• Language: TypeScript
• Homepage:
• Size: 391 KB
• Stars: 2
• Watchers: 7
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-config-flitto-typescript

Flitto Typescript Style Guide

## Get Started

### 1. Installing packages

**npm@>=7**

```

npm install --save-dev eslint-config-flitto-typescript@latest

```

(npm@<7 is not supported)

### 2. Create Eslint configuration file

Create `.eslintrc.json` file at the top of the project directory like below.

```json

{

  "parserOptions": {

    "project": "./tsconfig.json"

  },

  "extends": "flitto-typescript",

  "rules": {

  }

}

```

## Configuration On WebStorm

1. Open `Preferences` ( ⌘ + ,)

2. `Language & Frameworks` ▸ `javascript Code` ▸ `Quality tools` ▸ `Eslint`

3. Select `Manual ESLint Configuration `

    * ESLint package: `/{project_path}/node_modules/eslint`

    * Configuration file: `/{project_path}/.eslintrc.json`

4. (Optional) check `Run eslint --fix on save`

5. Click `OK`

## Rules

* [standardjs(original)](https://standardjs.com/rules.html)

* [extended rules for typescript originated from standardjs](https://github.com/standard/eslint-config-standard-with-typescript/blob/master/src/index.ts)

## Flags

* [Configuring Rules](https://eslint.org/docs/user-guide/configuring/rules#configuring-rules)

* [Disabling Rules](https://eslint.org/docs/user-guide/configuring/rules#disabling-rules)

* [Sample Files](https://github.com/flitto/eslint-config-flitto-typescript/tree/master/examples) (You can apply eslint

  to these files)