feat: enhanced v4 compat + update dependencies (#1070)

* Improved UI5 tooling V4 support (e.g. less tooling extension or dependencies)
* Update to UI5 version 1.127.0
* Support for ESLint 9
* Usage of distributed lintstaged monorepo config
* Fixed JSDoc

.gitignore

@@ -79,4 +79,7 @@ dist
 .vscode/settings.json
 
 # local workspace configs
-ui5-workspace.yaml
+ui5-workspace.yaml
+
+# local markdown files
+TODO.md

.ncurc.json

@@ -1,5 +1,6 @@
 {
  "reject": [
+ "pnpm",
  "@sap/cds",
  "chart.js",
  "@octokit/core",
@@ -11,7 +12,6 @@
  "@wdio/spec-reporter",
  "wdio-ui5-service",
  "eslint-plugin-wdio",
- "@prettier/plugin-xml",
- "prettier"
+ "http-proxy-middleware"
  ]
 }

.prettierrc.js

@@ -6,7 +6,7 @@ module.exports = {
  return packageName != "prettier" && packageName.includes("prettier");
  })
  .flatMap((packageName) => {
- return [require(packageName)];
+ return [require.resolve(packageName)];
  }),
  singleQuote: false,
  printWidth: 200,

eslint.config.mjs

@@ -0,0 +1,40 @@
+import globals from "globals";
+import js from "@eslint/js";
+import jsdoc from "eslint-plugin-jsdoc";
+
+export default [
+ js.configs.recommended,
+ jsdoc.configs["flat/recommended"],
+ {
+ languageOptions: {
+ globals: {
+ ...globals.browser,
+ ...globals.commonjs,
+ ...globals.node,
+ yo: "writable",
+ confirm: "writable",
+ map: "writable",
+ input: "writable",
+ sap: "readonly",
+ },
+ ecmaVersion: 2023,
+ sourceType: "script",
+ },
+ rules: {
+ "no-mixed-spaces-and-tabs": "warn",
+ "jsdoc/tag-lines": "off",
+ },
+ },
+ {
+ ignores: [
+ // ignore files for the following packages reusing this config
+ "/packages/ui5-middleware-approuter/test/*/**",
+ "/packages/ui5-tooling-modules/test/*/**",
+
+ // config files
+ "eslint.config.js",
+ "eslint.config.mjs",
+ "karma*.conf.js",
+ ],
+ },
+];

package.json

@@ -71,20 +71,21 @@
  "ncu": "ncu -ws --root"
  },
  "devDependencies": {
- "@commitlint/cli": "^19.3.0",
- "@commitlint/config-conventional": "^19.2.2",
- "@prettier/plugin-xml": "^2.2.0",
+ "@commitlint/cli": "^19.4.1",
+ "@commitlint/config-conventional": "^19.4.1",
+ "@prettier/plugin-xml": "^3.4.1",
  "cz-conventional-changelog": "^3.3.0",
- "eslint": "^8.57.0",
- "eslint-plugin-jsdoc": "^48.8.3",
- "husky": "^9.1.1",
- "lerna": "^8.1.7",
- "lint-staged": "^15.2.7",
+ "eslint": "^9.9.1",
+ "eslint-plugin-jsdoc": "^50.2.2",
+ "globals": "^15.9.0",
+ "husky": "^9.1.5",
+ "lerna": "^8.1.8",
+ "lint-staged": "^15.2.10",
  "npm-run-all": "^4.1.5",
- "prettier": "^2.8.8",
+ "prettier": "^3.3.3",
  "prettier-plugin-properties": "^0.3.0",
  "pretty-quick": "^4.0.0",
- "wait-on": "^7.2.0"
+ "wait-on": "^8.0.0"
  },
  "pnpm": {
  "overrides": {

packages/cds-plugin-ui5/.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+ "**/*.js": "eslint"
+}

packages/cds-plugin-ui5/package.json

@@ -11,9 +11,9 @@
  "directory": "packages/cds-plugin-ui5"
  },
  "dependencies": {
- "@ui5/fs": "^4.0.0",
- "@ui5/project": "^4.0.2",
- "@ui5/server": "^4.0.3",
+ "@ui5/fs": "^4",
+ "@ui5/project": "^4",
+ "@ui5/server": "^4",
  "js-yaml": "^4.1.0",
  "node-html-parser": "^6.1.13",
  "semver": "^7.6.3"

packages/dev-approuter/.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+ "lib/**/*.js": "eslint"
+}

packages/dev-approuter/package.json

@@ -11,8 +11,8 @@
  "directory": "packages/dev-approuter"
  },
  "dependencies": {
- "@sap/approuter": ">=16.6.0",
- "@sap/xsenv": "5.1.0",
+ "@sap/approuter": ">=16.7.1",
+ "@sap/xsenv": "5.2.0",
  "cds-plugin-ui5": "workspace:^",
  "express": "^4.19.2",
  "ui5-middleware-cap": "workspace:^"

packages/karma-ui5-transpile/.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+ "lib/**/*.js": "eslint"
+}

packages/karma-ui5-transpile/package.json

@@ -25,11 +25,11 @@
  "sapui5"
  ],
  "dependencies": {
- "babel-plugin-istanbul": "^6.1.1",
+ "babel-plugin-istanbul": "^7.0.0",
  "js-yaml": "^4.1.0"
  },
  "devDependencies": {
- "karma": "^6.4.3",
+ "karma": "^6.4.4",
  "ui5-tooling-transpile": "workspace:^"
  },
  "peerDependencies": {

packages/ui5-middleware-approuter/.lintstagedrc.json

@@ -0,0 +1,4 @@
+{
+ "lib/**/*.js": "eslint",
+ "test/*.js": "eslint"
+}

packages/ui5-middleware-approuter/lib/middleware.js

@@ -1,5 +1,3 @@
-/* global globalThis */
-
 const fs = require("fs")
 const path = require("path")
 
@@ -93,6 +91,7 @@ module.exports = async ({ log, options, middlewareUtil }) => {
  let destinations
  try {
  destinations = JSON.parse(process.env.destinations)
+ // eslint-disable-next-line no-unused-vars
  } catch (ex) {
  // no destinations from environment => let's check the effectiveOptions
  }
@@ -167,7 +166,7 @@ module.exports = async ({ log, options, middlewareUtil }) => {
  `adding cf-like destination "${
  route.destination || "(xs-app.json specific setting)"
  }" proxying reqs to ${route.source}`
-  )
+  )
  : null
  }
  })
@@ -210,6 +209,7 @@ module.exports = async ({ log, options, middlewareUtil }) => {
  )
  })
  return extensionModule
+ // eslint-disable-next-line no-unused-vars
  } catch (ex) {
  log.warn(
  `⚠️ Failed to resolve extension "${JSON.stringify(extension)}"! The extension will be ignored...`
@@ -381,6 +381,6 @@ module.exports = async ({ log, options, middlewareUtil }) => {
  })
  },
  proxyMiddleware
-  )
+  )
  : proxyMiddleware
 }

packages/ui5-middleware-approuter/package.json

@@ -23,7 +23,7 @@
  "timeout": "20s"
  },
  "dependencies": {
- "@sap/approuter": "^16.6.0",
+ "@sap/approuter": "^16.7.1",
  "content-type": "^1.0.5",
  "dotenv": "^16.4.5",
  "http-proxy-middleware": "^2.0.6",
@@ -32,16 +32,16 @@
  "ui5-utils-express": "workspace:^"
  },
  "devDependencies": {
- "@ui5/cli": "^3.11.0",
- "@ui5/project": "^3.9.2",
- "@ui5/server": "^3.2.1",
+ "@ui5/cli": "^3",
+ "@ui5/project": "^3",
+ "@ui5/server": "^3",
  "ava": "^6.1.3",
  "envfile": "7.1.0",
  "get-port": "^7.1.0",
- "nock": "^13.5.4",
- "replace-in-file": "^7.1.0",
+ "nock": "^13.5.5",
+ "replace-in-file": "^8.1.0",
  "supertest": "^7.0.0",
  "ui5-middleware-websocket": "workspace:^",
- "wait-on": "^7.2.0"
+ "wait-on": "^8.0.0"
  }
 }

packages/ui5-middleware-approuter/test/_fs_app_util.js

@@ -1,4 +1,4 @@
-const { mkdir, cp, rmdir, symlink } = require("fs").promises
+const { mkdir, cp, symlink } = require("fs").promises
 const path = require("path")
 
 /**

packages/ui5-middleware-approuter/test/_prep_server_util.js

@@ -1,6 +1,5 @@
 const { cp } = require("fs").promises
 const path = require("path")
-const replace = require("replace-in-file")
 
 /**
  * @typedef UI5ServerConfig
@@ -23,9 +22,10 @@ const replace = require("replace-in-file")
  * @returns {UI5ServerConfig} full path to the test fixtures of ui5.yaml, xsapp.json and defaultEnv.json (the latter is an empty object if not provided as an input parameter)
  */
 async function prepUI5ServerConfig({ ui5Yaml, appRouterPort, xsAppJson, defaultEnvJson, tmpDir }) {
+ const { replaceInFile } = await import("replace-in-file")
  // replace default port 1091 for app router w/ random port
  await cp(path.resolve(ui5Yaml), `${tmpDir}/ui5.yaml`) // copy orig ui5.yaml test fixture
- const _ui5Yaml = await replace({ files: path.resolve(`${tmpDir}/ui5.yaml`), from: "1091", to: appRouterPort }) // replace port config in file
+ const _ui5Yaml = await replaceInFile({ files: path.resolve(`${tmpDir}/ui5.yaml`), from: "1091", to: appRouterPort }) // replace port config in file
  const ui5 = { yaml: _ui5Yaml[0].file }
 
  const _xsapp = { json: path.resolve(xsAppJson) }

packages/ui5-middleware-approuter/test/auth/ui5-auth-in-yaml.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
  name: OpenUI5
- version: "1.126.0"
+ version: "1.127.0"
  libraries:
  - name: sap.m
  - name: sap.ui.core

packages/ui5-middleware-approuter/test/auth/ui5-with-localDir.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
  name: OpenUI5
- version: "1.126.0"
+ version: "1.127.0"
  libraries:
  - name: sap.m
  - name: sap.ui.core

packages/ui5-middleware-approuter/test/boot.test.js

@@ -1,4 +1,4 @@
-const crypto = require("crypto")
+const { randomBytes } = require("crypto")
 const fs = require("fs-extra")
 const nock = require("nock")
 const path = require("path")
@@ -12,7 +12,7 @@ const prepUI5ServerConfig = require("./_prep_server_util")
 
 test.beforeEach(async (t) => {
  // copy ui5 app to a temp dir in test folder scope
- t.context.tmpDir = path.resolve(`./test/_ui5-app/${crypto.randomBytes(5).toString("hex")}`)
+ t.context.tmpDir = path.resolve(`./test/_ui5-app/${randomBytes(5).toString("hex")}`)
  await copyUI5app(t.context.tmpDir)
 
  // dynamic port allocation for ui5 serve

packages/ui5-middleware-approuter/test/crud.test.js

@@ -1,8 +1,6 @@
-const crypto = require("crypto")
+const { randomBytes } = require("crypto")
 const fs = require("fs-extra")
-const nock = require("nock")
 const path = require("path")
-const replace = require("replace-in-file")
 const request = require("supertest")
 const { spawn } = require("child_process")
 const test = require("ava")
@@ -13,7 +11,7 @@ const prepUI5ServerConfig = require("./_prep_server_util")
 
 test.beforeEach(async (t) => {
  // copy ui5 app to a temp dir in test folder scope
- t.context.tmpDir = path.resolve(`./test/_ui5-app/${crypto.randomBytes(5).toString("hex")}`)
+ t.context.tmpDir = path.resolve(`./test/_ui5-app/${randomBytes(5).toString("hex")}`)
  await copyUI5app(t.context.tmpDir)
 
  // dynamic port allocation for ui5 serve
@@ -66,7 +64,7 @@ test("crud commands (GET, POST, PUT, DELETE)", async (t) => {
  t.true(respGET.body.value.length > 0, "Entries found")
 
  // create new person
- const user = `pimue${crypto.randomBytes(5).toString("hex")}`
+ const user = `pimue${randomBytes(5).toString("hex")}`
  const respPOST = await app
  .post("/backend/People")
  .send({

packages/ui5-middleware-approuter/test/crud/ui5.yaml

@@ -4,7 +4,7 @@ metadata:
 type: application
 framework:
  name: OpenUI5
- version: "1.126.0"
+ version: "1.127.0"
  libraries:
  - name: sap.m
  - name: sap.ui.core