chore: Update eslint dependencies (#4286)

* Update eslint * fix lint * Add changeset * update more packages * Update typescript-eslint packages
SAP · Nov 17, 2023 · d6bbd32 · d6bbd32
1 parent bb80f1f
commit d6bbd32
Show file tree

Hide file tree

Showing 11 changed files with 100 additions and 107 deletions.
diff --git a/.changeset/tricky-plants-happen.md b/.changeset/tricky-plants-happen.md
@@ -0,0 +1,5 @@
+---
+'@sap-cloud-sdk/eslint-config': patch
+---
+
+[Improvement] Update eslint plugins
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -61,9 +61,10 @@ module.exports = {
     'no-restricted-syntax': [
       'error',
       {
-        'selector': 'TSEnumDeclaration',
-        'message': 'Enums are weird in TypeScript. Prefer union types or const objects instead.'
-      },
+        selector: 'TSEnumDeclaration',
+        message:
+          'Enums are weird in TypeScript. Prefer union types or const objects instead.'
+      }
     ]
   }
 };
diff --git a/package.json b/package.json
@@ -96,19 +96,19 @@
     "@types/prettier": "3.0.0",
     "@types/uuid": "^9.0.7",
     "@types/voca": "^1.4.5",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "axios": "^1.6.2",
     "depcheck": "^1.4.7",
     "eslint": "^8.53.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-header": "^3.0.0",
+    "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-jest": "^27.6.0",
-    "eslint-plugin-jsdoc": "^39.9.1",
+    "eslint-plugin-jsdoc": "^46.9.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-regex": "^1.10.0",
-    "eslint-plugin-unused-imports": "^2.0.0",
+    "eslint-plugin-unused-imports": "^3.0.0",
     "execa": "^5.0.0",
     "glob": "^10.3.10",
     "jest": "^29.7.0",
@@ -121,7 +121,7 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "turbo": "^1.10.16",
-    "typedoc": "0.25.2",
+    "typedoc": "0.25.3",
     "typescript": "~5.2.2"
   },
   "resolutions": {

diff --git a/packages/connectivity/src/scp-cf/async-cache.ts b/packages/connectivity/src/scp-cf/async-cache.ts
@@ -60,13 +60,15 @@ export class AsyncCache<T> implements AsyncCacheInterface<T> {
    * Setter of entries in cache.
    * @param key - The entry's key.
    * @param item - The entry to cache.
+   * @returns A promise to oid.
    */
   async set(key: string | undefined, item: CacheEntry<T>): Promise<void> {
     return this.cache.set(key, item);
   }
 
   /**
    * Clear all cached items.
+   * @returns A promise to void.
    */
   async clear(): Promise<void> {
     return this.cache.clear();

diff --git a/packages/connectivity/src/scp-cf/connectivity-service-types.ts b/packages/connectivity/src/scp-cf/connectivity-service-types.ts
@@ -39,7 +39,6 @@ export interface BasicProxyConfiguration {
 
   /**
    * The protocol used by the proxy.
-   *
    */
   protocol: Protocol;
 }

diff --git a/packages/eslint-config/index.js b/packages/eslint-config/index.js
@@ -195,7 +195,7 @@ module.exports = {
     ],
     'jsdoc/check-syntax': 'error',
     'jsdoc/multiline-blocks': 'error',
-    'jsdoc/newline-after-description': ['error', 'never'],
+    'jsdoc/tag-lines': ['error', { 'tag-lines': 0 }],
     'jsdoc/no-bad-blocks': 'error',
     'jsdoc/no-defaults': 'error',
     'jsdoc/no-types': 'error',

diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -33,6 +33,6 @@
     "eslint": "^8.0.0",
     "eslint-plugin-import": "^2.20.2",
     "eslint-plugin-unused-imports": "^2.0.0",
-    "eslint-plugin-jsdoc": "^39.3.6"
+    "eslint-plugin-jsdoc": "^46.9.0"
   }
 }
diff --git a/packages/generator-common/src/sdk-metadata/sdk-metadata-types.ts b/packages/generator-common/src/sdk-metadata/sdk-metadata-types.ts
@@ -81,7 +81,6 @@ export interface ServiceStatus {
    * `verified`: generation tested and succeeded.
    * `unknown`: generation not tested.
    * `failed`: generation tested and failed.
-   *
    */
   status: 'certified' | 'verified' | 'unknown' | 'failed';
   /**

diff --git a/packages/generator/src/generator.ts b/packages/generator/src/generator.ts
@@ -66,6 +66,7 @@ const logger = createLogger({
  * Main entry point for the OData client generation.
  * Generates models and API files.
  * @param options - Options to configure generation.
+ * @returns A promise to void.
  */
 export async function generate(
   options: GeneratorOptions & { config?: string }

diff --git a/packages/openapi-generator/src/generator.ts b/packages/openapi-generator/src/generator.ts
@@ -46,6 +46,7 @@ const logger = createLogger('openapi-generator');
  * Main entry point for the OpenAPI client generation.
  * Generates models and API files.
  * @param options - Options to configure generation.
+ * @returns A promise to void.
  */
 export async function generate(
   options: GeneratorOptions & { config?: string }
-Original file line number
+Diff line change
@@ Expand Up / @@ -39,7 +39,6 @@ export interface BasicProxyConfiguration { @@
       /**
        * The protocol used by the proxy.
-       *
        */
       protocol: Protocol;
     }
@@ Expand Down @@