xo 2.0.2 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "xo",
-	"version": "2.0.2",
+	"version": "3.0.0",
 	"description": "JavaScript/TypeScript linter (ESLint wrapper) with great defaults",
 	"license": "MIT",
 	"repository": "xojs/xo",
@@ -13,12 +13,18 @@
 	"type": "module",
 	"bin": "./dist/cli.js",
 	"exports": {
-		"types": "./dist/index.d.ts",
-		"default": "./dist/index.js"
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./eslint-adapter": {
+			"types": "./dist/lib/eslint-adapter.d.ts",
+			"default": "./dist/lib/eslint-adapter.js"
+		}
 	},
 	"sideEffects": false,
 	"engines": {
-		"node": ">=20.19"
+		"node": ">=22"
 	},
 	"scripts": {
 		"build": "npm run clean && tsc",
@@ -27,7 +33,7 @@
 		"lint": "node dist/cli.js",
 		"prepare": "npm run build && husky",
 		"release": "np",
-		"test": "npm run build && npm run lint && npm run test:setup && ava",
+		"test": "npm run build && npm run lint && npm run test:setup && node --enable-source-maps --test \"dist/test/**/*.test.js\"",
 		"test:setup": "node scripts/setup-tests"
 	},
 	"files": [
@@ -67,86 +73,41 @@
 		"typescript"
 	],
 	"dependencies": {
-		"@eslint-community/eslint-plugin-eslint-comments": "^4.7.1",
-		"@eslint/compat": "^2.0.2",
 		"@sindresorhus/tsconfig": "^8.1.0",
 		"arrify": "^3.0.0",
-		"cosmiconfig": "^9.0.0",
+		"cosmiconfig": "^9.0.2",
 		"define-lazy-prop": "^3.0.0",
-		"eslint": "^10.0.2",
-		"eslint-config-prettier": "^10.1.8",
-		"eslint-config-xo-react": "^0.29.0",
-		"eslint-config-xo-typescript": "^10.0.0",
-		"eslint-formatter-pretty": "^7.0.0",
-		"eslint-plugin-ava": "^16.0.0",
-		"eslint-plugin-import-x": "^4.16.1",
-		"eslint-plugin-n": "^17.24.0",
-		"eslint-plugin-prettier": "^5.5.5",
-		"eslint-plugin-unicorn": "^63.0.0",
+		"eslint": "^10.5.0",
+		"eslint-config-xo": "^0.53.1",
+		"eslint-formatter-pretty": "^7.1.0",
 		"find-cache-directory": "^6.0.0",
 		"get-stdin": "^10.0.0",
-		"get-tsconfig": "^4.13.6",
-		"globals": "^17.3.0",
-		"globby": "^16.1.1",
+		"get-tsconfig": "^4.14.0",
+		"globby": "^16.2.0",
+		"jiti": "^2.7.0",
 		"meow": "^14.1.0",
 		"micromatch": "^4.0.8",
 		"open-editor": "^6.0.0",
 		"path-exists": "^5.0.0",
-		"prettier": "^3.8.1",
-		"type-fest": "^5.4.3",
-		"typescript": "^5.9.3",
-		"typescript-eslint": "^8.56.1"
+		"prettier": "^3.8.4",
+		"type-fest": "^5.7.0",
+		"typescript": "^6.0.3"
 	},
 	"devDependencies": {
-		"@commitlint/cli": "^20.4.1",
-		"@commitlint/config-conventional": "^20.4.1",
 		"@types/micromatch": "^4.0.10",
-		"@types/node": "^25.2.1",
-		"@types/prettier": "^3.0.0",
-		"ava": "^7.0.0",
-		"dedent": "^1.7.1",
+		"@types/node": "^25.9.3",
+		"dedent": "^1.7.2",
+		"eslint-plugin-vue": "^10.9.2",
 		"execa": "^9.6.1",
 		"husky": "^9.1.7",
-		"lint-staged": "^16.3.4",
-		"np": "^11.0.2",
-		"npm-package-json-lint": "^9.1.0",
-		"npm-package-json-lint-config-default": "^8.0.1",
-		"prettier-plugin-packagejson": "^3.0.0",
+		"np": "^11.2.1",
 		"temp-dir": "^3.0.0",
 		"xo": "file:."
 	},
-	"ava": {
-		"files": [
-			"dist/test/**/*.js",
-			"!dist/test/fixtures/**",
-			"!dist/test/helpers/**",
-			"!dist/test/scripts/**"
-		],
-		"nodeArguments": [
-			"--enable-source-maps"
-		],
-		"timeout": "1m",
-		"verbose": true,
-		"watchMode": {
-			"ignoreChanges": [
-				".history",
-				".history/**/*",
-				"node_modules",
-				"package.json",
-				"xo.config.*",
-				"**/*.ts"
-			]
-		}
-	},
 	"nyc": {
 		"reporter": [
 			"text",
 			"lcov"
 		]
-	},
-	"xo": {
-		"rules": {
-			"ava/no-ignored-test-files": "off"
-		}
 	}
 }

package/readme.md

@@ -34,7 +34,6 @@ It uses [ESLint](https://eslint.org) underneath, so issues regarding built-in ru
 - Open all files with errors at the correct line in your editor with `$ xo --open`.
 - Specify [indent](#space) and [semicolon](#semicolon) preferences easily without messing with the rule config.
 - Optionally use the [Prettier](https://github.com/prettier/prettier) code style or turn off all Prettier rules with the `compat` option.
-- Optionally use `eslint-config-xo-react` for easy JSX and React linting with zero config.
 - Optionally use with ESLint [directly](#usage-as-an-eslint-configuration)
 - Great [editor plugins](#editor-plugins).
 
@@ -46,33 +45,34 @@ npm install xo --save-dev
 
 *You must install XO locally. You can run it directly with `$ npx xo`.*
 
-*For framework-specific linting, see [Astro](#astro), [Svelte](#svelte), and [Vue](#vue).*
+*For framework-specific linting, see [Astro](#astro), [React](#react), [Svelte](#svelte), and [Vue](#vue).*
 
 ## Usage
 
-```
+```console
 $ xo --help
 
 	Usage
 		$ xo [<file|glob> ...]
 
 	Options
-		--fix             Automagically fix issues
-		--fix-dry-run     Automagically fix issues without saving the changes to the file system
-		--reporter        Reporter to use
-		--space           Use space indent instead of tabs [Default: 2]
-		--config          Path to a XO configuration file
-		--semicolon       Use semicolons [Default: true]
-		--react           Include React specific parsing and xo-react linting rules [Default: false]
-		--prettier        Format with prettier or turn off prettier-conflicted rules when set to 'compat' [Default: false]
-		--print-config    Print the effective ESLint config for the given file
-		--version         Print XO version
-		--open            Open files with issues in your editor
-		--quiet           Show only errors and no warnings
-		--stdin           Validate/fix code from stdin
-		--stdin-filename  Specify a filename for the --stdin option
-		--ignore          Ignore pattern globs, can be set multiple times
-		--cwd=<dir>       Working directory for files [Default: process.cwd()]
+		--fix                     Automagically fix issues
+		--fix-dry-run             Automagically fix issues without saving the changes to the file system
+		--reporter                Reporter to use
+		--space                   Use space indent instead of tabs [Default: 2]
+		--config                  Path to a XO configuration file
+		--semicolon               Use semicolons [Default: true]
+		--prettier                Format with prettier or turn off Prettier-conflicted rules when set to 'compat' [Default: false]
+		--print-config            Print the effective ESLint config for the given file
+		--version                 Print XO version
+		--open                    Open files with issues in your editor
+		--quiet                   Show only errors and no warnings
+		--max-warnings            Number of warnings to trigger nonzero exit code [Default: -1]
+		--stdin                   Validate/fix code from stdin
+		--stdin-filename          Specify a filename for the --stdin option
+		--ignore                  Ignore pattern globs, can be set multiple times
+		--suppressions-location   Path to a custom ESLint suppressions file
+		--cwd=<dir>               Working directory for files [Default: process.cwd()]
 
 	Examples
 		$ xo
@@ -89,7 +89,7 @@ $ xo --help
 
 ## Default code style
 
-*Any of these can be [overridden](#rules) if necessary.*
+*Any of these can be [overridden](#shareable-configs) if necessary.*
 
 - Tab indentation *[(or space)](#space)*
 - Semicolons *[(or not)](#semicolon)*
@@ -152,6 +152,16 @@ Some [paths](lib/constants.ts) are ignored by default, including paths in `.giti
 
 > Tip: For *global* ignores, keep `ignores` as the only key in the config item. You can optionally set a `name` property. Adding more properties will cause ignores to be scoped down to your files selection, which may have unexpected effects.
 
+Global negated ignores are supported in both config files and the CLI for reopening XO's built-in ignored paths. This includes directory globs like `!dist/**`, file globs like `!**/*.min.js`, and literal file paths like `!dist/src/index.js`.
+
+When global ignores are involved, XO uses them in this order:
+
+1. Built-in default ignores
+2. Global config `ignores`
+3. CLI `ignores`
+
+XO keeps positive ignores for fast file discovery and only rechecks XO's own default-ignored paths. ESLint makes the final ignore decision.
+
 ### space
 
 Type: `boolean | number`\
@@ -175,36 +185,22 @@ Default: `false`
 
 Format code with [Prettier](https://github.com/prettier/prettier).
 
-[Prettier options](https://prettier.io/docs/en/options.html) will be based on your [Prettier config](https://prettier.io/docs/en/configuration.html). XO will then **merge** your options with its own defaults:
+XO applies its own [Prettier options](https://prettier.io/docs/en/options.html):
 
 - [semi](https://prettier.io/docs/en/options.html#semicolons): based on [semicolon](#semicolon) option
 - [useTabs](https://prettier.io/docs/en/options.html#tabs): based on [space](#space) option
 - [tabWidth](https://prettier.io/docs/en/options.html#tab-width): based on [space](#space) option
 - [singleQuote](https://prettier.io/docs/en/options.html#quotes): `true`
 - [bracketSpacing](https://prettier.io/docs/en/options.html#bracket-spacing): `false`
+- [bracketSameLine](https://prettier.io/docs/en/options.html#bracket-line): `false`
+- [trailingComma](https://prettier.io/docs/en/options.html#trailing-commas): `all`
 
-To stick with Prettier's defaults, add this to your Prettier config:
-
-```js
-export default {
-	singleQuote: false,
-	bracketSpacing: true,
-};
-```
-
-If contradicting options are set for both Prettier and XO, an error will be thrown.
+Any options you set in a [Prettier config](https://prettier.io/docs/en/configuration.html) still apply for anything XO does not configure (like `printWidth` or plugins), but XO's own style settings take precedence.
 
 #### Compat
 
 If the Prettier option is set to `compat`, instead of formatting your code automatically, XO will turn off all rules that conflict with Prettier code style and allow you to pass your formatting to the Prettier tool directly.
 
-### react
-
-Type: `boolean`\
-Default: `false`
-
-Adds `eslint-plugin-react`, `eslint-plugin-react-hooks`, and `eslint-config-xo-react` to get all the React best practices applied automatically.
-
 ### Astro
 
 To lint [Astro](https://astro.build) files, install [`eslint-plugin-astro`](https://github.com/ota-meshi/eslint-plugin-astro):
@@ -225,6 +221,29 @@ const xoConfig = [
 export default xoConfig;
 ```
 
+### React
+
+To lint [React](https://react.dev) files, install [`eslint-config-xo-react`](https://github.com/xojs/eslint-config-xo-react):
+
+```sh
+npm install --save-dev eslint-config-xo-react
+```
+
+Then spread it in your `xo.config.js`:
+
+```js
+import xoReact from 'eslint-config-xo-react';
+
+const xoConfig = [
+	...xoReact(),
+];
+
+export default xoConfig;
+```
+
+> [!NOTE]
+> Until `eslint-plugin-react` supports ESLint 10 natively, you may need to wrap the config with [`fixupConfigRules`](https://github.com/eslint/rewrite/tree/main/packages/compat) from `@eslint/compat`.
+
 ### Svelte
 
 To lint [Svelte](https://svelte.dev) files, install [`eslint-plugin-svelte`](https://github.com/sveltejs/eslint-plugin-svelte):
@@ -265,6 +284,31 @@ const xoConfig = [
 export default xoConfig;
 ```
 
+### Shareable configs
+
+If you want to extend a [shareable ESLint config](https://eslint.org/docs/latest/extend/shareable-configs) or any other npm package, use `xo.config.js` instead of `package.json`, since `package.json` only supports serializable values and cannot `import`.
+
+`xo.config.js`
+
+```js
+export {default} from 'my-shareable-config';
+```
+
+You can also extend and override:
+
+```js
+import myConfig from 'my-shareable-config';
+
+export default [
+	...myConfig,
+	{
+		rules: {
+			// Your overrides
+		},
+	},
+];
+```
+
 ## TypeScript
 
 XO will automatically lint TypeScript files (`.ts`, `.mts`, `.cts`, and `.tsx`) with the rules defined in [eslint-config-xo-typescript#use-with-xo](https://github.com/xojs/eslint-config-xo-typescript#use-with-xo).
@@ -275,20 +319,33 @@ You can opt out of XO's automatic tsconfig handling by specifying your own `lang
 
 ## Usage as an ESLint Configuration
 
-With the introduction of the ESLint flat config, many of the original goals of `xo` were brought into the ESLint core, and shareable configs with plugins became possible. Although we highly recommend the use of the `xo` cli, we understand that some teams need to rely on ESLint directly.
-
-For these purposes, you can still get most of the features of `xo` by using our ESLint configuration helpers.
+There are two different ways to use XO's rules with ESLint directly, depending on whether you use the `xo` CLI.
 
-### xoToEslintConfig
+### Without the `xo` CLI
 
-The `xoToEslintConfig` function is designed for use in an `eslint.config.js` file. It is NOT for use in an `xo.config.js` file. This function takes a `FlatXoConfig` and outputs an ESLint config object. This function will neither be able to automatically handle TS integration for you nor automatic Prettier integration. You are responsible for configuring your other tools appropriately. The `xo` cli, will, however, handle all of these details for you.
+If you don't use the `xo` CLI and just want XO's rules in ESLint, use [`eslint-config-xo`](https://github.com/xojs/eslint-config-xo). It accepts the same core style options as XO, including Prettier integration:
 
 `eslint.config.js`
 
 ```js
-import xo from 'xo';
+import eslintConfigXo from 'eslint-config-xo';
 
-export default xo.xoToEslintConfig([{space: true, prettier: 'compat'}]);
+export default [
+	...eslintConfigXo({space: true, prettier: true}),
+];
+```
+
+> [!NOTE]
+> This replaces the old `xoToEslintConfig` helper. For example, `xoToEslintConfig([{space: true, prettier: true}])` becomes `eslintConfigXo({space: true, prettier: true})`. For per-file overrides, add normal ESLint config objects alongside it.
+
+### With the `xo` CLI (editor integration)
+
+If you use the `xo` CLI but your editor only has the ESLint extension (not [XO's](#editor-plugins)), add an `eslint.config.js` that re-exports the adapter. It reads your `xo.config.js` and generates the matching ESLint config automatically, so your editor shows the same errors as running `xo` — without duplicating your config.
+
+`eslint.config.js`
+
+```js
+export {default} from 'xo/eslint-adapter';
 ```
 
 ## Tips
@@ -307,17 +364,47 @@ const xoConfig = [{ignores: ['!vendor/**']}];
 export default xoConfig;
 ```
 
+This also works for narrower carve-outs:
+
+```js
+const xoConfig = [{ignores: ['!dist/src/**', '!dist/src/index.js']}];
+
+export default xoConfig;
+```
+
+### Warnings are hidden when there are errors
+
+When XO finds errors, warnings are automatically hidden to reduce noise and let you focus on what matters. Warnings are shown normally when there are no errors. Use `--quiet` to always suppress warnings, or `--max-warnings` to treat warnings as errors.
+
+### Bulk suppression
+
+XO automatically respects an [`eslint-suppressions.json`](https://eslint.org/docs/latest/use/suppressions) file if one exists in the working directory. This lets you suppress existing violations while still enforcing rules on new code — useful for incrementally adopting stricter rules in a large codebase.
+
+To generate the suppressions file, create a temporary `eslint.config.js` using [`xo/eslint-adapter`](#with-the-xo-cli-editor-integration) and run ESLint with `--suppress-all`:
+
+```sh
+npx eslint --suppress-all
+```
+
+Commit the resulting `eslint-suppressions.json` to share suppressions across your team.
+
+To use a custom suppressions file path, pass `--suppressions-location`:
+
+```sh
+xo --suppressions-location config/suppressions.json
+```
+
 ## FAQ
 
-#### What does XO mean?
+### What does XO mean?
 
 It means [hugs and kisses](https://en.wiktionary.org/wiki/xoxo).
 
-#### Why not Standard?
+### Why not Standard?
 
 The [Standard style](https://standardjs.com) is a really cool idea. I too wish we could have one style to rule them all! But the reality is that the JS community is just too diverse and opinionated to create *one* code style. They also made the mistake of pushing their own style instead of the most popular one. In contrast, XO is more pragmatic and has no aspiration of being *the* style. My goal with XO is to make it simple to enforce consistent code style with close to no config. XO comes with my code style preference by default, as I mainly made it for myself, but everything is configurable.
 
-#### Why not ESLint?
+### Why not ESLint?
 
 XO is based on ESLint. This project started out as just a shareable ESLint config, but it quickly grew out of that. I wanted something even simpler. Just typing `xo` and be done. No decision-making. No config. I also have some exciting future plans for it. However, you can still get most of the XO benefits while using ESLint directly with the [ESLint shareable config](https://github.com/xojs/eslint-config-xo).
 
@@ -376,14 +463,3 @@ Large badge: [![XO code style](https://shields.io/badge/code_style-5ed9c7?style=
 Or [customize the badge](https://github.com/xojs/xo/issues/689#issuecomment-1253127616).
 
 You can also find some nice dynamic XO badges on [badgen.net](https://badgen.net/#xo).
-
-## Team
-
-- [Sindre Sorhus](https://github.com/sindresorhus)
-
-###### Former
-
-- [James Talmage](https://github.com/jamestalmage)
-- [Michael Mayer](https://github.com/schnittstabil)
-- [Mario Nebl](https://github.com/marionebl)
-- [Pierre Vanduynslager](https://github.com/pvdlg)

package/dist/lib/rules/no-use-extend-native.d.ts

@@ -1,3 +0,0 @@
-import { type Rule } from 'eslint';
-declare const noUseExtendNativeRule: Rule.RuleModule;
-export default noUseExtendNativeRule;