Merge pull request #592 from nextcloud/fix/allow-jest-tags

fix: Allow `@jest-environment` docblock for jest tests
nextcloud-libraries · Jul 12, 2023 · fbb3b00 · fbb3b00
2 parents d23421b + b4da20e
commit fbb3b00
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/parts/base.js b/parts/base.js
@@ -63,6 +63,14 @@ module.exports = {
 		// ternary on multiline
 		'multiline-ternary': ['error', 'always-multiline'],
 		// force proper JSDocs
+		'jsdoc/check-tag-names': [
+			'warn', {
+				definedTags: [
+					// for jest
+					'jest-environment',
+				],
+			},
+		],
 		'jsdoc/require-returns': 0,
 		'jsdoc/require-returns-description': 0,
 		'jsdoc/tag-lines': ['off'],

diff --git a/parts/typescript.js b/parts/typescript.js
@@ -16,10 +16,12 @@ module.exports = {
 		'import/extensions': 'off',
 		'jsdoc/check-tag-names': [
 			'warn', {
-				// for projects using typedoc
 				definedTags: [
+					// for projects using typedoc
 					'notExported',
 					'packageDocumentation',
+					// for jest
+					'jest-environment',
 				],
 			},
 		],