mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-04-30 19:21:54 +00:00

Files

Dante cdf74c36f7 tool: add layer architecture boundary lint rule (#10109 )

## Summary
- Add `import-x/no-restricted-paths` ESLint rule enforcing the `base →
platform → workbench → renderer` layer hierarchy
- Set to `error` with eslint-disable comments on existing violations
(~11 suppressions)
- Consolidate zone definitions using array syntax for `from`/`target`
- Add `layer-audit` Claude skill for auditing violations
- Fix knip false positive for `zod` dependency in ingest-types

## Context
Ref:
https://github.com/Comfy-Org/ComfyUI_frontend/pull/10021#discussion_r2939392141

The codebase is migrating toward a layered architecture. This adds
static enforcement so new violations are caught in PR CI.

### Layer rules
| Layer | Can import from |
|---|---|
| `base/` | nothing |
| `platform/` | `base/` |
| `workbench/` | `platform/`, `base/` |
| `renderer/` | `workbench/`, `platform/`, `base/` |

### Current violations (pre-existing, suppressed with eslint-disable)
| Direction | Count |
|---|---|
| base → platform | 2 |
| platform → workbench | 3 |
| platform → renderer | 5 |
| workbench → renderer | 1 |

## Test plan
- [x] `pnpm lint` passes (0 errors, 0 warnings)
- [x] `pnpm typecheck` passes
- [x] `pnpm knip` passes
- [ ] CI green

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-17 02:08:25 -07:00

3.1 KiB

Raw Blame History

name, description

name	description
layer-audit	Detect violations of the layered architecture import rules (base -> platform -> workbench -> renderer). Runs ESLint with the import-x/no-restricted-paths rule and generates a grouped report.

Layer Architecture Audit

Finds imports that violate the layered architecture boundary rules enforced by import-x/no-restricted-paths in eslint.config.ts.

Layer Hierarchy (bottom to top)

renderer  (top -- can import from all lower layers)
   ^
workbench
   ^
platform
   ^
  base    (bottom -- cannot import from any upper layer)

Each layer may only import from layers below it.

How to Run

# Run ESLint filtering for just the layer boundary rule violations
pnpm lint 2>&1 | grep 'import-x/no-restricted-paths' -B1 | head -200

To get a full structured report, run:

# Collect all violations from base/, platform/, workbench/ layers
pnpm eslint src/base/ src/platform/ src/workbench/ --no-error-on-unmatched-pattern --rule '{"import-x/no-restricted-paths": "warn"}' --format compact 2>&1 | grep 'no-restricted-paths' | sort

How to Read Results

Each violation line shows:

The file containing the bad import
The import path crossing the boundary
The message identifying which layer pair is violated

Grouping by Layer Pair

After collecting violations, group them by the layer pair pattern:

Layer pair	Meaning
base -> platform	base/ importing from platform/
base -> workbench	base/ importing from workbench/
base -> renderer	base/ importing from renderer/
platform -> workbench	platform/ importing from workbench/
platform -> renderer	platform/ importing from renderer/
workbench -> renderer	workbench/ importing from renderer/

When to Use

Before creating a PR that adds imports between src/base/, src/platform/, src/workbench/, or src/renderer/
When auditing the codebase to find and plan migration of existing violations
After moving files between layers to verify no new violations were introduced

Fixing Violations

Common strategies to resolve a layer violation:

Move the import target down -- if the imported module doesn't depend on upper-layer concepts, move it to a lower layer
Introduce an interface -- define an interface/type in the lower layer and implement it in the upper layer via dependency injection or a registration pattern
Move the importing file up -- if the file logically belongs in a higher layer, relocate it
Extract shared logic -- pull the shared functionality into base/ or a shared utility

Reference

Resource	Path
ESLint config (rule definition)	`eslint.config.ts`
Base layer	`src/base/`
Platform layer	`src/platform/`
Workbench layer	`src/workbench/`
Renderer layer	`src/renderer/`

3.1 KiB Raw Blame History