xo 0.45.0 → 0.46.0

package/config/plugins.cjs

@@ -14,7 +14,8 @@ module.exports = {
 		'no-use-extend-native',
 		'ava',
 		'unicorn',
-		'promise',
+		// Disabled as the plugin doesn't support ESLint 8 yet.
+		// 'promise',
 		'import',
 		'node',
 		'eslint-comments',
@@ -173,17 +174,19 @@ module.exports = {
 		// TODO: Temporarily disabled as the rule is buggy.
 		'function-call-argument-newline': 'off',
 
-		'promise/param-names': 'error',
-		'promise/no-return-wrap': [
-			'error',
-			{
-				allowReject: true,
-			},
-		],
-		'promise/no-new-statics': 'error',
-		'promise/no-return-in-finally': 'error',
-		'promise/valid-params': 'error',
-		'promise/prefer-await-to-then': 'error',
+		// Disabled as the plugin doesn't support ESLint 8 yet.
+		// 'promise/param-names': 'error',
+		// 'promise/no-return-wrap': [
+		// 	'error',
+		// 	{
+		// 		allowReject: true,
+		// 	},
+		// ],
+		// 'promise/no-new-statics': 'error',
+		// 'promise/no-return-in-finally': 'error',
+		// 'promise/valid-params': 'error',
+		// 'promise/prefer-await-to-then': 'error',
+
 		'import/default': 'error',
 		'import/export': 'error',
 		'import/extensions': [

package/index.js

@@ -1,7 +1,7 @@
 import path from 'node:path';
 import {ESLint} from 'eslint';
 import {globby, isGitIgnoredSync} from 'globby';
-import {isEqual} from 'lodash-es';
+import {isEqual, groupBy} from 'lodash-es';
 import micromatch from 'micromatch';
 import arrify from 'arrify';
 import slash from 'slash';
@@ -12,30 +12,6 @@ import {
 } from './lib/options-manager.js';
 import {mergeReports, processReport, getIgnoredReport} from './lib/report.js';
 
-const runEslint = async (lint, options) => {
-	const {filePath, eslintOptions, isQuiet} = options;
-	const {cwd, baseConfig: {ignorePatterns}} = eslintOptions;
-
-	if (
-		filePath
-		&& (
-			micromatch.isMatch(path.relative(cwd, filePath), ignorePatterns)
-			|| isGitIgnoredSync({cwd, ignore: ignorePatterns})(filePath)
-		)
-	) {
-		return getIgnoredReport(filePath);
-	}
-
-	const eslint = new ESLint(eslintOptions);
-
-	if (filePath && await eslint.isPathIgnored(filePath)) {
-		return getIgnoredReport(filePath);
-	}
-
-	const report = await lint(eslint);
-	return processReport(report, {isQuiet});
-};
-
 const globFiles = async (patterns, options) => {
 	const {ignores, extensions, cwd} = (await mergeWithFileConfig(options)).options;
 
@@ -59,32 +35,76 @@ const getConfig = async options => {
 
 const lintText = async (string, options) => {
 	options = await parseOptions(options);
-	const {filePath, warnIgnored, eslintOptions} = options;
-	const {ignorePatterns} = eslintOptions.baseConfig;
+	const {filePath, warnIgnored, eslintOptions, isQuiet} = options;
+	const {cwd, baseConfig: {ignorePatterns}} = eslintOptions;
 
 	if (typeof filePath !== 'string' && !isEqual(getIgnores({}), ignorePatterns)) {
 		throw new Error('The `ignores` option requires the `filePath` option to be defined.');
 	}
 
-	return runEslint(
-		eslint => eslint.lintText(string, {filePath, warnIgnored}),
-		options,
-	);
-};
+	if (
+		filePath
+		&& (
+			micromatch.isMatch(path.relative(cwd, filePath), ignorePatterns)
+			|| isGitIgnoredSync({cwd, ignore: ignorePatterns})(filePath)
+		)
+	) {
+		return getIgnoredReport(filePath);
+	}
 
-const lintFile = async (filePath, options) => runEslint(
-	eslint => eslint.lintFiles([filePath]),
-	await parseOptions({...options, filePath}),
-);
+	const eslint = new ESLint(eslintOptions);
+
+	if (filePath && await eslint.isPathIgnored(filePath)) {
+		return getIgnoredReport(filePath);
+	}
+
+	const report = await eslint.lintText(string, {filePath, warnIgnored});
+	return processReport(report, {isQuiet});
+};
 
 const lintFiles = async (patterns, options) => {
 	const files = await globFiles(patterns, options);
 
-	const reports = await Promise.all(
-		files.map(filePath => lintFile(filePath, options)),
+	const allOptions = await Promise.all(
+		files.map(filePath => parseOptions({...options, filePath})),
 	);
 
-	const report = mergeReports(reports.filter(({isIgnored}) => !isIgnored));
+	// Files with same `xoConfigPath` can lint together
+	// https://github.com/xojs/xo/issues/599
+	const groups = groupBy(allOptions, 'eslintConfigId');
+
+	const reports = await Promise.all(
+		Object.values(groups)
+			.map(async filesWithOptions => {
+				const options = filesWithOptions[0];
+				const eslint = new ESLint(options.eslintOptions);
+				const files = [];
+
+				for (const options of filesWithOptions) {
+					const {filePath, eslintOptions} = options;
+					const {cwd, baseConfig: {ignorePatterns}} = eslintOptions;
+					if (filePath
+						&& (
+							micromatch.isMatch(path.relative(cwd, filePath), ignorePatterns)
+							|| isGitIgnoredSync({cwd, ignore: ignorePatterns})(filePath)
+						)) {
+						continue;
+					}
+
+					// eslint-disable-next-line no-await-in-loop
+					if ((await eslint.isPathIgnored(filePath))) {
+						continue;
+					}
+
+					files.push(filePath);
+				}
+
+				const report = await eslint.lintFiles(files);
+
+				return processReport(report, {isQuiet: options.isQuiet});
+			}));
+
+	const report = mergeReports(reports);
 
 	return report;
 };

package/lib/options-manager.js

@@ -50,6 +50,7 @@ const DEFAULT_CONFIG = {
 	cache: true,
 	cacheLocation: path.join(cacheLocation(), 'xo-cache.json'),
 	globInputPaths: false,
+	resolvePluginsRelativeTo: __dirname,
 	baseConfig: {
 		extends: [
 			resolveLocalConfig('xo'),
@@ -115,24 +116,57 @@ const mergeWithFileConfig = async options => {
 	options = mergeOptions(options, xoOptions, enginesOptions);
 	options.cwd = xoConfigPath && path.dirname(xoConfigPath) !== options.cwd ? path.resolve(options.cwd, path.dirname(xoConfigPath)) : options.cwd;
 
+	// Very simple way to ensure eslint is ran minimal times across
+	// all linted files, once for each unique configuration - xo config path + override hash + tsconfig path
+	let eslintConfigId = xoConfigPath;
 	if (options.filePath) {
-		({options} = applyOverrides(options.filePath, options));
+		const overrides = applyOverrides(options.filePath, options);
+		options = overrides.options;
+
+		if (overrides.hash) {
+			eslintConfigId += overrides.hash;
+		}
 	}
 
 	const prettierOptions = options.prettier ? await prettier.resolveConfig(searchPath, {editorconfig: true}) || {} : {};
 
 	if (options.filePath && isTypescript(options.filePath)) {
-		const tsConfigExplorer = cosmiconfig([], {searchPlaces: ['tsconfig.json'], loaders: {'.json': (_, content) => JSON5.parse(content)}});
-		const {config: tsConfig, filepath: tsConfigPath} = (await tsConfigExplorer.search(options.filePath)) || {};
+		// We can skip looking up the tsconfig if we have it defined
+		// in our parser options already. Otherwise we can look it up and create it as normal
+		const {project: tsConfigProjectPath, tsconfigRootDir} = options.parserOptions || {};
+
+		let tsConfig;
+		let tsConfigPath;
+		if (tsConfigProjectPath) {
+			tsConfigPath = path.resolve(options.cwd, tsConfigProjectPath);
+			tsConfig = await json.load(tsConfigPath);
+		} else {
+			const tsConfigExplorer = cosmiconfig([], {
+				searchPlaces: ['tsconfig.json'],
+				loaders: {'.json': (_, content) => JSON5.parse(content)},
+				stopDir: tsconfigRootDir,
+			});
+			const searchResults = (await tsConfigExplorer.search(options.filePath)) || {};
+			tsConfigPath = searchResults.filepath;
+			tsConfig = searchResults.config;
+		}
+
+		if (tsConfigPath) {
+			options.tsConfigPath = tsConfigPath;
+			eslintConfigId += tsConfigPath;
+		} else {
+			const {path: tsConfigCachePath, hash: tsConfigHash} = await getTsConfigCachePath([eslintConfigId], tsConfigPath, options.cwd);
+			eslintConfigId += tsConfigHash;
+			options.tsConfigPath = tsConfigCachePath;
+			const config = makeTSConfig(tsConfig, tsConfigPath, [options.filePath]);
+			await fs.mkdir(path.dirname(options.tsConfigPath), {recursive: true});
+			await fs.writeFile(options.tsConfigPath, JSON.stringify(config));
+		}
 
-		options.tsConfigPath = await getTsConfigCachePath([options.filePath], options.tsConfigPath, options.cwd);
 		options.ts = true;
-		const config = makeTSConfig(tsConfig, tsConfigPath, [options.filePath]);
-		await fs.mkdir(path.dirname(options.tsConfigPath), {recursive: true});
-		await fs.writeFile(options.tsConfigPath, JSON.stringify(config));
 	}
 
-	return {options, prettierOptions};
+	return {options, prettierOptions, eslintConfigId};
 };
 
 /**
@@ -141,10 +175,14 @@ Hashing based on https://github.com/eslint/eslint/blob/cf38d0d939b62f3670cdd59f0
 */
 const getTsConfigCachePath = async (files, tsConfigPath, cwd) => {
 	const {version} = await json.load('../package.json');
-	return path.join(
-		cacheLocation(cwd),
-		`tsconfig.${murmur(`${version}_${nodeVersion}_${stringify({files: files.sort(), tsConfigPath})}`).result().toString(36)}.json`,
-	);
+	const tsConfigHash = murmur(`${version}_${nodeVersion}_${stringify({files: files.sort(), tsConfigPath})}`).result().toString(36);
+	return {
+		path: path.join(
+			cacheLocation(cwd),
+			`tsconfig.${tsConfigHash}.json`,
+		),
+		hash: tsConfigHash,
+	};
 };
 
 const makeTSConfig = (tsConfig, tsConfigPath, files) => {
@@ -437,7 +475,7 @@ const mergeWithPrettierConfig = (options, prettierOptions) => {
 
 const buildTSConfig = options => config => {
 	if (options.ts) {
-		config.baseConfig.extends.push('xo-typescript');
+		config.baseConfig.extends.push(require.resolve('eslint-config-xo-typescript'));
 		config.baseConfig.parser = require.resolve('@typescript-eslint/parser');
 		config.baseConfig.parserOptions = {
 			...config.baseConfig.parserOptions,
@@ -538,13 +576,14 @@ const gatherImportResolvers = options => {
 
 const parseOptions = async options => {
 	options = normalizeOptions(options);
-	const {options: foundOptions, prettierOptions} = await mergeWithFileConfig(options);
+	const {options: foundOptions, prettierOptions, eslintConfigId} = await mergeWithFileConfig(options);
 	const {filePath, warnIgnored, ...eslintOptions} = buildConfig(foundOptions, prettierOptions);
 	return {
 		filePath,
 		warnIgnored,
 		isQuiet: options.quiet,
 		eslintOptions,
+		eslintConfigId,
 	};
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "xo",
-	"version": "0.45.0",
+	"version": "0.46.0",
 	"description": "JavaScript/TypeScript linter (ESLint wrapper) with great defaults",
 	"license": "MIT",
 	"repository": "xojs/xo",
@@ -16,6 +16,7 @@
 		"node": ">=12.20"
 	},
 	"scripts": {
+		"test:clean": "find ./test -type d -name 'node_modules' -prune -not -path ./test/fixtures/project/node_modules -exec rm -rf '{}' +",
 		"test": "node cli.js && nyc ava"
 	},
 	"files": [
@@ -51,30 +52,34 @@
 		"javascript",
 		"typescript"
 	],
+	"bundledDependencies": [
+		"@typescript-eslint/eslint-plugin",
+		"@typescript-eslint/parser",
+		"eslint-config-xo-typescript"
+	],
 	"dependencies": {
-		"@eslint/eslintrc": "^1.0.1",
-		"@typescript-eslint/eslint-plugin": "^4.32.0",
-		"@typescript-eslint/parser": "^4.32.0",
+		"@eslint/eslintrc": "^1.0.3",
+		"@typescript-eslint/eslint-plugin": "^5.2.0",
+		"@typescript-eslint/parser": "^5.2.0",
 		"arrify": "^3.0.0",
 		"cosmiconfig": "^7.0.1",
 		"define-lazy-prop": "^3.0.0",
-		"eslint": "^7.32.0",
+		"eslint": "^8.1.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-config-xo": "^0.39.0",
-		"eslint-config-xo-typescript": "^0.45.0",
+		"eslint-config-xo-typescript": "^0.47.0",
 		"eslint-formatter-pretty": "^4.1.0",
-		"eslint-import-resolver-webpack": "^0.13.1",
-		"eslint-plugin-ava": "^13.0.0",
+		"eslint-import-resolver-webpack": "^0.13.2",
+		"eslint-plugin-ava": "^13.1.0",
 		"eslint-plugin-eslint-comments": "^3.2.0",
-		"eslint-plugin-import": "^2.24.2",
+		"eslint-plugin-import": "^2.25.2",
 		"eslint-plugin-no-use-extend-native": "^0.5.0",
 		"eslint-plugin-node": "^11.1.0",
 		"eslint-plugin-prettier": "^4.0.0",
-		"eslint-plugin-promise": "^5.1.0",
-		"eslint-plugin-unicorn": "^36.0.0",
+		"eslint-plugin-unicorn": "^37.0.1",
 		"esm-utils": "^2.0.0",
 		"find-cache-dir": "^3.3.2",
-		"find-up": "^6.1.0",
+		"find-up": "^6.2.0",
 		"get-stdin": "^9.0.0",
 		"globby": "^12.0.2",
 		"imurmurhash": "^0.1.4",
@@ -88,7 +93,7 @@
 		"semver": "^7.3.5",
 		"slash": "^4.0.0",
 		"to-absolute-glob": "^2.0.2",
-		"typescript": "^4.4.3"
+		"typescript": "^4.4.4"
 	},
 	"devDependencies": {
 		"ava": "^3.15.0",
@@ -99,7 +104,7 @@
 		"nyc": "^15.1.0",
 		"proxyquire": "^2.1.3",
 		"temp-write": "^5.0.0",
-		"webpack": "^5.56.0"
+		"webpack": "^5.60.0"
 	},
 	"xo": {
 		"ignores": [

package/readme.md

@@ -221,14 +221,23 @@ Default: `false`
 
 Format code with [Prettier](https://github.com/prettier/prettier).
 
-The [Prettier options](https://prettier.io/docs/en/options.html) will be read from the [Prettier config](https://prettier.io/docs/en/configuration.html) and if **not set** will be determined as follow:
+[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:
 - [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
 - [trailingComma](https://prettier.io/docs/en/options.html#trailing-commas): `all`
 - [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`
+
+To stick with Prettier's defaults, add this to your Prettier config:
+
+```js
+module.exports = {
+	trailingComma: 'es5',
+	singleQuote: false,
+	bracketSpacing: true,
+};
+```
 
 If contradicting options are set for both Prettier and XO an error will be thrown.