eslint-config-xo 0.39.0

package/browser.js

@@ -0,0 +1,17 @@
+'use strict';
+const path = require('path');
+const confusingBrowserGlobals = require('confusing-browser-globals');
+
+module.exports = {
+	extends: path.join(__dirname, 'index.js'),
+	env: {
+		node: false,
+		browser: true
+	},
+	rules: {
+		'no-restricted-globals': [
+			'error',
+			...confusingBrowserGlobals
+		]
+	}
+};

package/index.js

@@ -0,0 +1,595 @@
+'use strict';
+
+module.exports = {
+	parserOptions: {
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+		ecmaFeatures: {
+			jsx: true
+		}
+	},
+	env: {
+		es2021: true,
+		node: true
+	},
+	reportUnusedDisableDirectives: true,
+	rules: {
+		'comma-dangle': [
+			'error',
+			'always-multiline'
+		],
+		'for-direction': 'error',
+		'getter-return': 'error',
+		'no-async-promise-executor': 'error',
+		'no-await-in-loop': 'error',
+		'no-compare-neg-zero': 'error',
+		'no-cond-assign': 'error',
+		'no-constant-condition': 'error',
+		'no-control-regex': 'error',
+		'no-debugger': 'error',
+		'no-dupe-args': 'error',
+		'no-dupe-else-if': 'error',
+		'no-dupe-keys': 'error',
+		'no-duplicate-case': 'error',
+		'no-empty-character-class': 'error',
+		'no-empty': [
+			'error',
+			{
+				allowEmptyCatch: true
+			}
+		],
+		'no-ex-assign': 'error',
+		'no-extra-boolean-cast': 'error',
+		// Disabled because of https://github.com/eslint/eslint/issues/6028
+		// 'no-extra-parens': [
+		// 	'error',
+		// 	'all',
+		// 	{
+		// 		conditionalAssign: false,
+		// 		nestedBinaryExpressions: false,
+		// 		ignoreJSX: 'multi-line'
+		// 	}
+		// ],
+		'no-extra-semi': 'error',
+		'no-func-assign': 'error',
+		'no-import-assign': 'error',
+		'no-inner-declarations': 'error',
+		'no-invalid-regexp': 'error',
+		'no-irregular-whitespace': 'error',
+		'no-loss-of-precision': 'error',
+		'no-misleading-character-class': 'error',
+		'no-obj-calls': 'error',
+		'no-promise-executor-return': 'error',
+		'no-prototype-builtins': 'error',
+		'no-regex-spaces': 'error',
+		'no-setter-return': 'error',
+		'no-sparse-arrays': 'error',
+		'no-template-curly-in-string': 'error',
+		'no-unreachable': 'error',
+		'no-unreachable-loop': 'error',
+		'no-unsafe-finally': 'error',
+		'no-unsafe-negation': [
+			'error',
+			{
+				enforceForOrderingRelations: true
+			}
+		],
+		'no-unsafe-optional-chaining': [
+			'error',
+			{
+				disallowArithmeticOperators: true
+			}
+		],
+		'no-useless-backreference': 'error',
+		'use-isnan': 'error',
+		'valid-typeof': [
+			'error',
+			{
+				requireStringLiterals: false
+			}
+		],
+		'no-unexpected-multiline': 'error',
+		'accessor-pairs': [
+			'error',
+			{
+				enforceForClassMembers: true
+			}
+		],
+		'array-callback-return': [
+			'error',
+			{
+				allowImplicit: true
+			}
+		],
+		'block-scoped-var': 'error',
+		complexity: 'warn',
+		curly: 'error',
+		'default-case': 'error',
+		'default-case-last': 'error',
+		'default-param-last': 'error',
+		'dot-notation': 'error',
+		'dot-location': [
+			'error',
+			'property'
+		],
+		eqeqeq: 'error',
+		'grouped-accessor-pairs': [
+			'error',
+			'getBeforeSet'
+		],
+		'guard-for-in': 'error',
+		'no-alert': 'error',
+		'no-caller': 'error',
+		'no-case-declarations': 'error',
+		'no-constructor-return': 'error',
+		'no-else-return': [
+			'error',
+			{
+				allowElseIf: false
+			}
+		],
+		'no-empty-pattern': 'error',
+		'no-eq-null': 'error',
+		'no-eval': 'error',
+		'no-extend-native': 'error',
+		'no-extra-bind': 'error',
+		'no-extra-label': 'error',
+		'no-fallthrough': 'error',
+		'no-floating-decimal': 'error',
+		'no-global-assign': 'error',
+		'no-implicit-coercion': 'error',
+		'no-implicit-globals': 'error',
+		'no-implied-eval': 'error',
+		'no-iterator': 'error',
+		'no-labels': 'error',
+		'no-lone-blocks': 'error',
+		'no-multi-spaces': 'error',
+		'no-multi-str': 'error',
+		'no-new-func': 'error',
+		'no-new-wrappers': 'error',
+		'no-nonoctal-decimal-escape': 'error',
+		'no-new': 'error',
+		'no-octal-escape': 'error',
+		'no-octal': 'error',
+		'no-proto': 'error',
+		'no-redeclare': 'error',
+		'no-return-assign': [
+			'error',
+			'always'
+		],
+		'no-return-await': 'error',
+		'no-script-url': 'error',
+		'no-self-assign': [
+			'error',
+			{
+				props: true
+			}
+		],
+		'no-self-compare': 'error',
+		'no-sequences': 'error',
+		'no-throw-literal': 'error',
+		'no-unmodified-loop-condition': 'error',
+		'no-unused-expressions': [
+			'error',
+			{
+				enforceForJSX: true
+			}
+		],
+		'no-unused-labels': 'error',
+		'no-useless-call': 'error',
+		'no-useless-catch': 'error',
+		'no-useless-concat': 'error',
+		'no-useless-escape': 'error',
+		'no-useless-return': 'error',
+		'no-void': 'error',
+		'no-warning-comments': 'warn',
+		'no-with': 'error',
+
+		// Disabled for now as Firefox doesn't support named capture groups and I'm tired of getting issues about the use of named capture groups...
+		// 'prefer-named-capture-group': 'error'
+
+		'prefer-promise-reject-errors': [
+			'error',
+			{
+				allowEmptyReject: true
+			}
+		],
+		'prefer-regex-literals': 'error',
+		radix: 'error',
+
+		// Disabled for now as it causes too much churn
+		// TODO: Enable it in the future when I have time to deal with
+		// the churn and the rule is stable and has an autofixer.
+		// Still doesn't have a fixer as of ESLint 7.24.0.
+		// 'require-unicode-regexp': 'error',
+
+		'wrap-iife': [
+			'error',
+			'inside',
+			{
+				functionPrototypeMethods: true
+			}
+		],
+		yoda: 'error',
+		'no-delete-var': 'error',
+		'no-label-var': 'error',
+		'no-restricted-globals': [
+			'error',
+			'event'
+		],
+		'no-shadow-restricted-names': 'error',
+		'no-undef-init': 'error',
+		'no-undef': [
+			'error',
+			{
+				typeof: true
+			}
+		],
+		'no-unused-vars': [
+			'error',
+			{
+				vars: 'all',
+				args: 'after-used',
+				ignoreRestSiblings: true,
+				argsIgnorePattern: /^_/.source,
+				caughtErrors: 'all',
+				caughtErrorsIgnorePattern: /^_$/.source
+			}
+		],
+		'no-buffer-constructor': 'error',
+		'no-restricted-imports': [
+			'error',
+			'domain',
+			'freelist',
+			'smalloc',
+			'punycode',
+			'sys',
+			'querystring',
+			'colors'
+		],
+		'array-bracket-newline': [
+			'error',
+			'consistent'
+		],
+		'array-bracket-spacing': [
+			'error',
+			'never'
+		],
+		'array-element-newline': [
+			'error',
+			'consistent'
+		],
+		'brace-style': [
+			'error',
+			'1tbs',
+			{
+				allowSingleLine: false
+			}
+		],
+		camelcase: [
+			'error',
+			{
+				properties: 'always'
+			}
+		],
+		'capitalized-comments': [
+			'error',
+			'always',
+			{
+				// You can also ignore this rule by wrapping the first word in quotes.
+				// c8 => https://github.com/bcoe/c8
+				ignorePattern: /pragma|ignore|prettier-ignore|webpack\w+:|c8/.source,
+				ignoreInlineComments: true,
+				ignoreConsecutiveComments: true
+			}
+		],
+		'comma-spacing': [
+			'error',
+			{
+				before: false,
+				after: true
+			}
+		],
+		'comma-style': [
+			'error',
+			'last'
+		],
+		'computed-property-spacing': [
+			'error',
+			'never',
+			{
+				enforceForClassMembers: true
+			}
+		],
+		'eol-last': 'error',
+		'func-call-spacing': [
+			'error',
+			'never'
+		],
+		'func-name-matching': [
+			'error',
+			{
+				considerPropertyDescriptor: true
+			}
+		],
+		'func-names': [
+			'error',
+			'never'
+		],
+		'function-call-argument-newline': [
+			'error',
+			'consistent'
+		],
+		indent: [
+			'error',
+			'tab',
+			{
+				SwitchCase: 1
+			}
+		],
+		'jsx-quotes': 'error',
+		'key-spacing': [
+			'error',
+			{
+				beforeColon: false,
+				afterColon: true
+			}
+		],
+		'keyword-spacing': 'error',
+		'linebreak-style': [
+			process.platform === 'win32' ? 'off' : 'error',
+			'unix'
+		],
+		'lines-between-class-members': [
+			'error',
+			'always',
+			{
+				// Workaround to allow class fields to not have lines between them.
+				// TODO: Get ESLint to add an option to ignore class fields.
+				exceptAfterSingleLine: true
+			}
+		],
+		'max-depth': 'warn',
+		'max-nested-callbacks': [
+			'warn',
+			4
+		],
+		'max-params': [
+			'warn',
+			{
+				max: 4
+			}
+		],
+		'max-statements-per-line': 'error',
+		'new-cap': [
+			'error',
+			{
+				newIsCap: true,
+				capIsNew: true
+			}
+		],
+		'new-parens': 'error',
+		'no-array-constructor': 'error',
+		'no-bitwise': 'error',
+		'no-lonely-if': 'error',
+		'no-mixed-operators': 'error',
+		'no-mixed-spaces-and-tabs': 'error',
+		'no-multi-assign': 'error',
+		'no-multiple-empty-lines': [
+			'error',
+			{
+				max: 1
+			}
+		],
+		'no-negated-condition': 'error',
+		'no-new-object': 'error',
+		'no-whitespace-before-property': 'error',
+		'no-trailing-spaces': 'error',
+		'no-unneeded-ternary': 'error',
+		'object-curly-spacing': [
+			'error',
+			'never'
+		],
+		// Disabled because of https://github.com/xojs/eslint-config-xo/issues/27
+		// 'object-property-newline': 'error',
+		'one-var': [
+			'error',
+			'never'
+		],
+		'one-var-declaration-per-line': 'error',
+		'operator-assignment': [
+			'error',
+			'always'
+		],
+		'operator-linebreak': [
+			'error',
+			'before'
+		],
+		'padded-blocks': [
+			'error',
+			'never',
+			{
+				allowSingleLineBlocks: false
+			}
+		],
+		'padding-line-between-statements': [
+			'error',
+			{
+				blankLine: 'always',
+				prev: 'multiline-block-like',
+				next: '*'
+			}
+		],
+		'prefer-exponentiation-operator': 'error',
+		'prefer-object-spread': 'error',
+		'quote-props': [
+			'error',
+			'as-needed'
+		],
+		quotes: [
+			'error',
+			'single'
+		],
+		'semi-spacing': [
+			'error',
+			{
+				before: false,
+				after: true
+			}
+		],
+		'semi-style': [
+			'error',
+			'last'
+		],
+		semi: [
+			'error',
+			'always'
+		],
+		'space-before-blocks': [
+			'error',
+			'always'
+		],
+		'space-before-function-paren': [
+			'error',
+			{
+				anonymous: 'always',
+				named: 'never',
+				asyncArrow: 'always'
+			}
+		],
+		'space-in-parens': [
+			'error',
+			'never'
+		],
+		'space-infix-ops': 'error',
+		'space-unary-ops': 'error',
+		'spaced-comment': [
+			'error',
+			'always',
+			{
+				line: {
+					exceptions: [
+						'-',
+						'+',
+						'*'
+					],
+					markers: [
+						'!',
+						'/',
+						'=>'
+					]
+				},
+				block: {
+					exceptions: [
+						'-',
+						'+',
+						'*'
+					],
+					markers: [
+						'!',
+						'*'
+					],
+					balanced: true
+				}
+			}
+		],
+		'switch-colon-spacing': [
+			'error',
+			{
+				after: true,
+				before: false
+			}
+		],
+		'template-tag-spacing': [
+			'error',
+			'never'
+		],
+		'unicode-bom': [
+			'error',
+			'never'
+		],
+		'arrow-body-style': 'error',
+		'arrow-parens': [
+			'error',
+			'as-needed'
+		],
+		'arrow-spacing': [
+			'error',
+			{
+				before: true,
+				after: true
+			}
+		],
+		'constructor-super': 'error',
+		'generator-star-spacing': [
+			'error',
+			'both'
+		],
+		'no-class-assign': 'error',
+		'no-const-assign': 'error',
+		'no-dupe-class-members': 'error',
+		'no-new-symbol': 'error',
+		'no-this-before-super': 'error',
+		'no-useless-computed-key': [
+			'error',
+			{
+				enforceForClassMembers: true
+			}
+		],
+		'no-useless-constructor': 'error',
+		'no-useless-rename': 'error',
+		'no-var': 'error',
+		'object-shorthand': [
+			'error',
+			'always'
+		],
+		'prefer-arrow-callback': [
+			'error',
+			{
+				allowNamedFunctions: true
+			}
+		],
+		'prefer-const': [
+			'error',
+			{
+				destructuring: 'all'
+			}
+		],
+		'prefer-destructuring': [
+			'error',
+			{
+				// `array` is disabled because it forces destructuring on
+				// stupid stuff like `foo.bar = process.argv[2];`
+				// TODO: Open ESLint issue about this
+				VariableDeclarator: {
+					array: false,
+					object: true
+				},
+				AssignmentExpression: {
+					array: false,
+
+					// Disabled because object assignment destructuring requires parens wrapping:
+					// `let foo; ({foo} = object);`
+					object: false
+				}
+			},
+			{
+				enforceForRenamedProperties: false
+			}
+		],
+		'prefer-numeric-literals': 'error',
+		'prefer-rest-params': 'error',
+		'prefer-spread': 'error',
+		'require-yield': 'error',
+		'rest-spread-spacing': [
+			'error',
+			'never'
+		],
+		'symbol-description': 'error',
+		'template-curly-spacing': 'error',
+		'yield-star-spacing': [
+			'error',
+			'both'
+		]
+	}
+};

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,63 @@
+{
+	"name": "eslint-config-xo",
+	"version": "0.39.0",
+	"description": "ESLint shareable config for XO",
+	"license": "MIT",
+	"repository": "xojs/eslint-config-xo",
+	"funding": "https://github.com/sponsors/sindresorhus",
+	"author": {
+		"name": "Sindre Sorhus",
+		"email": "sindresorhus@gmail.com",
+		"url": "https://sindresorhus.com"
+	},
+	"engines": {
+		"node": ">=10"
+	},
+	"scripts": {
+		"test": "ava"
+	},
+	"files": [
+		"index.js",
+		"browser.js"
+	],
+	"keywords": [
+		"eslintconfig",
+		"xo",
+		"xoxo",
+		"hugs",
+		"kisses",
+		"happy",
+		"happiness",
+		"code",
+		"quality",
+		"style",
+		"lint",
+		"linter",
+		"jscs",
+		"jshint",
+		"jslint",
+		"eslint",
+		"validate",
+		"code style",
+		"standard",
+		"strict",
+		"check",
+		"checker",
+		"verify",
+		"enforce",
+		"hint",
+		"simple"
+	],
+	"dependencies": {
+		"confusing-browser-globals": "1.0.10"
+	},
+	"devDependencies": {
+		"ava": "^2.4.0",
+		"eslint": "^7.20.0",
+		"is-plain-obj": "^3.0.0",
+		"temp-write": "^4.0.0"
+	},
+	"peerDependencies": {
+		"eslint": ">=7.20.0"
+	}
+}

package/readme.md

@@ -0,0 +1,70 @@
+# eslint-config-xo
+
+> ESLint [shareable config](https://eslint.org/docs/developer-guide/shareable-configs.html) for [XO](https://github.com/xojs/xo)
+
+This is for advanced users. [You probably want to use XO directly.](#use-the-xo-cli-instead)
+
+See [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) for some additional useful rules.
+
+**Use the [XO issue tracker](https://github.com/xojs/xo/issues) instead of this one.**
+
+## Install
+
+```
+$ npm install --save-dev eslint-config-xo
+```
+
+## Usage
+
+Add some ESLint config to your `package.json`:
+
+```json
+{
+	"name": "my-awesome-project",
+	"eslintConfig": {
+		"extends": "xo"
+	}
+}
+```
+
+Or to `.eslintrc`:
+
+```json
+{
+	"extends": "xo"
+}
+```
+
+Supports parsing ES2015+, but doesn't enforce it by default.
+
+This package also exposes [`xo/browser`](browser.js) if you're in the browser:
+
+```json
+{
+	"extends": "xo/browser"
+}
+```
+
+## Use the XO CLI instead
+
+XO is an ESLint wrapper with great defaults.
+
+Here are some reason why you should use the [XO CLI](https://github.com/xojs/xo) instead of this config:
+
+- XO comes bundled with this config.
+- [Beautiful output.](https://github.com/sindresorhus/eslint-formatter-pretty)
+- Bundles many useful plugins, like [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn), [`eslint-plugin-import`](https://github.com/benmosher/eslint-plugin-import), [`eslint-plugin-ava`](https://github.com/avajs/eslint-plugin-ava), and more.
+- No need to specify file paths to lint. It will lint all JS files except [commonly ignored paths](https://github.com/xojs/xo#ignores).
+- Super simple to add XO to a project with [`$ npm init xo`](https://github.com/xojs/create-xo).
+- Specify `indent` and `semicolon` preferences easily without messing with the rule config.
+- Config/rule overrides per files/globs.
+- Can open all files with errors at the correct line in your editor. *(See the `--open` flag)*
+- The [editor plugins](https://github.com/xojs/xo#editor-plugins) are IMHO better than the ESLint ones. *(Subjective)*
+
+tl;dr You miss out on a lot by just using this config.
+
+## Related
+
+- [eslint-config-xo-space](https://github.com/xojs/eslint-config-xo-space) - ESLint shareable config for XO with 2-space indent
+- [eslint-config-xo-react](https://github.com/xojs/eslint-config-xo-react) - ESLint shareable config for React to be used with this config
+- [eslint-config-xo-typescript](https://github.com/xojs/eslint-config-xo-typescript) - ESLint shareable config for TypeScript to be used with this config