eslint-plugin-th-rules 1.19.1 → 1.19.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.19.3](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.19.2...v1.19.3) (2026-01-06)
+
+
+### Bug Fixes
+
+* remove styles-in-styles-file rule and update configs ([e6779c2](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/e6779c2d6bf367fc9474c0ded5977b0a03ad159f))
+
+## [1.19.2](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.19.1...v1.19.2) (2026-01-05)
+
+
+### Bug Fixes
+
+* clean up JSDoc comments and improve code readability in no-destructuring rule ([f7c2547](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/f7c2547e71d41d19c874b1713c62bed25018803c))
+
 ## [1.19.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.19.0...v1.19.1) (2026-01-05)
 
 

package/README.md

@@ -22,7 +22,6 @@ This repository contains custom ESLint rules to enhance code quality and consist
 | [no-default-export](docs/rules/no-default-export.md)             | Convert unnamed default exports to named default exports based on the file name.       | ✅ ⚛️ 🟦 | 🔧 |
 | [no-destructuring](docs/rules/no-destructuring.md)               | Disallow destructuring that does not meet certain conditions                           | ✅ ⚛️ 🟦 |    |
 | [schemas-in-schemas-file](docs/rules/schemas-in-schemas-file.md) | Require Zod schema declarations to be placed in a .schemas.ts file                     | ✅ ⚛️ 🟦 |    |
-| [styles-in-styles-file](docs/rules/styles-in-styles-file.md)     | Require React-Native StyleSheet.create(...) to be placed in a .styles.ts file          | ✅ ⚛️ 🟦 |    |
 | [top-level-functions](docs/rules/top-level-functions.md)         | Require all top-level functions to be named/regular functions.                         | ✅ ⚛️ 🟦 | 🔧 |
 | [types-in-dts](docs/rules/types-in-dts.md)                       | Require TypeScript type declarations (type/interface/enum) to be placed in .d.ts files | ✅ ⚛️ 🟦 |    |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-th-rules",
-  "version": "1.19.1",
+  "version": "1.19.3",
   "description": "A List of custom ESLint rules created by Tomer Horowitz",
   "keywords": [
     "eslint",

package/src/index.js

@@ -19,7 +19,6 @@ const configs = {
 			'th-rules/no-default-export': 'error',
 			'th-rules/no-comments': 'error',
 			'th-rules/top-level-functions': 'error',
-			'th-rules/styles-in-styles-file': 'error',
 			'th-rules/schemas-in-schemas-file': 'error',
 			'th-rules/types-in-dts': 'error',
 			'unicorn/prefer-module': 'warn',

package/src/rules/no-destructuring.js

@@ -1,19 +1,5 @@
 const MAX_TAB_COUNT = 3;
 
-/**
- * Represents the metadata for the "no-destructuring" ESLint rule.
- *
- * @type {Object}
- * @property {string} type - The type of the rule.
- * @property {Object} docs - The documentation for the rule.
- * @property {string} docs.description - The description of the rule.
- * @property {string} docs.category - The category of the rule.
- * @property {boolean} docs.recommended - Indicates if the rule is recommended.
- * @property {Object[]} schema - The schema for the rule options.
- * @property {Object} schema[].properties - The properties of the rule options.
- * @property {number} schema[].properties.maximumDestructuredVariables - The maximum number of destructured variables allowed.
- * @property {number} schema[].properties.maximumLineLength - The maximum line length allowed.
- */
 const meta = {
 	type: 'problem',
 	docs: {
@@ -26,67 +12,103 @@ const meta = {
 		{
 			type: 'object',
 			properties: {
-				maximumDestructuredVariables: {
-					type: 'integer',
-					minimum: 0,
-				},
-				maximumLineLength: {
-					type: 'integer',
-					minimum: 0,
-				},
+				maximumDestructuredVariables: {type: 'integer', minimum: 0},
+				maximumLineLength: {type: 'integer', minimum: 0},
 			},
 			additionalProperties: false,
 		},
 	],
 };
 
-/**
- * Creates an ESLint rule that checks for excessive destructuring in variable declarations.
- * @param {Object} context - The ESLint rule context.
- * @returns {Object} - The ESLint rule object.
- */
 function create(context) {
-	const MAX_VARIABLES = context?.options[0]?.maximumDestructuredVariables || 2;
-	const MAX_LINE_LENGTH = context?.options[0]?.maximumLineLength || 100;
+	const MAX_VARIABLES = context?.options?.[0]?.maximumDestructuredVariables ?? 2;
+	const MAX_LINE_LENGTH = context?.options?.[0]?.maximumLineLength ?? 100;
 
-	return {
-		VariableDeclarator(node) {
-			const sourceCode = context.getSourceCode();
-			const line = sourceCode.lines[node.loc.start.line - 1];
-			const lineLength = line.length;
-			const tabCount = line.search(/\S|$/);
+	const sourceCode = context.getSourceCode();
+
+	function reportIfNeeded(patternNode, reportNode = patternNode) {
+		if (!patternNode || patternNode.type !== 'ObjectPattern' || !patternNode.loc) {
+			return;
+		}
 
-			if (node?.id?.type !== 'ObjectPattern') {
-				return;
+		const lineText = sourceCode.lines[patternNode.loc.start.line - 1] ?? '';
+		const indentCount = lineText.search(/\S|$/);
+
+		const propertyCount = patternNode.properties?.length ?? 0;
+
+		const startLine = patternNode.loc.start.line;
+		const endLine = patternNode.loc.end.line;
+		let maxSpannedLineLength = 0;
+		for (let i = startLine; i <= endLine; i++) {
+			const t = sourceCode.lines[i - 1] ?? '';
+			if (t.length > maxSpannedLineLength) {
+				maxSpannedLineLength = t.length;
 			}
+		}
+
+		if (indentCount > MAX_TAB_COUNT) {
+			context.report({
+				node: reportNode,
+				message: `destructuring at a nesting level above ${MAX_TAB_COUNT} is not allowed, instead saw ${indentCount} levels of nesting`,
+			});
+		}
 
-			if (tabCount > MAX_TAB_COUNT) {
-				context.report({
-					node,
-					message: `destructuring at a nesting level above ${MAX_TAB_COUNT} is not allowed, instead saw ${tabCount} levels of nesting`,
-				});
+		if (propertyCount > MAX_VARIABLES) {
+			context.report({
+				node: reportNode,
+				message: `destructuring of more than ${MAX_VARIABLES} variables is not allowed`,
+			});
+		}
+
+		if (maxSpannedLineLength > MAX_LINE_LENGTH) {
+			context.report({
+				node: reportNode,
+				message: `destructuring on a line exceeding ${MAX_LINE_LENGTH} characters is not allowed`,
+			});
+		}
+	}
+
+	function checkParameters(parameters) {
+		for (const p of parameters || []) {
+			if (!p) {
+				continue;
 			}
 
-			if (node?.id?.properties?.length > MAX_VARIABLES) {
-				context.report({
-					node,
-					message: `destructuring of more than ${MAX_VARIABLES} variables is not allowed`,
-				});
+			if (p.type === 'AssignmentPattern') {
+				reportIfNeeded(p.left, p);
+				continue;
 			}
 
-			if (lineLength > MAX_LINE_LENGTH) {
-				context.report({
-					node,
-					message: `destructuring on a line exceeding ${MAX_LINE_LENGTH} characters is not allowed`,
-				});
+			reportIfNeeded(p, p);
+		}
+	}
+
+	return {
+
+		VariableDeclarator(node) {
+			reportIfNeeded(node?.id, node);
+		},
+
+		FunctionDeclaration(node) {
+			checkParameters(node.params);
+		},
+		FunctionExpression(node) {
+			checkParameters(node.params);
+		},
+		ArrowFunctionExpression(node) {
+			checkParameters(node.params);
+		},
+
+		MethodDefinition(node) {
+			if (node?.value?.params) {
+				checkParameters(node.value.params);
 			}
 		},
+
+		TSDeclareFunction(node) {
+			checkParameters(node.params);
+		},
 	};
 }
 
-const rule = {
-	meta,
-	create,
-};
-
-module.exports = rule;
+module.exports = {meta, create};

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

@@ -1,141 +0,0 @@
-# th-rules/styles-in-styles-file
-
-📝 Require React-Native StyleSheet.create(...) to be placed in a .styles.ts file.
-
-💼 This rule is enabled in the following configs: ✅ `recommended`, ⚛️ `recommended-react`, 🟦 `recommended-typescript`.
-
-<!-- end auto-generated rule header -->
-
-This rule enforces that React-Native stylesheet declarations created via `StyleSheet.create(...)` live in a dedicated styles file, typically ending with `.styles.ts`.
-
-In practice, this prevents implementation/component files from containing large style objects, and encourages consistent separation of concerns.
-
-## Rationale
-
-Keeping styles in dedicated files:
-- improves readability of component files by reducing visual noise,
-- encourages reuse and consistency across components,
-- makes style changes easier to review (diffs focus only on styles),
-- standardizes project structure and naming conventions.
-
-## What the rule reports
-
-The rule reports any `StyleSheet.create(...)` call in files whose names do **not** match one of the allowed suffixes (by default, `.styles.ts`).
-
-Optionally, it can also report `StyleSheet.compose(...)` calls.
-
-## Examples
-
-### ❌ Incorrect
-
-```ts
-// ArticleCard.tsx
-import {StyleSheet} from 'react-native';
-
-const styles = StyleSheet.create({
-	container: {padding: 12},
-});
-```
-
-```ts
-// AnyOtherFile.ts
-import {StyleSheet} from 'react-native';
-
-export default StyleSheet.create({
-	row: {flexDirection: 'row'},
-});
-```
-
-### ✅ Correct
-
-```ts
-// ArticleCard.styles.ts
-import {StyleSheet} from 'react-native';
-
-export const styles = StyleSheet.create({
-	container: {padding: 12},
-});
-```
-
-```ts
-// ArticleCard.tsx
-import React from 'react';
-import {View} from 'react-native';
-import {styles} from './ArticleCard.styles';
-
-export function ArticleCard() {
-	return <View style={styles.container} />;
-}
-```
-
-### `includeCompose` example
-
-When `includeCompose: true`, the following becomes invalid outside a `.styles.ts(x)` file:
-
-```ts
-// ArticleCard.tsx
-import {StyleSheet} from 'react-native';
-
-const combined = StyleSheet.compose(
-	{padding: 12},
-	{margin: 8},
-);
-```
-
-With the same code moved to `ArticleCard.styles.ts`, it becomes valid.
-
-## Options
-
-<!-- begin auto-generated rule options list -->
-
-| Name              | Type     |
-| :---------------- | :------- |
-| `allowedSuffixes` | String[] |
-| `includeCompose`  | Boolean  |
-
-<!-- end auto-generated rule options list -->
-
-### `allowedSuffixes`
-
-An array of filename suffixes that are allowed to contain `StyleSheet.create(...)`.
-
-Default:
-- `.styles.ts`
-
-Example:
-
-```json
-{
-  "rules": {
-    "th-rules/styles-in-styles-file": ["error", {
-      "allowedSuffixes": [".styles.ts", ".native-styles.ts"]
-    }]
-  }
-}
-```
-
-### `includeCompose`
-
-When set to `true`, the rule also enforces the file restriction for `StyleSheet.compose(...)`.
-
-Default: `false`
-
-Example:
-
-```json
-{
-  "rules": {
-    "th-rules/styles-in-styles-file": ["error", {
-      "includeCompose": true
-    }]
-  }
-}
-```
-
-## Notes
-
-- This rule only targets `StyleSheet.create(...)` (and optionally `StyleSheet.compose(...)`). It does not restrict:
-  - plain object styles (e.g., `const styles = { ... }`),
-  - other styling systems (e.g., styled-components, Tamagui, Emotion),
-  - calls to other `StyleSheet.*` helpers (e.g., `flatten`, `hairlineWidth`).
-- The rule is filename-based. If ESLint is invoked with `<input>` (stdin), the rule will treat it as not being an allowed styles file.

package/src/rules/styles-in-styles-file.js

@@ -1,143 +0,0 @@
-const meta = {
-	type: 'problem',
-	docs: {
-		description: 'Require React-Native StyleSheet.create(...) to be placed in a .styles.ts file',
-		category: 'Stylistic Issues',
-		recommended: false,
-		url: 'https://github.com/tomerh2001/eslint-plugin-th-rules/blob/main/docs/rules/styles-in-styles-file.md',
-	},
-	schema: [
-		{
-			type: 'object',
-			properties: {
-				allowedSuffixes: {
-					type: 'array',
-					items: {type: 'string', minLength: 1},
-					minItems: 1,
-				},
-				includeCompose: {type: 'boolean'},
-			},
-			additionalProperties: false,
-		},
-	],
-	messages: {
-		moveStyles:
-			'React-Native styles must be defined in a dedicated styles file ({{suffixes}}).',
-	},
-};
-
-function create(context) {
-	const options = context.options?.[0] ?? {};
-	const allowedSuffixes = options.allowedSuffixes ?? ['.styles.ts'];
-	const includeCompose = Boolean(options.includeCompose);
-
-	function isAllowedStyleFile(filename) {
-		if (!filename || filename === '<input>') {
-			return false;
-		}
-
-		return allowedSuffixes.some(suffix => filename.endsWith(suffix));
-	}
-
-	function isStyleSheetMemberCall(node, memberName) {
-		const callee = node?.callee;
-		if (!callee || callee.type !== 'MemberExpression') {
-			return false;
-		}
-
-		const object = callee.object;
-		const property = callee.property;
-
-		return (
-			object?.type === 'Identifier'
-			&& object.name === 'StyleSheet'
-			&& !callee.computed
-			&& property?.type === 'Identifier'
-			&& property.name === memberName
-		);
-	}
-
-	/**
-	 * Try to infer the “name” of the style object, e.g.:
-	 *   const styles = StyleSheet.create(...)      -> "styles"
-	 *   styles = StyleSheet.create(...)            -> "styles"
-	 *   exports.styles = StyleSheet.create(...)    -> "exports.styles"
-	 */
-	function getAssignmentTargetName(callNode) {
-		const p = callNode.parent;
-
-		if (p?.type === 'VariableDeclarator') {
-			const id = p.id;
-			if (id?.type === 'Identifier') {
-				return id.name;
-			}
-
-			return null;
-		}
-
-		if (p?.type === 'AssignmentExpression') {
-			const left = p.left;
-
-			if (left?.type === 'Identifier') {
-				return left.name;
-			}
-
-			if (left?.type === 'MemberExpression' && !left.computed) {
-				const object = left.object;
-				const property = left.property;
-
-				const objectName
-					= object?.type === 'Identifier'
-						? object.name
-						: (object?.type === 'ThisExpression'
-							? 'this'
-							: null);
-
-				const propertyName = property?.type === 'Identifier' ? property.name : null;
-
-				if (objectName && propertyName) {
-					return `${objectName}.${propertyName}`;
-				}
-			}
-
-			return null;
-		}
-
-		return null;
-	}
-
-	function report(node) {
-		const filename = context.getFilename();
-		if (isAllowedStyleFile(filename)) {
-			return;
-		}
-
-		const targetName = getAssignmentTargetName(node);
-		const target = targetName ? ` "${targetName}"` : '';
-
-		context.report({
-			node,
-			messageId: 'moveStyles',
-			data: {
-				filename,
-				suffixes: allowedSuffixes.join(' or '),
-				target,
-			},
-		});
-	}
-
-	return {
-		CallExpression(node) {
-			if (isStyleSheetMemberCall(node, 'create')) {
-				report(node);
-				return;
-			}
-
-			if (includeCompose && isStyleSheetMemberCall(node, 'compose')) {
-				report(node);
-			}
-		},
-	};
-}
-
-module.exports = {meta, create};