@open-xchange/linter-presets 1.9.0 → 1.9.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## `1.9.2` – 2025-Sep-18
+
+- added: (ESLint) require JSDoc for classes and interfaces
+- changed: (ESLint) disallow type annotations for `@yields` tags in TypeScript files
+- chore: bump dependencies
+
+## `1.9.1` – 2025-Sep-11
+
+- chore: bump dependencies
+
 ## `1.9.0` – 2025-Sep-09
 
 - chore: bump `eslint-plugin-jsdoc` to v55.0.3

package/dist/eslint/core/jsdoc.js

@@ -24,7 +24,7 @@ export default function jsdoc() {
                         class: false,
                         const: false,
                         constant: false,
-                        constructor: false,
+                        "tag constructor": false,
                         extends: false,
                     },
                 },
@@ -33,20 +33,35 @@ export default function jsdoc() {
         },
         // overrides for TypeScript files
         {
-            name: "core.jsdoc.typescript",
             files: TS_GLOB,
-            rules: {
-                ...jsdocPlugin({ config: "flat/recommended-typescript-error" }).rules,
-                "jsdoc/check-param-names": ["error", { allowExtraTrailingParamDocs: true }], // overload signatures
-            },
+            ...jsdocPlugin({
+                config: "flat/recommended-typescript-error",
+                settings: {
+                    structuredTags: {
+                        // "@yields" tags in TypeScript do not need a type
+                        yields: {
+                            type: false,
+                        },
+                    },
+                },
+                rules: {
+                    "jsdoc/check-param-names": ["error", { allowExtraTrailingParamDocs: true }], // overload signatures
+                    "jsdoc/require-yields-type": "off",
+                },
+            }),
+            name: "core.jsdoc.typescript",
         },
         // configure plugin rules
+        // Note: These custom override rules must be located after the TS setup block above (instead of adding them
+        // to the "rules" option inside the leading "flat/recommended-error" block), otherwise they would be
+        // overwritten for all TS files.
         {
             name: "core.jsdoc.rules",
             files: SRC_GLOB,
             rules: {
                 "jsdoc/check-template-names": "error",
                 "jsdoc/require-asterisk-prefix": "error",
+                "jsdoc/require-jsdoc": ["error", { contexts: ["ClassDeclaration", "TSInterfaceDeclaration"] }],
                 "jsdoc/require-template": ["error", { requireSeparateTemplates: true }],
                 "jsdoc/require-throws": "error",
                 "jsdoc/tag-lines": "off",

package/dist/eslint/env/node.d.ts

@@ -2,17 +2,28 @@ import type ts from "typescript";
 import type { ConfigWithExtendsArg, LanguageOptions } from "../shared/env-utils.js";
 import { type EnvRestrictedOptions } from "../shared/restricted.js";
 export type EnvNodeConvertPathPattern = [pattern: string, replacement: string];
-export type EnvNodeConvertPathObject = Record<string, EnvNodeConvertPathPattern>;
-export interface EnvNodeConvertPathArray {
+/**
+ * Configuration for the record-style setting "convertPath" of the plugin
+ * `eslint-plugin-n`.
+ */
+export type EnvNodeConvertPathRecord = Record<string, EnvNodeConvertPathPattern>;
+/**
+ * Configuration for the elements in the array-style setting "convertPath" of
+ * the plugin `eslint-plugin-n`.
+ */
+export interface EnvNodeConvertPathElement {
     include: string[];
     exclude?: string[];
     replace: EnvNodeConvertPathPattern;
 }
+/**
+ * Shared settings for the plugin `eslint-plugin-n`.
+ */
 export interface EnvNodeSharedSettings {
     version?: string;
     allowModules?: string[];
     resolvePaths?: string[];
-    convertPath?: EnvNodeConvertPathObject | EnvNodeConvertPathArray[];
+    convertPath?: EnvNodeConvertPathRecord | EnvNodeConvertPathElement[];
     tryExtensions?: string[];
     tsconfigPath?: string[];
     typescriptExtensionMap?: ts.server.protocol.JsxEmit | Array<[string, string]>;

package/dist/eslint/rules/no-invalid-hierarchy.d.ts

@@ -1,4 +1,8 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
+/**
+ * Configuration for the rule "env-project/no-invalid-hierarchy" to specify a
+ * sub package inside a project.
+ */
 export interface RuleNoInvalidHierarchyPackage {
     /**
      * Glob patterns selecting all source files that are part of the package.

package/dist/eslint/rules/no-invalid-hierarchy.js

@@ -22,6 +22,7 @@ export default ESLintUtils.RuleCreator.withoutDocs({
     create(context, [options]) {
         // create the project context with aliases, root path, own module name, etc.
         const projectContext = new ProjectContext(context);
+        // convert strings in record entries to arrays
         const hierarchyMap = new Map();
         for (const [key, settings] of Object.entries(options)) {
             hierarchyMap.set(key, {
@@ -42,8 +43,7 @@ export default ESLintUtils.RuleCreator.withoutDocs({
                 if (!importWrapper.matchModuleName(packagesGlobs)) {
                     return;
                 }
-                // check package dependencies
-                // whether an invalid static import has been found
+                // whether an invalid static import has been found ("as boolean" to workaround linter)
                 let invalidStatic = false;
                 // recursively checks the imported module for dependency violations
                 const checkDependencies = (settings, root) => {
@@ -73,7 +73,6 @@ export default ESLintUtils.RuleCreator.withoutDocs({
                     }
                 }
                 // report package hierarchy errors
-                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- rule does not see assignment in callback function
                 if (invalidStatic) {
                     context.report({ messageId: "UNEXPECTED_OPTIONAL_STATIC", node: importWrapper.sourceNode });
                 }

package/dist/eslint/rules/no-invalid-modules.d.ts

@@ -1,4 +1,7 @@
 import { ESLintUtils } from "@typescript-eslint/utils";
+/**
+ * Configuration for the rule "env-project/no-invalid-modules".
+ */
 export interface RuleNoInvalidModulesOptions {
     /**
      * Specifies glob patterns for external modules.

package/dist/eslint/shared/rule-utils.d.ts

@@ -57,6 +57,10 @@ export declare function toPosixPath(path: string): string;
  *  existing directories).
  */
 export declare function isFile(path: string): boolean;
+/**
+ * A wrapper for an `import` statement containing a string literal node with a
+ * module name, and the resulting extracted module name.
+ */
 export declare class ImportNodeWrapper {
     /** The string literal node containing the name of the imported module. */
     readonly sourceNode: TSESTree.StringLiteral;

package/dist/eslint/shared/rule-utils.js

@@ -89,6 +89,10 @@ export function isFile(path) {
     }
 }
 // class ImportNodeWrapper ====================================================
+/**
+ * A wrapper for an `import` statement containing a string literal node with a
+ * module name, and the resulting extracted module name.
+ */
 export class ImportNodeWrapper {
     /** The string literal node containing the name of the imported module. */
     sourceNode;

package/dist/utils/utils.d.ts

@@ -12,7 +12,7 @@ export type DeepOptArray<T> = T | false | null | undefined | ReadonlyArray<DeepO
  * @param arrays
  *  The deeply nested arrays to be visited.
  *
- * @yields {T}
+ * @yields
  *  The truthy array elements.
  */
 export declare function yieldDeepArrays<T>(...arrays: Array<DeepOptArray<T>>): IterableIterator<T>;

package/dist/utils/utils.js

@@ -10,7 +10,7 @@
  * @param arrays
  *  The deeply nested arrays to be visited.
  *
- * @yields {T}
+ * @yields
  *  The truthy array elements.
  */
 export function* yieldDeepArrays(...arrays) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "@babel/eslint-parser": "^7.28.4",
     "@babel/plugin-proposal-decorators": "^7.28.0",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
-    "@eslint-react/eslint-plugin": "^1.53.0",
+    "@eslint-react/eslint-plugin": "^1.53.1",
     "@eslint/compat": "^1.3.2",
     "@eslint/config-helpers": "^0.3.1",
     "@eslint/js": "^9.35.0",
@@ -44,7 +44,7 @@
     "@stylistic/stylelint-config": "^3.0.1",
     "@stylistic/stylelint-plugin": "^4.0.0",
     "@types/picomatch": "^4.0.2",
-    "@vitest/eslint-plugin": "^1.3.9",
+    "@vitest/eslint-plugin": "^1.3.12",
     "confusing-browser-globals": "^1.0.11",
     "empathic": "^2.0.0",
     "eslint-plugin-chai-expect": "^3.1.0",
@@ -54,36 +54,36 @@
     "eslint-plugin-jest": "^29.0.1",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-jest-extended": "^3.0.0",
-    "eslint-plugin-jsdoc": "^55.0.3",
+    "eslint-plugin-jsdoc": "^58.1.1",
     "eslint-plugin-jsonc": "^2.20.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-license-header": "^0.8.0",
-    "eslint-plugin-n": "^17.21.3",
+    "eslint-plugin-n": "^17.23.0",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-hooks-static-deps": "^1.0.7",
     "eslint-plugin-react-refresh": "^0.4.20",
     "eslint-plugin-regexp": "^2.10.0",
-    "eslint-plugin-testing-library": "^7.6.8",
+    "eslint-plugin-testing-library": "^7.8.0",
     "eslint-plugin-vue": "^10.4.0",
     "eslint-plugin-yml": "^1.18.0",
-    "globals": "^16.3.0",
+    "globals": "^16.4.0",
     "picomatch": "^4.0.3",
     "postcss-html": "^1.8.0",
     "stylelint-config-standard": "^39.0.0",
     "stylelint-config-standard-less": "^3.0.1",
-    "stylelint-config-standard-scss": "^15.0.1",
+    "stylelint-config-standard-scss": "^16.0.0",
     "stylelint-config-standard-vue": "^1.0.0",
     "stylelint-plugin-license-header": "^1.0.3",
-    "typescript-eslint": "^8.43.0",
+    "typescript-eslint": "^8.44.0",
     "vue-eslint-parser": "^10.2.0"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "^1.0.3",
     "@types/eslint-scope": "^8.3.2",
-    "@types/node": "^24.3.1",
-    "@types/react": "^19.1.12",
-    "@typescript-eslint/utils": "^8.43.0",
+    "@types/node": "^24.5.2",
+    "@types/react": "^19.1.13",
+    "@typescript-eslint/utils": "^8.44.0",
     "eslint": "^9.35.0",
     "jest": "^30.1.3",
     "jiti": "^2.5.1",