lint-rules-alvin 1.0.5 → 1.1.1

package/eslint/configs/astro.js

@@ -1,9 +1,9 @@
 import eslintPluginAstro from 'eslint-plugin-astro';
 
 /**
- * The `ESLint` Astro config.
+ * The ESLint Astro config. Extends `configs['flat/base']` and configures all rules.
  *
- * Extends `eslint-plugin-astro`'s `flat/base` config.
+ * @type {import('eslint').Linter.Config}
  */
 export const astro = [
 	...eslintPluginAstro.configs['flat/base'],

package/eslint/configs/base.js

@@ -1,9 +1,14 @@
 import path from 'node:path';
 import { includeIgnoreFile } from '@eslint/compat';
+import eslintJs from '@eslint/js';
 import { globalIgnores } from 'eslint/config';
+import globals from 'globals';
 
 /**
- * The `ESLint` base config. Includes base rules, ignore files and directives.
+ * The ESLint base config. Includes base rules, ignore files and directives,
+ * and the recommended eslintJs rules.
+ *
+ * @type {import('eslint').Linter.Config}
  */
 export const base = [
 	includeIgnoreFile(
@@ -15,5 +20,18 @@ export const base = [
 	globalIgnores([
 		'eslint.config.js',
 		'eslint.config.ts'
-	])
+	]),
+	{
+		name: 'base/env',
+		languageOptions: {
+			ecmaVersion: 2020,
+			sourceType: 'module',
+			globals: {
+				...globals.browser,
+				...globals.nodeBuiltin,
+				...globals.serviceworker
+			}
+		}
+	},
+	eslintJs.configs.recommended
 ];

package/eslint/configs/custom.js

@@ -3,9 +3,15 @@ import { unnamedImportsLastRule } from '../custom_rules/unnamed-imports-last.js'
 import { jsxMultilinePropNewlineRule } from '../custom_rules/jsx-multiline-prop-newline.js';
 import { jsxNoSingleObjectCurlyNewlineRule } from '../custom_rules/jsx-no-single-object-curly-newline.js';
 import { maxChainPerLineRule } from '../custom_rules/max-chain-per-line.js';
-import { chainFirstOnNewlineRule } from '../custom_rules/chain-first-on-newline.js';
 import { multilineParenNewlineRule } from '../custom_rules/multiline-paren-newline.js';
+import { multilineArrayAccessorNewlineRule } from '../custom_rules/multiline-array-accessor-newline.js';
+import { destructureNewlineRule } from '../custom_rules/destructure-newline.js';
 
+/**
+ * Provides a config that creates a plugin and configures custom rules.
+ *
+ * @type {import('eslint').Linter.Config}
+ */
 export const custom = {
 	plugins: {
 		custom: {
@@ -15,8 +21,9 @@ export const custom = {
 				'jsx-multiline-prop-newline': jsxMultilinePropNewlineRule,
 				'jsx-no-single-object-curly-newline': jsxNoSingleObjectCurlyNewlineRule,
 				'max-chain-per-line': maxChainPerLineRule,
-				'chain-first-on-newline': chainFirstOnNewlineRule,
-				'multiline-paren-newline': multilineParenNewlineRule
+				'multiline-paren-newline': multilineParenNewlineRule,
+				'multiline-array-accessor-newline': multilineArrayAccessorNewlineRule,
+				'destructure-newline': destructureNewlineRule
 			}
 		}
 	},
@@ -30,16 +37,20 @@ export const custom = {
 		'custom/jsx-no-single-object-curly-newline': 'error',
 		'custom/max-chain-per-line': [
 			'error',
-			{ maxChain: 2 }
-		],
-		'custom/chain-first-on-newline': [
-			'error',
-			'require'
+			{
+				maxChain: 2,
+				enforceSingleLine: true,
+				checkSingleLink: true
+			}
 		],
 		'custom/multiline-paren-newline': [
 			'error',
 			{ singleArgument: true }
+		],
+		'custom/multiline-array-accessor-newline': 'error',
+		'custom/destructure-newline': [
+			'error',
+			{ minItems: 2 }
 		]
 	}
 };
-

package/eslint/configs/importX.js

@@ -1,7 +1,9 @@
 import { importX as eslintPluginImportX } from 'eslint-plugin-import-x';
 
 /**
- * The `ESLint` import config.
+ * The ESLint import config. Configures all rules.
+ *
+ * @type {import('eslint').Linter.Config}
  */
 export const importX = {
 	name: 'eslint-plugin-import-x',

package/eslint/configs/importXTs.js

@@ -2,9 +2,11 @@ import { importX as eslintPluginImportX } from 'eslint-plugin-import-x';
 import { importX } from './index.js';
 
 /**
- * The `ESLint` import config with a TS resolver.
+ * The ESLint import config with a TS resolver.
+ * Extends `../importX` and `flatConfigs.typescript` config.
+ *
+ * @type {import('eslint').Linter.Config}
  *
- * Extends `eslint-plugin-import-x`'s `typescript` flat config.
  */
 export const importXTs = {
 	...importX,

package/eslint/configs/json.js

@@ -1,20 +1,23 @@
 import eslintPluginJsonc from 'eslint-plugin-jsonc';
 
 /**
- * The `ESLint` JSON config. Supports JSON, JSONc an JSON5.
+ * The ESLint JSON config. Extends `flat/recommended-with-json`,
+ * `...with-jsonc` and `...with-json5` for the corresponding file types.
+ *
+ * @type {import('eslint').Linter.Config}
  */
 export const json = [
-	{ // eslint-plugin-json
+	{
 		name: 'eslint-plugin-json',
 		files: [ '**/*.{json}' ],
 		...eslintPluginJsonc.configs['flat/recommended-with-json']
 	},
-	{ // eslint-plugin-jsonc
+	{
 		name: 'eslint-plugin-jsonc',
 		files: [ '**/*.{jsonc}' ],
 		...eslintPluginJsonc.configs['flat/recommended-with-jsonc']
 	},
-	{ // eslint-plugin-json5
+	{
 		name: 'eslint-plugin-json5',
 		files: [ '**/*.{json5}' ],
 		...eslintPluginJsonc.configs['flat/recommended-with-json5']

package/eslint/configs/markdown.js

@@ -1,7 +1,10 @@
 import eslintPluginMarkdown from 'eslint-plugin-markdown';
 
 /**
- * The `ESLint` markdown config.
+ * The ESLint markdown config. Extends `configs.recommended` only for `md` files.
+ *
+ * @type {import('eslint').Linter.Config}
+ *
  */
 export const markdown = {
 	name: 'eslint-plugin-markdown',

package/eslint/configs/reactHooks.js

@@ -1,7 +1,15 @@
 import eslintPluginReactHooks from 'eslint-plugin-react-hooks';
 
+/**
+ * The ESLint `react-hooks` config. Extends `configs.flat.recommended` only for `jsx` and `tsx` files.
+ *
+ * @type {import('eslint').Linter.Config}
+ */
 export const reactHooks = {
 	name: 'eslint-plugin-react-hooks',
 	files: [ '**/*.{jsx,tsx}' ],
-	...eslintPluginReactHooks.configs.flat.recommended
+	...eslintPluginReactHooks
+		.configs
+		.flat
+		.recommended
 };

package/eslint/configs/stylistic.js

@@ -1,5 +1,11 @@
+// eslint-disable-next-line import-x/no-deprecated, import-x/namespace, import-x/default
 import eslintPluginStylistic from '@stylistic/eslint-plugin';
 
+/**
+ * The ESLint `stylistic` config. Extends `configs.recommended` and overrides all rules.
+ *
+ * @type {import('eslint').Linter.Config}
+ */
 export const stylistic = {
 	name: 'eslint-plugin-stylistic',
 	...eslintPluginStylistic.configs.recommended,
@@ -309,6 +315,7 @@ export const stylistic = {
 			'all',
 			{
 				ignoreJSX: 'multi-line',
+				nestedBinaryExpressions: false,
 				ignoredNodes: [
 
 					// Arrow function ternaries

package/eslint/configs/typescript.js

@@ -1,6 +1,11 @@
-import eslintTs from 'typescript-eslint';
+import eslintTs from '@typescript-eslint/eslint-plugin';
+import eslintTsParser from '@typescript-eslint/parser';
 
 /**
+ * The ESLint `typescript` config. Extends `configs.base`,
+ * enables `languageOptions.parserOptions.projectService` and configures all rules,
+ * only for `ts`, `tsx`, `mts` and `cts` files.
+ *
  * @type {import('eslint').Linter.Config}
  */
 export const typescript = {
@@ -11,8 +16,12 @@ export const typescript = {
 		'**/*.mts',
 		'**/*.cts'
 	],
-	...eslintTs.configs.base,
-	languageOptions: { parserOptions: { projectService: true } },
+	...eslintTs.configs['flat/base'],
+	languageOptions: {
+		parser: eslintTsParser,
+		parserOptions: { projectService: true },
+		sourceType: 'module'
+	},
 	rules: {
 		'@typescript-eslint/array-type': [
 			'error',
@@ -458,7 +467,6 @@ export const typescript = {
 			'always'
 		],
 		'@typescript-eslint/sort-type-constituents': 'off', // Deprecated in favor of sort-intersection-types, etc.
-		'@typescript-eslint/strict-boolean-expressions': 'off',
 		'@typescript-eslint/strict-boolean-expressions': [
 			'error',
 			{
@@ -498,7 +506,10 @@ export const typescript = {
 				ignoreOverloadsWithDifferentJSDoc: true
 			}
 		],
-		'@typescript-eslint/use-unknown-in-catch-callback-variable': 'off'
+		'@typescript-eslint/use-unknown-in-catch-callback-variable': 'off',
+
+		// Other base ESLint overrides
+		'no-undef': 'off'
 
 	}
 };

package/eslint/custom_rules/destructure-newline.js

@@ -0,0 +1,88 @@
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+export const destructureNewlineRule = {
+	meta: {
+		type: 'layout',
+		docs: {
+			description: 'Enforce newlines between properties in destructuring assignments',
+			category: 'Stylistic Issues',
+			recommended: false
+		},
+		fixable: 'whitespace',
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					minItems: {
+						type: 'integer',
+						minimum: 2
+					}
+				},
+				additionalProperties: false
+			}
+		],
+		messages: { error: 'There should be a newline between destructuring properties.' }
+	},
+
+	create(context) {
+
+		const sourceCode = context.sourceCode;
+		const { minItems = 2 } = context.options[0] || {};
+
+		return {
+			VariableDeclarator(node) {
+
+				if (node.id.type !== 'ObjectPattern') {
+
+					return;
+
+				}
+				const properties = node.id.properties;
+
+				if (properties.length < minItems) {
+
+					return;
+
+				}
+
+				for (let i = 0; i < properties.length - 1; i++) {
+
+					const currentProperty = properties[i];
+					const nextProperty = properties[i + 1];
+
+					const lastTokenOfCurrent = sourceCode.getLastToken(currentProperty);
+					const firstTokenOfNext = sourceCode.getFirstToken(nextProperty);
+
+					if (
+						lastTokenOfCurrent
+							.loc
+							.end
+							.line === firstTokenOfNext
+							.loc
+							.start
+							.line
+					) {
+
+						context.report({
+							node: nextProperty,
+							messageId: 'error',
+							fix(fixer) {
+
+								return fixer.insertTextBefore(
+									nextProperty,
+									'\n'
+								);
+
+							}
+						});
+
+					}
+
+				}
+
+			}
+		};
+
+	}
+};

package/eslint/custom_rules/jsx-multiline-prop-newline.js

@@ -20,7 +20,13 @@ export const jsxMultilinePropNewlineRule = {
 
 		function isMultiline(node) {
 
-			return node && node.loc && node.loc.start.line < node.loc.end.line;
+			return node && node.loc && node
+				.loc
+				.start
+				.line < node
+				.loc
+				.end
+				.line;
 
 		}
 
@@ -63,7 +69,16 @@ export const jsxMultilinePropNewlineRule = {
 				const firstProp = node.attributes[0];
 
 				// Check if the tag name and the first prop are on the same line.
-				if (node.name.loc.end.line === firstProp.loc.start.line) {
+				if (
+					node
+						.name
+						.loc
+						.end
+						.line === firstProp
+						.loc
+						.start
+						.line
+				) {
 
 					context.report({
 						node: firstProp,
@@ -71,9 +86,12 @@ export const jsxMultilinePropNewlineRule = {
 						fix(fixer) {
 
 							// Get indentation of the line with the opening tag.
-							const line = sourceCode
-								.getLines()
-								[node.loc.start.line - 1];
+							const line = sourceCode.getLines()[
+								node
+									.loc
+									.start
+									.line - 1
+							];
 							const baseIndentMatch = line.match(/^\s*/);
 							const baseIndent = baseIndentMatch
 								? baseIndentMatch[0]

package/eslint/custom_rules/jsx-no-single-object-curly-newline.js

@@ -31,7 +31,15 @@ export const jsxNoSingleObjectCurlyNewlineRule = {
 				}
 
 				// If the expression itself isn't multiline, there are no newlines to collapse.
-				if (expression.loc.start.line === expression.loc.end.line) {
+				if (
+					expression
+						.loc
+						.start
+						.line === expression
+						.loc
+						.end
+						.line
+				) {
 
 					return;
 
@@ -42,8 +50,20 @@ export const jsxNoSingleObjectCurlyNewlineRule = {
 				const firstTokenInExpression = sourceCode.getFirstToken(expression);
 				const lastTokenInExpression = sourceCode.getLastToken(expression);
 
-				const hasNewlineBefore = openingBrace.loc.end.line < firstTokenInExpression.loc.start.line;
-				const hasNewlineAfter = lastTokenInExpression.loc.end.line < closingBrace.loc.start.line;
+				const hasNewlineBefore = openingBrace
+					.loc
+					.end
+					.line < firstTokenInExpression
+					.loc
+					.start
+					.line;
+				const hasNewlineAfter = lastTokenInExpression
+					.loc
+					.end
+					.line < closingBrace
+					.loc
+					.start
+					.line;
 
 				if (hasNewlineBefore || hasNewlineAfter) {