From b4da20e73f7e2ca9776d2032c1da71e75b7eec71 Mon Sep 17 00:00:00 2001 From: Ferdinand Thiessen Date: Tue, 11 Jul 2023 18:35:34 +0200 Subject: [PATCH] fix: Allow `@jest-environment` docblock for jest tests Signed-off-by: Ferdinand Thiessen --- parts/base.js | 8 ++++++++ parts/typescript.js | 4 +++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/parts/base.js b/parts/base.js index a8ee911..e68f0a8 100644 --- 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 index b3ddd89..3397ce1 100644 --- 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', ], }, ],