@juuso.piikkila/eslint-config-typescript 4.1.0 → 4.2.0

package/AGENTS.md

@@ -0,0 +1,112 @@
+<!--
+This file is intended to help AI coding assistants make useful, repository-specific
+edits in the `eslint-config-typescript` project. Keep guidance short and actionable.
+-->
+
+# Repository snapshot
+
+- Purpose: a shareable ESLint configuration package for TypeScript (and Vue) projects.
+- Package: `@juuso.piikkila/eslint-config-typescript` (published to npm)
+- Key entry points:
+  - `index.mjs` — package export that composes base + TypeScript configurations.
+  - `eslint.config.mjs` — ESLint configuration used when linting this repo directly.
+  - `configurations/` — modular rule sets (see `base/`, `typescript/`, `vue/`).
+  - `test/` — Vitest tests for rule validation.
+  - `test-fixtures/` — fixture files for testing specific rule behaviors.
+
+## What to change and where (high-value areas)
+
+- **Add or tweak rules**: edit `configurations/*/index.mjs`.
+  - `base/index.mjs` composes canonical and stylistic rules and sets project-wide stylistic choices (indentation 4 spaces, max-len 120, trailing commas, import sorting with `perfectionist/sort-imports`).
+  - `typescript/index.mjs` adds TypeScript-specific rules and languageOptions (note: `parserOptions.project: true` and `extraFileExtensions: ['.vue']`). Includes naming conventions and type-checking rules.
+  - `vue/index.mjs` adds Vue.js specific rules, accessibility rules, and Vue parser configuration.
+
+- **Compose exports**: `index.mjs` aggregates the configurations. Default export spreads `base` and `typescript` (Vue is opt-in). If you add a new configuration (e.g., `node`), import and spread it into the default array.
+
+- **Testing**: add test fixtures in `test-fixtures/` and update `test/lint-rules.test.mjs` when adding or significantly changing rules.
+
+## Conventions and patterns (do not break)
+
+- Rule files export arrays of ESLint config objects (not a single object). Files use ESM (`.mjs`) imports/exports.
+- File globs: most configurations target globs such as `**/*.{js,jsx,cjs,mjs,ts,tsx,vue}` — preserve these patterns when adding new rule blocks unless intentionally narrowing scope.
+- Import style: dependencies often import entire recommended sets from `eslint-config-canonical` and spread them (e.g. `...canonical.recommended`). Follow the same pattern for adding upstream presets.
+- Sorting/imports: `perfectionist/sort-imports` is enabled with explicit groupings; avoid disabling globally unless necessary.
+
+## Developer workflows & commands
+
+- **Package manager**: Yarn v4 (project specifies `packageManager: "yarn@4.12.0"` and `.yarn/releases/yarn-4.12.0.cjs` is used). Use the repository Yarn when running commands (e.g., `yarn -v` should report v4.x in CI). Avoid changing `packageManager` without updating `.yarnrc.yml`.
+- **Lint**: run `yarn lint` (runs: `eslint "configurations/**/*.mjs" "eslint.config.mjs" "index.mjs"`). This is the primary local check.
+- **Test**: run `yarn test` to execute Vitest tests that validate rules against fixtures. Use `yarn test:watch` for development.
+- **Releases**: semantic-release is configured in `.releaserc.json` and CI (`.github/workflows/main.yml`) uses semantic-release. Maintain Conventional Commits semantics for automated releases (see `.releaserc.json` for release rules).
+- **Dependency updates**: Renovate config `renovate.json` groups minor/major updates and uses semantic commit messages. Keep dependency version style (tilde `~`) — it's intentional to make Renovate open grouped PRs.
+
+## Common change tasks & examples
+
+- **To add a new stylistic rule for TypeScript files only**:
+  - Edit `configurations/typescript/index.mjs` and add the rule inside the `rules` object in the exported config that targets `**/*.{ts,tsx,vue}`.
+  - Example: Adding a rule to enforce return type annotations:
+    ```javascript
+    '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }]
+    ```
+
+- **To add a new plugin globally**:
+  - Add the plugin to `dependencies` in `package.json` and import it at the top of `configurations/base/index.mjs`.
+  - Register it in the `plugins` entry of the relevant config object and add rules under `rules`.
+  - Example: Adding a new plugin `eslint-plugin-security`:
+    ```javascript
+    import securityPlugin from 'eslint-plugin-security';
+    // ... in config object:
+    plugins: {
+        security: securityPlugin,
+    },
+    rules: {
+        'security/detect-object-injection': 'warn',
+    }
+    ```
+
+- **To modify import sorting behavior**:
+  - Edit the `perfectionist/sort-imports` rule in `configurations/base/index.mjs`.
+  - The `groups` array defines order. Current grouping:
+    1. `type` - All type imports
+    2. `builtin`, `external` - Node built-ins and npm packages
+    3. `internal` - Internal modules
+    4. `parent`, `sibling`, `index` - Relative imports
+    5. `unknown` - Special cases
+  - `newlinesBetween: 1` enforces blank lines between groups.
+
+- **To add Vue-specific rules**:
+  - Edit `configurations/vue/index.mjs` and add rules to the config targeting `**/*.vue` files.
+  - Vue config is opt-in; consumers must explicitly import it.
+
+- **To add test coverage for a rule**:
+  - Create fixtures in `test-fixtures/<rule-name>/` with subdirectories for `valid-*` and `invalid-*` cases.
+  - Update `test/lint-rules.test.mjs` to include the new rule test.
+  - Each fixture directory should contain representative code that the rule should pass or fail.
+
+## Integration & testing notes for AI edits
+
+- Keep changes small and focused. After edits, verify lint script passes locally using the repository Yarn: `yarn lint`.
+- Avoid changing published API shape: the package default export must remain an array of config objects (the library is consumed via `import config from '@.../eslint-config-typescript'`).
+- Do not change `type: "module"` or convert file extensions away from `.mjs` without updating build/consumption expectations.
+
+## Files to reference when making edits
+
+- `index.mjs` — where configurations are composed and exported.
+- `eslint.config.mjs` — how this repo is linted; useful when adding repository-only rules.
+- `configurations/base/index.mjs` — global stylistic and canonical rules.
+- `configurations/typescript/index.mjs` — TypeScript specific rules and parserOptions.
+- `configurations/vue/index.mjs` — Vue.js specific rules and parser configuration.
+- `package.json`, `.yarnrc.yml` — package manager and script information.
+- `.releaserc.json`, `.github/workflows/main.yml`, `renovate.json` — release/CI/automation expectations.
+- `README.md` — user-facing documentation with installation, usage, and configuration details.
+- `test/lint-rules.test.mjs` — Vitest tests for validating rule behavior.
+- `test-fixtures/` — sample code for testing specific rules.
+
+## Safety & review guidance
+
+- If a change touches dependencies or CI (package.json, `.yarnrc.yml`, workflow files), add a short note in the PR description explaining why it's needed and how it was tested (`yarn lint` results, CI run link).
+- Prefer incremental PRs for rules changes (one plugin or rule group per PR) so maintainers can review behavior and release impact.
+
+---
+
+If anything above is unclear or you want more examples (e.g. how to add a `vue`-specific rule set), tell me which area to expand and I will iterate.

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [4.2.0](https://github.com/optioni/eslint-config-typescript/compare/4.1.1...4.2.0) (2026-01-30)
+
+### Features
+
+* **deps:** update dependency eslint-config-canonical to ~47.4.0 ([4e76f5e](https://github.com/optioni/eslint-config-typescript/commit/4e76f5e08dba554036e0ffb0568d4bb8bcdabfcf))
+* **deps:** update dependency globals to ~17.1.0 ([7cfe68f](https://github.com/optioni/eslint-config-typescript/commit/7cfe68f3b3b47619ad404298fc112a87088fd7f8))
+
+## [4.1.1](https://github.com/optioni/eslint-config-typescript/compare/4.1.0...4.1.1) (2026-01-23)
+
+### Bug Fixes
+
+* fix perfectionist/sort-imports groups ([e6cb074](https://github.com/optioni/eslint-config-typescript/commit/e6cb074d5e03869151b9e2bccacc4d63d4473897))
+
 ## [4.1.0](https://github.com/optioni/eslint-config-typescript/compare/4.0.0...4.1.0) (2026-01-23)
 
 ### Features

package/configurations/base.mjs

@@ -134,19 +134,12 @@ export default function createBaseConfig() {
                                 'builtin',
                                 'external',
                             ],
-                            'internal-type',
                             'internal',
-                            [
-                                'parent-type',
-                                'sibling-type',
-                                'index-type',
-                            ],
                             [
                                 'parent',
                                 'sibling',
                                 'index',
                             ],
-                            'object',
                             'unknown',
                         ],
                         ignoreCase: true,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@juuso.piikkila/eslint-config-typescript",
     "description": "ESLint config for typescript projects",
-    "version": "4.1.0",
+    "version": "4.2.0",
     "main": "index.mjs",
     "author": "Juuso Piikkilä",
     "license": "MIT",
@@ -17,10 +17,10 @@
     },
     "dependencies": {
         "eslint": "~9.39.0",
-        "eslint-config-canonical": "~47.3.0",
+        "eslint-config-canonical": "~47.4.0",
         "eslint-plugin-vue": "~10.7.0",
         "eslint-plugin-vuejs-accessibility": "~2.4.0",
-        "globals": "~17.0.0",
+        "globals": "~17.1.0",
         "vue-eslint-parser": "~10.2.0"
     },
     "devDependencies": {