eslint-plugin-th-rules 2.7.1 → 3.0.0

package/docs/rules/no-boolean-coercion.md

@@ -1,9 +0,0 @@
-# th-rules/no-boolean-coercion
-
-📝 Disallow Boolean(value) or !!value. Enforce _.isNil(value) for scalar values and _.isEmpty(value) for strings, arrays, and objects.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
-
-<!-- end auto-generated rule header -->

package/docs/rules/no-comments.md

@@ -1,50 +0,0 @@
-# th-rules/no-comments
-
-📝 Disallow comments except for specified allowed patterns.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
-<!-- end auto-generated rule header -->
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name       | Description                                  | Type     |
-| :--------- | :------------------------------------------- | :------- |
-| `allow`    | Additional patterns to allow in comments.    | String[] |
-| `disallow` | Additional patterns to disallow in comments. | String[] |
-
-<!-- end auto-generated rule options list -->
-
-## Description
-
-This rule disallows comments unless they match specified allowed patterns. It ensures that only relevant and permitted comments are present in the codebase, such as TODOs, warnings, JSDoc comments, ESLint directives, etc.
-
-## Rule Details
-
-By default, the following comments are allowed:
-
-- TODO, WARNING, ERROR, INFO (case-insensitive).
-- ESLint directives like `/* eslint-disable */`.
-- JSDoc comments (any comment starting with `/**`).
-
-You can also configure additional patterns to allow or disallow specific types of comments.
-
-## Usage
-
-```json
-{
-  "rules": {
-    "th-rules/no-comments": [
-      "error",
-      {
-        "allow": ["keep", "important"],
-        "disallow": ["deprecated", "hack"]
-      }
-    ]
-  }
-}
-```

package/docs/rules/no-default-export.md

@@ -1,26 +0,0 @@
-# th-rules/no-default-export
-
-📝 Convert unnamed default exports to named default exports based on the file name.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
-<!-- end auto-generated rule header -->
-
-## Description
-
-Converts unnamed default exports to named default exports based on the file name. This rule helps maintain consistency in export names and facilitates easier identification of components or modules.
-
-## Rule Details
-
-This rule targets unnamed default exports and automatically generates a named export based on the file name.
-
-## Usage
-```json
-{
-  "rules": {
-    "no-default-export": "error"
-  }
-}
-```

package/docs/rules/no-destructuring.md

@@ -1,40 +0,0 @@
-# th-rules/no-destructuring
-
-📝 Disallow destructuring that does not meet certain conditions.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-<!-- end auto-generated rule header -->
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name                           | Type    |
-| :----------------------------- | :------ |
-| `maximumDestructuredVariables` | Integer |
-| `maximumLineLength`            | Integer |
-
-<!-- end auto-generated rule options list -->
-
-## Description
-
-This rule disallows destructuring that does not meet certain conditions, aiming to prevent overly complex destructuring patterns and ensure code readability.
-
-## Rule Details
-
-This rule checks for:
-
-- Destructuring at a nesting level above 3.
-- Destructuring of more than the specified maximum number of variables (default is 2).
-- Destructuring on a line exceeding the specified maximum line length (default is 100 characters).
-
-## Usage
-
-```json
-{
-  "rules": {
-    "th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
-  }
-}
-```

package/docs/rules/prefer-is-empty.md

@@ -1,9 +0,0 @@
-# th-rules/prefer-is-empty
-
-📝 Require _.isEmpty instead of length comparisons.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
-
-<!-- end auto-generated rule header -->

package/docs/rules/schemas-in-schemas-file.md

@@ -1,170 +0,0 @@
-# th-rules/schemas-in-schemas-file
-
-📝 Require Zod schema declarations to be placed in a .schemas.ts file.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-<!-- end auto-generated rule header -->
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-react`, `recommended-typescript`.
-
-&lt;!-- end auto-generated rule header --&gt;
-
-This rule enforces that Zod schema **declarations** are defined in dedicated schema files (by default: `.schemas.ts` / `.schemas.tsx`), rather than inside implementation/component files.
-
-The intent is to keep business logic and UI code focused, while consolidating validation/contract definitions into a predictable location.
-
-## Rationale
-
-Keeping Zod schemas in dedicated files:
-- reduces noise in implementation files (especially components and services),
-- encourages reuse of validation contracts across the codebase,
-- improves review quality by keeping diffs focused (schema changes vs logic changes),
-- standardizes file layout in larger projects and monorepos.
-
-## What the rule reports
-
-The rule reports Zod “schema builder” calls (e.g. `z.object(...)`, `z.string()`, `z.enum(...)`, `z.coerce.number()`, etc.) in files that do **not** match one of the allowed suffixes.
-
-By default, it identifies Zod usage by tracking imports from `'zod'` (e.g. `import { z } from 'zod'`, `import { z as zod } from 'zod'`, `import * as zod from 'zod'`).
-
-## Examples
-
-### ❌ Incorrect
-
-```ts
-// ArticleCard.tsx
-import {z} from 'zod';
-
-const articleSchema = z.object({
-	id: z.string(),
-	title: z.string().min(1),
-});
-```
-
-```ts
-// user.ts
-import {z as zod} from 'zod';
-
-export const userSchema = zod.object({
-	email: zod.string().email(),
-});
-```
-
-### ✅ Correct
-
-```ts
-// ArticleCard.schemas.ts
-import {z} from 'zod';
-
-export const articleSchema = z.object({
-	id: z.string(),
-	title: z.string().min(1),
-});
-```
-
-```ts
-// ArticleCard.tsx
-import {articleSchema} from './ArticleCard.schemas';
-
-export function ArticleCard() {
-	// articleSchema is used here (validation, inference, etc.)
-	return null;
-}
-```
-
-### Allowed usage (always allowed)
-
-Using schemas and type inference is allowed anywhere:
-
-```ts
-import type {z} from 'zod';
-import {articleSchema} from './ArticleCard.schemas';
-
-export type Article = z.infer&lt;typeof articleSchema&gt;;
-```
-
-## Options
-
-&lt;!-- begin auto-generated rule options list --&gt;
-
-| Name               | Type     |
-| :----------------- | :------- |
-| `allowedSuffixes`  | String[] |
-| `allowInTests`     | Boolean  |
-| `onlyWhenAssigned` | Boolean  |
-
-&lt;!-- end auto-generated rule options list --&gt;
-
-### `allowedSuffixes`
-
-An array of filename suffixes that are allowed to contain Zod schema declarations.
-
-Default:
-- `.schemas.ts`
-- `.schemas.tsx`
-
-Example:
-
-```json
-{
-  "rules": {
-    "th-rules/schemas-in-schemas-file": ["error", {
-      "allowedSuffixes": [".schemas.ts", ".schemas.tsx", ".validation.ts"]
-    }]
-  }
-}
-```
-
-### `allowInTests`
-
-When set to `true`, the rule allows Zod schema declarations in common test file patterns (e.g. `*.test.ts`, `*.spec.ts`, `*.test.tsx`, `*.spec.tsx`).
-
-Default: `false`
-
-Example:
-
-```json
-{
-  "rules": {
-    "th-rules/schemas-in-schemas-file": ["error", {
-      "allowInTests": true
-    }]
-  }
-}
-```
-
-### `onlyWhenAssigned`
-
-When set to `true`, the rule reports only Zod schema builder calls that are assigned to a variable (or assigned via `=`), for example:
-
-```ts
-const userSchema = z.object({ ... });
-userSchema = z.object({ ... });
-```
-
-If set to `false` (default), the rule reports any Zod schema builder call found in a non-allowed file, including inline schemas:
-
-```ts
-foo(z.object({ ... }));
-```
-
-Default: `false`
-
-Example:
-
-```json
-{
-  "rules": {
-    "th-rules/schemas-in-schemas-file": ["error", {
-      "onlyWhenAssigned": true
-    }]
-  }
-}
-```
-
-## Notes
-
-- This rule is filename-based; it enforces a convention rather than performing semantic analysis.
-- The rule does not auto-fix, as moving schemas across files safely (and updating imports) is not generally safe to automate.
-- If you define Zod builders through wrappers (e.g. `createSchema(...)` that internally calls Zod), this rule will not detect those unless extended to match your helper patterns.

package/docs/rules/top-level-functions.md

@@ -1,48 +0,0 @@
-# th-rules/top-level-functions
-
-📝 Require all top-level functions to be named/regular functions.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
-<!-- end auto-generated rule header -->
-
-## Description
-
-This rule requires all top-level functions to be named/regular functions, preventing the use of arrow functions at the top level. This rule aims to improve code readability and maintainability by enforcing consistent function declaration styles.
-
-## Rule Details
-
-This rule checks for arrow functions at the top level and reports them as errors.
-
-Examples of **incorrect** code for this rule:
-
-```js
-const myFunction = () => {
-  // Function body
-};
-```
-
-Examples of **correct** code for this rule:
-
-```js
-function myFunction() {
-  // Function body
-}
-```
-
-## Usage
-
-```json
-{
-  "rules": {
-    "th-rules/top-level-functions": "error"
-  }
-}
-```
-
-
-## When Not To Use It
-
-If you do not want to enforce consistent function declaration styles, you can disable this rule.

package/docs/rules/types-in-dts.md

@@ -1,112 +0,0 @@
-# th-rules/types-in-dts
-
-📝 Require TypeScript type declarations (type/interface/enum) to be placed in .d.ts files.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-<!-- end auto-generated rule header -->
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-react`, `recommended-typescript`.
-
-&lt;!-- end auto-generated rule header --&gt;
-
-This rule enforces a strict separation between **runtime code** and **type declarations** by requiring all top-level TypeScript type declarations to be defined in `.d.ts` files.
-
-The rule applies to:
-- `type` aliases
-- `interface` declarations
-- `enum` declarations
-
-Any of these constructs declared outside of a `.d.ts` file will be reported, unless explicitly allowed via configuration.
-
-## Rationale
-
-Keeping type declarations in `.d.ts` files provides several benefits:
-
-- Enforces a clean architectural boundary between runtime logic and type definitions
-- Improves file readability by reducing noise in implementation files
-- Encourages intentional, centralized ownership of public and shared types
-- Prevents accidental runtime coupling with type-only constructs
-- Aligns well with library-oriented or API-driven codebases
-
-This rule is especially useful in large TypeScript projects, shared packages, or monorepos where type contracts are meant to be consumed independently of implementation.
-
-## Examples
-
-### ❌ Incorrect
-
-```ts
-// user.ts
-type UserId = string;
-
-interface User {
-  id: UserId;
-  name: string;
-}
-
-enum Role {
-  Admin,
-  User,
-}
-```
-
-### ✅ Correct
-
-```ts
-// user.d.ts
-type UserId = string;
-
-interface User {
-  id: UserId;
-  name: string;
-}
-
-enum Role {
-  Admin,
-  User,
-}
-```
-
-```ts
-// user.ts
-import type { User, UserId, Role } from './user';
-```
-
-### Allowed usage
-
-Using types, interfaces, or enums is always allowed in any file:
-
-```ts
-function getUser(id: UserId): User {
-  // ...
-}
-```
-
-## Options
-
-&lt;!-- begin auto-generated rule options list --&gt;
-
-| Name           | Type    |
-| :------------- | :------ |
-| `allowDeclare` | Boolean |
-| `allowEnums`   | Boolean |
-
-&lt;!-- end auto-generated rule options list --&gt;
-
-### `allowDeclare`
-
-When set to `true`, the rule allows `declare` type declarations in non-`.d.ts` files.
-
-This is useful when working with ambient declarations, global augmentations, or compatibility shims that must live alongside implementation code.
-
-### `allowEnums`
-
-When set to `true`, the rule allows `enum` declarations in non-`.d.ts` files.
-
-This can be helpful in codebases that rely on runtime enums while still wanting to enforce `.d.ts` placement for interfaces and type aliases.
-
-## Notes
-
-- This rule does not enforce how types are imported or re-exported.
-- It does not attempt to auto-fix violations, as moving declarations across files is not safe to do automatically.
-- The rule operates purely at the syntax level and does not require type information.

package/renovate.json

@@ -1,3 +0,0 @@
-{
-    "automerge": true
-}

package/scripts/verify.mjs

@@ -1,16 +0,0 @@
-import {ESLint} from 'eslint';
-import thRules from '../src/index.js';
-
-const run = async (name, config) => {
-	const eslint = new ESLint({
-		overrideConfigFile: true,
-		overrideConfig: config,
-	});
-
-	const results = await eslint.lintText('const x = 1;\n', {filePath: 'fixtures/test.js'});
-	console.log(`OK: ${name} (${results[0].messages.length} messages)`);
-};
-
-await run('recommended', thRules.configs.recommended);
-await run('recommended-typescript', thRules.configs['recommended-typescript']);
-await run('recommended-react', thRules.configs['recommended-react']);

package/src/index.js

@@ -1,144 +0,0 @@
-/* eslint-disable import-x/order */
-/* eslint-disable n/no-path-concat */
-/* eslint-disable unicorn/prefer-module */
-
-'use strict';
-
-const requireIndex = require('requireindex');
-const globals = require('globals');
-const {FlatCompat} = require('@eslint/eslintrc');
-const reactPlugin = require('eslint-plugin-react');
-const reactHooks = require('eslint-plugin-react-hooks');
-const tseslint = require('typescript-eslint');
-const lodashPlugin = require('eslint-plugin-lodash');
-
-const nPlugin = require('eslint-plugin-n');
-const sonarjsPlugin = require('eslint-plugin-sonarjs');
-const securityPlugin = require('eslint-plugin-security');
-
-const plugin = {
-	rules: requireIndex(`${__dirname}/rules`),
-	configs: {},
-};
-
-// Flattens configs so we never embed arrays inside arrays (avoids "Unexpected key '0'")
-const asArray = value => (Array.isArray(value) ? value : [value]);
-const flatConfigs = (...items) => items.flatMap(element => asArray(element));
-
-// Converts legacy "extends"/eslintrc configs into flat config objects
-const compat = new FlatCompat({
-	baseDirectory: __dirname,
-});
-
-const baseRecommended = {
-	plugins: {
-		// Local rules
-		'th-rules': plugin,
-
-		// Third-party plugins used by rule names below
-		n: nPlugin,
-		sonarjs: sonarjsPlugin,
-		security: securityPlugin,
-		lodash: lodashPlugin,
-
-		// Included so consumers can use react/react-hooks rules as well
-		react: reactPlugin,
-		'react-hooks': reactHooks,
-	},
-	languageOptions: {
-		ecmaVersion: 2024,
-		sourceType: 'module',
-		globals: {
-			...globals.node,
-			...globals.es2024,
-			...globals.jest,
-		},
-	},
-	settings: {
-		react: {version: 'detect'},
-		lodash: {version: 4, pragma: '_'},
-	},
-	rules: {
-		'th-rules/no-destructuring': 'error',
-		'th-rules/no-default-export': 'error',
-		'th-rules/no-comments': 'error',
-		'th-rules/top-level-functions': 'error',
-		'th-rules/schemas-in-schemas-file': 'error',
-		'th-rules/types-in-dts': 'error',
-		'th-rules/no-boolean-coercion': 'error',
-		'th-rules/prefer-is-empty': 'error',
-		'unicorn/filename-case': 'off',
-		'unicorn/no-array-callback-reference': 'off',
-		'import/extensions': 'off',
-		'unicorn/no-static-only-class': 'off',
-		'unicorn/no-await-expression-member': 'off',
-		'new-cap': 'off',
-		'no-await-in-loop': 'off',
-		'n/file-extension-in-import': 'off',
-		'n/prefer-global/buffer': 'off',
-		'n/prefer-global/process': 'off',
-		'import/no-cycle': 'off',
-		camelcase: 'warn',
-		'sonarjs/mouse-events-a11y': 'off',
-		'sonarjs/no-unstable-nested-components': 'off',
-		'unicorn/prefer-global-this': 'off',
-		'unicorn/no-thenable': 'off',
-		'sonarjs/no-clear-text-protocols': 'off',
-		'security/detect-unsafe-regex': 'off',
-		'lodash/import-scope': [2, 'full'],
-		'@typescript-eslint/ban-types': 'off',
-		'@typescript-eslint/naming-convention': 'off',
-		'@typescript-eslint/no-restricted-types': 'off',
-		'import-x/extensions': 'off',
-		'lodash/chaining': ['error', 'implicit'],
-	},
-};
-
-/** @type {import('eslint').Linter.FlatConfig[]} */
-plugin.configs.recommended = flatConfigs(
-	// Legacy configs -> convert them
-	compat.extends('plugin:sonarjs/recommended-legacy', 'plugin:security/recommended-legacy', 'plugin:lodash/recommended'),
-	baseRecommended,
-);
-
-plugin.configs['recommended-typescript'] = flatConfigs(
-	plugin.configs.recommended,
-
-	// Typescript-eslint exports flat configs (arrays of flat config objects)
-	tseslint.configs.strictTypeChecked,
-	tseslint.configs.stylisticTypeChecked,
-
-	{
-		languageOptions: {
-			parserOptions: {
-				projectService: true,
-			},
-		},
-		rules: {
-			'@typescript-eslint/consistent-type-definitions': 'off',
-			'@typescript-eslint/no-extraneous-class': 'off',
-			'@typescript-eslint/no-duplicate-type-constituents': 'off',
-			'@typescript-eslint/no-non-null-assertion': 'off',
-			'@typescript-eslint/require-await': 'off',
-			'@typescript-eslint/no-unsafe-member-access': 'off',
-			'@typescript-eslint/no-unsafe-call': 'off',
-			'@typescript-eslint/no-unsafe-return': 'off',
-			'@typescript-eslint/no-unsafe-argument': 'off',
-		},
-	},
-);
-
-plugin.configs['recommended-react'] = flatConfigs(
-	plugin.configs.recommended,
-	compat.extends('plugin:react/recommended'),
-	compat.extends('plugin:react/jsx-runtime'),
-	compat.extends('plugin:react-hooks/recommended'),
-	{
-		rules: {
-			'n/prefer-global/process': 'off',
-			'react-hooks/set-state-in-effect': 'off',
-		},
-	},
-);
-
-module.exports = plugin;