eslint-plugin-weld 0.0.4-rc.2 → 0.2.0

package/README.md

@@ -2,22 +2,33 @@
 
 Подход к организации кода во frontend-приложениях и инструменты для его соблюдения.
 
-## Что это
+## Ключевые идеи подхода
 
-WELD описывает, как разложить frontend-приложение по слоям и как провести границы между модулями
-так, чтобы эти границы держались со временем. Ключевая идея — строгая инкапсуляция: модуль публикует
-наружу узкий, осознанно спроектированный интерфейс, а всё остальное остаётся его внутренним делом.
-Слои задают направление зависимостей, инкапсуляция не даёт им расползтись.
+### 1. Баррель = граница модуля
 
-Правила такого рода почти невозможно удержать одними договорённостями в команде — поэтому
-репозиторий содержит не только документацию подхода, но и ESLint-плагин, который проверяет
-соблюдение правил автоматически.
+Папка с `index.ts` — модуль с публичным интерфейсом: что в барреле — публично, остальное недоступно
+снаружи.
+
+Префикс `_` и папка `internal/` прячут содержимое даже там, где барреля нет.
+
+### 2. Однонаправленность зависимостей
+
+Слой не импортирует ничего из слоев выше.
+
+### 3. Слои задает проект
+
+Список и порядок слоёв задаёт проект.
+
+### 4. Общие слои и фрактальность модулей
+
+Общие слои наверху, модули в `modules/` — со слоями или без, с вложенными модулями в собственной
+`modules/`. Правила одинаковы на любой глубине.
 
 ## Статус
 
-Ранняя стадия. Документация пишется; ESLint-плагин опубликован как основа — пакет собирается,
-подключается и проходит CI, но правил в нём пока нет. Правила и их именование могут меняться без
-обратной совместимости.
+Ранняя стадия. Документация подхода пишется; в ESLint-плагине реализовано первое правило —
+[`weld/no-barrel-bypass`](docs/rules/no-barrel-bypass.md). Правила и их именование могут меняться
+без обратной совместимости.
 
 ## ESLint-плагин
 
@@ -35,6 +46,14 @@ import weld from 'eslint-plugin-weld';
 export default [weld.configs.recommended];
 ```
 
+Плагин предоставляет готовые наборы правил `recommended` и `strict`:
+
+```js
+import weld from 'eslint-plugin-weld';
+
+export default [weld.configs.strict];
+```
+
 Можно подключить и сам плагин, включая правила поштучно:
 
 ```js
@@ -44,12 +63,47 @@ export default [
     {
         plugins: { weld },
         rules: {
-            // правила появятся здесь по мере реализации
+            'weld/no-barrel-bypass': 'error',
+        },
+    },
+];
+```
+
+### Правила
+
+- [`weld/no-barrel-bypass`](docs/rules/no-barrel-bypass.md) — запрещает импорты, которые входят
+  внутрь модуля мимо его точки входа (`index.*`), минуя баррель.
+
+Правило учитывает алиасы путей и корень репозитория. Если алиасы не заданы в конфиге, они
+автоматически подхватываются из `compilerOptions.paths` ближайшего `tsconfig.json` (с резолвом
+`extends`); задать их явно можно через `settings.weld`:
+
+```js
+export default [
+    {
+        settings: {
+            weld: {
+                repoRoot: '.', // необязательно; по умолчанию — авто-поиск
+                aliasesBaseUrl: 'packages/app', // необязательно; по умолчанию '.'
+                aliases: { '@/*': ['src/*'] },
+            },
         },
     },
 ];
 ```
 
+Формат и разбор этих настроек описаны в [документации настроек](docs/settings.md); подробности
+самого правила — в [документации правила](docs/rules/no-barrel-bypass.md).
+
+### Отладка
+
+Плагин использует пакет [`debug`](https://www.npmjs.com/package/debug) под namespace
+`eslint-plugin-weld:*`:
+
+```sh
+DEBUG=eslint-plugin-weld:* npx eslint .
+```
+
 ## Разработка
 
 Нужен Node 20.19+ и Yarn 4 (через corepack: `corepack enable`).

package/dist/index.d.ts

@@ -1,44 +1,18 @@
+import * as node_modules__eslint_core_dist_cjs_types_cjs from 'node_modules/@eslint/core/dist/cjs/types.cjs';
+import * as eslint from 'eslint';
 import { Linter } from 'eslint';
 
-/**
- * @fileoverview Shared types for ESLint Core.
- */
-
-/**
- * The human readable severity level used in a configuration.
- */
-type SeverityName = "off" | "warn" | "error";
-/**
- * The numeric severity level for a rule.
- *
- * - `0` means off.
- * - `1` means warn.
- * - `2` means error.
- */
-type SeverityLevel = 0 | 1 | 2;
-/**
- * The severity of a rule in a configuration.
- */
-type Severity = SeverityName | SeverityLevel;
-/**
- * The configuration for a rule.
- */
-type RuleConfig<RuleOptions extends unknown[] = unknown[]> = Severity | [Severity, ...Partial<RuleOptions>];
-/**
- * A collection of rules and their configurations.
- */
-interface RulesConfig {
-    [key: string]: RuleConfig;
-}
-
 declare const plugin: {
     meta: {
         name: string;
         version: string;
     };
-    rules: {};
+    rules: {
+        'no-barrel-bypass': eslint.Rule.RuleModule;
+    };
     configs: {
-        recommended: Linter.Config<RulesConfig>;
+        recommended: Linter.Config<node_modules__eslint_core_dist_cjs_types_cjs.RulesConfig>;
+        strict: Linter.Config<node_modules__eslint_core_dist_cjs_types_cjs.RulesConfig>;
     };
 };