@dmitryrechkin/eslint-standard 1.5.7 → 1.5.9

package/README.md

@@ -62,6 +62,66 @@ export default config();
 - ✅ No console/debugging code
 - ✅ Enhanced type safety rules
 
+### Strict Mode
+Enterprise-grade architectural conventions for large-scale TypeScript monorepos. Enforces consistent project structure, naming conventions, and design patterns.
+
+```javascript
+import config from '@dmitryrechkin/eslint-standard';
+
+export default config({
+	strict: true,
+	tsconfigPath: './tsconfig.json'
+});
+```
+
+**Features:**
+- ✅ Enforced folder structure (services/, repositories/, helpers/, etc.)
+- ✅ Single Responsibility Principle for services and transformers
+- ✅ CQRS pattern enforcement for repositories
+- ✅ Static-only helpers, no static methods in other classes
+- ✅ Consistent interface naming conventions
+- ✅ One class per file
+
+#### Strict Mode Rules
+
+| Rule | Enforcement | Rationale |
+|------|-------------|-----------|
+| **Class Location** | `*Service` → `services/`, `*Repository` → `repositories/`, `*Helper` → `helpers/`, `*Factory` → `factories/`, `*Transformer` → `transformers/`, `*Registry` → `registries/`, `*Adapter` → `adapters/` | Predictable project structure enables faster navigation and onboarding |
+| **Service Single Method** | Services must have only one public method | Single Responsibility Principle - each service does one thing well |
+| **Transformer Single Method** | Transformers must have only one public method | Clear data transformation contracts |
+| **Helper Static Only** | Helper classes must contain only static methods | Helpers are utility collections, not stateful objects |
+| **No Static in Non-Helpers** | Non-helper/factory classes cannot have static methods | Prevents hidden global state, improves testability via dependency injection |
+| **Type Location** | `interface TypeXXX` must be in `types/` folder | Centralized type definitions for reusability |
+| **Interface Naming** | `TypeXXX` for data types, `XXXInterface` for class contracts | Clear distinction between data structures and behavioral contracts |
+| **One Class Per File** | Each file can contain only one class | Simplifies imports, improves code organization |
+| **Repository CQRS** | `CommandRepository` cannot have query methods (`get`, `find`, `list`), `QueryRepository` cannot have command methods (`create`, `update`, `delete`) | Command Query Responsibility Segregation for scalable data access |
+| **Folder CamelCase** | All folder names must be camelCase | Consistent naming across the codebase |
+| **Function Name Match Filename** | Top-level function name must match filename | Predictable imports and file discovery |
+| **No Utils Folder** | `utils/` folder is forbidden | Use `helpers/` for stateless logic or domain objects for stateful logic |
+
+#### Example Project Structure
+
+```
+src/
+├── services/
+│   ├── UserService.ts          # class UserService { execute() }
+│   └── PaymentService.ts       # class PaymentService { process() }
+├── repositories/
+│   ├── UserCommandRepository.ts # create(), update(), delete()
+│   └── UserQueryRepository.ts   # find(), getById(), list()
+├── helpers/
+│   └── ValidationHelper.ts      # static validate(), static sanitize()
+├── factories/
+│   └── UserFactory.ts           # static create()
+├── transformers/
+│   └── UserTransformer.ts       # transform()
+├── types/
+│   ├── TypeUser.ts              # interface TypeUser { id: string }
+│   └── TypePayment.ts           # interface TypePayment { amount: number }
+└── adapters/
+    └── StripeAdapter.ts         # class StripeAdapter
+```
+
 ## ⚙️ Configuration Options
 
 All configurations accept the same configuration options:
@@ -124,16 +184,22 @@ npx @dmitryrechkin/eslint-standard check-deps --install
 
 ## 📊 Preset Comparison
 
-| Feature | Standard | Aggressive | Library |
-|---------|----------|------------|---------|
-| Unused imports cleanup | ✅ | ✅ | ✅ |
-| Unused variables detection | Basic | Enhanced | Enhanced |
-| Dead code detection | Basic | ✅ | ✅ |
-| Unused exports check | ❌ | ✅ | Very Strict |
-| JSDoc requirements | Basic | Basic | Strict |
-| Console statements | Warning | Warning | Error |
-| Return type hints | Error | Error | Explicit |
-| Type safety | High | High | Very High |
+| Feature | Standard | Aggressive | Library | Strict Mode |
+|---------|----------|------------|---------|-------------|
+| Unused imports cleanup | ✅ | ✅ | ✅ | ✅ |
+| Unused variables detection | Basic | Enhanced | Enhanced | Basic |
+| Dead code detection | Basic | ✅ | ✅ | Basic |
+| Unused exports check | ❌ | ✅ | Very Strict | ❌ |
+| JSDoc requirements | Basic | Basic | Strict | Basic |
+| Console statements | Warning | Warning | Error | Warning |
+| Return type hints | Error | Error | Explicit | Error |
+| Type safety | High | High | Very High | High |
+| Folder structure enforcement | ❌ | ❌ | ❌ | ✅ |
+| Single Responsibility (Services) | ❌ | ❌ | ❌ | ✅ |
+| CQRS Repository pattern | ❌ | ❌ | ❌ | ✅ |
+| Interface naming conventions | ❌ | ❌ | ❌ | ✅ |
+| One class per file | ❌ | ❌ | ❌ | ✅ |
+| Static method restrictions | ❌ | ❌ | ❌ | ✅ |
 
 ## 📈 Industry Standards Comparison
 
@@ -198,6 +264,9 @@ Use **Library** preset - ensures clean public APIs and comprehensive documentati
 ### For Maximum Code Quality
 Use **Aggressive** preset - comprehensive unused code detection.
 
+### For Enterprise Monorepos
+Use **Strict Mode** - enforces architectural conventions, folder structure, and design patterns for large teams.
+
 ## 🔍 Example Projects
 
 ### React Application
@@ -235,6 +304,18 @@ export default config({
 });
 ```
 
+### Enterprise Monorepo
+```javascript
+// eslint.config.mjs
+import config from '@dmitryrechkin/eslint-standard';
+
+export default config({
+	strict: true,
+	tsconfigPath: './tsconfig.json',
+	ignores: ['dist/**', 'node_modules/**']
+});
+```
+
 ## 🤝 Contributing
 
 Issues and pull requests are welcome on [GitHub](https://github.com/dmitryrechkin/eslint-standard).

package/eslint.config.mjs

@@ -27,16 +27,19 @@ import unicornPlugin from 'eslint-plugin-unicorn';
 import noSecretsPlugin from 'eslint-plugin-no-secrets';
 import regexpPlugin from 'eslint-plugin-regexp';
 import functionalPlugin from 'eslint-plugin-functional';
+import standardConventionsPlugin from './src/plugins/standard-conventions.mjs';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import prettierConfig from 'eslint-config-prettier';
 // eslint-disable-next-line import/no-extraneous-dependencies
 import prettierPlugin from 'eslint-plugin-prettier';
+
 export default function ({
 	tsconfigPath = './tsconfig.json',
 	ignores = [],
 	files = [],
 	plugins = {},
 	rules = {},
+	strict = false,
 	prettierPlugin: externalPrettierPlugin = undefined
 } = {}) {
 	// Use external prettier plugin if provided, otherwise fallback to bundled one
@@ -77,6 +80,7 @@ export default function ({
 				'no-secrets': noSecretsPlugin,
 				'regexp': regexpPlugin,
 				'functional': functionalPlugin,
+				'standard-conventions': standardConventionsPlugin,
 				'prettier': activePrettierPlugin,
 				...plugins,
 			},
@@ -99,6 +103,7 @@ export default function ({
 				
 				// Original @dmitryrechkin/eslint-standard rules
 				'@typescript-eslint/explicit-function-return-type': 'error',
+				'@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
 				'@typescript-eslint/no-explicit-any': 'error', // Ban 'any' type for type safety
 
 				// Original coding guidelines - formatting rules disabled in favor of prettier
@@ -843,6 +848,92 @@ export default function ({
 				'unicorn/prefer-query-selector': 'off', // Allow different DOM query methods
 				'unicorn/prevent-abbreviations': 'off', // Allow abbreviations for domain-specific terms
 				
+				...(strict ? {
+					// Standard conventions for services, transformers, and function naming
+					'standard-conventions/service-single-public-method': 'error',
+					'standard-conventions/transformer-single-public-method': 'error',
+					'standard-conventions/function-name-match-filename': 'error',
+					'standard-conventions/folder-camel-case': 'error',
+
+					// Helper static-only rule: Helpers MUST have only static methods
+					'standard-conventions/helper-static-only': 'error',
+					// Non-helper classes should NOT have static methods (except Factories)
+					'standard-conventions/no-static-in-non-helpers': 'error',
+
+					// Class location rules: enforce proper folder structure
+					'standard-conventions/class-location': ['error', {
+						mappings: {
+							Service: 'services',
+							Repository: 'repositories',
+							Helper: 'helpers',
+							Factory: 'factories',
+							Transformer: 'transformers',
+							Registry: 'registries',
+							Adapter: 'adapters'
+						}
+					}],
+
+					// Type location rule: Types must be in types folder
+					'standard-conventions/type-location': 'error',
+
+					// One class per file rule
+					'standard-conventions/one-class-per-file': 'error',
+
+					// Repository CQRS enforcement
+					'standard-conventions/repository-cqrs': 'error',
+
+					// Repository 'ById' naming enforcement
+					'standard-conventions/repository-by-id': 'error',
+
+					// No 'utils' folder enforcement
+					'standard-conventions/no-utils-folder': 'error',
+
+					// Enforce separation of schemas, types, and constants from class files
+					'standard-conventions/no-schemas-in-class-files': 'error',
+					'standard-conventions/no-types-in-class-files': 'error',
+					'standard-conventions/no-constants-in-class-files': 'error',
+
+					'unicorn/filename-case': ['error', {
+						cases: {
+							camelCase: true,
+							pascalCase: true
+						}
+					}],
+					// Enforce Type prefix OR Interface suffix strictly
+					// TypeXXX for data types, XXXInterface for class contracts
+					'@typescript-eslint/naming-convention': [
+						'error',
+						{
+							selector: 'interface',
+							format: ['PascalCase'],
+							custom: {
+								regex: '(^Type[A-Z]|Interface$)',
+								match: true
+							}
+						},
+						{
+							selector: 'typeAlias',
+							format: ['PascalCase'],
+							custom: {
+								regex: '^Type[A-Z]',
+								match: true
+							}
+						},
+						{
+							selector: 'class',
+							format: ['PascalCase']
+						},
+						{
+							selector: 'enum',
+							format: ['PascalCase'],
+							custom: {
+								regex: '^Enum[A-Z]',
+								match: true
+							}
+						}
+					]
+				} : {}),
+
 				// Allow custom rules to be added
 				...rules
 			},

package/package.json

@@ -1,7 +1,8 @@
 {
 	"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.5.7",
+	"version": "1.5.9",
+	"type": "module",
 	"main": "eslint.config.mjs",
 	"exports": {
 		".": "./eslint.config.mjs"
@@ -31,7 +32,8 @@
 		"test:spacing": "node tests/test-spacing-rules.mjs",
 		"test:switch-case": "node tests/test-switch-case-simple.mjs",
 		"test:cli": "node tests/test-cli.mjs",
-		"test:install": "node tests/test-install-simulation.mjs"
+		"test:install": "node tests/test-install-simulation.mjs",
+		"test:strict": "node tests/test-strict-rules.mjs"
 	},
 	"keywords": [],
 	"author": "",
@@ -65,4 +67,4 @@
 		"prettier": "^3.0.0",
 		"typescript": "^5.0.0"
 	}
-}
+}

package/src/cli/check-deps.mjs

@@ -1,9 +1,8 @@
 #!/usr/bin/env node
 
-import { readFileSync } from 'fs';
-import { fileURLToPath } from 'url';
-import { dirname, join, resolve } from 'path';
-import { spawn } from 'child_process';
+import { readFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -17,18 +16,8 @@ const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
 const peerDeps = packageJson.peerDependencies || {};
 
 // Check if running from node_modules and find project root
-const isInNodeModules = __dirname.includes('node_modules');
-let projectRoot;
-
-if (isInNodeModules) {
-	// Handle different package manager structures
-	// pnpm: .pnpm/@org+pkg@version_deps/node_modules/@org/pkg
-	// npm/yarn: node_modules/@org/pkg
-	const parts = __dirname.split('node_modules');
-	projectRoot = parts[0].replace(/[\\/]$/, ''); // Remove trailing slash
-} else {
-	projectRoot = process.cwd();
-}
+// We primarily use process.cwd() as this is a CLI tool meant to run in the target project
+const projectRoot = process.cwd();
 
 // Read project's package.json
 let projectPackageJson;
@@ -36,6 +25,7 @@ try {
 	projectPackageJson = JSON.parse(readFileSync(join(projectRoot, 'package.json'), 'utf8'));
 } catch (error) {
 	console.error('❌ Could not read project package.json');
+	console.error(`Checked in: ${projectRoot}`);
 	process.exit(1);
 }
 
@@ -69,13 +59,13 @@ if (missingDeps.length === 0 && outdatedDeps.length === 0) {
 	if (missingDeps.length > 0) {
 		console.log(`\n❌ Missing ${missingDeps.length} dependencies:`);
 		missingDeps.forEach(dep => console.log(`  - ${dep}`));
-		
+
 		if (shouldInstall) {
 			console.log('\n🔧 Auto-installing missing dependencies...\n');
-			
+
 			// Import and run the install-deps script
 			try {
-				const installDepsModule = await import('./install-deps.mjs');
+				await import('./install-deps.mjs');
 				// The install-deps script will handle the installation
 			} catch (error) {
 				console.error('❌ Failed to auto-install dependencies:', error.message);
@@ -91,7 +81,7 @@ if (missingDeps.length === 0 && outdatedDeps.length === 0) {
 		console.log(`\n⚠️  ${outdatedDeps.length} dependencies may be outdated:`);
 		outdatedDeps.forEach(dep => console.log(`  - ${dep}`));
 	}
-	
+
 	if (!shouldInstall && missingDeps.length > 0) {
 		process.exit(1);
 	}
@@ -99,4 +89,4 @@ if (missingDeps.length === 0 && outdatedDeps.length === 0) {
 
 export default function checkDeps() {
 	// Export for programmatic use
-}
+}

package/src/cli/format.mjs

@@ -0,0 +1,22 @@
+
+import { spawn } from 'node:child_process';
+
+const args = process.argv.slice(3); // First 3 are node, script, command
+
+console.log('Running formatting...');
+
+// Determine eslint command (npx eslint or just eslint if in path)
+// We inject --fix to enable auto-fixing/formatting
+const eslint = spawn('npx', ['eslint', '--fix', ...args], {
+	stdio: 'inherit',
+	shell: true
+});
+
+eslint.on('close', (code) => {
+	if (code !== 0) {
+		console.log('\n\x1b[33m%s\x1b[0m', 'formatting completed with issues. please address remaining errors and warnings manually, make sure everything builds and all tests pass after modifying the code');
+		process.exit(code);
+	} else {
+		console.log('\n✅ Formatting passed');
+	}
+});

package/src/cli/index.mjs

@@ -9,6 +9,12 @@ switch (command) {
 	case 'check-deps':
 		await import('./check-deps.mjs');
 		break;
+	case 'lint':
+		await import('./lint.mjs');
+		break;
+	case 'format':
+		await import('./format.mjs');
+		break;
 	case 'help':
 	case '--help':
 	case '-h':
@@ -23,12 +29,16 @@ Commands:
   install-deps                  Install all peer dependencies
   check-deps                    Check if all peer dependencies are installed
   check-deps --install          Auto-install missing dependencies if any
+  lint                          Run eslint with custom error message
+  format                        Run eslint --fix with custom error message
   help                          Show this help message
 
 Examples:
   npx @dmitryrechkin/eslint-standard install-deps
   npx @dmitryrechkin/eslint-standard check-deps
   npx @dmitryrechkin/eslint-standard check-deps --install
+  npx @dmitryrechkin/eslint-standard lint .
+  npx @dmitryrechkin/eslint-standard format .
 		`);
 		break;
 	default:

package/src/cli/install-deps.mjs

@@ -1,49 +1,67 @@
 #!/usr/bin/env node
 
-import { execSync } from 'child_process';
-import { readFileSync, existsSync } from 'fs';
-import { fileURLToPath } from 'url';
-import { dirname, join } from 'path';
+import { spawnSync } from 'node:child_process';
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
-// Detect package manager
-function detectPackageManager() {
-	if (existsSync('pnpm-lock.yaml')) return 'pnpm';
-	if (existsSync('yarn.lock')) return 'yarn';
-	if (existsSync('package-lock.json')) return 'npm';
-	if (existsSync('bun.lockb')) return 'bun';
-	return 'npm'; // default
+// Get peer dependencies from our package.json
+const packageJsonPath = join(__dirname, '../../package.json');
+let peerDeps = {};
+
+try {
+	const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
+	peerDeps = packageJson.peerDependencies || {};
+} catch (error) {
+	console.error('❌ Could not read package.json:', error.message);
+	process.exit(1);
 }
 
-// Get peer dependencies from package.json
-const packageJsonPath = join(__dirname, '../../package.json');
-const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
-const peerDeps = packageJson.peerDependencies || {};
+const depsToInstall = Object.entries(peerDeps).map(([dep, version]) => `${dep}@${version}`);
+
+if (depsToInstall.length === 0) {
+	console.log('✅ No peer dependencies to install.');
+	process.exit(0);
+}
 
-// Build install command
-const packageManager = detectPackageManager();
-const deps = Object.entries(peerDeps).map(([name, version]) => `${name}@${version}`).join(' ');
+// Check for lockfiles to determine package manager
+const projectRoot = process.cwd();
+let packageManager = 'npm';
+let installArgs = ['install', '--save-dev'];
 
-const installCommands = {
-	npm: `npm install --save-dev ${deps}`,
-	pnpm: `pnpm add -D ${deps}`,
-	yarn: `yarn add -D ${deps}`,
-	bun: `bun add -d ${deps}`
-};
+if (existsSync(join(projectRoot, 'pnpm-lock.yaml'))) {
+	packageManager = 'pnpm';
+	installArgs = ['add', '-D'];
+} else if (existsSync(join(projectRoot, 'yarn.lock'))) {
+	packageManager = 'yarn';
+	installArgs = ['add', '-D'];
+} else if (existsSync(join(projectRoot, 'bun.lockb'))) {
+	packageManager = 'bun';
+	installArgs = ['add', '-D'];
+}
 
-const command = installCommands[packageManager];
+console.log(`📦 Installing peer dependencies using ${packageManager}...`);
+console.log(`   ${depsToInstall.join(' ')}\n`);
 
-console.log(`🔧 Installing ESLint Standard peer dependencies...`);
-console.log(`📦 Detected package manager: ${packageManager}`);
-console.log(`📋 Running: ${command}\n`);
+// Use shell: true on Windows compatibility or if packageManager is a .cmd/.bat file,
+// but generally spawnSync handles this better than execSync.
+// However, 'npm' often needs a shell on Windows or when run via npx.
+// Using shell: true is standard for cross-platform npm execution unless using .cmd explicitly on Windows.
+const result = spawnSync(packageManager, [...installArgs, ...depsToInstall], {
+	stdio: 'inherit',
+	shell: true
+});
 
-try {
-	execSync(command, { stdio: 'inherit' });
-	console.log('\n✅ All peer dependencies installed successfully!');
-} catch (error) {
-	console.error('\n❌ Failed to install dependencies. Please run manually:');
-	console.error(command);
-	process.exit(1);
-}
+if (result.status !== 0) {
+	console.error('❌ Installation failed');
+	process.exit(result.status || 1);
+}
+
+console.log('\n✅ Peer dependencies installed successfully!');
+
+export default function installDeps() {
+	// Export for programmatic use
+}

package/src/cli/lint.mjs

@@ -0,0 +1,21 @@
+
+import { spawn } from 'node:child_process';
+
+const args = process.argv.slice(3); // First 3 are node, script, command
+
+console.log('Running linting...');
+
+// Determine eslint command (npx eslint or just eslint if in path)
+const eslint = spawn('npx', ['eslint', ...args], {
+	stdio: 'inherit',
+	shell: true
+});
+
+eslint.on('close', (code) => {
+	if (code !== 0) {
+		console.log('\n\x1b[33m%s\x1b[0m', 'please address all the errors and warnings and re-run linting after, make sure everything builds and all tests pass after modifying the code');
+		process.exit(code);
+	} else {
+		console.log('\n✅ Linting passed');
+	}
+});

package/src/cli/postinstall-check.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import { readFileSync, existsSync } from 'fs';
-import { fileURLToPath } from 'url';
-import { dirname, join } from 'path';
-import { execSync } from 'child_process';
+import { readFileSync, existsSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
+import { execSync } from 'node:child_process';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);

package/src/cli/postinstall.mjs

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
+import { fileURLToPath } from 'node:url';
+import { dirname, join } from 'node:path';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -52,7 +52,7 @@ if (autoInstall) {
 	
 	try {
 		// Run check-deps with --install flag
-		const { execSync } = await import('child_process');
+		const { execSync } = await import('node:child_process');
 		execSync('node ' + join(__dirname, 'index.mjs') + ' check-deps --install', {
 			stdio: 'inherit',
 			cwd: process.cwd()