@juuso.piikkila/eslint-config-typescript 3.4.0 → 3.5.4

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+## [3.5.4](https://github.com/optioni/eslint-config-typescript/compare/3.5.3...3.5.4) (2025-12-19)
+
+### Bug Fixes
+
+* Revert "chore: remove npmrc" ([d2a3491](https://github.com/optioni/eslint-config-typescript/commit/d2a34915435779846c421947d1b53cfd680b170e))
+* update workflow ([f710c77](https://github.com/optioni/eslint-config-typescript/commit/f710c770653563d63dcb06ea2af2fcc31340edd5))
+
+## [3.5.3](https://github.com/optioni/eslint-config-typescript/compare/3.5.2...3.5.3) (2025-12-19)
+
+### Bug Fixes
+
+* restore npm token ([b415192](https://github.com/optioni/eslint-config-typescript/commit/b415192d9e2f7acf25994b295c0ba437fee84928))
+
+## [3.5.2](https://github.com/optioni/eslint-config-typescript/compare/3.5.1...3.5.2) (2025-12-19)
+
+### Bug Fixes
+
+* update docs ([bb02106](https://github.com/optioni/eslint-config-typescript/commit/bb021066c1f50d7d0501f41870f986daa38b5fd5))
+
+## [3.5.1](https://github.com/optioni/eslint-config-typescript/compare/3.5.0...3.5.1) (2025-12-19)
+
+### Bug Fixes
+
+* disable unicorn/no-array-sort ([60b1325](https://github.com/optioni/eslint-config-typescript/commit/60b1325973faa198fae9ed579e497483fce1df55))
+* fix import paths ([32306bc](https://github.com/optioni/eslint-config-typescript/commit/32306bcc6b0d0ec0c0d51b701d1025ac10097d23))
+* update perfectionist/sort-imports ([0fcb24b](https://github.com/optioni/eslint-config-typescript/commit/0fcb24b9d3be6ce15be08fca63d9fe8471f115b1))
+
+## [3.5.0](https://github.com/optioni/eslint-config-typescript/compare/3.4.0...3.5.0) (2025-11-28)
+
+### Features
+
+* **deps:** update dependency eslint-plugin-vue to ~10.6.0 ([df4f3eb](https://github.com/optioni/eslint-config-typescript/commit/df4f3eb532b43e765ee80ae3b06fdc68ae9c2e04))
+
 ## [3.4.0](https://github.com/optioni/eslint-config-typescript/compare/3.3.0...3.4.0) (2025-11-07)
 
 ### Features

package/README.md

@@ -3,7 +3,137 @@
 ESLint shareable config for TypeScript projects by Juuso Piikkilä.
 
 ## Purpose
-This repository publishes an ESLint configuration package for TypeScript projects.
+This repository publishes an ESLint configuration package for TypeScript projects. It provides opinionated, production-ready ESLint rules built on top of `eslint-config-canonical` with customizations for TypeScript and Vue.js projects.
+
+## Installation
+
+```bash
+npm install --save-dev @juuso.piikkila/eslint-config-typescript
+```
+
+or
+
+```bash
+yarn add -D @juuso.piikkila/eslint-config-typescript
+```
+
+## Usage
+
+### Basic Setup (TypeScript)
+
+Create an `eslint.config.mjs` file in your project root:
+
+```javascript
+import config from '@juuso.piikkila/eslint-config-typescript';
+
+export default config;
+```
+
+This includes both the base configuration and TypeScript-specific rules.
+
+### Custom Configuration
+
+You can extend or override the configuration:
+
+```javascript
+import config from '@juuso.piikkila/eslint-config-typescript';
+
+export default [
+    ...config,
+    {
+        rules: {
+            // Your custom rules here
+        },
+    },
+];
+```
+
+### Modular Configurations
+
+The package exports modular configurations that you can compose:
+
+```javascript
+import base from '@juuso.piikkila/eslint-config-typescript/configurations/base/index.mjs';
+import typescript from '@juuso.piikkila/eslint-config-typescript/configurations/typescript/index.mjs';
+import vue from '@juuso.piikkila/eslint-config-typescript/configurations/vue/index.mjs';
+
+export default [
+    ...base,
+    ...typescript,
+    ...vue, // Add if using Vue.js
+];
+```
+
+## Configuration Modules
+
+### Base Configuration
+- **Built on**: `eslint-config-canonical` (canonical + regexp presets)
+- **Key features**:
+  - 4-space indentation
+  - Max line length: 120 characters
+  - Consistent array/object formatting
+  - Enforces trailing commas in multiline structures
+  - Sorted imports with `perfectionist/sort-imports`
+  - Numeric separators for readability (e.g., `10_000`)
+  - Arrow functions: concise style when possible
+  - Function declarations preferred (arrow functions allowed)
+
+### TypeScript Configuration
+- **Built on**: `eslint-config-canonical/typescript` + type-checking rules
+- **Key features**:
+  - Interfaces preferred over type aliases
+  - Strict naming conventions:
+    - Variables: `camelCase`, `UPPER_CASE`, or `PascalCase`
+    - Parameters: `camelCase` (leading underscore allowed)
+    - Enum members: `UPPER_CASE`
+    - Types/Interfaces: `PascalCase`
+  - No extraneous classes (except with decorators)
+  - TypeScript member delimiter: none for multiline, semicolon for single-line
+  - Type-checked rules enabled (requires `tsconfig.json`)
+
+### Vue Configuration
+- **Built on**: `eslint-plugin-vue` (recommended) + `eslint-plugin-vuejs-accessibility`
+- **Key features**:
+  - 4-space HTML indentation
+  - Component names: `PascalCase`
+  - Custom events: `kebab-case`
+  - Attribute hyphenation: always
+  - Self-closing components: always for non-HTML elements
+  - Multi-word component names enforced
+  - Accessibility (a11y) rules enabled
+
+## Highlighted Rules
+
+### Import Sorting (`perfectionist/sort-imports`)
+Imports are automatically sorted with blank lines between groups:
+1. Type imports
+2. Built-in and external modules
+3. Internal type imports
+4. Internal modules
+5. Parent/sibling/index type imports
+6. Parent/sibling/index modules
+7. Object imports
+8. Unknown imports
+
+### Numeric Separators (`unicorn/numeric-separators-style`)
+- Numbers ≥ 10,000: grouped by thousands (e.g., `10_000`)
+- Hexadecimal: grouped by 2 digits (e.g., `0xFF_FF`)
+- Binary/Octal: grouped by 4 digits
+
+## TypeScript Project Setup
+
+This configuration requires a `tsconfig.json` in your project root for type-checked rules to work. Example:
+
+```json
+{
+    "compilerOptions": {
+        "strict": true,
+        "target": "ES2020",
+        "module": "ESNext"
+    },
+    "include": ["src/**/*"]
+}
+```
 
 ## Release & dependency automation
 - Renovate is configured to:

package/configurations/base/index.mjs

@@ -145,7 +145,7 @@ export default [
                     ],
                     ignoreCase: true,
                     maxLineLength: undefined,
-                    newlinesBetween: 'never',
+                    newlinesBetween: 1,
                     type: 'natural',
                 },
             ],
@@ -177,6 +177,7 @@ export default [
                     },
                 },
             ],
+            'unicorn/no-array-sort': 'off',
         },
     },
 ];

package/eslint.config.mjs

@@ -1,11 +1,13 @@
-// eslint-disable-next-line import/no-useless-path-segments
-import rules from './configurations/base/index.mjs';
+import base from './configurations/base/index.mjs';
+import typescript from './configurations/typescript/index.mjs';
 
 export default [
-    ...rules,
+    ...base,
+    ...typescript,
     {
         rules: {
             'import/no-extraneous-dependencies': 'off',
+            'import/no-useless-path-segments': 'off',
         },
     },
 ];

package/index.mjs

@@ -1,5 +1,5 @@
-import base from './configurations/base';
-import typescript from './configurations/typescript';
+import base from './configurations/base/index.mjs';
+import typescript from './configurations/typescript/index.mjs';
 
 export default [
     ...base,

package/package.json

@@ -1,22 +1,24 @@
 {
     "name": "@juuso.piikkila/eslint-config-typescript",
     "description": "ESLint config for typescript projects",
-    "version": "3.4.0",
+    "version": "3.5.4",
     "main": "index.mjs",
     "author": "Juuso Piikkilä",
     "license": "MIT",
-    "packageManager": "yarn@4.10.3",
+    "packageManager": "yarn@4.12.0",
     "type": "module",
     "publishConfig": {
         "access": "public"
     },
     "scripts": {
-        "lint": "eslint \"configurations/**/*.mjs\" \"eslint.config.mjs\" \"index.mjs\""
+        "lint": "eslint \"configurations/**/*.mjs\" \"eslint.config.mjs\" \"index.mjs\"",
+        "test": "vitest run",
+        "test:watch": "vitest"
     },
     "dependencies": {
         "eslint": "~9.39.0",
-        "eslint-config-canonical": "~45.0.0",
-        "eslint-plugin-vue": "~10.5.0",
+        "eslint-config-canonical": "~47.3.0",
+        "eslint-plugin-vue": "~10.6.0",
         "eslint-plugin-vuejs-accessibility": "~2.4.0",
         "globals": "~16.5.0",
         "vue-eslint-parser": "~10.2.0"
@@ -25,7 +27,8 @@
         "@semantic-release/changelog": "^6.0.1",
         "@semantic-release/git": "^10.0.1",
         "conventional-changelog-conventionalcommits": "^9.0.0",
-        "semantic-release": "^24.0.0",
-        "typescript": "^5.9.3"
+        "semantic-release": "^25.0.0",
+        "typescript": "^5.9.3",
+        "vitest": "^4.0.16"
     }
 }

package/vitest.config.mjs

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+    test: {
+        include: ['test/**/*.test.mjs'],
+        watch: {
+            include: ['test/**/*.test.mjs', 'test-fixtures/**/*'],
+        },
+    },
+});

package/.nvmrc

@@ -1 +0,0 @@
-24.11