@ololoepepe/eslint-config-typescript 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -4,6 +4,30 @@ 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.2] - 2026-07-02
+
+### Fixed
+
+- **base:** resolved a mutual exclusion between `unicorn/prefer-export-from` and
+  `no-duplicate-imports` ({`includeExports: true`}). A binding imported for
+  internal use **and** re-exported (`import {x} from './m'; ... use x ...;
+  export {x};`) had no valid arrangement: the former demanded `export…from`,
+  which the latter forbade, and the internal use blocked dropping the import.
+  `unicorn/prefer-export-from` is now configured with `{checkUsedVariables:
+  false}`, so it no longer rewrites re-exports of internally-used bindings; pure
+  re-exports are still pushed to `export…from`. Added re-export compatibility
+  fixtures plus `--fix` fixpoint guards over `src` and every positive fixture to
+  catch future autofix conflicts across the ruleset.
+
+## [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

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,6 +1,6 @@
 {
   "name": "@ololoepepe/eslint-config-typescript",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "ESLint config for TypeScript",
   "main": "src/index.js",
   "exports": {

package/src/plugins/unicorn.js

@@ -216,7 +216,16 @@ export default {
     'unicorn/prefer-else-if': 'error',
     'unicorn/prefer-error-is-error': 'off',
     'unicorn/prefer-event-target': 'error',
-    'unicorn/prefer-export-from': 'error',
+    'unicorn/prefer-export-from': ['error', {
+      // Do not require `export…from` for a binding that is also used internally:
+      // `import {x} from './m'; ... use x ...; export {x};`. With the default
+      // (checkUsedVariables: true) this pattern is unsatisfiable — the rule demands
+      // `export {x} from './m'`, but `no-duplicate-imports` ({includeExports: true})
+      // forbids importing and export-from'ing the same path, and the internal use
+      // means the import cannot be dropped. Pure re-exports (binding never used
+      // internally) are still required to use `export…from`.
+      checkUsedVariables: false
+    }],
     'unicorn/prefer-flat-math-min-max': 'error',
     'unicorn/prefer-get-or-insert-computed': 'error',
     'unicorn/prefer-global-number-constants': 'error',