@pumpn/eslint-config 10.4.2 → 11.0.2

package/config.js

@@ -0,0 +1,111 @@
+import babelParser from "@babel/eslint-parser";
+import js from "@eslint/js";
+import eslintPluginImport from "eslint-plugin-import";
+import eslintPluginJsdoc from "eslint-plugin-jsdoc";
+import reactJsxRuntime from "eslint-plugin-react/configs/jsx-runtime.js";
+import reactRecommended from "eslint-plugin-react/configs/recommended.js";
+import eslintPluginSortKeysPlus from "eslint-plugin-sort-keys-plus";
+import globals from "globals";
+
+import rules from "./rules.js";
+
+const convertedGlobals = Object.fromEntries(
+	Object.entries({
+		...globals.node,
+		...globals.browser
+	})
+		.map(([global, isWritable]) => [global, isWritable ? "writable" : "readonly"])
+);
+
+export default [
+	js.configs.recommended,
+	{
+		files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
+		...reactRecommended,
+		...reactJsxRuntime
+	},
+	{
+		files: ["**/*.{js,mjs,cjs,jsx,mjsx,ts,tsx,mtsx}"],
+		languageOptions: {
+			ecmaVersion: "latest",
+			sourceType: "module",
+			globals: {
+				...convertedGlobals
+			},
+			parser: babelParser,
+			parserOptions: {
+				ecmaVersion: "latest",
+				sourceType: "module",
+				requireConfigFile: false,
+				ecmaFeatures: {
+					jsx: true
+				},
+				babelOptions: {
+					babelrc: false,
+					configFile: false,
+					presets: ["@babel/preset-react"],
+					plugins: ["@babel/plugin-syntax-import-assertions", "@babel/plugin-proposal-export-default-from"]
+				}
+			}
+		},
+		plugins: {
+			"sort-keys-plus": eslintPluginSortKeysPlus,
+			jsdoc: eslintPluginJsdoc,
+			import: eslintPluginImport
+		},
+		settings: {
+			jsdoc: {
+				ignorePrivate: true,
+				mode: "permissive"
+			},
+			"import/core-modules": [],
+			"import/extensions": [
+				".js",
+				".mjs",
+				".jsx"
+			],
+			"import/ignore": ["node_modules", "\\.(coffee|scss|css|less|hbs|svg|json|cjs)$"],
+			"import/parsers": {
+				espree: [
+					".js",
+					".cjs",
+					".mjs",
+					".jsx"
+				]
+			},
+			"import/resolver": {
+				node: true
+			},
+			react: {
+				version: "detect"
+			},
+			formComponents: ["Form"],
+			linkComponents: [
+				{
+					name: "Link",
+					linkAttribute: "to"
+				}
+			]
+		},
+		rules
+	},
+	{
+		files: ["jsdoc-example.js"],
+		rules: {
+			"import/no-unused-modules": "off"
+		}
+	},
+	{
+		files: ["**/**.cjs"],
+		rules: {
+			"import/no-commonjs": ["off"],
+			"import/no-unused-modules": "off"
+		}
+	},
+	{
+		languageOptions: {
+			ecmaVersion: "latest",
+			sourceType: "module"
+		}
+	}
+];

package/package.json

@@ -1,32 +1,38 @@
 {
 	"name": "@pumpn/eslint-config",
-	"version": "10.4.2",
+	"version": "11.0.2",
 	"description": "standard eslint config for pumpn code projects",
-	"main": "index.cjs",
+	"main": "config.js",
 	"author": "Nano Miratus <nanomiratus@gmail.com>",
 	"license": "MIT",
 	"private": false,
 	"type": "module",
-	"peerDependencies": {
-		"eslint": "^7.32.0"
-	},
-	"dependencies": {
-		"@babel/eslint-parser": "^7.15.4",
-		"confusing-browser-globals": "^1.0.10",
-		"eslint-plugin-compat": "^3.13.0",
-		"eslint-plugin-import": "^2.24.2",
-		"eslint-plugin-jsdoc": "^36.1.0",
-		"eslint-plugin-sort-keys": "^2.3.5"
-	},
 	"repository": "https://github.com/pumpncode/eslint-config",
-	"devDependencies": {
-		"@babel/core": "^7.15.5",
-		"@pumpn/babel-preset": "^3.2.2",
-		"@pumpn/np-config": "^2.3.2",
-		"eslint": "^7.32.0"
-	},
 	"scripts": {
+		"lint": "eslint .",
+		"prepublish": "npm run lint",
 		"release": "np",
 		"test": "echo 'no tests yet'"
+	},
+	"devDependencies": {
+		"@pumpn/np-config": "^2.3.2",
+		"eslint": "^8.35.0",
+		"eslint-plugin-react": "*",
+		"np": "^7.6.3"
+	},
+	"dependencies": {
+		"@babel/eslint-parser": "^7.19.1",
+		"@babel/plugin-proposal-export-default-from": "^7.18.10",
+		"@babel/plugin-syntax-import-assertions": "^7.20.0",
+		"@babel/preset-react": "^7.18.6",
+		"@eslint/js": "^8.35.0",
+		"globals": "^13.20.0"
+	},
+	"peerDependencies": {
+		"eslint": "^8.34.0",
+		"eslint-plugin-import": "^2.27.5",
+		"eslint-plugin-jsdoc": "^40.0.0",
+		"eslint-plugin-react": "^7.32.2",
+		"eslint-plugin-sort-keys-plus": "^1.3.1"
 	}
 }

package/rules/imports.js

@@ -0,0 +1,134 @@
+const maxDependencies = 10;
+
+export default {
+	"import/default": ["error"],
+	"import/dynamic-import-chunkname": [
+		"off",
+		{
+			importFunctions: [],
+			webpackChunknameFormat: "[0-9a-zA-Z-_/.]+"
+		}
+	],
+	"import/export": ["error"],
+	"import/exports-last": ["error"],
+	"import/extensions": ["error", "ignorePackages"],
+	"import/first": ["error"],
+	"import/group-exports": ["off"],
+	"import/max-dependencies": [
+		"error",
+		{
+			max: maxDependencies
+		}
+	],
+	"import/named": ["error"],
+	"import/namespace": ["error"],
+	"import/newline-after-import": ["error"],
+	"import/no-absolute-path": ["error"],
+	"import/no-amd": ["error"],
+	"import/no-anonymous-default-export": [
+		"off",
+		{
+			allowAnonymousClass: false,
+			allowAnonymousFunction: false,
+			allowArray: false,
+			allowArrowFunction: false,
+			allowLiteral: false,
+			allowObject: false
+		}
+	],
+	"import/no-commonjs": ["error"],
+	"import/no-cycle": [
+		"error",
+		{
+			maxDepth: Infinity
+		}
+	],
+	"import/no-default-export": ["off"],
+	"import/no-deprecated": ["error"],
+	"import/no-duplicates": ["error"],
+	"import/no-dynamic-require": ["error"],
+	"import/no-extraneous-dependencies": [
+		"error",
+		{
+			devDependencies: [
+				"test/**",
+				"tests/**",
+				"spec/**",
+				"**/__tests__/**",
+				"**/__mocks__/**",
+				"test.{js,jsx}",
+				"test-*.{js,jsx}",
+				"**/*{.,_}{test,spec}.{js,jsx}",
+				"**/jest.config.js",
+				"**/jest.setup.js",
+				"**/vue.config.js",
+				"**/webpack.config.js",
+				"**/webpack.config.*.js",
+				"**/rollup.config.js",
+				"**/rollup.config.*.js",
+				"**/gulpfile.js",
+				"**/gulpfile.*.js",
+				"**/Gruntfile{,.js}",
+				"**/protractor.conf.js",
+				"**/protractor.conf.*.js",
+				"**/karma.conf.js",
+				"**/eslint.config.js"
+			],
+			optionalDependencies: false
+		}
+	],
+	"import/no-internal-modules": [
+		"off",
+		{
+			allow: []
+		}
+	],
+	"import/no-mutable-exports": ["error"],
+	"import/no-named-as-default": ["error"],
+	"import/no-named-as-default-member": ["error"],
+	"import/no-named-default": ["error"],
+	"import/no-named-export": ["off"],
+	"import/no-namespace": ["error"],
+	"import/no-nodejs-modules": ["off"],
+	"import/no-relative-parent-imports": ["off"],
+	"import/no-restricted-paths": ["off"],
+	"import/no-self-import": ["error"],
+	"import/no-unassigned-import": ["error"],
+	"import/no-unresolved": [
+		"error",
+		{
+			caseSensitive: true,
+			commonjs: true
+		}
+	],
+	"import/no-unused-modules": [
+		"off",
+		{
+			ignoreExports: ["./main.js"],
+			missingExports: true,
+			unusedExports: false
+		}
+	],
+	"import/no-useless-path-segments": [
+		"error",
+		{
+			commonjs: true
+		}
+	],
+	"import/no-webpack-loader-syntax": ["error"],
+	"import/order": [
+		"error",
+		{
+			groups: [
+				"builtin",
+				"external",
+				"parent",
+				"sibling",
+				"index"
+			],
+			"newlines-between": "always"
+		}
+	],
+	"import/prefer-default-export": ["error"],
+	"import/unambiguous": "off"
+};

package/rules/jsdoc.js

@@ -0,0 +1,79 @@
+export default {
+	"jsdoc/check-access": ["warn"],
+	"jsdoc/check-alignment": ["warn", "always"],
+	"jsdoc/check-examples": [
+		"off",
+		{
+			matchingFileName: "jsdoc-example.js"
+		}
+	],
+	"jsdoc/check-indentation": [
+		"warn",
+		{
+			excludeTags: ["description", "example"]
+		}
+	],
+	"jsdoc/check-param-names": ["warn"],
+	"jsdoc/check-property-names": ["warn"],
+	"jsdoc/check-syntax": ["warn"],
+	"jsdoc/check-tag-names": ["warn"],
+	"jsdoc/check-types": ["warn"],
+	"jsdoc/check-values": ["warn"],
+	"jsdoc/empty-tags": ["warn"],
+	"jsdoc/implements-on-classes": ["warn"],
+	"jsdoc/match-description": ["warn"],
+	"jsdoc/newline-after-description": ["warn"],
+	"jsdoc/no-bad-blocks": ["warn"],
+	"jsdoc/no-defaults": ["warn"],
+	"jsdoc/no-undefined-types": ["warn"],
+	"jsdoc/require-description": [
+		"warn",
+		{
+			contexts: [
+				"Program",
+				"ArrowFunctionExpression",
+				"FunctionDeclaration",
+				"FunctionExpression",
+				"VariableDeclaration"
+			]
+		}
+	],
+	"jsdoc/require-description-complete-sentence": ["warn"],
+	"jsdoc/require-example": ["off"],
+	"jsdoc/require-file-overview": ["off"],
+	"jsdoc/require-hyphen-before-param-description": ["warn"],
+	"jsdoc/require-jsdoc": [
+		"warn",
+		{
+			contexts: [
+				"ArrowFunctionExpression",
+				"ClassDeclaration",
+				"ClassExpression",
+				"FunctionDeclaration",
+				"FunctionExpression"
+			],
+			publicOnly: true,
+			require: {
+				ArrowFunctionExpression: true,
+				ClassDeclaration: true,
+				ClassExpression: true,
+				FunctionDeclaration: true,
+				FunctionExpression: true,
+				MethodDefinition: true
+			}
+		}
+	],
+	"jsdoc/require-param": ["warn"],
+	"jsdoc/require-param-description": ["warn"],
+	"jsdoc/require-param-name": ["warn"],
+	"jsdoc/require-param-type": ["warn"],
+	"jsdoc/require-property": ["warn"],
+	"jsdoc/require-property-description": ["warn"],
+	"jsdoc/require-property-name": ["warn"],
+	"jsdoc/require-property-type": ["warn"],
+	"jsdoc/require-returns": ["warn"],
+	"jsdoc/require-returns-check": ["warn"],
+	"jsdoc/require-returns-description": ["warn"],
+	"jsdoc/require-returns-type": ["warn"],
+	"jsdoc/valid-types": ["warn"]
+};

package/rules/layout-and-formatting.js

@@ -0,0 +1,262 @@
+const minItemsForArrayNewline = 3;
+const maxLineLength = 100;
+const tabWidth = 4;
+const maxIgnoredChainDepth = 3;
+const minPropertiesForObjectNewline = 3;
+
+export default {
+	"array-bracket-newline": [
+		"error",
+		{
+			multiline: true,
+			minItems: minItemsForArrayNewline
+		}
+	],
+	"array-bracket-spacing": ["error", "never"],
+	"array-element-newline": [
+		"error",
+		{
+			multiline: true,
+			minItems: minItemsForArrayNewline
+		}
+	],
+	"arrow-parens": ["error", "always"],
+	"arrow-spacing": [
+		"error",
+		{
+			before: true,
+			after: true
+		}
+	],
+	"block-spacing": ["error", "always"],
+	"brace-style": ["error", "stroustrup"],
+	"comma-dangle": ["error", "never"],
+	"comma-spacing": [
+		"error",
+		{
+			before: false,
+			after: true
+		}
+	],
+	"comma-style": ["error", "last"],
+	"computed-property-spacing": ["error", "never"],
+	"dot-location": ["error", "property"],
+	"eol-last": ["error", "always"],
+	"func-call-spacing": ["error", "never"],
+	"function-call-argument-newline": ["error", "consistent"],
+	"function-paren-newline": ["error", "multiline-arguments"],
+	"generator-star-spacing": [
+		"error",
+		{
+			before: false,
+			after: true
+		}
+	],
+	"implicit-arrow-linebreak": ["error", "beside"],
+	indent: [
+		"error",
+		"tab",
+		{ SwitchCase: 1 }
+	],
+	"jsx-quotes": ["error", "prefer-double"],
+	"key-spacing": [
+		"error",
+		{
+			beforeColon: false,
+			afterColon: true,
+			mode: "strict"
+		}
+	],
+	"keyword-spacing": [
+		"error",
+		{
+			before: true,
+			after: true
+		}
+	],
+	"line-comment-position": ["error", { position: "above" }],
+	"linebreak-style": ["off"],
+	"lines-around-comment": [
+		"error",
+		{
+			afterBlockComment: false,
+			afterLineComment: false,
+			allowArrayEnd: false,
+			allowArrayStart: false,
+			allowBlockEnd: false,
+			allowBlockStart: false,
+			allowClassEnd: false,
+			allowClassStart: false,
+			allowObjectEnd: false,
+			allowObjectStart: false,
+			beforeBlockComment: true,
+			beforeLineComment: false
+		}
+	],
+	"lines-between-class-members": ["error", "always"],
+	"max-len": [
+		"error",
+		{
+			code: maxLineLength,
+			tabWidth,
+			ignoreComments: false,
+			ignoreTrailingComments: false,
+			ignoreUrls: true,
+			ignoreStrings: false,
+			ignoreTemplateLiterals: true,
+			ignoreRegExpLiterals: true
+		}
+	],
+	"max-statements-per-line": ["error", { max: 1 }],
+	"multiline-ternary": ["error", "always-multiline"],
+	"new-parens": ["error", "always"],
+	"newline-per-chained-call": [
+		"error",
+		{
+			ignoreChainWithDepth: maxIgnoredChainDepth
+		}
+	],
+	"no-extra-parens": ["error", "functions"],
+	"no-multi-spaces": ["error", { exceptions: { Property: false } }],
+	"no-multiple-empty-lines": [
+		"error",
+		{
+			max: 1,
+			maxEOF: 1,
+			maxBOF: 0
+		}
+	],
+	"no-tabs": ["off"],
+	"no-trailing-spaces": [
+		"error",
+		{
+			skipBlankLines: false,
+			ignoreComments: false
+		}
+	],
+	"no-whitespace-before-property": ["error"],
+	"nonblock-statement-body-position": ["error", "beside"],
+	"object-curly-newline": [
+		"error",
+		{
+			multiline: true,
+			minProperties: minPropertiesForObjectNewline,
+			consistent: true
+		}
+	],
+	"object-curly-spacing": ["error", "always"],
+	"object-property-newline": [
+		"error",
+		{
+			allowAllPropertiesOnSameLine: false
+		}
+	],
+	"operator-linebreak": [
+		"error",
+		"after",
+		{
+			overrides: {
+				"?": "before",
+				":": "before"
+			}
+		}
+	],
+	"padded-blocks": [
+		"error",
+		{
+			blocks: "never",
+			classes: "always",
+			switches: "never"
+		}
+	],
+	"padding-line-between-statements": [
+		"error",
+		{
+			blankLine: "always",
+			prev: "*",
+			next: "return"
+		},
+		{
+			blankLine: "always",
+			prev: [
+				"const",
+				"let",
+				"var"
+			],
+			next: "*"
+		},
+		{
+			blankLine: "any",
+			prev: [
+				"const",
+				"let",
+				"var"
+			],
+			next: [
+				"const",
+				"let",
+				"var"
+			]
+		},
+		{
+			blankLine: "always",
+			prev: [
+				"return",
+				"break",
+				"block",
+				"block-like"
+			],
+			next: ["case", "default"]
+		}
+	],
+	quotes: ["error", "double"],
+	"rest-spread-spacing": ["error", "never"],
+	semi: ["error", "always"],
+	"semi-spacing": [
+		"error",
+		{
+			before: false,
+			after: true
+
+		}
+	],
+	"semi-style": ["error", "last"],
+	"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", { int32Hint: false }],
+	"space-unary-ops": [
+		"error",
+		{
+			words: true,
+			nonwords: false,
+			overrides: {}
+		}
+	],
+	"switch-colon-spacing": [
+		"error",
+		{
+			before: false,
+			after: true
+		}
+	],
+	"template-curly-spacing": ["error", "never"],
+	"template-tag-spacing": ["error", "never"],
+	"unicode-bom": ["error", "never"],
+	"wrap-iife": ["error", "inside"],
+	"wrap-regex": ["off"],
+	"yield-star-spacing": [
+		"error",
+		{
+			before: false,
+			after: true
+		}
+	]
+};

package/rules/possible-problems.js

@@ -0,0 +1,16 @@
+export default {
+	"array-callback-return": ["error"],
+	"no-await-in-loop": ["off"],
+	"no-constant-binary-expression": ["error"],
+	"no-constructor-return": ["off"],
+	"no-duplicate-imports": ["error"],
+	"no-new-native-nonconstructor": ["error"],
+	"no-promise-executor-return": ["error"],
+	"no-self-compare": ["error"],
+	"no-template-curly-in-string": ["warn"],
+	"no-unmodified-loop-condition": ["error"],
+	"no-unreachable-loop": ["error"],
+	"no-unused-private-class-members": ["error"],
+	"no-use-before-define": ["error"],
+	"require-atomic-updates": ["error"]
+};

package/rules/react.js

@@ -0,0 +1,4 @@
+export default {
+	"react/jsx-uses-vars": "error",
+	"react/jsx-uses-react": "error"
+};