@ololoepepe/eslint-config-typescript 0.0.11 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Changelog
+
+All notable changes to this project are documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2026-07-01
+
+### Documentation
+
+- Expanded the README into full package documentation: highlights, config entry
+  points (`base` / `/node` / `/react`), installation, usage examples, a
+  type-aware linting section (project service / `tsconfig.json` requirement), and
+  the enforced conventions.
+
+## [0.1.0] - 2026-07-01
+
+A major modernization of the config, brought to parity with the sibling
+`@ololoepepe/eslint-config` while staying standalone and TypeScript-specific.
+**This release contains breaking changes.**
+
+### Changed
+
+- **BREAKING:** Upgraded to **ESLint 10** (`>= 10.4`) and migrated to the **flat
+  config** format. The legacy `.eslintrc` format is no longer supported.
+- **BREAKING:** Each entry point now exports a **flat-config array** to be spread
+  into a consumer's `eslint.config.js`, instead of a legacy config object
+  (`env` / `parser` / `parserOptions` / `plugins: []` / `rules: {}`).
+- **BREAKING:** Replaced `eslint-plugin-import` with **`eslint-plugin-import-x`**
+  (all `import/*` rules are now `import-x/*`).
+- **BREAKING:** Core formatting rules were moved to **`@stylistic/eslint-plugin`**
+  (`@stylistic/*`), mirroring their removal from ESLint core in v10. Options are
+  preserved 1:1.
+- Adopted the **`typescript-eslint@8`** meta-package; typed linting is enabled via
+  `parserOptions.projectService`. The `@typescript-eslint/*` rule prefixes are
+  unchanged.
+- Bumped **`eslint-plugin-perfectionist`** to `^5.9` — retained as this package's
+  distinctive type/interface/enum-sorting feature.
+- Bumped `eslint-plugin-sort-keys-shorthand` to `^5`; it is now the **sole owner**
+  of object-literal key ordering (shorthand-first).
+
+### Added
+
+- **Layered entry points:**
+  - `@ololoepepe/eslint-config-typescript` — env-neutral TypeScript base.
+  - `@ololoepepe/eslint-config-typescript/node` — base + Node globals +
+    `eslint-plugin-n`.
+  - `@ololoepepe/eslint-config-typescript/react` — base + browser globals +
+    `@eslint-react`, `eslint-plugin-react-hooks`, and JSX `@stylistic`, scoped to
+    `.tsx` / `.jsx`.
+- Correctness plugins on the base: **`unicorn`**, **`regexp`**, **`promise`**, and
+  **`@eslint-community/eslint-comments`**, each with an explicitly configured rule
+  map.
+- **`typescript`** as a peer dependency (`>=5 <6.1`) and dev dependency.
+- A **fixture-driven test suite** (positive + negative fixtures across the base,
+  `/node`, and `/react` layers), alongside the retained self-lint test.
+- The base config now registers TypeScript file extensions (`.ts` / `.cts` /
+  `.mts`), so `eslint .` lints TypeScript out of the box.
+
+### Removed
+
+- **BREAKING:** Removed `eslint-plugin-import`, `eslint-find-rules`, and the
+  `find-rules` script.
+- Removed core rules that no longer exist in ESLint 10, replacing them with their
+  modern equivalents or `@typescript-eslint/*` typed analogs (single owner per
+  concern, no double-reporting).
+
+### Fixed
+
+- Resolved rule conflicts between overlapping plugins:
+  - Object-literal key ordering: `perfectionist/sort-objects` disabled in favor of
+    `sort-keys-shorthand` (shorthand-first).
+  - Import-statement ordering: `perfectionist/sort-imports` disabled in favor of
+    `import-x/order` (which carries the project path groups).
+  - Disabled `n/no-unsupported-features/es-syntax`, since downlevel syntax for
+    TypeScript is owned by the compiler (`tsconfig` `target`).

package/README.md

@@ -1 +1,158 @@
-# ESLint config for TypeScript
+# @ololoepepe/eslint-config-typescript
+
+A shareable [ESLint](https://eslint.org/) configuration for **TypeScript**
+projects.
+
+It aims to **cover as many cases as possible** and to enforce a **single,
+unambiguous code style** wherever a clear "right answer" exists — leaving a rule
+off only when the preferred style genuinely depends on context, or when a
+compromise is worth it for ergonomics. Every available rule is configured
+explicitly, including the ones turned off.
+
+It is the TypeScript-oriented sibling of
+[`@ololoepepe/eslint-config`](https://gitea.void-walkers.com/libs/eslint-config):
+a **standalone** config (it keeps its own copy of the core/formatting rules
+rather than depending on the base package) that adds full **type-aware**
+linting and TypeScript-specific rules on top.
+
+## Highlights
+
+- **Flat config** (ESLint's modern format) — each entry point is exported as a
+  config array.
+- **ESLint 10** with all formatting rules provided by
+  [`@stylistic/eslint-plugin`](https://eslint.style/).
+- **Type-aware linting** via
+  [`typescript-eslint`](https://typescript-eslint.io/) — the `@typescript-eslint`
+  rules run with full type information (`parserOptions.projectService`), and core
+  rules are replaced by their typed analogs wherever one exists.
+- **Type / interface / enum sorting** via
+  [`eslint-plugin-perfectionist`](https://perfectionist.dev/) — the distinctive
+  feature of this package.
+- **Import hygiene** via
+  [`eslint-plugin-import-x`](https://github.com/un-ts/eslint-plugin-import-x)
+  with the TypeScript resolver.
+- **Promise / async correctness** via
+  [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise).
+- **Regex correctness & style** via
+  [`eslint-plugin-regexp`](https://github.com/ota-meshi/eslint-plugin-regexp).
+- **Modern idioms & a large catch-all of correctness rules** via
+  [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn).
+- **React** (opt-in `/react` layer) via
+  [`@eslint-react`](https://eslint-react.xyz/) and the official
+  [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks),
+  with type-aware React rules on `.tsx`.
+- **Sorted object keys** via
+  [`eslint-plugin-sort-keys-shorthand`](https://github.com/leonardovillela/eslint-plugin-sort-keys-shorthand).
+- **Disciplined `eslint-disable` comments** via
+  [`@eslint-community/eslint-plugin-eslint-comments`](https://github.com/eslint-community/eslint-plugin-eslint-comments).
+
+## Config entry points
+
+The package is **environment-neutral by default** and ships environment layers
+on top of it:
+
+- **`@ololoepepe/eslint-config-typescript`** — the base config. Language + style
+  + import + promise + correctness + type-aware `@typescript-eslint` rules. No
+  environment globals beyond standard ES, no Node- or browser-specific rules.
+  Use this directly for environment-agnostic code, or as the base for an
+  environment-specific config.
+- **`@ololoepepe/eslint-config-typescript/node`** — the base **plus** a Node
+  layer: Node globals and
+  [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n). Use
+  this for Node.js libraries and applications.
+- **`@ololoepepe/eslint-config-typescript/react`** — the base **plus** a React
+  layer: browser globals, [`@eslint-react`](https://eslint-react.xyz/),
+  `eslint-plugin-react-hooks`, and JSX formatting via `@stylistic`. Targets
+  modern function components and lints `.tsx` / `.jsx` files, with type-aware
+  React rules.
+
+## Requirements
+
+- ESLint `>= 10.4`
+- TypeScript `>= 5 < 6.1` (peer dependency — you provide it)
+- Node.js `>= 24`
+- A `tsconfig.json` for your project (required for type-aware linting — see
+  [Type-aware linting](#type-aware-linting)).
+
+## Installation
+
+```sh
+npm install --save-dev @ololoepepe/eslint-config-typescript typescript
+```
+
+## Usage
+
+This package is **ESM**. Each entry point exports a flat-config array — spread it
+into your own `eslint.config.js` and add any project-specific overrides
+afterwards.
+
+For a **Node.js** project:
+
+```js
+// eslint.config.js
+import ololoepepe from '@ololoepepe/eslint-config-typescript/node';
+
+export default [
+  ...ololoepepe,
+  {
+    // Your project-specific overrides.
+    rules: {}
+  }
+];
+```
+
+For a **React** project:
+
+```js
+// eslint.config.js
+import ololoepepe from '@ololoepepe/eslint-config-typescript/react';
+
+export default [
+  ...ololoepepe,
+  {
+    // Your project-specific overrides.
+    rules: {}
+  }
+];
+```
+
+For an **environment-agnostic** project, or as the base for another config,
+import `@ololoepepe/eslint-config-typescript` instead and add the environment
+globals and rules your project needs.
+
+> CommonJS consumers on Node.js ≥ 22 can still load it via `require()`
+> (`require(ESM)` is supported), but an ESM `eslint.config.js` is recommended.
+
+## Type-aware linting
+
+The `@typescript-eslint` rules in this config need **type information**. The base
+config enables the TypeScript project service
+(`parserOptions.projectService: true`), which discovers the nearest
+`tsconfig.json` for each linted file automatically. In practice this means:
+
+- Your project must have a `tsconfig.json`, and the files you lint must be
+  covered by it (via `include` / `files`).
+- `typescript` must be installed (it is a peer dependency).
+
+The base registers the TypeScript extensions (`.ts`, `.cts`, `.mts` — plus the
+JavaScript ones), so `eslint .` lints your TypeScript sources out of the box. The
+`/react` layer additionally targets `.tsx` / `.jsx`.
+
+## Conventions
+
+A few of the style choices the config enforces:
+
+- 2-space indentation, Unix line endings, semicolons always, single quotes.
+- Max line length of 120.
+- No trailing commas, no spaces inside braces.
+- Object keys sorted (natural, case-insensitive, shorthand first); types,
+  interfaces, enums, and union/intersection members sorted via `perfectionist`.
+- Imports ordered and grouped, no duplicates, no unresolved (via `import-x`).
+- Typed `@typescript-eslint` rules preferred over their core equivalents; explicit
+  function/module boundary types where they add clarity.
+- `const` over `let`, never `var`; arrow callbacks; template strings over
+  concatenation.
+
+## License
+
+UNLICENSED — private package.

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@ololoepepe/eslint-config-typescript",
-  "version": "0.0.11",
+  "version": "0.1.1",
   "description": "ESLint config for TypeScript",
   "main": "src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./node": "./src/node.js",
+    "./react": "./src/react.js"
+  },
   "imports": {
     "#src/*.js": "./src/*.js"
   },
   "type": "module",
   "scripts": {
-    "find-rules": "eslint-find-rules --unused ./src/index.js",
     "lint": "eslint ./src",
-    "test": "mocha ./test/*"
+    "test": "mocha './test/**/*.test.js'"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.com"
@@ -18,7 +22,8 @@
   "files": [
     "src",
     "package.json",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "repository": {
     "type": "git",
@@ -31,16 +36,31 @@
   },
   "homepage": "https://gitea.void-walkers.com/libs/eslint-config-typescript#README",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.50.1",
-    "@typescript-eslint/parser": "^8.50.1",
-    "eslint": "^8.57.1",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-perfectionist": "^5.1.0",
-    "eslint-plugin-sort-keys-shorthand": "^2.3.0"
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
+    "@eslint-react/eslint-plugin": "^5.10.0",
+    "@stylistic/eslint-plugin": "^5.0.0",
+    "eslint": "^10.6.0",
+    "eslint-import-resolver-typescript": "^4.4.0",
+    "eslint-plugin-import-x": "^4.17.0",
+    "eslint-plugin-n": "^18.2.1",
+    "eslint-plugin-perfectionist": "^5.9.0",
+    "eslint-plugin-promise": "^7.3.0",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-regexp": "^3.1.1",
+    "eslint-plugin-sort-keys-shorthand": "^5.0.0",
+    "eslint-plugin-unicorn": "^69.0.0",
+    "globals": "^17.0.0",
+    "ts-declaration-location": "^1.0.7",
+    "typescript-eslint": "^8.62.0"
   },
   "devDependencies": {
-    "eslint-find-rules": "^5.0.0",
-    "mocha": "^11.7.5"
+    "@types/node": "^22.20.0",
+    "@types/react": "^19.2.0",
+    "mocha": "^11.7.5",
+    "react": "^19.2.0",
+    "typescript": "^5.9.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=5 <6.1"
   }
 }