@dmitryrechkin/eslint-standard 1.4.6 → 1.4.8

package/README.md

@@ -1,6 +1,6 @@
 # @dmitryrechkin/eslint-standard
 
-A comprehensive ESLint configuration package with TypeScript support, featuring Prettier integration and industry-standard rules.
+A comprehensive ESLint configuration package with TypeScript support, featuring **Prettier integration with Allman brace style** and industry-standard rules for maximum code quality.
 
 ## 🚀 Quick Start
 
@@ -101,10 +101,20 @@ npx @dmitryrechkin/eslint-standard check-deps --install
 - **Performance**: Avoid performance anti-patterns
 
 ### Code Style & Formatting
-- **Brace Style**: Allman style (braces on new lines) via Prettier
-- **Indentation**: Tabs with consistent spacing
+- **Prettier Integration**: Automatic code formatting with industry-standard plugins
+- **Brace Style**: Allman style (braces on new lines) via `prettier-plugin-brace-style`
+- **Indentation**: Tabs (4-space width) for accessibility and user preference
+- **Quotes**: Single quotes for consistency
 - **Import Organization**: Automatic import sorting and grouping
-- **JSDoc**: Required documentation with proper formatting
+- **JSDoc**: Required documentation with proper alignment and formatting
+
+### Code Complexity & Architecture
+- **Function Complexity**: Max 10 cyclomatic complexity (industry standard)
+- **Cognitive Complexity**: Max 15 (SonarJS) for maintainable code
+- **Function Length**: Max 100 lines (300 for tests) following clean code principles
+- **File Length**: Max 300 lines (500 for tests) for focused modules
+- **Function Parameters**: Max 7 parameters (allows dependency injection patterns)
+- **Nesting Depth**: Max 3 levels to prevent callback hell
 
 ### Modern JavaScript/TypeScript
 - **ES2020+ Features**: Prefer modern syntax and APIs
@@ -125,6 +135,40 @@ npx @dmitryrechkin/eslint-standard check-deps --install
 | Return type hints | Error | Error | Explicit |
 | Type safety | High | High | Very High |
 
+## 📈 Industry Standards Comparison
+
+| Metric | This Package | Google | Airbnb | SonarQube | Clean Code |
+|--------|--------------|--------|---------|-----------|------------|
+| Max Parameters | 7 | 4 | No limit* | 7 | 3-4 |
+| Max Function Lines | 100 | 50 | No limit | 200 | 20 |
+| Max File Lines | 300 | 2000 | 2500 | 1000 | 300 |
+| Cyclomatic Complexity | 10 | 10 | No limit | 10 | 5-10 |
+| Max Nesting | 3 levels | 3 levels | No limit | 3 levels | 2-3 levels |
+| Brace Style | Allman | 1TBS | 1TBS | Configurable | Any |
+| Indentation | Tabs (4) | Spaces (2) | Spaces (2) | Configurable | Spaces (4) |
+
+*Airbnb recommends objects for >3 parameters
+
+## 🎨 Prettier Integration Features
+
+This package includes seamless **Prettier integration** that handles all formatting automatically:
+
+### Supported File Types
+- **TypeScript/JavaScript**: `.ts`, `.js`, `.tsx`, `.jsx` with Allman brace style
+- **Astro**: `.astro` files with optimized formatting via `prettier-plugin-astro`
+
+### Automatic Formatting
+- **Allman Brace Style**: All braces on new lines for maximum readability
+- **Single Quotes**: Consistent string quoting throughout codebase  
+- **Tab Indentation**: Accessible indentation with 4-space tab width
+- **Semicolons**: Always required for statement clarity
+- **No Trailing Commas**: Clean object/array formatting
+
+### ESLint-Prettier Harmony
+- All conflicting ESLint formatting rules are **automatically disabled**
+- Prettier handles formatting, ESLint handles code quality
+- **No configuration conflicts** - works out of the box
+
 ## 🔧 External Tools Integration
 
 For comprehensive unused code detection, consider these additional tools:

package/eslint.config.mjs

@@ -88,29 +88,23 @@ export default function ({
 				'@typescript-eslint/explicit-function-return-type': 'error',
 				'@typescript-eslint/no-explicit-any': 'error', // Ban 'any' type for type safety
 
-				// Original coding guidelines
-				'brace-style': 'off', // Disabled in favor of @stylistic/brace-style
-				'@stylistic/brace-style': ['error', 'allman', { allowSingleLine: false }],
-				'@stylistic/block-spacing': ['error', 'never'], // Enforce consistent spacing inside blocks
-				indent: 'off', // Disabled to avoid conflicts with @stylistic/indent and our JSDoc plugin
-				'@stylistic/indent': ['error', 'tab', { 
-					SwitchCase: 1,
-					ignoredNodes: [
-						'ImportDeclaration', // Fix for maximum call stack issue with complex imports
-						'TSTypeReference' // Fix for TypeScript type references causing recursion
-					]
-				}],
-				quotes: 'off', // Disabled in favor of @stylistic/quotes
-				'@stylistic/quotes': ['error', 'single'],
-				semi: 'off', // Disabled in favor of @stylistic/semi
-				'@stylistic/semi': ['error', 'always'],
+				// Original coding guidelines - formatting rules disabled in favor of prettier
+				'brace-style': 'off', // Handled by prettier-plugin-brace-style
+				'@stylistic/brace-style': 'off', // Handled by prettier-plugin-brace-style
+				'@stylistic/block-spacing': 'off', // Handled by prettier
+				indent: 'off', // Handled by prettier (useTabs: true, tabWidth: 4)
+				'@stylistic/indent': 'off', // Handled by prettier (useTabs: true, tabWidth: 4)
+				quotes: 'off', // Handled by prettier (singleQuote: true)
+				'@stylistic/quotes': 'off', // Handled by prettier (singleQuote: true)
+				semi: 'off', // Handled by prettier (semi: true)
+				'@stylistic/semi': 'off', // Handled by prettier (semi: true)
 				'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
-				'no-trailing-spaces': 'off', // Disabled in favor of @stylistic/no-trailing-spaces
-				'@stylistic/no-trailing-spaces': 'error',
-				'eol-last': 'off', // Disabled in favor of @stylistic/eol-last
-				'@stylistic/eol-last': ['error', 'always'],
-				'comma-dangle': 'off', // Disabled in favor of @stylistic/comma-dangle
-				'@stylistic/comma-dangle': ['error', 'never'],
+				'no-trailing-spaces': 'off', // Handled by prettier
+				'@stylistic/no-trailing-spaces': 'off', // Handled by prettier
+				'eol-last': 'off', // Handled by prettier
+				'@stylistic/eol-last': 'off', // Handled by prettier
+				'comma-dangle': 'off', // Handled by prettier (trailingComma: 'none')
+				'@stylistic/comma-dangle': 'off', // Handled by prettier (trailingComma: 'none')
 
 				// Comprehensive naming conventions based on coding standards
 
@@ -354,6 +348,11 @@ export default function ({
 						format: ['camelCase', 'UPPER_CASE'],
 						leadingUnderscore: 'forbid',
 					},
+					{
+						selector: 'objectLiteralProperty',
+						format: ['camelCase', 'UPPER_CASE'],
+						leadingUnderscore: 'forbid',
+					},
 					{
 						selector: 'enumMember',
 						format: ['camelCase', 'UPPER_CASE'],
@@ -383,7 +382,7 @@ export default function ({
 					IIFEs: true
 				}],
 				'max-statements': ['error', 20], // Max 20 statements per function
-				'max-params': ['error', 4], // Max 4 parameters per function
+				'max-params': ['error', 7], // Max 7 parameters per function
 				'max-depth': ['error', { max: 3 }], // Max 3 levels of block nesting
 				'max-nested-callbacks': ['error', 3], // Max 3 levels of callback nesting
 				'max-lines': ['warn', {
@@ -401,7 +400,7 @@ export default function ({
 					ignoreComments: true
 				}],
 				'max-statements-per-line': ['error', { max: 1 }],
-				'@typescript-eslint/max-params': ['error', { max: 4 }], // TypeScript-aware version
+				'@typescript-eslint/max-params': ['error', { max: 7 }], // TypeScript-aware version
 				'no-else-return': ['error', { allowElseIf: false }], // Encourage early returns
 				'no-lonely-if': 'error', // Avoid single if in else block
 				'no-nested-ternary': 'error', // Avoid complex ternary operators
@@ -803,7 +802,12 @@ export default function ({
 					{
 						parser: 'typescript',
 						plugins: [import.meta.resolve('prettier-plugin-brace-style')],
-						braceStyle: 'allman'
+						braceStyle: 'allman',
+						singleQuote: true,
+						useTabs: true,
+						tabWidth: 4,
+						semi: true,
+						trailingComma: 'none'
 					}
 				]
 			}
@@ -816,7 +820,12 @@ export default function ({
 					'error',
 					{
 						parser: 'astro',
-						plugins: [import.meta.resolve('prettier-plugin-astro')]
+						plugins: [import.meta.resolve('prettier-plugin-astro')],
+						singleQuote: true,
+						useTabs: true,
+						tabWidth: 4,
+						semi: true,
+						trailingComma: 'none'
 					}
 				]
 			}
@@ -845,6 +854,22 @@ export default function ({
 				'security/detect-non-literal-fs-filename': 'off', // Tests legitimately need dynamic file paths
 				'unicorn/prefer-module': 'off',              // Tests may need __dirname for reliable paths
 				
+				// Relax complexity rules for test files
+				'max-lines-per-function': ['error', {
+					max: 300,
+					skipBlankLines: true,
+					skipComments: true,
+					IIFEs: true
+				}],
+				'max-lines': ['warn', {
+					max: 500,
+					skipBlankLines: true,
+					skipComments: true
+				}],
+				'complexity': ['error', 20], // Higher complexity allowed in tests
+				'max-statements': ['error', 40], // More statements allowed in test functions
+				'sonarjs/cognitive-complexity': ['error', 30], // Higher cognitive complexity for tests
+				
 				// Keep as warnings - still worth improving when possible
 				'unicorn/no-null': 'off',                    // APIs often use null, but const can be better
 				'sonarjs/no-duplicate-string': 'off',        // Test strings repeat, but constants still help readability

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@dmitryrechkin/eslint-standard",
 	"description": "This package provides a shared ESLint configuration which includes TypeScript support and a set of specific linting rules designed to ensure high-quality and consistent code style across projects.",
-	"version": "1.4.6",
+	"version": "1.4.8",
 	"main": "eslint.config.mjs",
 	"exports": {
 		".": "./eslint.config.mjs"