eslint-config-arklint 1.0.0

package/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 3
+insert_final_newline = false
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Arkellys
+
+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/README.md

@@ -0,0 +1,38 @@
+# eslint-config-arklint
+My personal ESLint configuration. Most of it is based on [eslint-config-react-app](https://github.com/facebook/create-react-app/blob/0a827f69ab0d2ee3871ba9b71350031d8a81b7ae/packages/eslint-config-react-app/README.md) but with additional stylistic and JSDoc rules.
+
+---
+
+## Installation
+
+```shell
+yarn add eslint-config-arklint -D
+```
+ESLint and all the plugins used in the config are dependencies, so no need to install them. I'm aware that ESLint is supposed to be in the `peerDependencies`, but since I'm maintaining my own package, I'd rather have everything in one place for when I update the versions.
+
+## Usage
+
+Add the extend in your `.eslintrc.js`:
+
+```javascript
+module.exports = {
+  extends: "arklint",
+  rules: {
+    // Rule overrides
+  }
+}
+```
+
+The default configuration includes the extensions for `import` and `jsdoc`. The configuration for `react` has to be added manually:
+
+```javascript
+module.exports = {
+  extends: [
+    "arklint",
+    "arklint/extensions/react"
+  ],
+  rules: {
+    // Rule overrides
+  }
+}
+```

package/extensions/import.js

@@ -0,0 +1,26 @@
+module.exports = {
+	parserOptions: {
+		sourceType: "module"
+	},
+	plugins: [
+		"import",
+		"sort-imports-es6-autofix"
+	],
+	rules: {
+		"sort-imports-es6-autofix/sort-imports-es6": ["warn", {
+			ignoreCase: true,
+			memberSyntaxSortOrder: ["all", "multiple", "single", "none"]
+		}],
+		"import/no-anonymous-default-export": "off",
+		"import/newline-after-import": ["warn", { count: 2, considerComments: true }],
+		"import/order": ["warn", {
+			"newlines-between": "always",
+			"groups": [["type", "unknown", "builtin"], "external", ["internal", "parent", "index", "sibling"]],
+			"warnOnUnassignedImports": true,
+			"pathGroupsExcludedImportTypes": ["prop-types"]
+		}],
+		"import/first": "error",
+		"import/no-amd": "error",
+		"import/no-webpack-loader-syntax": "error"
+	}
+};

package/extensions/jsdoc.js

@@ -0,0 +1,65 @@
+module.exports = {
+	plugins: [
+		"jsdoc"
+	],
+	extends: [
+		"plugin:jsdoc/recommended"
+	],
+	rules: {
+		"jsdoc/require-returns": "off",
+		"jsdoc/require-jsdoc": "off",
+		"jsdoc/check-param-names": "warn",
+		"jsdoc/check-indentation": "warn",
+		"jsdoc/no-bad-blocks": "warn",
+		"jsdoc/tag-lines": ["warn", "never"],
+		"jsdoc/no-defaults": "off",
+		"jsdoc/require-hyphen-before-param-description": ["warn", "always", {
+			tags: {
+				property: "always",
+				return: "never"
+			}
+		}],
+		"jsdoc/check-line-alignment": ["warn", "never"],
+		"jsdoc/match-name": ["warn", {
+			match: [{
+				allowName: "/^([A-Z][a-z]+)+$/",
+				message: "The name should be written in PascalCase.",
+				tags: ["callback", "typedef"]
+			}]
+		}],
+		"jsdoc/match-description": ["warn", {
+			contexts: ["any"],
+			mainDescription: {
+				message: "The main description should be written in the third person, begin with a capital letter and end with a period.",
+				match: "/^[A-Z][.^\\w]*s\\b.*\\.$/us"
+			},
+			matchDescription: "[A-Z].*|^\\w+([-]*\\w)*( \\| \\w+([-]*\\w)*)*$",
+			tags: {
+				param: {
+					message: "@param description should begin with a capital letter or be a list of options separated by pipes.",
+					match: true
+				},
+				property: {
+					message: "@property description should begin with a capital letter or be a list of options separated by pipes.",
+					match: true
+				},
+				returns: {
+					message: "@returns description should begin with a capital letter.",
+					match: "[A-Z].*"
+				}
+			}
+		}]
+	},
+	settings: {
+		jsdoc: {
+			maxLines: 2,
+			mode: "typescript",
+			preferredTypes: {
+				"object.<>": false,
+				"Object": "object",
+				"<>": ".<>",
+				"*": "any"
+			}
+		}
+	}
+};

package/extensions/react.js

@@ -0,0 +1,68 @@
+module.exports = {
+	parserOptions: {
+		ecmaFeatures: {
+			jsx: true
+		}
+	},
+	settings: {
+		react: {
+			version: "detect"
+		}
+	},
+	plugins: [
+		"react",
+		"react-hooks",
+		"jsx-a11y"
+	],
+	extends: [
+		"plugin:react/recommended",
+		"plugin:react/jsx-runtime"
+	],
+	rules: {
+		"react/no-typos": "error",
+		"react/prop-types": ["warn", { ignore: ["t"] }],
+		"react/display-name": "warn",
+		"react/jsx-fragments": ["warn", "element"],
+		"react/jsx-key": "warn",
+		"react/jsx-first-prop-new-line": ["warn", "multiline"],
+		"react/jsx-max-props-per-line": ["warn", { maximum: { single: 3, multi: 1 } }],
+		"react/jsx-wrap-multilines": "warn",
+		"react/jsx-boolean-value": ["warn", "never"],
+		"react/jsx-closing-bracket-location": "warn",
+		"react/jsx-no-duplicate-props": "warn",
+		"react/jsx-curly-brace-presence": "warn",
+		"react/jsx-uses-vars": "warn",
+		"react/jsx-uses-react": "warn",
+		"react/forbid-foreign-prop-types": ["warn", { allowInPropTypes: true }],
+		"react/jsx-no-comment-textnodes": "warn",
+		"react-hooks/exhaustive-deps": "warn",
+		"react/jsx-no-target-blank": "warn",
+		"react/jsx-no-undef": "error",
+		"react/jsx-pascal-case": "warn",
+		"react/no-danger-with-children": "warn",
+		"react/no-direct-mutation-state": "warn",
+		"react/no-is-mounted": "warn",
+		"react/require-render-return": "error",
+		"react-hooks/rules-of-hooks": "error",
+		"react/style-prop-object": "warn",
+		"jsx-a11y/alt-text": "warn",
+		"jsx-a11y/anchor-has-content": "warn",
+		"jsx-a11y/anchor-is-valid": ["warn", {
+			aspects: ["noHref", "invalidHref"]
+		}],
+		"jsx-a11y/aria-activedescendant-has-tabindex": "warn",
+		"jsx-a11y/aria-props": "warn",
+		"jsx-a11y/aria-proptypes": "warn",
+		"jsx-a11y/aria-role": ["warn", { ignoreNonDOM: true }],
+		"jsx-a11y/aria-unsupported-elements": "warn",
+		"jsx-a11y/heading-has-content": "warn",
+		"jsx-a11y/iframe-has-title": "warn",
+		"jsx-a11y/img-redundant-alt": "warn",
+		"jsx-a11y/no-access-key": "warn",
+		"jsx-a11y/no-distracting-elements": "warn",
+		"jsx-a11y/no-redundant-roles": "warn",
+		"jsx-a11y/role-has-required-aria-props": "warn",
+		"jsx-a11y/role-supports-aria-props": "warn",
+		"jsx-a11y/scope": "warn"
+	}
+};

package/index.js

@@ -0,0 +1,135 @@
+const restrictedGlobals = require("confusing-browser-globals");
+
+
+module.exports = {
+	env: {
+		browser: true,
+		commonjs: true,
+		es6: true,
+		node: true
+	},
+	parserOptions: {
+		ecmaVersion: 2023
+	},
+	ignorePatterns: ["node_modules/"],
+	extends: [
+		"eslint:recommended",
+		"./extensions/import.js",
+		"./extensions/jsdoc.js"
+	],
+	rules: {
+		"quotes": ["warn", "double"],
+		"semi": "warn",
+		"camelcase": "warn",
+		"no-multi-spaces": "warn",
+		"array-bracket-spacing": "warn",
+		"object-curly-spacing": ["warn", "always"],
+		"space-infix-ops": "warn",
+		"space-in-parens": "warn",
+		"spaced-comment": ["warn", "always"],
+		"comma-spacing": "warn",
+		"comma-dangle": ["warn", "never"],
+		"prefer-arrow-callback": "warn",
+		"quote-props": ["warn", "consistent-as-needed"],
+		"nonblock-statement-body-position": "warn",
+		"arrow-body-style": "warn",
+		"dot-notation": "warn",
+		"no-var": "warn",
+		"indent": ["warn", "tab", { SwitchCase: 1, ignoreComments: true }],
+		"no-duplicate-imports": "warn",
+		"no-multiple-empty-lines": ["warn", { max: 2, maxBOF: 0, maxEOF: 0 }],
+		"no-restricted-globals": ["error"].concat(restrictedGlobals),
+		"array-callback-return": "warn",
+		"default-case": ["warn", { commentPattern: "^no default$" }],
+		"dot-location": ["warn", "property"],
+		"eqeqeq": ["warn", "smart"],
+		"new-parens": "warn",
+		"no-array-constructor": "warn",
+		"no-caller": "warn",
+		"no-case-declarations": "off",
+		"no-cond-assign": ["warn", "except-parens"],
+		"no-const-assign": "warn",
+		"no-control-regex": "warn",
+		"no-delete-var": "warn",
+		"no-dupe-args": "warn",
+		"no-dupe-class-members": "warn",
+		"no-dupe-keys": "warn",
+		"no-duplicate-case": "warn",
+		"no-empty-character-class": "warn",
+		"no-empty-pattern": "warn",
+		"no-async-promise-executor": "off",
+		"no-eval": "warn",
+		"no-ex-assign": "warn",
+		"no-extend-native": "warn",
+		"no-extra-bind": "warn",
+		"no-extra-label": "warn",
+		"no-extra-semi": "off",
+		"no-fallthrough": "warn",
+		"no-func-assign": "warn",
+		"no-implied-eval": "warn",
+		"no-invalid-regexp": "warn",
+		"no-iterator": "warn",
+		"no-label-var": "warn",
+		"no-labels": ["warn", { allowLoop: true, allowSwitch: false }],
+		"no-lone-blocks": "warn",
+		"no-loop-func": "warn",
+		"no-mixed-operators": "warn",
+		"no-multi-str": "warn",
+		"no-global-assign": "warn",
+		"no-unsafe-negation": "warn",
+		"no-new-func": "warn",
+		"no-new-object": "warn",
+		"no-new-symbol": "warn",
+		"no-new-wrappers": "warn",
+		"no-obj-calls": "warn",
+		"no-octal": "warn",
+		"no-octal-escape": "warn",
+		"no-redeclare": "warn",
+		"no-regex-spaces": "warn",
+		"no-restricted-syntax": ["warn", "WithStatement"],
+		"no-script-url": "warn",
+		"no-self-assign": "warn",
+		"no-self-compare": "warn",
+		"no-sequences": "warn",
+		"no-shadow-restricted-names": "warn",
+		"no-sparse-arrays": "warn",
+		"no-template-curly-in-string": "warn",
+		"no-this-before-super": "warn",
+		"no-throw-literal": "warn",
+		"no-undef": "error",
+		"no-unreachable": "warn",
+		"no-unused-expressions": ["error", {
+			allowShortCircuit: true,
+			allowTernary: true,
+			allowTaggedTemplates: true
+		}],
+		"no-unused-labels": "warn",
+		"no-unused-vars": ["warn", {
+			args: "none",
+			ignoreRestSiblings: true
+		}],
+		"no-use-before-define": ["warn", {
+			functions: false,
+			classes: false,
+			variables: false
+		}],
+		"no-useless-computed-key": "warn",
+		"no-useless-concat": "warn",
+		"no-useless-constructor": "warn",
+		"no-useless-escape": "warn",
+		"no-useless-rename": ["warn", {
+			ignoreDestructuring: false,
+			ignoreImport: false,
+			ignoreExport: false
+		}],
+		"no-with": "warn",
+		"no-whitespace-before-property": "warn",
+		"require-yield": "warn",
+		"rest-spread-spacing": ["warn", "never"],
+		"strict": ["warn", "never"],
+		"unicode-bom": ["warn", "never"],
+		"use-isnan": "warn",
+		"valid-typeof": "warn",
+		"getter-return": "warn"
+	}
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "eslint-config-arklint",
+  "version": "1.0.0",
+  "author": "Arkellys",
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Arkellys/eslint-config-arklint.git"
+  },
+  "homepage": "https://github.com/Arkellys/eslint-config-arklint#readme",
+  "dependencies": {
+    "confusing-browser-globals": "^1.0.11",
+    "eslint": "^8.46.0",
+    "eslint-plugin-import": "^2.28.0",
+    "eslint-plugin-jsdoc": "^46.4.6",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-react": "^7.33.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-sort-imports-es6-autofix": "^0.6.0"
+  },
+  "eslintConfig": {
+    "extends": "./index.js"
+  }
+}