fix(documentation): do not remove JSDoc types in Vue JS files

Signed-off-by: Grigorii K. Shartsev <[email protected]>

Author: ShGKme

lib/configs/documentation.ts

@@ -13,6 +13,20 @@ import {
 } from '../globs.ts'
 import jsdocPlugin from 'eslint-plugin-jsdoc'
 
+const TS_FUNCTION_CONTEXTS = [
+	'FunctionDeclaration:has(TSTypeAnnotation)',
+	'FunctionExpression:has(TSTypeAnnotation)',
+	'ArrowFunctionExpression:has(TSTypeAnnotation)',
+	'MethodDefinition:has(TSTypeAnnotation)',
+]
+
+const JS_FUNCTION_CONTEXTS = [
+	'FunctionDeclaration:not(:has(TSTypeAnnotation))',
+	'FunctionExpression:not(:has(TSTypeAnnotation))',
+	'ArrowFunctionExpression:not(:has(TSTypeAnnotation))',
+	'MethodDefinition:not(:has(TSTypeAnnotation))',
+]
+
 /**
  * Config factory for code documentation related rules (JSDoc)
  *
@@ -56,7 +70,7 @@ export function documentation(options: ConfigOptions): Linter.Config[] {
 
 		{
 			rules: {
-			// Force proper documentation
+				// Force proper documentation
 				'jsdoc/check-tag-names': 'error',
 				// But ignore return values
 				'jsdoc/require-returns': 'off',
@@ -86,16 +100,39 @@ export function documentation(options: ConfigOptions): Linter.Config[] {
 
 		{
 			rules: {
-			// Overwrites for documentation as types are already provided by Typescript
+				// Overwrites for documentation as types are already provided by Typescript
+				'jsdoc/no-types': 'error',
 				'jsdoc/require-param-type': 'off',
-				'jsdoc/require-property-type': 'off',
 				'jsdoc/require-returns-type': 'off',
 			},
-			files: [
-				...GLOB_FILES_TYPESCRIPT,
-				...(options.vueIsTypescript ? GLOB_FILES_VUE : []),
-			],
+			files: [...GLOB_FILES_TYPESCRIPT],
 			name: 'nextcloud/documentation/rules-typescript',
 		},
+
+		...(options.vueIsTypescript
+			? [
+					{
+						rules: {
+							// Vue files can be both Javascript and Typescript
+							// Try to apply TS files only for functions with TS definitions
+							'jsdoc/no-types': [
+								'error',
+								{ contexts: TS_FUNCTION_CONTEXTS },
+							],
+							'jsdoc/require-param-type': [
+								'error',
+								{ contexts: JS_FUNCTION_CONTEXTS },
+							],
+							// Unlike params, return values are often inferred and not explicitly typed
+							'jsdoc/require-returns-type': 'off',
+							// Unfortunately, we cannot check when it is used in TS context and when not
+							'jsdoc/check-tag-names': ['error', { typed: false }],
+						},
+						files: [...(options.vueIsTypescript ? GLOB_FILES_VUE : [])],
+						name: 'nextcloud/documentation/rules-vue',
+					} satisfies Linter.Config,
+				]
+			: []
+		),
 	]
 }