xo 0.38.0 → 0.39.1

package/cli-main.js

@@ -27,10 +27,10 @@ const cli = meow(`
 	  --open            Open files with issues in your editor
 	  --quiet           Show only errors and no warnings
 	  --extension       Additional extension to lint [Can be set multiple times]
-	  --no-esnext       Don't enforce ES2015+ rules
 	  --cwd=<dir>       Working directory for files
 	  --stdin           Validate/fix code from stdin
 	  --stdin-filename  Specify a filename for the --stdin option
+	  --print-config    Print the effective ESLint config for the given file
 
 	Examples
 	  $ xo
@@ -41,6 +41,7 @@ const cli = meow(`
 	  $ xo --plugin=react
 	  $ xo --plugin=html --extension=html
 	  $ echo 'const x=true' | xo --stdin --fix
+	  $ xo --print-config=index.js
 
 	Tips
 	  - Add XO to your project with \`npm init xo\`.
@@ -97,12 +98,12 @@ const cli = meow(`
 			type: 'string',
 			isMultiple: true
 		},
-		esnext: {
-			type: 'boolean'
-		},
 		cwd: {
 			type: 'string'
 		},
+		printConfig: {
+			type: 'string'
+		},
 		stdin: {
 			type: 'boolean'
 		},
@@ -168,13 +169,27 @@ if (options.nodeVersion) {
 	if (options.nodeVersion === 'false') {
 		options.nodeVersion = false;
 	} else if (!semver.validRange(options.nodeVersion)) {
-		console.error('The `node-engine` option must be a valid semver range (for example `>=6`)');
+		console.error('The `--node-engine` flag must be a valid semver range (for example `>=6`)');
 		process.exit(1);
 	}
 }
 
 (async () => {
-	if (options.stdin) {
+	if (options.printConfig) {
+		if (input.length > 0) {
+			console.error('The `--print-config` flag must be used with exactly one filename');
+			process.exit(1);
+		}
+
+		if (options.stdin) {
+			console.error('The `--print-config` flag is not supported on stdin');
+			process.exit(1);
+		}
+
+		options.filename = options.printConfig;
+		const config = xo.getConfig(options);
+		console.log(JSON.stringify(config, undefined, '\t'));
+	} else if (options.stdin) {
 		const stdin = await getStdin();
 
 		if (options.stdinFilename) {
@@ -189,7 +204,7 @@ if (options.nodeVersion) {
 		}
 
 		if (options.open) {
-			console.error('The `open` option is not supported on stdin');
+			console.error('The `--open` flag is not supported on stdin');
 			process.exit(1);
 		}
 

package/config/plugins.js

@@ -186,20 +186,18 @@ module.exports = {
 		'promise/prefer-await-to-then': 'error',
 		'import/default': 'error',
 		'import/export': 'error',
-
-		// Disabled as we use `node/file-extension-in-import` instead as it has an auto-fix.
-		// 'import/extensions': [
-		// 	'error',
-		// 	'always',
-		// 	{
-		// 		ignorePackages: true,
-		// 		// TypeScript doesn't yet support using extensions and fails with error TS2691.
-		// 		pattern: {
-		// 			ts: 'never',
-		// 			tsx: 'never'
-		// 		}
-		// 	}
-		// ],
+		'import/extensions': [
+			'error',
+			'always',
+			{
+				ignorePackages: true,
+				// TypeScript doesn't yet support using extensions and fails with error TS2691.
+				pattern: {
+					ts: 'never',
+					tsx: 'never'
+				}
+			}
+		],
 
 		// Disabled as it causes problems with TypeScript when you use mixed ESM and CommonJS.
 		// TODO: Enable again when I target only ESM.
@@ -283,6 +281,8 @@ module.exports = {
 		// 'node/no-missing-require': 'error',
 
 		'node/no-unpublished-bin': 'error',
+
+		// We have this enabled in addition to `import/extensions` as this one has an auto-fix.
 		'node/file-extension-in-import': [
 			'error',
 			'always',

package/index.js

@@ -57,6 +57,13 @@ const globFiles = async (patterns, {ignores, extensions, cwd}) => (
 		{ignore: ignores, gitignore: true, cwd}
 	)).filter(file => extensions.includes(path.extname(file).slice(1))).map(file => path.resolve(cwd, file));
 
+const getConfig = options => {
+	const {options: foundOptions, prettierOptions} = mergeWithFileConfig(normalizeOptions(options));
+	options = buildConfig(foundOptions, prettierOptions);
+	const engine = new eslint.CLIEngine(options);
+	return engine.getConfigForFile(options.filename);
+};
+
 const lintText = (string, options) => {
 	const {options: foundOptions, prettierOptions} = mergeWithFileConfig(normalizeOptions(options));
 	options = buildConfig(foundOptions, prettierOptions);
@@ -121,6 +128,7 @@ module.exports = {
 	getFormatter: eslint.CLIEngine.getFormatter,
 	getErrorResults: eslint.CLIEngine.getErrorResults,
 	outputFixes: eslint.CLIEngine.outputFixes,
+	getConfig,
 	lintText,
 	lintFiles
 };

package/lib/constants.js

@@ -109,7 +109,6 @@ const ENGINE_RULES = {
 const PRETTIER_CONFIG_OVERRIDE = {
 	'eslint-plugin-babel': 'prettier/babel',
 	'eslint-plugin-flowtype': 'prettier/flowtype',
-	'eslint-plugin-react': 'prettier/react',
 	'eslint-plugin-standard': 'prettier/standard',
 	'eslint-plugin-vue': 'prettier/vue'
 };

package/lib/options-manager.js

@@ -162,9 +162,11 @@ const mergeWithFileConfigs = async (files, options, configFiles) => {
 		([tsConfigPath, groups]) => {
 			const files = [].concat(...groups.map(group => group.files));
 			const cachePath = getTsConfigCachePath(files, tsConfigPath);
-			groups.forEach(group => {
+
+			for (const group of groups) {
 				group.options.tsConfigPath = cachePath;
-			});
+			}
+
 			return outputJson(cachePath, makeTSConfig(tsConfigs[tsConfigPath], tsConfigPath, files));
 		}
 	));
@@ -180,11 +182,11 @@ Hashing based on https://github.com/eslint/eslint/blob/cf38d0d939b62f3670cdd59f0
 */
 const getTsConfigCachePath = (files, tsConfigPath) => path.join(
 	cacheLocation,
-	`tsconfig.${murmur(`${pkg.version}_${nodeVersion}_${stringify({files: files.sort(), tsConfigPath: tsConfigPath})}`).result().toString(36)}.json`
+	`tsconfig.${murmur(`${pkg.version}_${nodeVersion}_${stringify({files: files.sort(), tsConfigPath})}`).result().toString(36)}.json`
 );
 
 const makeTSConfig = (tsConfig, tsConfigPath, files) => {
-	const config = {files: files.filter(isTypescript)};
+	const config = {files: files.filter(file => isTypescript(file))};
 
 	if (tsConfig) {
 		config.extends = tsConfigPath;
@@ -308,15 +310,15 @@ const buildXOConfig = options => config => {
 		}];
 	}
 
-	if (options.esnext !== false) {
-		config.baseConfig.extends = [
-			'xo/esnext',
-			path.join(__dirname, '../config/plugins.js')
-		];
-	}
-
 	if (options.ts) {
 		config.rules['unicorn/import-style'] = 'off';
+		config.rules['node/file-extension-in-import'] = 'off';
+
+		// Disabled because of https://github.com/benmosher/eslint-plugin-import/issues/1590
+		config.rules['import/export'] = 'off';
+
+		// Does not work when the TS definition exports a default const.
+		config.rules['import/default'] = 'off';
 	}
 
 	if (options.rules) {
@@ -382,7 +384,6 @@ const buildPrettierConfig = (options, prettierConfig) => config => {
 
 		// The prettier config overrides ESLint stylistic rules that are handled by Prettier
 		config.baseConfig.extends = config.baseConfig.extends.concat('prettier');
-		config.baseConfig.extends = config.baseConfig.extends.concat('prettier/unicorn');
 
 		// The `prettier/prettier` rule reports errors if the code is not formatted in accordance to Prettier
 		config.rules['prettier/prettier'] = ['error', mergeWithPrettierConfig(options, prettierConfig)];
@@ -394,10 +395,6 @@ const buildPrettierConfig = (options, prettierConfig) => config => {
 				config.baseConfig.extends = config.baseConfig.extends.concat(prettierConfig);
 			}
 		}
-
-		if (options.ts) {
-			config.baseConfig.extends = config.baseConfig.extends.concat('prettier/@typescript-eslint');
-		}
 	}
 
 	return config;
@@ -460,7 +457,7 @@ const applyOverrides = (file, options) => {
 		const {overrides} = options;
 		delete options.overrides;
 
-		let {applicable, hash} = findApplicableOverrides(path.relative(options.cwd, file), overrides);
+		const {applicable, hash} = findApplicableOverrides(path.relative(options.cwd, file), overrides);
 
 		options = mergeWith(...[getEmptyOptions(), options].concat(applicable.map(override => normalizeOptions(override)), mergeFn));
 		delete options.files;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "xo",
-	"version": "0.38.0",
-	"description": "JavaScript/TypeScript linter with great defaults",
+	"version": "0.39.1",
+	"description": "JavaScript/TypeScript linter (ESLint wrapper) with great defaults",
 	"license": "MIT",
 	"repository": "xojs/xo",
 	"funding": "https://github.com/sponsors/sindresorhus",
@@ -51,25 +51,25 @@
 		"typescript"
 	],
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "^4.15.1",
-		"@typescript-eslint/parser": "^4.15.1",
+		"@typescript-eslint/eslint-plugin": "^4.22.0",
+		"@typescript-eslint/parser": "^4.22.0",
 		"arrify": "^2.0.1",
 		"cosmiconfig": "^7.0.0",
 		"debug": "^4.3.1",
-		"eslint": "^7.20.0",
-		"eslint-config-prettier": "^7.2.0",
-		"eslint-config-xo": "^0.35.0",
-		"eslint-config-xo-typescript": "^0.38.0",
+		"eslint": "^7.24.0",
+		"eslint-config-prettier": "^8.2.0",
+		"eslint-config-xo": "^0.36.0",
+		"eslint-config-xo-typescript": "^0.39.0",
 		"eslint-formatter-pretty": "^4.0.0",
 		"eslint-import-resolver-webpack": "^0.13.0",
-		"eslint-plugin-ava": "^11.0.0",
+		"eslint-plugin-ava": "^12.0.0",
 		"eslint-plugin-eslint-comments": "^3.2.0",
 		"eslint-plugin-import": "^2.22.1",
 		"eslint-plugin-no-use-extend-native": "^0.5.0",
 		"eslint-plugin-node": "^11.1.0",
-		"eslint-plugin-prettier": "^3.3.1",
-		"eslint-plugin-promise": "^4.3.1",
-		"eslint-plugin-unicorn": "^28.0.2",
+		"eslint-plugin-prettier": "^3.4.0",
+		"eslint-plugin-promise": "^5.1.0",
+		"eslint-plugin-unicorn": "^30.0.0",
 		"find-cache-dir": "^3.3.1",
 		"find-up": "^5.0.0",
 		"fs-extra": "^9.1.0",
@@ -77,28 +77,28 @@
 		"globby": "^9.2.0",
 		"has-flag": "^4.0.0",
 		"imurmurhash": "^0.1.4",
-		"is-path-inside": "^3.0.2",
+		"is-path-inside": "^3.0.3",
 		"json-stable-stringify-without-jsonify": "^1.0.1",
 		"json5": "^2.2.0",
-		"lodash": "^4.17.20",
+		"lodash": "^4.17.21",
 		"meow": "^9.0.0",
-		"micromatch": "^4.0.2",
+		"micromatch": "^4.0.4",
 		"open-editor": "^3.0.0",
 		"p-reduce": "^2.1.0",
 		"path-exists": "^4.0.0",
 		"prettier": "^2.2.1",
 		"resolve-cwd": "^3.0.0",
 		"resolve-from": "^5.0.0",
-		"semver": "^7.3.4",
+		"semver": "^7.3.5",
 		"slash": "^3.0.0",
 		"to-absolute-glob": "^2.0.2",
-		"typescript": "^4.1.5",
+		"typescript": "^4.2.4",
 		"update-notifier": "^5.1.0"
 	},
 	"devDependencies": {
 		"ava": "^3.15.0",
-		"eslint-config-xo-react": "^0.23.0",
-		"eslint-plugin-react": "^7.22.0",
+		"eslint-config-xo-react": "^0.25.0",
+		"eslint-plugin-react": "^7.23.2",
 		"eslint-plugin-react-hooks": "^4.2.0",
 		"esm": "^3.2.25",
 		"execa": "^5.0.0",
@@ -106,7 +106,7 @@
 		"pify": "^5.0.0",
 		"proxyquire": "^2.1.3",
 		"temp-write": "^4.0.0",
-		"webpack": "^5.23.0"
+		"webpack": "^5.34.0"
 	},
 	"eslintConfig": {
 		"extends": "eslint-config-xo",

package/readme.md

@@ -6,7 +6,7 @@
 	<br>
 </h1>
 
-> JavaScript/TypeScript linter with great defaults
+> JavaScript/TypeScript linter (ESLint wrapper) with great defaults
 
 [![Coverage Status](https://codecov.io/gh/xojs/xo/branch/main/graph/badge.svg)](https://codecov.io/gh/xojs/xo/branch/main)
 [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
@@ -68,10 +68,10 @@ $ xo --help
     --open            Open files with issues in your editor
     --quiet           Show only errors and no warnings
     --extension       Additional extension to lint [Can be set multiple times]
-    --no-esnext       Don't enforce ES2015+ rules
     --cwd=<dir>       Working directory for files
     --stdin           Validate/fix code from stdin
     --stdin-filename  Specify a filename for the --stdin option
+    --print-config    Print the ESLint configuration for the given file
 
   Examples
     $ xo
@@ -82,6 +82,7 @@ $ xo --help
     $ xo --plugin=react
     $ xo --plugin=html --extension=html
     $ echo 'const x=true' | xo --stdin --fix
+    $ xo --print-config=index.js
 
   Tips
     - Add XO to your project with `npm init xo`.
@@ -267,15 +268,6 @@ Type: `string`
 
 [ESLint processor.](https://eslint.org/docs/user-guide/configuring#specifying-processor)
 
-### esnext
-
-Type: `boolean`\
-Default: `true`
-
-Enforce ES2015+ rules. Disabling this will make it not *enforce* ES2015+ syntax and conventions.
-
-*ES2015+ is parsed even without this option. You can already use ES2017 features like [`async`/`await`](https://github.com/lukehoban/ecmascript-asyncawait).
-
 ### webpack
 
 Type: `boolean | object`
@@ -317,12 +309,11 @@ XO makes it easy to override configs for specific files. The `overrides` propert
 		"overrides": [
 			{
 				"files": "test/*.js",
-				"esnext": false,
 				"space": 3
 			},
 			{
 				 "files": "test/foo.js",
-				 "esnext": true
+				 "semicolon": true
 			}
 		]
 	}
@@ -331,11 +322,10 @@ XO makes it easy to override configs for specific files. The `overrides` propert
 
 - The base configuration is simply `space: 2`, `semicolon: false`. These settings are used for every file unless otherwise noted below.
 
-- For every file in `test/*.js`, the base config is used, but `space` is overridden with `3`, and the `esnext` option is set to `false`. The resulting config is:
+- For every file in `test/*.js`, the base config is used, but `space` is overridden with `3`. The resulting config is:
 
 ```json
 {
-	"esnext": false,
 	"semicolon": false,
 	"space": 3
 }
@@ -345,8 +335,7 @@ XO makes it easy to override configs for specific files. The `overrides` propert
 
 ```json
 {
-	"esnext": true,
-	"semicolon": false,
+	"semicolon": true,
 	"space": 3
 }
 ```