@rnzeus/eslint-plugin 0.1.4 → 0.1.5

package/README.md

@@ -3,6 +3,7 @@
 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
@@ -16,9 +17,11 @@ The plugin is **static**, **runtime-free**, and optimized for **ESLint Flat Conf
 ## Features
 
 ### ✅ `rnzeus/styles-usage`
+
 Ensures that all styles declared in `*.styles.ts(x)` files are actually used in the corresponding component file.
 
 **What it checks:**
+
 - detects unused style keys
 - forbids passing the whole `styles` object (`styles={styles}`)
 - supports arrays: `style={[styles.foo, condition && styles.bar]}`
@@ -27,6 +30,7 @@ Ensures that all styles declared in `*.styles.ts(x)` files are actually used in
 - supports additional “style-like” props (configurable): e.g. `contentContainerStyle`
 
 **File convention (required):**
+
 ```
 Component.tsx
 Component.styles.ts
@@ -35,21 +39,27 @@ Component.styles.ts
 ---
 
 ### ✅ `rnzeus/styles-naming`
+
 Enforces **snake_case** naming for style keys.
 
 **Example:**
+
 ```ts
 // ❌ bad
-itemName: {}
+itemName: {
+}
 
 // ✅ good
-item_name: {}
+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>`
@@ -57,10 +67,12 @@ Enforces **FSD import boundaries** for alias imports:
 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
 
@@ -72,6 +84,7 @@ import { submit } from "../model/submit";
 ```
 
 **Examples (cross-slice via @x):**
+
 ```ts
 // file: src/entities/product/ui/ProductCard.tsx
 
@@ -111,24 +124,18 @@ const imports = require("@rnzeus/eslint-plugin/configs/imports");
 ### Minimal setup
 
 ```js
-module.exports = [
-  ...styles,
-  ...imports,
-];
+module.exports = [...styles, ...imports];
 ```
 
 ### With other presets
 
 ```js
-const rnfsd = require('@rnzeus/themis/eslint/rnfsd');
+const rnfsd = require("@rnzeus/themis/eslint/rnfsd");
+const base = require("@rnzeus/eslint-plugin/configs/base");
 const styles = require("@rnzeus/eslint-plugin/configs/styles");
 const imports = require("@rnzeus/eslint-plugin/configs/imports");
 
-module.exports = [
-  ...rnfsd,
-  ...styles,
-  ...imports,
-];
+module.exports = [...rnfsd, ...styles, ...imports];
 ```
 
 ---
@@ -145,6 +152,7 @@ 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
@@ -207,12 +215,14 @@ You **must** explicitly document allowed keys using a directive comment:
 ```
 
 Supported comment forms:
+
 ```ts
 // rnzeus-styles-used: a | b
 /* rnzeus-styles-used: a | b */
 ```
 
 This makes dynamic styles:
+
 - explicit
 - reviewable
 - safe during refactors
@@ -222,10 +232,12 @@ 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");
 
@@ -251,46 +263,48 @@ module.exports = [
 
 ### `rnzeus/styles-usage`
 
-| Check | Status |
-|-----|------|
-Unused styles | ✅ |
-Whole styles object (`styles={styles}`) | ❌ |
-Array styles | ✅ |
-Conditional styles | ✅ |
-Dynamic styles | ⚠️ (directive required) |
-Extra style props | ✅ (configurable) |
+| Check                                   | Status                  |
+| --------------------------------------- | ----------------------- |
+| Unused styles                           | ✅                      |
+| Whole styles object (`styles={styles}`) | ❌                      |
+| Array styles                            | ✅                      |
+| Conditional styles                      | ✅                      |
+| Dynamic styles                          | ⚠️ (directive required) |
+| Extra style props                       | ✅ (configurable)       |
 
 ---
 
 ### `rnzeus/styles-naming`
 
-| Rule | Status |
-|----|----|
-snake_case only | ✅ |
-camelCase | ❌ |
-PascalCase | ❌ |
+| Rule            | Status |
+| --------------- | ------ |
+| snake_case only | ✅     |
+| camelCase       | ❌     |
+| PascalCase      | ❌     |
 
 Regex used:
+
 ```ts
-/^[a-z][a-z0-9_]*$/
+/^[a-z][a-z0-9_]*$/;
 ```
 
 ---
 
 ### `rnzeus/slice-imports`
 
-| Check | Status |
-|-----|------|
-Layer order (lower cannot import higher) | ✅ |
-Same slice must be relative | ✅ |
-Cross-slice via `@x/<currentSlice>` | ✅ |
-Relative imports | Ignored |
+| 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:
+
 - avoids runtime helpers
 - avoids TypeScript compiler APIs
 - avoids project-wide analysis