eslint-plugin-nextfriday 3.2.1 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-nextfriday",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "A comprehensive ESLint plugin providing custom rules and configurations for Next Friday development workflows.",
   "keywords": [
     "eslint",

package/docs/rules/ENFORCE_CURLY_NEWLINE.md

@@ -1,55 +0,0 @@
-# enforce-curly-newline
-
-Enforce curly braces for multi-line if statements and forbid them for single-line.
-
-## Rule Details
-
-This rule manages curly braces for `IfStatement` based on visual layout (line breaks). Designed to work seamlessly with Prettier's line wrapping.
-
-### Logic
-
-1. **Single-line** (`startLine === endLine`): Braces are **forbidden**
-2. **Multi-line** (`startLine !== endLine`): Braces are **required**
-
-## Examples
-
-### Incorrect
-
-```ts
-if (!data) {
-  return [];
-}
-if (x > 0) {
-  doSomething();
-}
-```
-
-```ts
-if (veryLongCondition && anotherCondition) return [];
-```
-
-### Correct
-
-```ts
-if (!data) return [];
-if (x > 0) doSomething();
-```
-
-```ts
-if (veryLongCondition && anotherCondition) {
-  return [];
-}
-```
-
-## Auto-Fix
-
-This rule provides automatic fixes:
-
-- **Single-line with braces** → Removes braces (only when block contains single statement)
-- **Multi-line without braces** → Adds braces with proper indentation
-
-## When Not To Use It
-
-- If you prefer always using braces regardless of line count
-- If you prefer never using braces
-- If using a formatter that conflicts with this rule

package/docs/rules/FILE_KEBAB_CASE.md

@@ -1,70 +0,0 @@
-# file-kebab-case
-
-Enforce kebab-case filenames for .ts and .js files.
-
-## Rule Details
-
-This rule enforces that all TypeScript (.ts) and JavaScript (.js) files use kebab-case naming convention for their **filenames**. Kebab-case uses lowercase letters and hyphens to separate words, making filenames more consistent and URL-friendly. Single word filenames are considered valid kebab-case.
-
-**This rule checks the filename, not the code content.** Only `.ts` and `.js` files are checked; other file types are ignored.
-
-## Examples
-
-### Incorrect
-
-- `MyFile.ts` (PascalCase)
-- `camelCase.js` (camelCase)
-- `PascalCase.ts` (PascalCase)
-- `snake_case.js` (snake_case)
-- `UPPERCASE.ts` (UPPERCASE)
-- `My File.js` (contains spaces)
-
-### Correct
-
-- `my-file.ts`
-- `kebab-case.js`
-- `single.ts`
-- `file-with-numbers-123.js`
-- `user-service.ts`
-- `api-utils.ts`
-
-## Allowed Patterns and Edge Cases
-
-- **Only `.ts` and `.js` are checked.** `.tsx` and `.jsx` files are ignored — use [`jsx-pascal-case`](./JSX_PASCAL_CASE.md) for React component filenames.
-- **Compound extensions are allowed when each segment is kebab-case.** Both the basename and the trailing token before the file extension are validated independently. This pattern is useful for config, setup, spec, test, and rc files:
-  - `next.config.ts` ✓
-  - `vitest.setup.ts` ✓
-  - `user-service.test.ts` ✓
-  - `auth.spec.ts` ✓
-  - `eslint.rc.ts` ✓
-- **Numbers are allowed inside segments.** `file-with-numbers-123.ts` ✓
-- **Single-word filenames are valid.** `single.ts` ✓ (no hyphens needed)
-
-## Scoping the Rule
-
-This rule has **no built-in framework detection**. It checks every `.ts`/`.js` file it sees against kebab-case. In Next.js projects, routing directories (`app/`, `pages/`) contain framework-named files (`route.ts`, `middleware.ts`) that already happen to be kebab-case — but if you colocate helpers there with non-kebab names (`useThing.ts`, `MyHelper.ts`), the rule will flag them.
-
-The `nextjs` and `nextjs/recommended` presets ship with an override that **automatically disables this rule** for files under `app/**`, `src/app/**`, `pages/**`, and `src/pages/**` (matched against `*.{js,jsx,ts,tsx}`). Filename conventions in those directories are owned by the framework, not by this plugin. The `base` and `react` presets do **not** include this override — they enforce `file-kebab-case` on every `.ts`/`.js` regardless of directory.
-
-## Disabling the Rule
-
-To opt out for additional directories or file patterns, add an override in your flat config:
-
-```js
-import nextfriday from "eslint-plugin-nextfriday";
-
-export default [
-  nextfriday.configs["base/recommended"],
-
-  {
-    files: ["src/legacy/**/*.ts", "src/vendor/**/*.js"],
-    rules: {
-      "nextfriday/file-kebab-case": "off",
-    },
-  },
-];
-```
-
-## When Not To Use It
-
-If your project has established naming conventions that conflict with kebab-case, or if you're working with frameworks that require specific filename patterns, you may want to disable this rule.

package/docs/rules/JSX_PASCAL_CASE.md

@@ -1,71 +0,0 @@
-# jsx-pascal-case
-
-Enforce PascalCase filenames for .jsx and .tsx files.
-
-## Rule Details
-
-This rule enforces that JSX and TSX files use PascalCase naming convention for their **filenames**. This is a common pattern in React applications where components are typically named with PascalCase.
-
-**This rule checks the filename, not the code content.**
-
-## Examples
-
-### Incorrect
-
-- `my-component.jsx` (kebab-case)
-- `userProfile.jsx` (camelCase)
-- `user_profile.tsx` (snake_case)
-- `component.jsx` (lowercase)
-- `MYCOMPONENT.tsx` (UPPERCASE)
-- `My Component.jsx` (contains spaces)
-- `My.Component.tsx` (contains dots)
-
-### Correct
-
-- `MyComponent.jsx`
-- `UserProfile.tsx`
-- `App.jsx`
-- `LoginForm.tsx`
-- `UserProfile2.jsx` (PascalCase with numbers)
-
-## Scoping the Rule
-
-This rule has **no built-in framework detection** and no allowlist of "known" filenames. It checks every `.jsx`/`.tsx` it sees against PascalCase.
-
-The `nextjs` and `nextjs/recommended` presets ship with an override that **automatically disables this rule** for files under `app/**`, `src/app/**`, `pages/**`, and `src/pages/**` — Next.js owns those filenames (`page.tsx`, `layout.tsx`, `error.tsx`, etc.). If you use a `nextjs` preset, you do not need to add a routing override yourself.
-
-The `base` and `react` presets do **not** include this override. If you use `react` on a Next.js project (or any project that mixes PascalCase component files with lowercase framework routing files), scope the rule explicitly via ESLint's `files` glob:
-
-```js
-import nextfriday from "eslint-plugin-nextfriday";
-
-export default [
-  nextfriday.configs.react,
-
-  {
-    files: ["src/components/**/*.{jsx,tsx}", "components/**/*.{jsx,tsx}"],
-    rules: {
-      "nextfriday/jsx-pascal-case": "error",
-    },
-  },
-
-  {
-    files: ["src/app/**/*.{jsx,tsx}", "app/**/*.{jsx,tsx}", "src/pages/**/*.{jsx,tsx}", "pages/**/*.{jsx,tsx}"],
-    rules: {
-      "nextfriday/jsx-pascal-case": "off",
-    },
-  },
-];
-```
-
-The first override turns the rule on only inside component directories where PascalCase is the convention. The second override explicitly disables the rule for Next.js routing directories where the framework owns the filename.
-
-The plugin deliberately does not try to detect Next.js, Remix, or other framework conventions outside of the `nextjs` preset — folder structures vary across projects (monorepos, custom `app` locations, hybrid Pages + App Router setups), and a built-in allowlist would inevitably go stale. ESLint's `files` glob is the deterministic way to express the scope you actually want.
-
-## When Not To Use It
-
-If your project uses different naming conventions for JSX/TSX files, you can disable this rule.
-
-## Related Rules
-
-- [file-kebab-case](./FILE_KEBAB_CASE.md) - For regular TypeScript and JavaScript files

package/docs/rules/NEXTJS_REQUIRE_PUBLIC_ENV.md

@@ -1,44 +0,0 @@
-# nextjs-require-public-env
-
-Require `NEXT_PUBLIC_` prefix for environment variables in client components.
-
-## Rule Details
-
-This rule ensures that environment variables accessed in Next.js client components (files with `"use client"` directive) use the `NEXT_PUBLIC_` prefix. In Next.js, only environment variables prefixed with `NEXT_PUBLIC_` are exposed to the browser. Only files with `"use client"` directive are checked. `NODE_ENV` is always allowed.
-
-## Examples
-
-### Incorrect
-
-```tsx
-"use client";
-
-// These will be undefined at runtime!
-const url = process.env.API_URL;
-const secret = process.env.DATABASE_SECRET;
-const key = process.env.PRIVATE_API_KEY;
-```
-
-### Correct
-
-```tsx
-"use client";
-
-// Properly prefixed for client-side access
-const url = process.env.NEXT_PUBLIC_API_URL;
-const baseUrl = process.env.NEXT_PUBLIC_BASE_URL;
-
-// NODE_ENV is always available
-const isDev = process.env.NODE_ENV === "development";
-```
-
-```tsx
-// Server component (no "use client") - any env var is allowed
-const dbUrl = process.env.DATABASE_URL;
-const secret = process.env.API_SECRET;
-```
-
-## When Not To Use It
-
-- If you're not using Next.js
-- If you have a custom build setup that exposes env vars differently