chore: Update to eslint 9 (#6233)

marikaner · web-flow · commit 64314637150c · 2026-01-05T09:44:04.000Z
* update to eslint 9

* remove extra yarn.lock

* update readme

* add changeset
diff --git a/.changeset/funny-adults-fold.md b/.changeset/funny-adults-fold.md
@@ -0,0 +1,5 @@
+---
+'@sap-cloud-sdk/eslint-config': patch
+---
+
+[Improvement] Open the peer dependency range of the `eslint` module to include version 8 and 9. Version 9 can now be used without the potentially unsafe npm flag `--legacy-peer-deps`.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/actions/changesets-fixed-version-bump/index.js b/.github/actions/changesets-fixed-version-bump/index.js
diff --git a/.github/actions/check-public-api/index.js b/.github/actions/check-public-api/index.js
diff --git a/.github/actions/get-changelog/index.js b/.github/actions/get-changelog/index.js
diff --git a/build-packages/changesets-fixed-version-bump/package.json b/build-packages/changesets-fixed-version-bump/package.json
@@ -21,7 +21,7 @@
   "devDependencies": {
     "@vercel/ncc": "^0.38.4",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.1",
+    "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "typescript": "~5.9.3"
   }
diff --git a/build-packages/changesets-fixed-version-bump/util.ts b/build-packages/changesets-fixed-version-bump/util.ts
@@ -3,6 +3,7 @@
 import { info } from 'node:console';
 import getReleasePlan from '@changesets/get-release-plan';
 import { inc } from 'semver';
+// eslint-disable-next-line import/no-internal-modules
 import { getPackageVersion } from '../../scripts/get-package-version';
 
 const bumpTypeOrder = ['major', 'minor', 'patch', 'none'] as const;
@@ -18,7 +19,7 @@ export async function getNextVersion(): Promise<{
   info(`Bump type: ${bumpType}`);
 
   if (bumpType === 'none' || !bumpType) {
-    throw new Error(`No changesets to release`);
+    throw new Error('No changesets to release');
   }
 
   const version = inc(currentVersion, bumpType);
diff --git a/build-packages/check-license/package.json b/build-packages/check-license/package.json
@@ -18,7 +18,7 @@
   "devDependencies": {
     "@vercel/ncc": "^0.38.4",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.0",
+    "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "typescript": "~5.9.3"
   }
diff --git a/build-packages/check-pr/package.json b/build-packages/check-pr/package.json
@@ -21,7 +21,7 @@
   "devDependencies": {
     "@vercel/ncc": "^0.38.4",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.1",
+    "eslint": "^9.39.2",
     "mock-fs": "^5.5.0",
     "prettier": "^3.7.4",
     "typescript": "~5.9.3"
diff --git a/build-packages/check-public-api/check-public-api.spec.ts b/build-packages/check-public-api/check-public-api.spec.ts
@@ -1,6 +1,7 @@
-import mock from 'mock-fs';
 import path from 'path';
+import mock from 'mock-fs';
 import * as core from '@actions/core';
+// eslint-disable-next-line no-restricted-imports
 import {
   checkBarrelRecursive,
   checkIndexFileExists,
@@ -10,6 +11,7 @@ import {
   parseExportedObjectsInFile,
   regexExportedIndex,
   typeDescriptorPaths
+  // eslint-disable-next-line import/no-useless-path-segments
 } from './index';
 
 describe('check-public-api', () => {
diff --git a/build-packages/check-public-api/package.json b/build-packages/check-public-api/package.json
@@ -26,8 +26,8 @@
   "devDependencies": {
     "@vercel/ncc": "^0.38.4",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.0",
+    "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "typescript": "~5.9.3"
   }
-}
+}
diff --git a/build-packages/get-changelog/index.ts b/build-packages/get-changelog/index.ts
@@ -1,4 +1,5 @@
 import { setOutput, setFailed } from '@actions/core';
+// eslint-disable-next-line import/no-internal-modules
 import { getChangelog } from '../../scripts/get-changelog';
 
 (async () => {
diff --git a/build-packages/get-changelog/package.json b/build-packages/get-changelog/package.json
@@ -18,7 +18,7 @@
   "devDependencies": {
     "@vercel/ncc": "^0.38.4",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.1",
+    "eslint": "^9.39.2",
     "prettier": "^3.7.4",
     "typescript": "~5.9.3"
   }
diff --git a/build-packages/merge-and-write-changelogs/package.json b/build-packages/merge-and-write-changelogs/package.json
@@ -19,7 +19,7 @@
   "devDependencies": {
     "@vercel/ncc": "^0.38.3",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.1",
+    "eslint": "^9.39.2",
     "prettier": "^3.5.2",
     "typescript": "~5.7.3"
   }
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,93 @@
+const { defineConfig, globalIgnores } = require('eslint/config');
+
+const globals = require('globals');
+const tsParser = require('@typescript-eslint/parser');
+const js = require('@eslint/js');
+
+const { FlatCompat } = require('@eslint/eslintrc');
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all
+});
+
+module.exports = defineConfig([
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest
+      },
+      parser: tsParser,
+      sourceType: 'module',
+      parserOptions: {
+        project: {
+          extends: 'tsconfig.json',
+          include: ['**/*.ts'],
+
+          exclude: [
+            '**/*.d.ts',
+            '**/dist/**/*',
+            '**/node_modules/**/*',
+            'test-packages/test-services*/**/*',
+            'test-packages/test-services-e2e/**/*',
+            'test-packages/memory-tests/sdk-v1/test-service/*',
+            'test-packages/memory-tests/sdk-canary/test-service/*',
+            'build-packages/check-pr/lib/**',
+            'build-packages/get-changelog/lib/**',
+            'packages/rest-generator/test/test-services/**/*',
+            'test-resources/cli/**/*',
+            '**/test-output/**',
+            '**/README.md'
+          ]
+        }
+      }
+    },
+    extends: compat.extends('@sap-cloud-sdk'),
+    rules: {
+      radix: 'off',
+      'no-restricted-syntax': [
+        'error',
+        {
+          selector: 'TSEnumDeclaration',
+          message:
+            'Enums are weird in TypeScript. Prefer union types or const objects instead.'
+        }
+      ]
+    }
+  },
+  globalIgnores([
+    '**/dist',
+    '**/node_modules',
+    '**/README.md',
+    'test-packages/test-services-odata-v2',
+    'test-packages/test-services-odata-v4',
+    'test-packages/test-services-odata-common',
+    'test-packages/test-services-openapi',
+    'test-packages/test-services-e2e',
+    'test-packages/e2e-tests/test/generator-test-output',
+    'test-packages/memory-tests/sdk-v1/test-service',
+    'test-packages/memory-tests/sdk-canary/test-service',
+    'packages/rest-generator/test/test-services',
+    '**/scripts/',
+    'test-resources/cli/',
+    'test-resources/generator/test-output',
+    '**/*.js',
+    '**/*.json'
+  ]),
+  {
+    files: ['**/test/**/*', '**/*.spec.ts'],
+    rules: {
+      'import/no-internal-modules': 'off',
+      'no-unused-expressions': 'off',
+      'jsdoc/require-jsdoc': 'off'
+    }
+  },
+  {
+    files: ['**/index.ts'],
+    rules: {
+      'jsdoc/require-description-complete-sentence': 'off'
+    }
+  }
+]);
diff --git a/package.json b/package.json
@@ -88,8 +88,10 @@
     "type-tests": "yarn workspace @sap-cloud-sdk/type-tests"
   },
   "devDependencies": {
-    "@types/jest": "^30.0.0",
     "@changesets/cli": "^2.29.8",
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.2",
+    "@types/jest": "^30.0.0",
     "@types/jsonwebtoken": "^9.0.10",
     "@types/license-checker": "^25.0.6",
     "@types/mock-fs": "^4.13.4",
@@ -98,9 +100,10 @@
     "axios": "^1.13.2",
     "cross-env": "10.1.0",
     "depcheck": "^1.4.7",
-    "eslint": "^8.57.1",
+    "eslint": "^9.39.2",
     "execa": "^5.0.0",
     "glob": "^13.0.0",
+    "globals": "^17.0.0",
     "jest": "^30.2.0",
     "jest-junit": "^16.0.0",
     "license-checker": "^25.0.1",
diff --git a/packages/connectivity/src/scp-cf/destination/destination.ts b/packages/connectivity/src/scp-cf/destination/destination.ts
@@ -399,7 +399,7 @@ export interface DestinationConfiguration {
    */
   Type?: 'HTTP' | 'LDAP' | 'MAIL' | 'RFC';
 }
-/* eslint-disable-next-line valid-jsdoc */
+
 /**
  * @internal
  */
@@ -409,7 +409,6 @@ export function isDestinationConfiguration(
   return destination.URL !== undefined;
 }
 
-/* eslint-disable-next-line valid-jsdoc */
 /**
  * @internal
  */
diff --git a/packages/connectivity/src/scp-cf/protocol.ts b/packages/connectivity/src/scp-cf/protocol.ts
@@ -1,5 +1,3 @@
-/* eslint-disable  import/export */
-
 const protocols = {
   http: 'http',
   https: 'https',
diff --git a/packages/eslint-config/README.md b/packages/eslint-config/README.md
@@ -11,6 +11,16 @@ It also uses the `eslint-config-prettier` to avoid any formatting conflicts when
 
 ## How to use
 
+Import the flat configuration in your `eslint.config.js`:
+
+```
+import sapCloudSdkConfig from '@sap-cloud-sdk/eslint-config/flat-config';
+```
+
+Then add it to your own configuration in `defineConfig()`: `defineConfig(sapCloudSdkConfig, /* your config */)`.
+
+### Legacy ESLint configuration files
+
 To add the configuration please adjust your ESlint configuration (usually called `.eslintrc` or `.eslintrc.js`):
 
 ```
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -42,6 +42,6 @@
     "typescript-eslint": "^8.51.0"
   },
   "peerDependencies": {
-    "eslint": "^8.0.0"
+    "eslint": ">=8.0.0"
   }
 }
diff --git a/packages/generator-common/src/file-writer/package-json.ts b/packages/generator-common/src/file-writer/package-json.ts
@@ -25,7 +25,6 @@ export interface PackageJsonOptions {
   moduleType?: ModuleType;
 }
 
-/* eslint-disable valid-jsdoc */
 /**
  * @internal
  */
diff --git a/packages/odata-v4/src/filter-function.ts b/packages/odata-v4/src/filter-function.ts
@@ -13,7 +13,6 @@ import type {
   FilterFunctionReturnType as FilterFunctionReturnTypeBase
 } from '@sap-cloud-sdk/odata-common/internal';
 import type { Entity } from './entity';
-// eslint-disable valid-jsdoc
 
 export function filterFunction<EntityT extends Entity>(
   functionName: string,
diff --git a/test-packages/integration-tests/test/v2/__snapshots__/function-imports.spec.ts.snap b/test-packages/integration-tests/test/v2/__snapshots__/function-imports.spec.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
-exports[`Function imports should reject on error response, using \`functionImports\` import 1`] = `
+exports['Function imports should reject on error response, using `functionImports` import 1'] = `
 "get request to https://example.com/sap/opu/odata/sap/API_TEST_SRV failed! Some error occured
 {"code":"ABC","message":{"lang":"en","value":"Some error occured"},"innererror":{"application":{"component_id":"XYZ","service_namespace":"/SAP/","service_id":"API_TEST_SRV","service_version":"0001"},"transactionid":"0123456789ABCDEFGHIJKLMNOPQRSTUV","timestamp":"20130410220202.0726600","Error_Resolution":{"SAP_Transaction":"You can do something!","SAP_Note":"See SAP Note XXXX for error analysis."},"errordetails":[{"code":"ABC","message":"Some error occured","longtext_url":"URL","propertyref":"","severity":"error","target":""}]}}
 Cause: Request failed with status code 400"
diff --git a/test-packages/test-services-odata-common/yarn.lock b/test-packages/test-services-odata-common/yarn.lock
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@sap-cloud-sdk/eslint-config': patch
 +---
++
 +[Improvement] Open the peer dependency range of the `eslint` module to include version 8 and 9. Version 9 can now be used without the potentially unsafe npm flag `--legacy-peer-deps`.
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`"devDependencies": {`
`22`	`22`	`"@vercel/ncc": "^0.38.4",`
`23`	`23`	`"depcheck": "^1.4.7",`
`24`		`- "eslint": "^8.57.1",`
	`24`	`+ "eslint": "^9.39.2",`
`25`	`25`	`"prettier": "^3.7.4",`
`26`	`26`	`"typescript": "~5.9.3"`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`"devDependencies": {`
`19`	`19`	`"@vercel/ncc": "^0.38.4",`
`20`	`20`	`"depcheck": "^1.4.7",`
`21`		`- "eslint": "^8.57.0",`
	`21`	`+ "eslint": "^9.39.2",`
`22`	`22`	`"prettier": "^3.7.4",`
`23`	`23`	`"typescript": "~5.9.3"`
`24`	`24`	`}`