@sarj/eslint-plugin 1.0.1 → 2.0.0

package/README.md

@@ -1,138 +1,17 @@
 # @sarj/eslint-plugin
 
-Custom ESLint rules collection for Sarj projects. Supports ESLint 9+ flat config format.
-
-## Installation
+Custom ESLint rules for hypermodern TypeScript / React / Next.js projects.
 
 ```bash
-yarn add -D @sarj/eslint-plugin eslint
+pnpm add -D @sarj/eslint-plugin
 ```
 
-## Usage (ESLint 9+ Flat Config)
-
 ```js
-// eslint.config.js
-import sarj, { configs } from "@sarj/eslint-plugin";
-
-export default [
-  // Use a preset config
-  ...configs.recommended,
-
-  // Or configure manually
-  {
-    plugins: {
-      "@sarj": sarj,
-    },
-    rules: {
-      "@sarj/zod-naming-convention": "warn",
-      "@sarj/require-assert-never": "error",
-    },
-  },
-];
-```
-
-## Available Configs
-
-| Config | Description |
-|--------|-------------|
-| `configs.recommended` | Basic sarj rules for everyday use |
-| `configs.strict` | All sarj rules at error level |
-| `configs.style-guide` | Comprehensive rules (sarj + core ESLint) |
-
-## Rules
-
-| Rule | Description | Recommended |
-|------|-------------|-------------|
-| `@sarj/zod-naming-convention` | Enforce Zod schemas to be named with a Z prefix | warn |
-| `@sarj/require-assert-never` | Require assertNever in switch default cases | error |
-| `@sarj/require-zod-form-validation` | Require Zod validation when parsing FormData | error |
-| `@sarj/enforce-file-structure` | Enforce consistent file structure | warn |
-| `@sarj/no-raw-env` | Disallow direct process.env access | - |
-| `@sarj/prefer-shadcn` | Prefer shadcn/ui components over native HTML | - |
-| `@sarj/no-enum` | Disallow TypeScript enums | - |
-
-## Rule Details
-
-### `zod-naming-convention`
-
-Ensures Zod schemas are named with a Z prefix for consistency.
-
-```ts
-// Bad
-const userSchema = z.object({ name: z.string() });
-
-// Good
-const ZUserSchema = z.object({ name: z.string() });
-```
-
-### `require-assert-never`
-
-Ensures switch statements with default cases use assertNever for exhaustive type checking.
-
-```ts
-// Bad
-switch (status) {
-  case "active":
-    return 1;
-  default:
-    return 0;
-}
-
-// Good
-switch (status) {
-  case "active":
-    return 1;
-  default:
-    assertNever(status);
-}
-```
-
-### `no-raw-env`
-
-Disallows direct access to process.env. Use a Zod-validated env schema instead.
-
-```ts
-// Bad
-const apiKey = process.env.API_KEY;
-
-// Good
-const apiKey = env.API_KEY; // from validated schema
-```
-
-### `prefer-shadcn`
-
-Encourages use of shadcn/ui components instead of native HTML elements.
-
-```tsx
-// Bad
-<button onClick={handleClick}>Submit</button>
-
-// Good
-<Button onClick={handleClick}>Submit</Button>
+// eslint.config.mjs
+import sarj from "@sarj/eslint-plugin";
+export default [...sarj.configs.recommended];
 ```
 
-### `no-enum`
-
-Discourages TypeScript enums in favor of union types or const objects.
-
-```ts
-// Bad
-enum Status {
-  Active,
-  Inactive,
-}
-
-// Good
-type Status = "active" | "inactive";
-// or
-const Status = { ACTIVE: "active", INACTIVE: "inactive" } as const;
-```
-
-## Requirements
-
-- ESLint >= 9.0.0
-- Node.js >= 18.0.0
-
-## License
+Each rule's source under `lib/rules/` carries its own `meta.docs.description` + `meta.messages` — read the file for full rationale.
 
-MIT
+Presets: `recommended` (warn-first), `strict` (every rule at error), `style-guide` (formatting/naming subset).