@tofrankie/eslint 0.0.18 → 0.0.20

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## eslint@0.0.20 (2026-04-07)
+
+- Refactor `defineConfig()` (layered options, presets, and post-antfu patches)
+- Temporarily default JSDoc to antfu-managed mode
+- Disable built-in formatter integrations by default
+- Remove the `OptionsConfig` type export from this package
+- Re-export the full public API of `@antfu/eslint-config`
+- Declare antfu optional integration plugins as direct `dependencies`
+- Export `MINIPROGRAM_LANGUAGE_OPTIONS` for WeChat miniprogram globals
+- Set `style/operator-linebreak` to `['error', 'after', { overrides: { '?': 'before', ':': 'before' } }]`
+- Expand documentation and the Vitest-based test suite
+- Miscellaneous bug fixes
+
+## eslint@0.0.19 (2026-04-04)
+
+- Update `@antfu/eslint-config` to `v8.0.0`
+- Update `@eslint-react/eslint-plugin` to `v4.2.3`
+- Update `eslint-plugin-jsdoc` to `^62.9.0`
+- Remove `eslint-plugin-react-hooks` from `dependencies`
+
 ## eslint@0.0.18 (2026-04-04)
 
 - Update documentation

package/README.md

@@ -2,11 +2,17 @@
 
 ![npm version](https://img.shields.io/npm/v/@tofrankie/eslint) ![node version](https://img.shields.io/node/v/@tofrankie/eslint) ![npm package license](https://img.shields.io/npm/l/@tofrankie/eslint) ![npm last update](https://img.shields.io/npm/last-update/@tofrankie/eslint)
 
-A shared ESLint configuration built on [@antfu/eslint-config](https://github.com/antfu/eslint-config), with opinionated presets.
+Shared [ESLint](https://eslint.org/) configuration built on [@antfu/eslint-config](https://github.com/antfu/eslint-config).
 
 > [!IMPORTANT]
 > Before 1.0.0, releases may include breaking changes. Read the [CHANGELOG](CHANGELOG.md) before upgrading.
 
+## Requirements
+
+- Node.js >= 20
+- ESLint >= 9.10.0
+- Flat config only
+
 ## Quick Start
 
 Install dependencies:
@@ -15,7 +21,7 @@ Install dependencies:
 $ pnpm add eslint @tofrankie/eslint -D
 ```
 
-Create an `eslint.config.js` in your project root:
+ESM (`eslint.config.mjs`):
 
 ```js
 import { defineConfig } from '@tofrankie/eslint'
@@ -23,54 +29,125 @@ import { defineConfig } from '@tofrankie/eslint'
 export default defineConfig()
 ```
 
-**Customization:** [antfu/eslint-config](https://github.com/antfu/eslint-config#customization)
+CJS (`eslint.config.cjs`):
+
+```js
+const { defineConfig } = require('@tofrankie/eslint')
+
+module.exports = defineConfig()
+```
+
+## Configuration
+
+`defineConfig(antfuOptions?, ...flatConfigItems)` mirrors [@antfu/eslint-config usage](https://github.com/antfu/eslint-config#customization): the first argument is antfu-style options (integrations, `rules`, etc.); rest arguments are extra flat config items appended after the generated stack.
 
 ```js
 import { defineConfig } from '@tofrankie/eslint'
 
 export default defineConfig(
   {
-    // antfu options...
-    ignores: ['node_modules', 'dist'],
     typescript: true,
     react: true,
-    rules: {
-      // user's custom rules...
-      'no-console': 'off',
-    },
   },
   {
-    // user's eslint flat configs...
+    // additional flat config item
   }
 )
 ```
 
-## Examples
+- The first argument uses antfu-compatible options.
+- User `rules` in the first argument follow antfu's fused-config semantics and stay ahead of any extra flat configs passed in the rest arguments.
+
+> `@tofrankie/eslint` already ships the plugin dependencies behind antfu's renamed rule prefixes. In normal usage you do not need to install those ESLint plugins again in your project. Enable the corresponding antfu options as needed, such as `typescript`, `vue`, `react`, `test`, or `formatters`.
 
-### Native Miniprogram
+### Integration `overrides` vs global `rules`
+
+Prefer per-integration `overrides` when a rule belongs to a specific stack (correct file globs and plugin context). Use top-level `rules` only for truly global tweaks; that layer is not scoped to integration file patterns.
 
 ```js
 import { defineConfig } from '@tofrankie/eslint'
 
-export default defineConfig(
-  {
-    ignores: ['project.config.json', 'project.private.config.json'],
-    // other antfu options...
+export default defineConfig({
+  vue: {
+    overrides: {
+      'vue/operator-linebreak': ['error', 'before'],
+    },
   },
-  {
-    languageOptions: {
-      globals: {
-        wx: true,
-        App: true,
-        getApp: true,
-        getCurrentPages: true,
-        Page: true,
-        Component: true,
-        Behavior: true,
-        requireMiniProgram: true,
-        requirePlugin: true,
-      },
+  typescript: {
+    overrides: {
+      'ts/consistent-type-definitions': ['error', 'interface'],
     },
-  }
+  },
+})
+```
+
+```js
+export default defineConfig({
+  rules: { 'no-console': 'off' },
+})
+```
+
+## TypeScript
+
+Activation follows antfu: when `typescript` is left unset, support turns on if a `typescript` package is present. Set `typescript: false` for JS-only repos that still install TypeScript for tooling.
+
+Type-aware rules need `typescript.tsconfigPath` (stricter, slower, requires a valid `tsconfig.json`). With React enabled, React type-aware rules follow the same gate.
+
+```js
+export default defineConfig({
+  typescript: { tsconfigPath: 'tsconfig.json' },
+})
+```
+
+## Formatters
+
+@antfu/eslint-config can wire formatters (CSS, HTML, Markdown, GraphQL, Astro, etc.). **This preset disables those integrations by default** so ESLint does not duplicate work when you already use Prettier (and optionally Stylelint). Defaults still include a `formatters.prettierOptions` base aligned with `@tofrankie/prettier`; it applies once you turn formatters on.
+
+Behavior:
+
+- `formatters: false` — all formatter integrations off
+- `formatters: true` — enables the same subset as antfu's boolean shortcut (`css`, `html`, `markdown`, `graphql`), merged with the built-in `prettierOptions` base
+- `formatters: { ... }` — deep-merged with the preset defaults (individual flags off until you set them)
+
+```js
+export default defineConfig({
+  formatters: {
+    html: true,
+    markdown: true,
+    prettierOptions: { printWidth: 100 },
+  },
+})
+```
+
+<!--
+## JSDoc
+
+JSDoc stays on antfu's built-in integration; this package layers rule and settings overrides without registering the `jsdoc` plugin twice. Details: [JSDoc strategy](./docs/jsdoc-strategy.md).
+-->
+
+## Unused variables
+
+With default options:
+
+- `.js` — `unused-imports/no-unused-vars`
+- `.ts` — `ts/no-unused-vars`
+- Vue SFCs with TypeScript `<script>` — `ts/no-unused-vars`
+
+## WeChat miniprogram
+
+`MINIPROGRAM_LANGUAGE_OPTIONS` exposes common miniprogram globals for an extra flat item:
+
+```js
+import { defineConfig, MINIPROGRAM_LANGUAGE_OPTIONS } from '@tofrankie/eslint'
+
+export default defineConfig(
+  { ignores: ['project.config.json', 'project.private.config.json'] },
+  { languageOptions: MINIPROGRAM_LANGUAGE_OPTIONS }
 )
 ```
+
+## Acknowledgements
+
+Thanks to these referenced packages:
+
+- [`@antfu/eslint-config`](https://github.com/antfu/eslint-config)