lint-rules-alvin 1.2.1 → 2.0.2

package/.vscode/settings.json

@@ -5,5 +5,12 @@
 	"eslint.codeAction.showDocumentation": {
 		"enable": true
 	},
-	"eslint.enable": true
+	"eslint.enable": true,
+	"eslint.validate": [
+		"javascript",
+		"typescript",
+		"javascriptreact",
+		"typescriptreact"
+	],
+	"typescript.tsdk": "node_modules\\typescript\\lib"
 }

package/eslint/configs/{astro.js → astro.ts}

@@ -1,11 +1,10 @@
+import { TSESLint } from '@typescript-eslint/utils';
 import eslintPluginAstro from 'eslint-plugin-astro';
 
 /**
  * The ESLint Astro config. Extends `configs['flat/base']` and configures all rules.
- *
- * @type {import('eslint').Linter.Config}
  */
-export const astro = [
+export const astro: TSESLint.FlatConfig.ConfigArray = [
 	...eslintPluginAstro.configs['flat/base'],
 	{
 		name: 'eslint-plugin-astro',

package/eslint/configs/{base.js → base.ts}

@@ -3,14 +3,13 @@ import { includeIgnoreFile } from '@eslint/compat';
 import eslintJs from '@eslint/js';
 import { globalIgnores } from 'eslint/config';
 import globals from 'globals';
+import { TSESLint } from '@typescript-eslint/utils';
 
 /**
  * The ESLint base config. Includes base rules, ignore files and directives,
  * and the recommended eslintJs rules.
- *
- * @type {import('eslint').Linter.Config}
  */
-export const base = [
+export const base: TSESLint.FlatConfig.ConfigArray = [
 	includeIgnoreFile(
 		path.join(
 			process.cwd(),

package/eslint/configs/{custom.js → custom.ts}

@@ -1,17 +1,16 @@
-import { newlineBetweenImportsRule } from '../custom_rules/newline-between-imports.js';
-import { unnamedImportsLastRule } from '../custom_rules/unnamed-imports-last.js';
-import { jsxMultilinePropNewlineRule } from '../custom_rules/jsx-multiline-prop-newline.js';
-import { maxChainPerLineRule } from '../custom_rules/max-chain-per-line.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';
+import { TSESLint } from '@typescript-eslint/utils';
+import { newlineBetweenImportsRule } from '../custom_rules/newline-between-imports';
+import { unnamedImportsLastRule } from '../custom_rules/unnamed-imports-last';
+import { jsxMultilinePropNewlineRule } from '../custom_rules/jsx-multiline-prop-newline';
+import { maxChainPerLineRule } from '../custom_rules/max-chain-per-line';
+import { multilineParenNewlineRule } from '../custom_rules/multiline-paren-newline';
+import { multilineArrayAccessorNewlineRule } from '../custom_rules/multiline-array-accessor-newline';
+import { destructureNewlineRule } from '../custom_rules/destructure-newline';
 
 /**
  * Provides a config that creates a plugin and configures custom rules.
- *
- * @type {import('eslint').Linter.Config}
  */
-export const custom = {
+export const custom: TSESLint.FlatConfig.Config = {
 	plugins: {
 		custom: {
 			rules: {
@@ -42,8 +41,7 @@ export const custom = {
 			'error',
 			{
 				maxChain: 2,
-				enforceSingleLine: true,
-				checkSingleLink: true
+				enforceSingleLine: true
 			}
 		],
 		'custom/multiline-paren-newline': [

package/eslint/configs/{importX.js → importX.ts}

@@ -1,13 +1,23 @@
+import { TSESLint } from '@typescript-eslint/utils';
 import { importX as eslintPluginImportX } from 'eslint-plugin-import-x';
 
 /**
  * The ESLint import config. Configures all rules.
- *
- * @type {import('eslint').Linter.Config}
  */
-export const importX = {
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+export const importX: TSESLint.FlatConfig.Config = {
 	name: 'eslint-plugin-import-x',
+
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
 	plugins: { 'import-x': eslintPluginImportX },
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+	...eslintPluginImportX.flatConfigs.typescript,
+	settings: {
+		'import-x/resolver': {
+			typescript: true,
+			node: true
+		}
+	},
 	rules: {
 		'import-x/export': 'error',
 		'import-x/no-deprecated': 'error',

package/eslint/configs/index.d.ts

@@ -1,13 +1,11 @@
-import { Linter } from 'eslint';
-
-export declare const astro: Linter.Config[];
-export declare const base: Linter.Config[];
-export declare const custom: Linter.Config;
-export declare const importX: Linter.Config;
-export declare const importXTs: Linter.Config;
-export declare const json: Linter.Config[];
-export declare const markdown: Linter.Config;
-export declare const reactHooks: Linter.Config;
-export declare const stylistic: Linter.Config;
-export declare const sveltekit: Linter.Config[];
-export declare const typescript: Linter.Config;
+import type { TSESLint } from '@typescript-eslint/utils';
+export const astro: TSESLint.FlatConfig.ConfigArray;
+export const base: TSESLint.FlatConfig.ConfigArray;
+export const custom: TSESLint.FlatConfig.Config;
+export const importX: TSESLint.FlatConfig.Config;
+export const json: TSESLint.FlatConfig.ConfigArray;
+export const markdown: TSESLint.FlatConfig.Config;
+export const reactHooks: TSESLint.FlatConfig.Config;
+export const stylistic: TSESLint.FlatConfig.Config;
+export const sveltekit: TSESLint.FlatConfig.ConfigArray;
+export const typescript: TSESLint.FlatConfig.Config;

package/eslint/configs/index.ts

@@ -0,0 +1,10 @@
+export { astro } from './astro';
+export { base } from './base';
+export { custom } from './custom';
+export { importX } from './importX';
+export { json } from './json';
+export { markdown } from './markdown';
+export { reactHooks } from './reactHooks';
+export { stylistic } from './stylistic';
+export { sveltekit } from './sveltekit';
+export { typescript } from './typescript';

package/eslint/configs/json.ts

@@ -0,0 +1,7 @@
+import { TSESLint } from '@typescript-eslint/utils';
+import eslintPluginJsonc from 'eslint-plugin-jsonc';
+
+/**
+ * The ESLint JSON config. Extends `flat/recommended-with-json`.
+ */
+export const json: TSESLint.FlatConfig.ConfigArray = [ ...eslintPluginJsonc.configs['flat/recommended-with-json'] ];

package/eslint/configs/{markdown.js → markdown.ts}

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

package/eslint/configs/{reactHooks.js → reactHooks.ts}

@@ -1,11 +1,10 @@
+import { TSESLint } from '@typescript-eslint/utils';
 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 = {
+export const reactHooks: TSESLint.FlatConfig.Config = {
 	name: 'eslint-plugin-react-hooks',
 	files: [ '**/*.{jsx,tsx}' ],
 	...eslintPluginReactHooks

package/eslint/configs/{stylistic.js → stylistic.ts}

@@ -1,12 +1,10 @@
-// eslint-disable-next-line import-x/no-deprecated, import-x/namespace, import-x/default
 import eslintPluginStylistic from '@stylistic/eslint-plugin';
+import { TSESLint } from '@typescript-eslint/utils';
 
 /**
  * The ESLint `stylistic` config. Extends `configs.recommended` and overrides all rules.
- *
- * @type {import('eslint').Linter.Config}
  */
-export const stylistic = {
+export const stylistic: TSESLint.FlatConfig.Config = {
 	name: 'eslint-plugin-stylistic',
 	...eslintPluginStylistic.configs.recommended,
 	plugins: { '@stylistic': eslintPluginStylistic },

package/eslint/configs/{sveltekit.js → sveltekit.ts}

@@ -1,18 +1,26 @@
+import { TSESLint } from '@typescript-eslint/utils';
 import eslintPluginSvelte from 'eslint-plugin-svelte';
+import tsEslintParser from '@typescript-eslint/parser';
 
 /**
  * The ESLint `stylistic` config. Extends `configs.recommended` and overrides all rules.
- *
- * @type {import('eslint').Linter.Config[]}
  */
-export const sveltekit = [
+export const sveltekit: TSESLint.FlatConfig.ConfigArray = [
 	...eslintPluginSvelte.configs['flat/base'],
 	{
+		name: 'sveltekit-config',
 		files: [
 			'**/*.svelte',
 			'**/*.svelte.ts',
 			'**/*.svelte.js'
 		],
+		languageOptions: {
+			parserOptions: {
+				parser: tsEslintParser,
+				projectService: true,
+				extraFileExtensions: [ '.svelte' ]
+			}
+		},
 		rules: {
 
 			// Svelte-specific
@@ -117,10 +125,7 @@ export const sveltekit = [
 					}
 				}
 			],
-			'svelte/html-self-closing': [
-				'error',
-				'default'
-			],
+			'svelte/html-self-closing': 'error', // leave it on 'default'
 			'indent': 'off', // eslint-disable-line @stylistic/quote-props
 			'@stylistic/indent': 'off',
 			'svelte/indent': [

package/eslint/configs/{typescript.js → typescript.ts}

@@ -1,14 +1,13 @@
 import eslintTs from '@typescript-eslint/eslint-plugin';
 import eslintTsParser from '@typescript-eslint/parser';
+import { TSESLint } from '@typescript-eslint/utils';
 
 /**
  * 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 = {
+export const typescript: TSESLint.FlatConfig.Config = {
 	name: 'typescript',
 	files: [
 		'**/*.ts',
@@ -16,7 +15,8 @@ export const typescript = {
 		'**/*.mts',
 		'**/*.cts'
 	],
-	...eslintTs.configs['flat/base'],
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+	...eslintTs.configs['flat/base'] as TSESLint.FlatConfig.Config,
 	languageOptions: {
 		parser: eslintTsParser,
 		parserOptions: { projectService: true },

package/eslint/custom_rules/{destructure-newline.js → destructure-newline.ts}

@@ -1,14 +1,12 @@
-/**
- * @type {import('eslint').Rule.RuleModule}
- */
-export const destructureNewlineRule = {
+import {
+	AST_NODE_TYPES,
+	ESLintUtils
+} from '@typescript-eslint/utils';
+
+export const destructureNewlineRule = ESLintUtils.RuleCreator.withoutDocs({
 	meta: {
 		type: 'layout',
-		docs: {
-			description: 'Enforce newlines between properties in destructuring assignments',
-			category: 'Stylistic Issues',
-			recommended: false
-		},
+		docs: { description: 'Enforce newlines between properties in destructuring assignments' },
 		fixable: 'whitespace',
 		schema: [
 			{
@@ -24,16 +22,16 @@ export const destructureNewlineRule = {
 		],
 		messages: { error: 'There should be a newline between destructuring properties.' }
 	},
-
-	create(context) {
+	defaultOptions: [ { minItems: 2 } ],
+	create(context, options) {
 
 		const sourceCode = context.sourceCode;
-		const { minItems = 2 } = context.options[0] || {};
+		const { minItems } = options[0];
 
 		return {
 			VariableDeclarator(node) {
 
-				if (node.id.type !== 'ObjectPattern') {
+				if (node.id.type !== AST_NODE_TYPES.ObjectPattern) {
 
 					return;
 
@@ -54,6 +52,13 @@ export const destructureNewlineRule = {
 					const lastTokenOfCurrent = sourceCode.getLastToken(currentProperty);
 					const firstTokenOfNext = sourceCode.getFirstToken(nextProperty);
 
+					// Token not found
+					if (!lastTokenOfCurrent || !firstTokenOfNext) {
+
+						continue;
+
+					}
+
 					if (
 						lastTokenOfCurrent
 							.loc
@@ -85,4 +90,4 @@ export const destructureNewlineRule = {
 		};
 
 	}
-};
+});

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

@@ -0,0 +1,245 @@
+import {
+	AST_NODE_TYPES,
+	ESLintUtils,
+	TSESTree
+} from '@typescript-eslint/utils';
+
+export const jsxMultilinePropNewlineRule = ESLintUtils.RuleCreator.withoutDocs({
+	meta: {
+		type: 'layout',
+		docs: { description: 'Enforces newline consistency for JSX properties.' },
+		fixable: 'code',
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					enforceSingleLine: { type: 'boolean' },
+					allowSingleExpression: { type: 'boolean' }
+				},
+				additionalProperties: false
+			}
+		],
+		messages: {
+			collapse: 'This expression should not be surrounded by newlines.',
+			expand: 'This multiline expression should be surrounded by newlines.'
+		}
+	},
+	defaultOptions: [
+		{
+			enforceSingleLine: false,
+			allowSingleExpression: true
+		}
+	],
+	create(context, options) {
+
+		const sourceCode = context.sourceCode;
+		const {
+			enforceSingleLine,
+			allowSingleExpression
+		} = options[0];
+
+		function isMultiline(node: TSESTree.Node): boolean {
+
+			return node
+				.loc
+				.start
+				.line !== node
+				.loc
+				.end
+				.line;
+
+		}
+
+		function isSingleObjectOrArrayExpression(node: TSESTree.Node): boolean {
+
+			return node.type === AST_NODE_TYPES.ObjectExpression || node.type === AST_NODE_TYPES.ArrayExpression;
+
+		}
+
+		function checkContainer(node: TSESTree.JSXExpressionContainer) {
+
+			// Only enforce for JSX props (attributes), not for children
+			/* eslint-disable-next-line
+			@typescript-eslint/no-unnecessary-condition,
+			@typescript-eslint/strict-boolean-expressions */
+			if (!node?.parent || node.parent.type !== AST_NODE_TYPES.JSXAttribute)
+				return;
+
+			const expr = node.expression;
+			/* eslint-disable-next-line
+			@typescript-eslint/no-unnecessary-condition,
+			@typescript-eslint/strict-boolean-expressions */
+			if (!expr)
+				return;
+
+			/*
+			 * Find the surrounding braces around the expression
+			 * Use tokenBefore/After relative to the inner expression to avoid TS/estree mismatches
+			 */
+
+			// Use the expression container's outer tokens to find the real surrounding braces
+
+			const openBrace = sourceCode.getFirstToken(node);
+
+			const closeBrace = sourceCode.getLastToken(node);
+			if (!openBrace || !closeBrace)
+				return;
+
+			const firstTokenOfExpr = sourceCode.getFirstToken(expr);
+
+			const lastTokenOfExpr = sourceCode.getLastToken(expr);
+			if (!firstTokenOfExpr || !lastTokenOfExpr)
+				return;
+
+			const exprIsMultiline = isMultiline(expr);
+			const exceptionApplies = allowSingleExpression && isSingleObjectOrArrayExpression(expr);
+
+			/*
+			 * If configured to prefer compact braces for a single object/array expression,
+			 * collapse surrounding whitespace/newlines regardless of multiline/single-line.
+			 */
+			if (exceptionApplies) {
+
+				if (
+					openBrace
+						.loc
+						.end
+						.line !== firstTokenOfExpr
+						.loc
+						.start
+						.line
+				) {
+
+					context.report({
+						node: openBrace,
+						messageId: 'collapse',
+						fix: (fixer) => fixer.removeRange([
+							openBrace.range[1],
+							firstTokenOfExpr.range[0]
+						])
+					});
+
+				}
+				if (
+					lastTokenOfExpr
+						.loc
+						.end
+						.line !== closeBrace
+						.loc
+						.start
+						.line
+				) {
+
+					context.report({
+						node: closeBrace,
+						messageId: 'collapse',
+						fix: (fixer) => fixer.removeRange([
+							lastTokenOfExpr.range[1],
+							closeBrace.range[0]
+						])
+					});
+
+				}
+				return;
+
+			}
+
+			if (exprIsMultiline) {
+
+				// Require newlines after '{' and before '}' for multiline expressions
+				if (
+					openBrace
+						.loc
+						.end
+						.line === firstTokenOfExpr
+						.loc
+						.start
+						.line
+				) {
+
+					context.report({
+						node: openBrace,
+						messageId: 'expand',
+						fix: (fixer) => fixer.insertTextAfter(
+							openBrace,
+							'\n'
+						)
+					});
+
+				}
+				if (
+					lastTokenOfExpr
+						.loc
+						.end
+						.line === closeBrace
+						.loc
+						.start
+						.line
+				) {
+
+					context.report({
+						node: closeBrace,
+						messageId: 'expand',
+						fix: (fixer) => fixer.insertTextBefore(
+							closeBrace,
+							'\n'
+						)
+					});
+
+				}
+				return;
+
+			}
+
+			// Single-line expression: optionally enforce collapse (no surrounding newlines)
+			if (enforceSingleLine) {
+
+				if (
+					openBrace
+						.loc
+						.end
+						.line !== firstTokenOfExpr
+						.loc
+						.start
+						.line
+				) {
+
+					context.report({
+						node: openBrace,
+						messageId: 'collapse',
+						fix: (fixer) => fixer.removeRange([
+							openBrace.range[1],
+							firstTokenOfExpr.range[0]
+						])
+					});
+
+				}
+				if (
+					lastTokenOfExpr
+						.loc
+						.end
+						.line !== closeBrace
+						.loc
+						.start
+						.line
+				) {
+
+					context.report({
+						node: closeBrace,
+						messageId: 'collapse',
+						fix: (fixer) => fixer.removeRange([
+							lastTokenOfExpr.range[1],
+							closeBrace.range[0]
+						])
+					});
+
+				}
+
+			}
+
+		}
+
+		return { JSXExpressionContainer: checkContainer };
+
+	}
+});