@squares/eslint-plugin v0.0.6

@squares/eslint-plugin

ESLint & Prettier plugin for Squares

💾 Installation

npm

npm install -D @squares/eslint-plugin eslint prettier

yarn

yarn add -D @squares/eslint-plugin eslint prettier

🔨Usage

VSCode setting

// .vscode/setting.json, 파일 저장 시 자동 fix 처리를 위해 설정 추가
{
  ...
  "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    },
  ...
}

Your Project (.esilntrc.js)

module.exports = {
  plugins: ["@squares"],
  extends: ["plugin:@squares/auto"],
}

Your Project (.eslintrc.json)

{
  plugins: ["@squares"],
  extends: ["plugin:@squares/auto"],
}

📙 auto config 설명

plugins

• @squares: 커스텀하게 작성 되어진 squares eslint 플러그인을 명시합니다.

extends

• plugin:@squares/base: 기본적인 js 플러그인들과 rule을 관리하는 base config 를 기본으로 사용합니다.

overrides

• "**/*.ts?(x)": ts 파일은 typescript configa 설정을 적용하도록 override 합니다.
• "**/*.{jsx,tsx}": jsx, tsx 와 같은 파일은 react config 설정을 적용하도록 override 합니다.
• "**/*.tsx": tsx 파일 (react, typesciprt)에 대한 설정을 유연하게 적용하기 위해 별도로 꺼내두고 룰 적용

rules

📙 base config 설명

extends

• plugin:import/errors: import 플러그인의 오류를 검사하는 규칙 세트를 확장합니다. 이 규칙은 import 구문의 잘못된 사용 또는 문제를 식별합니다
• eslint:recommended: ESLint에서 권장하는 규칙을 사용합니다. 이것은 일반적으로 권장되는 ESLint의 기본 규칙을 의미합니다.
• prettier: Prettier 플러그인을 사용하여 ESLint 규칙을 설정합니다.

plugins

• json-format: JSON 파일의 유효성을 검사하는 규칙을 포함합니다. 이 플러그인은 JSON 파일의 형식을 확인하고 유효하지 않은 구조를 검출합니다.
• prettier: Prettier 플러그인을 사용하여 코드를 포맷합니다. Prettier는 코드 포맷팅을 담당하여 설정된 규칙에 따라 코드를 자동으로 정리합니다.
• imple-import-sort: import 구문을 간단하게 정렬하는 규칙을 포함합니다. 이는 import 구문을 알파벳순으로 정렬하고 내부적으로 특정한 패턴을 따르도록 돕습니다.

rules(prettier)

📙 react config 설명

plugins

• react: react의 기본 규칙을 포함하는 플러그인 정의
• react-hooks: react hooks의 기본 규칙을 포함하는 플러그인 정의, hooks의 호출 위치, 의존성 배열(dependancy) 등을 체크
• jsx-a11y: react component 에서의 웹 접근성 관련 규칙을 포함한 플러그인을 정의

rules

📙 typescript config 설명

parser

• @typescript-eslint/parser: TypeScript 파일을 파싱하기 위해 사용할 파서를 설정

extends

• plugin:@typescript-eslint/recommended: TypeScript 관련 ESLint 플러그인인 @typescript-eslint의 권장 규칙들을 사용하도록 설정

rules

🚀 Squares Site

• Squares
• QShop

📜 License

This software is licensed under the MIT © Squares