cli-extensions/packages/middleware-code-coverage/eslint.common.config.js at main · UI5/cli-extensions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
import jsdoc from "eslint-plugin-jsdoc";
import ava from "eslint-plugin-ava";
import globals from "globals";
import js from "@eslint/js";
import google from "eslint-config-google";

export default [
	{
		ignores: [
			// Common ignore patterns across all UI5 CLI repos
			"**/coverage/",
			"test/tmp/",
			"test/expected/",
			"test/fixtures/",
			"**/docs/",
			"**/jsdocs/",
		],
	},
	js.configs.recommended,
	google,
	ava.configs["flat/recommended"],
	{
		name: "Common ESLint config used for all UI5 CLI repos",

		plugins: {
			jsdoc,
		},

		languageOptions: {
			globals: {
				...globals.node,
			},

			ecmaVersion: 2023,
			sourceType: "module",
		},

		settings: {
			jsdoc: {
				mode: "jsdoc",

				tagNamePreference: {
					return: "returns",
					augments: "extends",
				},
			},
		},

		rules: {
			"indent": ["error", "tab"],
			"linebreak-style": ["error", "unix"],

			"quotes": [
				"error",
				"double",
				{
					allowTemplateLiterals: true,
				},
			],

			"semi": ["error", "always"],
			"no-negated-condition": "off",
			"require-jsdoc": "off",
			"no-mixed-requires": "off",

			"max-len": [
				"error",
				{
					code: 120,
					ignoreUrls: true,
					ignoreRegExpLiterals: true,
				},
			],

			"no-implicit-coercion": [
				2,
				{
					allow: ["!!"],
				},
			],

			"comma-dangle": "off",
			"no-tabs": "off",
			"no-console": 2, // Disallow console.log()
			"no-eval": 2,
			// The following rule must be disabled as of ESLint 9.
			// It's removed and causes issues when present
			// https://eslint.org/docs/latest/rules/valid-jsdoc
			"valid-jsdoc": 0,
			"jsdoc/check-examples": 0,
			"jsdoc/check-param-names": 2,
			"jsdoc/check-tag-names": 2,
			"jsdoc/check-types": 2,
			"jsdoc/no-undefined-types": 0,
			"jsdoc/require-description": 0,
			"jsdoc/require-description-complete-sentence": 0,
			"jsdoc/require-example": 0,
			"jsdoc/require-hyphen-before-param-description": 0,
			"jsdoc/require-param": 2,
			"jsdoc/require-param-description": 0,
			"jsdoc/require-param-name": 2,
			"jsdoc/require-param-type": 2,
			"jsdoc/require-returns": 0,
			"jsdoc/require-returns-description": 0,
			"jsdoc/require-returns-type": 2,

			"jsdoc/tag-lines": [
				2,
				"any",
				{
					startLines: 1,
				},
			],

			"jsdoc/valid-types": 0,
			"ava/assertion-arguments": 0,
		},
	},
];