@alexlit/lint-kit 214.3.0 → 215.0.0

package/README.md

@@ -1,32 +1,37 @@
-# Lint Kit
+[![version](https://npmx.dev/api/registry/badge/version/@alexlit/lint-kit)](https://www.npmjs.com/package/@alexlit/lint-kit)
+[![downloads](https://npmx.dev/api/registry/badge/downloads/@alexlit/lint-kit)](https://npmx.dev/package/@alexlit/lint-kit)
+[![license](https://npmx.dev/api/registry/badge/license/@alexlit/lint-kit)](LICENSE)
 
-Presets of configuration files and dependencies for linting web applications
-(designed for [Vue.js](https://vuejs.org) with
-[TypeScript](https://www.typescriptlang.org/))
+# Lint Kit
 
-## Usage
+Набор пакетов с конфигурациями для линтинга и форматирования кода Vue +
+TypeScript проектов.
 
-### Instal all linters
+## Пакеты
 
-```sh
-npm i @alexlit/config-commitlint @alexlit/config-eslint @alexlit/config-hooks @alexlit/config-htmllint @alexlit/config-markdownlint @alexlit/config-npmlint @alexlit/config-prettier @alexlit/config-stylelint --legacy-peer-deps -D
-```
+| Пакет                                                  | Назначение                         |
+| :----------------------------------------------------- | :--------------------------------- |
+| [eslint](packages/config-eslint/README.md)             | Линтинг JavaScript и TypeScript    |
+| [hooks](packages/config-hooks/README.md)               | Git-хуки (commitlint, lint-staged) |
+| [htmllint](packages/config-htmllint/README.md)         | Линтинг HTML                       |
+| [markdownlint](packages/config-markdownlint/README.md) | Линтинг Markdown                   |
+| [npmlint](packages/config-npmlint/README.md)           | Линтинг `package.json`             |
+| [prettier](packages/config-prettier/README.md)         | Форматирование кода                |
+| [stylelint](packages/config-stylelint/README.md)       | Линтинг CSS                        |
 
-### Configuration
+## Установка
 
-- [commitlint](https://github.com/alex-lit/lint-kit/blob/master/packages/config-commitlint/README.md)
-- [eslint](https://github.com/alex-lit/lint-kit/blob/master/packages/config-eslint/README.md)
-- [hooks](https://github.com/alex-lit/lint-kit/blob/master/packages/config-hooks/README.md)
-- [htmllint](https://github.com/alex-lit/lint-kit/blob/master/packages/config-htmllint/README.md)
-- [markdownlint](https://github.com/alex-lit/lint-kit/blob/master/packages/config-markdownlint/README.md)
-- [npmlint](https://github.com/alex-lit/lint-kit/blob/master/packages/config-npmlint/README.md)
-- [prettier](https://github.com/alex-lit/lint-kit/blob/master/packages/config-prettier/README.md)
-- [stylelint](https://github.com/alex-lit/lint-kit/blob/master/packages/config-stylelint/README.md)
+Рекомендуется устанавливать необходимые пакеты по отдельности - так вы
+подключаете только те линтеры, которые необходимы и сможете управлять их
+версиями.
 
-## Dev mode
+Инструкции по настройке каждого пакета приведены в его README (см. ссылки в
+разделе [«Пакеты»](#пакеты)).
 
-### Installation
+```bash
+# установка необходимого пакета
+npm install --save-dev @alexlit/config-<PACKAGE_NAME>
 
-```sh
-npm run i
+# или все сразу одной командой
+npm install --save-dev @alexlit/lint-kit
 ```

package/eslint.config.js

@@ -1,65 +1,32 @@
-import {
-  base,
-  deMorgan,
-  importX,
-  javascript,
-  jsdoc,
-  json,
-  perfectionist,
-  prettierConfig,
-  regexp,
-  sonar,
-  stylistic,
-  tailwindcss,
-  tanstackQuery,
-  typescriptTypeChecked,
-  unicorn,
-  vitest,
-  vue,
-  vueAccessibility,
-  vueI18n,
-  zod,
-} from '@alexlit/config-eslint';
+import { defineConfig, plugins } from '@alexlit/config-eslint';
 import path from 'node:path';
 
-export default [
-  ...base, // must be first
-
-  ...javascript,
-  ...deMorgan,
-  ...importX,
-  ...jsdoc,
-  ...json,
-  ...perfectionist,
-  ...regexp,
-  ...sonar,
-  ...stylistic,
-  ...typescriptTypeChecked,
-  ...unicorn,
-  ...vue,
-  ...vueAccessibility,
-  ...vueI18n,
-
-  ...tanstackQuery,
-  ...vitest,
-  ...zod,
-
-  ...tailwindcss({
+export default defineConfig([
+  ...plugins.javascript(),
+  ...plugins.deMorgan(),
+  ...plugins.importX(),
+  ...plugins.jsdoc(),
+  ...plugins.json(),
+  ...plugins.perfectionist(),
+  ...plugins.regexp(),
+  ...plugins.sonar(),
+  ...plugins.stylistic(),
+  ...plugins.typescriptTypeChecked(),
+  ...plugins.unicorn(),
+  ...plugins.vue(),
+  ...plugins.vueAccessibility(),
+  ...plugins.vueI18n(),
+  ...plugins.tanstackQuery(),
+  ...plugins.vitest(),
+  ...plugins.zod(),
+  ...plugins.tailwindcss({
     cssConfigPath: path.resolve(
       import.meta.dirname,
       'examples/css.tailwind.css',
     ),
   }),
 
-  ...prettierConfig, // must be last
-
-  { ignores: ['**/packages/config-eslint/_legacy/**'] },
+  { files: ['**/*.js'], rules: { 'no-restricted-imports': 'off' } },
 
-  {
-    files: ['**/*.js'],
-    rules: {
-      'no-restricted-imports': 'off',
-      'unicorn/comment-content': ['warn'],
-    },
-  },
-];
+  ...plugins.prettierConfig(),
+]);

package/lint-staged.config.js

@@ -1,3 +1,3 @@
-import { createLintStagedConfig } from '@alexlit/config-hooks';
+import { defineConfig } from '@alexlit/config-hooks';
 
-export default createLintStagedConfig();
+export default defineConfig();

package/linthtml.config.js

@@ -1,3 +1,3 @@
-import { createConfig } from '@alexlit/config-htmllint';
+import { defineConfig } from '@alexlit/config-htmllint';
 
-export default createConfig();
+export default defineConfig();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alexlit/lint-kit",
-  "version": "214.3.0",
+  "version": "215.0.0",
   "private": false,
   "description": "Preset of configuration files and dependencies for linting web applications (designed for Vue.js with TypeScript)",
   "keywords": [
@@ -73,6 +73,7 @@
     "commit-msg": "npx commitlint --edit"
   },
   "devDependencies": {
-    "changelogen": "^0.6.2"
+    "changelogen": "^0.6.2",
+    "radash": "^12.1.1"
   }
 }

package/packages/config-eslint/README.md

@@ -1,135 +1,185 @@
+[![version](https://npmx.dev/api/registry/badge/version/@alexlit/config-eslint)](https://www.npmjs.com/package/@alexlit/config-eslint)
+[![downloads](https://npmx.dev/api/registry/badge/downloads/@alexlit/config-eslint)](https://npmx.dev/package/@alexlit/config-eslint)
+[![license](https://npmx.dev/api/registry/badge/license/@alexlit/config-eslint)](LICENSE)
+
 # ESLint Configuration
 
-> [!WARNING]  
-> For **eslint version < 9** use
-> [@alexlit/config-eslint@90](https://www.npmjs.com/package/@alexlit/config-eslint?activeTab=versions)
-> or lower.
+Готовая конфигурация [ESLint](https://eslint.org/) в формате flat config:
+настроенные правила для JavaScript, TypeScript, Vue.js, JSON, YAML, импортов,
+Prettier и не только - всё, что обычно приходится настраивать вручную. Вместо
+того чтобы подключать и настраивать каждый плагин по отдельности, соберите
+конфигурацию из готовых модулей.
 
-There are no presets: `base` only provides the shared file scope, ignore
-patterns and globals. Every plugin is enabled explicitly, so you pay only for
-what you use.
+Плагины модульные: по умолчанию ничего не включено - вы сами перечисляете нужные
+в `defineConfig`.
 
-## Installation
+## Установка
 
-```sh
+```bash
 npm i @alexlit/config-eslint -D
 ```
 
-## Connection
+## Быстрый старт
+
+```js
+// eslint.config.js
+import { defineConfig, plugins } from '@alexlit/config-eslint';
+
+export default defineConfig([
+  ...plugins.javascript(),
+  ...plugins.typescript(),
+  ...plugins.unicorn(),
+  ...plugins.prettierConfig(),
+]);
+```
+
+Каждый плагин возвращает массив блоков конфигурации, поэтому его нужно
+развернуть оператором spread (`...`). Добавьте только то, что нужно проекту;
+полный список - в разделе [Плагины](#плагины).
+
+> [!NOTE]
+>
+> `plugins.prettierConfig()` должен быть последним - он отключает правила,
+> конфликтующие с Prettier.
+
+Больше плагинов - просто допишите их в массив. Пример:
+
+```js
+// eslint.config.js
+import { defineConfig, plugins } from '@alexlit/config-eslint';
+
+export default defineConfig([
+  // базовые
+  ...plugins.deMorgan(),
+  ...plugins.importX(),
+  ...plugins.javascript(),
+  ...plugins.jsdoc(),
+  ...plugins.json(),
+  ...plugins.perfectionist(),
+  ...plugins.regexp(),
+  ...plugins.sonar(),
+  ...plugins.stylistic(),
+  ...plugins.typescript(),
+  ...plugins.unicorn(),
+
+  // проектные
+  ...plugins.pinia(),
+  ...plugins.tanstackQuery(),
+  ...plugins.unocss(),
+  ...plugins.vitest(),
+  ...plugins.vue(),
+  ...plugins.vueAccessibility(),
+  ...plugins.vueI18n(),
+  ...plugins.zod(),
+
+  // дополнительные правила
+  { ignores: ['fixtures/**'], rules: { 'no-console': 'off' } },
+
+  // стилистика
+  ...plugins.prettierConfig(),
+]);
+```
 
-Always start with `base` (it must be first) and finish with `prettierConfig` (it
-must be last, it disables the formatting rules).
+## Плагины
+
+| Плагин                            | Что делает                                    | Пакет                               |
+| --------------------------------- | --------------------------------------------- | ----------------------------------- |
+| `plugins.deMorgan()`              | Упрощает логические выражения                 | `eslint-plugin-de-morgan`           |
+| `plugins.importX()`               | Проверяет импорты и модули                    | `eslint-plugin-import-x`            |
+| `plugins.javascript()`            | Базовые правила JavaScript                    | `@eslint/js`                        |
+| `plugins.jsdoc()`                 | Проверяет JSDoc-комментарии                   | `eslint-plugin-jsdoc`               |
+| `plugins.json()`                  | Проверяет JSON, JSONC, JSON5 и YAML           | `@eslint/json`                      |
+| `plugins.perfectionist()`         | Сортирует импорты, объекты, интерфейсы и типы | `eslint-plugin-perfectionist`       |
+| `plugins.pinia()`                 | Проверяет Pinia-хранилища                     | `eslint-plugin-pinia`               |
+| `plugins.prettier()`              | Форматирует код самим Prettier                | `eslint-plugin-prettier`            |
+| `plugins.prettierConfig()`        | Отключает правила, конфликтующие с Prettier   | `eslint-config-prettier`            |
+| `plugins.regexp()`                | Проверяет регулярные выражения                | `eslint-plugin-regexp`              |
+| `plugins.sonar()`                 | Проверяет код по правилам SonarJS             | `eslint-plugin-sonarjs`             |
+| `plugins.stylistic()`             | Проверяет форматирование и стиль кода         | `@stylistic/eslint-plugin`          |
+| `plugins.tailwindcss()`           | Проверяет классы Tailwind CSS                 | `eslint-plugin-tailwindcss`         |
+| `plugins.tanstackQuery()`         | Проверяет TanStack Query                      | `@tanstack/eslint-plugin-query`     |
+| `plugins.typescript()`            | Проверяет TypeScript без анализа типов        | `typescript-eslint`                 |
+| `plugins.typescriptTypeChecked()` | Проверяет TypeScript с анализом типов         | `typescript-eslint`                 |
+| `plugins.unicorn()`               | Проверяет код по правилам unicorn             | `eslint-plugin-unicorn`             |
+| `plugins.unocss()`                | Проверяет UnoCSS                              | `@unocss/eslint-config`             |
+| `plugins.vitest()`                | Проверяет тесты Vitest                        | `@vitest/eslint-plugin`             |
+| `plugins.vue()`                   | Проверяет Vue.js-компоненты                   | `eslint-plugin-vue`                 |
+| `plugins.vueAccessibility()`      | Проверяет доступность Vue.js-компонентов      | `eslint-plugin-vuejs-accessibility` |
+| `plugins.vueI18n()`               | Проверяет Vue.js I18n                         | `@intlify/eslint-plugin-vue-i18n`   |
+| `plugins.zod()`                   | Проверяет Zod-схемы                           | `eslint-plugin-zod`                 |
+
+## Настройки Tailwind CSS
+
+У `plugins.tailwindcss()` есть собственные настройки плагина - путь к CSS-файлу
+с конфигурацией Tailwind CSS (`cssConfigPath`):
 
 ```js
 // eslint.config.js
-import {
-  // foundation
-  base,
-
-  // plugins
-  deMorgan,
-  importX,
-  javascript,
-  jsdoc,
-  json,
-  perfectionist,
-  prettierConfig,
-  regexp,
-  sonar,
-  stylistic,
-  typescript,
-  unicorn,
-
-  // framework plugins
-  pinia,
-  tailwindcss,
-  tanstackQuery,
-  unocss,
-  vitest,
-  vue,
-  vueAccessibility,
-  vueI18n,
-  zod,
-} from '@alexlit/config-eslint';
-
-export default [
-  ...base, // must be first
-
-  ...deMorgan,
-  ...importX,
-  ...javascript,
-  ...jsdoc,
-  ...json,
-  ...perfectionist,
-  ...regexp,
-  ...sonar,
-  ...stylistic,
-  ...typescript,
-  ...unicorn,
-
-  ...pinia,
-  ...tanstackQuery,
-  ...unocss,
-  ...vitest,
-  ...vue,
-  ...vueAccessibility,
-  ...vueI18n,
-  ...zod,
-
-  // `tailwindcss` is the only plugin exported as a factory, because it needs a path to your CSS entrypoint
-  ...tailwindcss({ cssConfigPath: './src/assets/css/main.css' }),
-
-  ...prettierConfig, // must be last
-
-  // Custom rules example
-  // { files: ['**/*.js'], rules: { 'no-console': 'off' } },
-];
+import path from 'node:path';
+
+import { defineConfig, plugins } from '@alexlit/config-eslint';
+
+export default defineConfig([
+  ...plugins.tailwindcss({
+    cssConfigPath: path.resolve(import.meta.dirname, 'src/main.css'),
+  }),
+]);
 ```
 
-Drop what you do not need.
+По умолчанию используется путь `./styles/tailwind.css`.
 
-## Type-aware rules (optional)
+## Type-aware правила
 
-Type-aware rules (`no-floating-promises`, `no-misused-promises`,
+Type-aware правила (`no-floating-promises`, `no-misused-promises`,
 `await-thenable`, `no-unsafe-*`, `switch-exhaustiveness-check`,
-`no-unnecessary-condition`, …) require type information, which makes linting
-slower. They are not enabled by default.
+`no-unnecessary-condition`, …) требуют информации о типах, из-за чего линтинг
+замедляется. По умолчанию они не включены.
 
-To enable them, replace `typescript` with `typescriptTypeChecked`:
+Чтобы их включить, замените `plugins.typescript()` на
+`plugins.typescriptTypeChecked()`:
 
 ```js
-import {
-  base,
-  typescriptTypeChecked,
-  prettierConfig,
-} from '@alexlit/config-eslint';
-
-export default [
-  ...base,
-  // ...other plugins
-  ...typescriptTypeChecked, // instead of ...typescript
-  ...prettierConfig,
-];
+// eslint.config.js
+import { defineConfig, plugins } from '@alexlit/config-eslint';
+
+export default defineConfig([
+  ...plugins.javascript(),
+  ...plugins.typescriptTypeChecked(), // вместо plugins.typescript()
+  ...plugins.prettierConfig(),
+]);
 ```
 
-> [!NOTE] `typescriptTypeChecked` needs a `tsconfig.json` in your project root
-> (`projectService` is used, so keep both `tsconfig.json` and
-> `tsconfig.node.json` etc. in a single root if needed). Use it instead of
-> `typescript`, not alongside.
+> [!NOTE]
+>
+> `plugins.typescriptTypeChecked()` требует `tsconfig.json` в корне проекта
+> (используется `projectService`, поэтому держите `tsconfig.json` и
+> `tsconfig.node.json` в одном корне, если нужно). Используйте его вместо
+> `plugins.typescript()`, а не вместе с ним.
+
+## Prettier или prettierConfig
+
+Оба варианта доступны, и они **не взаимозаменяемы**.
 
-## Formatting: `prettier` vs `prettierConfig`
+| Плагин                     | Пакет                    | Что делает                                                       |
+| -------------------------- | ------------------------ | ---------------------------------------------------------------- |
+| `plugins.prettierConfig()` | `eslint-config-prettier` | Только отключает форматирующие правила, конфликтующие с Prettier |
+| `plugins.prettier()`       | `eslint-plugin-prettier` | Дополнительно запускает сам Prettier как правило ESLint          |
 
-Both are included, and they are **not** interchangeable.
+Используйте `plugins.prettierConfig()`, если Prettier запускается отдельным
+шагом (редактор, CLI `prettier`, Husky). Используйте `plugins.prettier()`, если
+хотите, чтобы ESLint сам сообщал о форматировании и исправлял его за один
+проход - это медленнее и дублирует форматтер.
 
-| Export           | From                     | Effect                                           |
-| ---------------- | ------------------------ | ------------------------------------------------ |
-| `prettierConfig` | `eslint-config-prettier` | only turns off formatting rules that conflict    |
-| `prettier`       | `eslint-plugin-prettier` | additionally runs Prettier itself as a lint rule |
+## Разработка
 
-Use `prettierConfig` when Prettier runs as a separate step (editor, `prettier`
-CLI, Husky). Use `prettier` if you want ESLint to report and fix formatting in
-one pass — it is slower and duplicates the formatter.
+Просмотр итоговой конфигурации:
+
+```bash
+npm run inspect
+```
 
-## Usefull links
+## Полезные ссылки
 
 - [Awesome ESLint](https://github.com/dustinspecker/awesome-eslint)
+- [ESLint - Documentation](https://eslint.org/docs/latest/)
+- [ESLint - Configure Flat Config](https://eslint.org/docs/latest/use/configure/configuration-files)

package/packages/config-eslint/base.js

@@ -37,6 +37,7 @@ export const IGNORES = [
   '**/.*',
   '**/.*/**',
   '**/_deprecated/**',
+  '**/_legacy/**',
   '**/build/**',
   '**/dist/**',
   '**/docs/**',
@@ -49,12 +50,13 @@ export const IGNORES = [
  * Base config.
  *
  * Provides the file scope, the shared ignore patterns and the global variables.
- * Include it first, then the plugins you actually need.
+ * It is added automatically by `defineConfig`, so you never spread it
+ * yourself.
  *
  * @example
- *   import { base, javascript, unicorn } from '@alexlit/config-eslint';
+ *   import { defineConfig, plugins } from '@alexlit/config-eslint';
  *
- *   export default [...base, ...javascript, ...unicorn];
+ *   export default defineConfig([plugins.javascript(), plugins.unicorn()]);
  */
 export const base = defineConfig([
   { files: FILES, languageOptions: { globals: globals.browser } },

package/packages/config-eslint/index.d.ts

@@ -0,0 +1,112 @@
+import type { Linter } from 'eslint';
+
+/** Flat-конфиг ESLint. */
+export type Config = Linter.Config;
+
+/**
+ * Фабрики плагинов. Каждый вызов возвращает массив flat-конфигов, который нужно
+ * развернуть через spread-оператор: `...plugins.<name>()`.
+ */
+export interface Plugins {
+  /** @see eslint-plugin-de-morgan */
+  deMorgan(): Config[];
+  /** @see eslint-plugin-import-x */
+  importX(): Config[];
+  /** @see eslint */
+  javascript(): Config[];
+  /** @see eslint-plugin-jsdoc */
+  jsdoc(): Config[];
+  /** @see ESLint/JSON */
+  json(): Config[];
+  /** @see eslint-plugin-perfectionist */
+  perfectionist(): Config[];
+  /** @see eslint-plugin-pinia */
+  pinia(): Config[];
+  /** @see eslint-plugin-prettier */
+  prettier(): Config[];
+  /** @see eslint-config-prettier */
+  prettierConfig(): Config[];
+  /** @see eslint-plugin-regexp */
+  regexp(): Config[];
+  /** @see eslint-plugin-sonarjs */
+  sonar(): Config[];
+  /** @see @stylistic/eslint-plugin */
+  stylistic(): Config[];
+  /** @see eslint-plugin-tailwindcss */
+  tailwindcss(settings?: TailwindcssSettings): Config[];
+  /** @see @tanstack/query */
+  tanstackQuery(): Config[];
+  /** @see typescript-eslint */
+  typescript(): Config[];
+  /** @see typescript-eslint */
+  typescriptTypeChecked(): Config[];
+  /** @see eslint-plugin-unicorn */
+  unicorn(): Config[];
+  /** @see @unocss/eslint-config */
+  unocss(): Config[];
+  /** @see eslint-plugin-vitest */
+  vitest(): Config[];
+  /** @see eslint-plugin-vue */
+  vue(): Config[];
+  /** @see eslint-plugin-vuejs-accessibility */
+  vueAccessibility(): Config[];
+  /** @see eslint-plugin-vue-i18n */
+  vueI18n(): Config[];
+  /** @see eslint-plugin-zod */
+  zod(): Config[];
+}
+
+/** Ограничение синтаксиса - сообщение об ошибке и селектор AST. */
+export interface RestrictedSyntax {
+  message: string;
+  selector: string;
+}
+
+/** Настройки eslint-plugin-tailwindcss. */
+export interface TailwindcssSettings {
+  [key: string]: unknown;
+  /** Путь к CSS-файлу с Tailwind-конфигурацией */
+  cssConfigPath?: string;
+}
+
+/** Пространство имён фабрик плагинов. */
+export declare const plugins: Plugins;
+
+/**
+ * Базовый конфиг: область файлов, игнорируемые пути и глобальные переменные.
+ * Добавляется автоматически первым блоком в `defineConfig`.
+ */
+export declare const base: Config[];
+
+export declare const DATA_FILES: string[];
+export declare const DTS_FILES: string[];
+export declare const FILES: string[];
+export declare const IGNORES: string[];
+export declare const JSON_FILES: string[];
+export declare const NO_RESTRICTED_SYNTAX: RestrictedSyntax[];
+export declare const TEST_FILES: string[];
+export declare const TS_FILES: string[];
+export declare const TS_RULES: Record<string, Linter.RuleEntry>;
+export declare const VUE_FILES: string[];
+export declare const YAML_FILES: string[];
+
+/**
+ * Создать конфигурацию ESLint.
+ *
+ * Базовые настройки (`base`) добавляются автоматически и всегда идут первыми.
+ * Разворачивайте вызовы плагинов через spread-оператор, а переопределения
+ * добавляйте прямо в массив.
+ *
+ * @example
+ *   import { defineConfig, plugins } from '@alexlit/config-eslint';
+ *
+ *   export default defineConfig([
+ *     ...plugins.javascript(),
+ *     ...plugins.unicorn(),
+ *     ...plugins.prettierConfig(),
+ *     { rules: { 'no-console': 'off' } },
+ *   ]);
+ *
+ * @param configs - Массив flat-конфигов
+ */
+export declare function defineConfig(configs?: Config[]): Config[];