@caspeco/eslint-config-ts 5.0.0-beta.0

package/README.md

@@ -0,0 +1,77 @@
+# @caspeco/eslint-config-ts
+
+Caspeco ESLint configuration for TypeScript projects.
+
+## Installation
+
+```bash
+npm install --save-dev @caspeco/eslint-config-ts
+```
+
+## Usage
+
+Create an `eslint.config.js` file in your project root:
+
+```js
+import config from "@caspeco/eslint-config-ts";
+
+export default [{ ignores: ["dist/**/*", "build/**/*"] }, ...config];
+```
+
+## What's Included
+
+This configuration includes:
+
+- **TypeScript ESLint** - Using [recommended-type-checked](https://typescript-eslint.io/users/configs/#recommended-type-checked) config
+- **No Barrel Files** - Prevents barrel file usage (index files that just re-export)
+- **File Naming Conventions** - Enforces kebab-case for files and folders
+- **Prettier Integration** - Compatible with Prettier formatting
+
+## Peer Dependencies
+
+This package requires the following peer dependencies (automatically installed by npm 7+):
+
+- `@eslint/js` >=9
+- `eslint` >=9
+- `eslint-config-prettier` >=9
+- `eslint-plugin-check-file` >=2.8.0
+- `eslint-plugin-no-barrel-files` >=1.2.0
+- `typescript-eslint` >=8.39.0
+
+## Plugins
+
+### typescript-eslint
+
+Using [recommended-type-checked](https://typescript-eslint.io/users/configs/#recommended-type-checked) config with project service enabled.
+
+### eslint-plugin-no-barrel-files
+
+[eslint-plugin-no-barrel-files](https://github.com/art0rz/eslint-plugin-no-barrel-files)
+
+We opt out of using barrel files as they can:
+
+- Slow down builds and tests
+- Cause circular dependencies
+- Make tree shaking more difficult
+
+**Note:** We allow barrel files for libraries consumed as npm packages.
+
+More information:
+
+- [Please Stop Using Barrel Files](https://tkdodo.eu/blog/please-stop-using-barrel-files)
+
+### eslint-plugin-check-file
+
+[eslint-plugin-check-file](https://github.com/dukeluo/eslint-plugin-check-file/)
+
+Enforces `KEBAB_CASE` for filenames and folders.
+
+#### Why kebab-case?
+
+1. **Cross-Platform Consistency**: Avoids issues on case-insensitive systems (Windows, macOS) where `MyFile.js` and `myfile.js` are treated the same
+2. **Readability**: Clear, natural separation of words with hyphens
+3. **Predictability**: Consistent file-naming pattern across the project
+
+## License
+
+MIT

package/bin/README.md

@@ -0,0 +1,60 @@
+# Migration Tool
+
+This migration tool helps you upgrade from `@caspeco/eslint-config` v4.x to `@caspeco/eslint-config-ts` v5.x.
+
+## Usage
+
+```bash
+# Preview changes without modifying files
+npx caspeco-ts-migrate-v5 . --dry-run
+
+# Apply changes to your project
+npx caspeco-ts-migrate-v5 .
+
+# Or specify a directory
+npx caspeco-ts-migrate-v5 src/
+```
+
+## What it does
+
+The migration script automatically updates:
+
+1. **Package imports**: Changes `@caspeco/eslint-config` to `@caspeco/eslint-config-ts`
+2. **Named imports**: Converts `{ vanillaConfig }` to default import `config`
+3. **Variable references**: Updates `vanillaConfig` to `config` throughout your config files
+
+## Example
+
+**Before:**
+
+```js
+import { vanillaConfig } from "@caspeco/eslint-config";
+
+export default [{ ignores: ["dist/**/*"] }, ...vanillaConfig];
+```
+
+**After:**
+
+```js
+import config from "@caspeco/eslint-config-ts";
+
+export default [{ ignores: ["dist/**/*"] }, ...config];
+```
+
+## Files processed
+
+The script processes files with these extensions:
+
+- `.js`, `.jsx`
+- `.ts`, `.tsx`
+- `.mjs`, `.cjs`
+- `.json`
+- `.md`
+
+It automatically skips:
+
+- `node_modules/`
+- `.git/`
+- `dist/`
+- `build/`
+- `coverage/`

package/bin/caspeco-ts-migrate-v5.js

@@ -0,0 +1,170 @@
+#!/usr/bin/env node
+
+/**
+ * Migration script for v4.x to v5.x (TypeScript/Vanilla)
+ *
+ * This script updates:
+ * - Package imports: @caspeco/eslint-config → @caspeco/eslint-config-ts
+ * - Named imports: { vanillaConfig } → default import
+ * - Variable references: vanillaConfig → config
+ *
+ * Usage:
+ *   npx caspeco-ts-migrate-v5 [path] [--dry-run]
+ *
+ * Examples:
+ *   npx caspeco-ts-migrate-v5 .
+ *   npx caspeco-ts-migrate-v5 . --dry-run
+ */
+
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const args = process.argv.slice(2);
+const isDryRun = args.includes("--dry-run");
+const targetPath = args.find((arg) => !arg.startsWith("--")) || ".";
+
+// Import transformation for eslint.config.js files
+function transformImports(content, filename) {
+	if (!filename.includes("eslint.config.")) {
+		return { content, hasChanges: false };
+	}
+
+	let transformed = content;
+	let hasChanges = false;
+
+	// Replace import { vanillaConfig } from "@caspeco/eslint-config" → import config from "@caspeco/eslint-config-ts"
+	const importPattern = /import\s*\{\s*vanillaConfig\s*\}\s*from\s*["']@caspeco\/eslint-config["']/;
+	if (importPattern.test(transformed)) {
+		transformed = transformed.replace(importPattern, 'import config from "@caspeco/eslint-config-ts"');
+		hasChanges = true;
+
+		// If we changed the import, also update variable references
+		transformed = transformed.replace(/\bvanillaConfig\b/g, "config");
+	}
+
+	return { content: transformed, hasChanges };
+}
+
+// File extensions to process
+const extensions = [".js", ".jsx", ".ts", ".tsx", ".json", ".md", ".mjs", ".cjs"];
+
+let filesProcessed = 0;
+let filesChanged = 0;
+let totalReplacements = 0;
+
+/**
+ * Recursively process directory
+ */
+function processDirectory(dir) {
+	const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+	for (const entry of entries) {
+		const fullPath = path.join(dir, entry.name);
+
+		// Skip node_modules, .git, dist, build directories
+		if (entry.isDirectory()) {
+			if (["node_modules", ".git", "dist", "build", "coverage"].includes(entry.name)) {
+				continue;
+			}
+			processDirectory(fullPath);
+		} else {
+			const ext = path.extname(entry.name);
+			if (extensions.includes(ext)) {
+				processFile(fullPath);
+			}
+		}
+	}
+}
+
+/**
+ * Process a single file
+ */
+function processFile(filePath) {
+	filesProcessed++;
+
+	let content;
+	try {
+		content = fs.readFileSync(filePath, "utf8");
+	} catch (err) {
+		console.error(`Error reading ${filePath}:`, err.message);
+		return;
+	}
+
+	let newContent = content;
+	let fileReplacements = 0;
+
+	// Try import transformations for config files
+	const filename = path.basename(filePath);
+	const importResult = transformImports(newContent, filename);
+	if (importResult.hasChanges) {
+		newContent = importResult.content;
+		fileReplacements++; // Count as one logical replacement (import + references)
+	}
+
+	// If changes were made
+	if (fileReplacements > 0) {
+		filesChanged++;
+		totalReplacements += fileReplacements;
+
+		const relativePath = path.relative(process.cwd(), filePath);
+		console.log(
+			`${isDryRun ? "[DRY RUN] " : ""}✓ ${relativePath} (${fileReplacements} replacement${fileReplacements > 1 ? "s" : ""})`,
+		);
+
+		if (!isDryRun) {
+			try {
+				fs.writeFileSync(filePath, newContent, "utf8");
+			} catch (err) {
+				console.error(`Error writing ${filePath}:`, err.message);
+			}
+		}
+	}
+}
+
+/**
+ * Main execution
+ */
+function main() {
+	console.log("Caspeco TypeScript Migration Tool");
+	console.log("==================================\n");
+
+	if (isDryRun) {
+		console.log("🔍 Running in DRY RUN mode - no files will be modified\n");
+	}
+
+	const resolvedPath = path.resolve(targetPath);
+
+	if (!fs.existsSync(resolvedPath)) {
+		console.error(`Error: Path "${targetPath}" does not exist`);
+		process.exit(1);
+	}
+
+	console.log(`Scanning: ${resolvedPath}\n`);
+
+	const stat = fs.statSync(resolvedPath);
+	if (stat.isDirectory()) {
+		processDirectory(resolvedPath);
+	} else {
+		processFile(resolvedPath);
+	}
+
+	console.log("\nSummary:");
+	console.log("========");
+	console.log(`Files scanned: ${filesProcessed}`);
+	console.log(`Files with changes: ${filesChanged}`);
+	console.log(`Total replacements: ${totalReplacements}`);
+
+	if (isDryRun && filesChanged > 0) {
+		console.log("\n💡 Run without --dry-run to apply changes");
+	} else if (filesChanged > 0) {
+		console.log("\n✅ Migration complete!");
+	} else {
+		console.log("\n✨ No files needed migration");
+	}
+}
+
+main();

package/package.json

@@ -0,0 +1,51 @@
+{
+	"name": "@caspeco/eslint-config-ts",
+	"version": "5.0.0-beta.0",
+	"description": "Caspeco ESLint configuration for TypeScript projects",
+	"keywords": [
+		"eslint",
+		"eslint-config",
+		"typescript",
+		"caspeco"
+	],
+	"homepage": "https://github.com/Caspeco/eslint-config#readme",
+	"bugs": {
+		"url": "https://github.com/Caspeco/eslint-config/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Caspeco/eslint-config",
+		"directory": "packages/eslint-config-ts"
+	},
+	"license": "MIT",
+	"type": "module",
+	"main": "src/index.js",
+	"bin": {
+		"caspeco-ts-migrate-v5": "./bin/caspeco-ts-migrate-v5.js"
+	},
+	"files": [
+		"src",
+		"bin"
+	],
+	"scripts": {
+		"test": "vitest"
+	},
+	"devDependencies": {
+		"@caspeco/test-utils": "*"
+	},
+	"peerDependencies": {
+		"@eslint/js": ">=9",
+		"eslint": ">=9",
+		"eslint-config-prettier": ">=9",
+		"eslint-plugin-check-file": ">=2.8.0",
+		"eslint-plugin-no-barrel-files": ">=1.2.0",
+		"typescript-eslint": ">=8.39.0"
+	},
+	"engines": {
+		"node": ">=24",
+		"npm": ">=11.5.1"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/src/index.js

@@ -0,0 +1,57 @@
+import { configs as typescriptEslintConfig, parser, plugin } from "typescript-eslint";
+import js from "@eslint/js";
+import checkFile from "eslint-plugin-check-file";
+import eslintConfigPrettier from "eslint-config-prettier";
+import noBarrelFilesPlugin from "eslint-plugin-no-barrel-files";
+
+/** @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigArray} */
+const flatConfig = [
+	js.configs.recommended,
+	...typescriptEslintConfig.recommendedTypeChecked,
+	{
+		languageOptions: {
+			parserOptions: {
+				projectService: true,
+				// @ts-ignore
+				tsconfigRootDir: import.meta.name,
+			},
+		},
+	},
+	{
+		files: ["**/*.ts", "**/*.tsx"],
+		ignores: ["**/*.d.ts", "**/dist/**/*", "**/node_modules/**/*"],
+		linterOptions: {
+			reportUnusedDisableDirectives: "warn",
+		},
+		languageOptions: {
+			parser: parser,
+			sourceType: "module",
+		},
+		plugins: {
+			"@typescript-eslint": plugin,
+			"check-file": checkFile,
+			"no-barrel-files": noBarrelFilesPlugin,
+		},
+		rules: {
+			"no-barrel-files/no-barrel-files": "error",
+			"check-file/filename-naming-convention": [
+				"error",
+				{
+					"**/*.{js,ts,tsx}": "KEBAB_CASE",
+				},
+				{
+					ignoreMiddleExtensions: true,
+				},
+			],
+			"check-file/folder-naming-convention": [
+				"error",
+				{
+					"src/**/": "KEBAB_CASE",
+				},
+			],
+		},
+	},
+	eslintConfigPrettier,
+];
+
+export default flatConfig;