🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Sign inDemoInstall
Socket

@sima-land/linters

Package Overview
Dependencies
Maintainers
0
Versions
17
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sima-land/linters

Code style linter configuration presets

5.0.1
latest
Source
npm
Version published
Weekly downloads
6.4K
-20.12%
Maintainers
0
Weekly downloads
 
Created
Source

Frontend linters

Пакет с пресетами конфигураций линтеров.

Использование

Установка

# npm
$ npm i -D @sima-land/linters eslint stylelint prettier

# или yarn
yarn add -D @sima-land/linters eslint stylelint prettier

Конфигурация

С помощью package.json

{
  "prettier": "@sima-land/linters/prettier",
  "eslintConfig": {
    "extends": "./node_modules/@sima-land/linters/eslint/index.js"
  },
  "stylelint": {
    "extends": "@sima-land/linters/stylelint"
  }
}

С помощью отдельных конфигурационных файлов

ESLint

Создать в корне проекта файл eslint.config.mjs со следующим содержимым:

import simaland from '@sima-land/linters/eslint';

export default [
  // используем все правила из пакета, собранные вместе
  ...simaland,

  // ...опционально переопределяем правила
];

Правила разбиты по модулям:

  • ./linters/eslint/base - базовые правила JS
  • ./linters/eslint/typescript - базовые правила TS
  • ./linters/eslint/react - правила React/JSX
  • ./linters/eslint/lodash - правила работы с Lodash
  • ./linters/eslint/jest - правила работы с Jest
  • ./linters/eslint/testing-library - правила работы с Testing Library
  • ./linters/eslint/jsdoc - правила оформления JSDoc
  • ./linters/eslint/jsdoc-ts - правила оформления JSDoc в TS
  • ./linters/eslint/jsdoc-jest - правила оформления JSDoc в тестах Jest
  • ./linters/eslint - все правила вместе
Stylelint

Создать в корне проекта файл stylelint.config.сjs со следующим содержимым:

module.exports = {
  extends: require.resolve('@sima-land/linters/stylelint'),
};
Prettier

Создать в корне проекта файл .prettierrc.js со следующим содержимым:

module.exports = require('@sima-land/linters/prettier');

Настройка git-хуков

Удобно использовать husky в связке с lint-staged, для этого необходимо:

  • Установить пакеты
npm i -D husky lint-staged
  • Создать в корне проекта файл lint-staged.config.сjs со следующим содержимым:
module.exports = {
  '*.{js,jsx,ts,tsx}': ['prettier --write', 'eslint --fix --ext .js,.jsx,.ts,.tsx'],
  '*.{css,scss}': ['prettier --write', 'stylelint'],
};
  • Добавить pre-commit хук согласно документации husky: npx lint-staged

https://typicode.github.io/husky/#/?id=create-a-hook

Проблемы с ESLint (до ESLint версии 9)

ESLint может бросать ошибку, говоря что не может найти плагины, требуемые в конфигурации.

В этом случае поможет пакет @rushstack/eslint-patch:

Конфигурация текстовых редакторов и IDE

Актуальная информация в официальных документациях:

FAQs

Package last updated on 27 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts