@rnzeus/eslint-plugin 0.1.2 → 0.1.4

package/README.md

@@ -1,12 +1,13 @@
-# @rnzeus/eslint-plugin-style
+# @rnzeus/eslint-plugin
 
-ESLint plugin for React / React Native projects focused on **style discipline**.
+ESLint plugin for React / React Native projects focused on **style discipline** and **FSD import boundaries**.
 
 This plugin is designed to solve real-world problems that appear during refactoring:
 - unused styles left in `*.styles.ts` files
 - inconsistent style naming
 - unsafe dynamic style usage
 - passing whole `styles` objects to components
+- architectural erosion via unconstrained cross-slice imports (FSD)
 
 The plugin is **static**, **runtime-free**, and optimized for **ESLint Flat Config (ESLint v9+)**.
 
@@ -20,9 +21,10 @@ Ensures that all styles declared in `*.styles.ts(x)` files are actually used in
 **What it checks:**
 - detects unused style keys
 - forbids passing the whole `styles` object (`styles={styles}`)
-- supports arrays: `style={[styles.foo, styles.bar]}`
+- supports arrays: `style={[styles.foo, condition && styles.bar]}`
 - supports conditional styles
 - supports dynamic styles **only with explicit directive comments**
+- supports additional “style-like” props (configurable): e.g. `contentContainerStyle`
 
 **File convention (required):**
 ```
@@ -46,12 +48,48 @@ item_name: {}
 
 ---
 
+### ✅ `rnzeus/slice-imports`
+Enforces **FSD import boundaries** for alias imports:
+- **layer order**: lower layers cannot import higher layers
+- **same-slice imports** must be **relative**
+- **cross-slice** imports inside the same layer are allowed only via `@x/<currentSlice>`
+
+This rule validates only alias imports starting with `@` (relative imports are ignored).
+
+**Assumed structure (defaults):**
+- `srcRoot`: `"src"`
+- `layers`: `shared -> entities -> features -> widgets -> pages -> app`
+
+**Examples (same slice must be relative):**
+```ts
+// file: src/features/auth/ui/Login.tsx
+
+// ❌ bad (same slice via alias)
+import { submit } from "@features/auth/model/submit";
+
+// ✅ good
+import { submit } from "../model/submit";
+```
+
+**Examples (cross-slice via @x):**
+```ts
+// file: src/entities/product/ui/ProductCard.tsx
+
+// ❌ bad (direct cross-slice import inside same layer)
+import { getCartTotal } from "@entities/cart/model/getCartTotal";
+
+// ✅ good (cart exposes cross-slice API specifically for product slice)
+import { getCartTotal } from "@entities/cart/@x/product";
+```
+
+---
+
 ## Installation
 
 ```bash
-npm install -D @rnzeus/eslint-plugin-style
+npm install -D @rnzeus/eslint-plugin
 # or
-yarn add -D @rnzeus/eslint-plugin-style
+yarn add -D @rnzeus/eslint-plugin
 ```
 
 > Peer dependency: `eslint >= 9`
@@ -63,10 +101,11 @@ yarn add -D @rnzeus/eslint-plugin-style
 This plugin exports **ready-to-use flat config presets**.
 No `.default` access and no manual plugin wiring is required.
 
-### Import preset
+### Import presets
 
 ```js
-const styles = require('@rnzeus/eslint-plugin-style/configs/styles');
+const styles = require("@rnzeus/eslint-plugin/configs/styles");
+const imports = require("@rnzeus/eslint-plugin/configs/imports");
 ```
 
 ### Minimal setup
@@ -74,6 +113,7 @@ const styles = require('@rnzeus/eslint-plugin-style/configs/styles');
 ```js
 module.exports = [
   ...styles,
+  ...imports,
 ];
 ```
 
@@ -81,11 +121,71 @@ module.exports = [
 
 ```js
 const rnfsd = require('@rnzeus/themis/eslint/rnfsd');
-const styles = require('@rnzeus/eslint-plugin-style/configs/styles');
+const styles = require("@rnzeus/eslint-plugin/configs/styles");
+const imports = require("@rnzeus/eslint-plugin/configs/imports");
 
 module.exports = [
   ...rnfsd,
   ...styles,
+  ...imports,
+];
+```
+
+---
+
+## Configure `styles-usage` style props
+
+By default, `rnzeus/styles-usage` tracks style usage from these JSX props:
+
+- `style`
+- `contentContainerStyle`
+
+You can extend or override this list via rule options.
+
+### Merge (default)
+
+`type: "merge"` is the default behavior:
+- takes plugin defaults
+- adds your `styleProps`
+- de-duplicates
+
+Example (add FlatList prop):
+
+```js
+module.exports = [
+  ...styles,
+  {
+    rules: {
+      "rnzeus/styles-usage": [
+        "error",
+        {
+          styleProps: ["columnWrapperStyle"],
+          type: "merge", // optional (default)
+        },
+      ],
+    },
+  },
+];
+```
+
+### Override
+
+`type: "override"` ignores plugin defaults and uses **only** your `styleProps`.
+
+```js
+module.exports = [
+  ...styles,
+  {
+    rules: {
+      "rnzeus/styles-usage": [
+        "error",
+        {
+          styleProps: ["style"],
+          type: "override",
+        },
+      ],
+    },
+  },
 ];
 ```
 
@@ -119,6 +219,34 @@ This makes dynamic styles:
 
 ---
 
+## Configure `slice-imports`
+
+`rnzeus/slice-imports` supports these options:
+- `srcRoot` (default: `"src"`): marker folder used to detect layer/slice from absolute filename
+- `layers` (default: `["shared","entities","features","widgets","pages","app"]`): allowed layers in dependency order
+
+Example (custom `srcRoot` and layers):
+```js
+const imports = require("@rnzeus/eslint-plugin/configs/imports");
+
+module.exports = [
+  ...imports,
+  {
+    rules: {
+      "rnzeus/slice-imports": [
+        "error",
+        {
+          srcRoot: "src",
+          layers: ["shared", "entities", "features", "widgets", "pages", "app"],
+        },
+      ],
+    },
+  },
+];
+```
+
+---
+
 ## Rules
 
 ### `rnzeus/styles-usage`
@@ -126,10 +254,11 @@ This makes dynamic styles:
 | Check | Status |
 |-----|------|
 Unused styles | ✅ |
-Whole styles object | ❌ |
+Whole styles object (`styles={styles}`) | ❌ |
 Array styles | ✅ |
 Conditional styles | ✅ |
 Dynamic styles | ⚠️ (directive required) |
+Extra style props | ✅ (configurable) |
 
 ---
 
@@ -148,6 +277,17 @@ Regex used:
 
 ---
 
+### `rnzeus/slice-imports`
+
+| Check | Status |
+|-----|------|
+Layer order (lower cannot import higher) | ✅ |
+Same slice must be relative | ✅ |
+Cross-slice via `@x/<currentSlice>` | ✅ |
+Relative imports | Ignored |
+
+---
+
 ## Philosophy
 
 This plugin intentionally: