https://github.com/sima-land/frontend-linters
Конфиги линтеров стилей и скриптов
https://github.com/sima-land/frontend-linters
eslint presets prettier stylelint
Last synced: 3 months ago
JSON representation
Конфиги линтеров стилей и скриптов
- Host: GitHub
- URL: https://github.com/sima-land/frontend-linters
- Owner: sima-land
- License: apache-2.0
- Created: 2021-07-13T05:53:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-07-07T11:39:31.000Z (3 months ago)
- Last Synced: 2025-07-07T11:41:31.295Z (3 months ago)
- Topics: eslint, presets, prettier, stylelint
- Language: JavaScript
- Homepage:
- Size: 850 KB
- Stars: 1
- Watchers: 17
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Frontend linters
Пакет с пресетами конфигураций линтеров.
## Использование
### Установка
```bash
# npm
$ npm i -D @sima-land/linters eslint stylelint prettier
# или yarn
yarn add -D @sima-land/linters eslint stylelint prettier
```
### Конфигурация
#### С помощью `package.json`
```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` со следующим содержимым:
```js
import simaland from '@sima-land/linters/eslint';
export default [
// используем все правила из пакета, собранные вместе
...simaland,
// ...опционально переопределяем правила
];
```
или `eslint.config.ts`
```ts
import tseslint from 'typescript-eslint';
import simaland from '@sima-land/linters/eslint';
export default tseslint.config(
// используем все правила из пакета, собранные вместе
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.mjs` со следующим содержимым:
```js
export default {
extends: '@sima-land/linters/stylelint',
};
```
##### Prettier
Создать в корне проекта файл `.prettierrc` со следующим содержимым:
```json
"@sima-land/linters/prettier"
```
### Настройка git-хуков
Удобно использовать `husky` в связке с `lint-staged`, для этого необходимо:
1. Установить пакеты
```bash
npm i -D husky lint-staged
```
2. Создать в корне проекта файл `lint-staged.config.js` со следующим содержимым:
```js
{
'*.{mjs,js,jsx,ts,tsx}': ['eslint --fix'],
'*.{css,scss}': ['stylelint --fix'],
'*': ['prettier --write --ignore-unknown'],
};
```
3. Добавить **pre-commit** хук согласно документации husky: `npx lint-staged`
### Конфигурация текстовых редакторов и IDE
Актуальная информация в официальных документациях:
-
-
-