@sap/cds-dk 4.6.3 → 4.7.3

package/lib/init/template/hana/index.js

@@ -22,11 +22,11 @@ module.exports = class HanaTemplate extends TemplateBase {
 
         const env = await this.getEnv();
 
-        const hdiConfigPath = path.join(this.projectPath, env.folders.db, 'src/.hdiconfig');
-        if (await this.fsUtil.pathExists(hdiConfigPath)) {
-            const configFilePath = path.join(env.folders.db, 'src/.hdiconfig');
-            throw new Error(`Database config file ${configFilePath} already exists. Use --force to overwrite.`);
-        }
+        await Promise.all(['src/.hdiconfig', 'undeploy.json'].map(async(filePath) => {
+            if (await this.fsUtil.pathExists(path.join(this.projectPath, env.folders.db, filePath))) {
+                throw new Error(`File ${path.join(env.folders.db, filePath)} already exists. Use --force to overwrite.`);
+            }
+        }))
 
         return true;
     }

package/lib/init/template/lint/index.js

@@ -9,10 +9,15 @@ const readline = require("readline");
 
 const { OPTION_LINT_DEV, OPTION_LINT_GLOBAL } = require("../../constants");
 const { mkdirp, fs } = require("@sap/cds/lib/utils");
-const { getConfigPath } = require("@sap/eslint-plugin-cds/lib/api");
+const { getConfigPath, getFileExtensions } = require("@sap/eslint-plugin-cds/lib/api");
 const generators = require("../../../lint/generators");
 
 const IS_WIN = os.platform() === "win32";
+const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
+const VSCODE_FILE_ASSOCIATIONS = {
+  "csv": [ "csv", "csv (semicolon)", "tsv", "tab" ]
+}
+
 module.exports = class LintTemplate extends TemplateBase {
   constructor(projectPath, generator) {
     super(projectPath, generator, __dirname);
@@ -68,10 +73,21 @@ module.exports = class LintTemplate extends TemplateBase {
       }
 
       // Generate VS Code extension settings
+      const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => {
+        return path.extname(ext).replace('.', '');
+      })
+      extensions.forEach((ext) => {
+        if (ext in VSCODE_FILE_ASSOCIATIONS) {
+          VSCODE_FILE_ASSOCIATIONS[ext].forEach((assoc) => {
+            extensions.push(assoc)
+          })
+        }
+      });
       await io.sanitizeVscodeSettings(
         this.projectPath,
         path.join(this.projectPath, ".vscode/settings.json"),
         this.lintType,
+        extensions,
         this.customRuleExample
       );
     }

package/lib/init/template/mta/files/mta.yaml.hbs

@@ -13,7 +13,12 @@ build-parameters:
   before-all:
    - builder: custom
      commands:
+{{#cap.isNodejs}}
+      - npm ci
+{{/cap.isNodejs}}
+{{#cap.isJava}}
       - npm install --production
+{{/cap.isJava}}
       - npx -p @sap/cds-dk cds build --production
 
 {{! This template creates one or two deployable modules:
@@ -30,6 +35,8 @@ modules:
 {{#cap.isNodejs}}
    parameters:
      buildpack: nodejs_buildpack
+   build-parameters:
+     builder: npm-ci
 {{/cap.isNodejs}}
 {{#cap.isJava}}
    parameters:
@@ -207,11 +214,11 @@ resources:
    type: org.cloudfoundry.managed-service
    requires:
       - name: {{cap.appName}}-uaa-mt
-      - name: mtx-api 
-        properties: 
-           prop: ~{mtx-url} 
-        parameters: 
-           param: ~{mtx-url} 
+      - name: mtx-api
+        properties:
+           prop: ~{mtx-url}
+        parameters:
+           param: ~{mtx-url}
    parameters:
       service: saas-registry
       service-plan: application

package/lib/init/util/fsUtil.js

@@ -18,7 +18,7 @@ module.exports = class FsUtil {
         await fse.outputFile(filepath, content, UTF_8);
     }
 
-    async writeJSON(filepath, object, options = { spaces: 4 }, skipFileLog = false) {
+    async writeJSON(filepath, object, options = { spaces: 2 }, skipFileLog = false) {
         if (!skipFileLog) {
             this._addTouchedFile(filepath);
         }

package/lib/init/util/mvnArchetypeUtil.js

@@ -31,7 +31,9 @@ class MvnArchetypeUtil {
 
         params.set('-B');
 
-        defaultLogger.isDebug && params.set('-X');
+        if (defaultLogger.isDebug) {
+            params.set('-X'); params.set('-e');
+        }
 
         return Array.from(params, (e) => {
             let result = e[0];

package/lib/lint/Linter.js

@@ -23,7 +23,6 @@ class Linter {
     this.eslintCmdOpts = {};
     this.eslintCmdOptsIndex = 0;
     this.eslintCmdFileExpr = "";
-    this.formatter = false;
     this.isFile = false;
     this.help = "";
     this.debug = "";
@@ -141,7 +140,7 @@ class Linter {
 
   _addExtensions() {
     // Add CDS file extensions to lint
-    const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => ext.replace('*.', '.'));
+    const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => path.extname(ext));
     this.eslintCmdOpts = io.mergeWithUserOpts(
       this.eslintCmdOpts,
       "ext",

package/lib/lint/io.js

@@ -22,7 +22,7 @@ module.exports = {
       case ".eslintrc.js":
       case ".eslintrc.cjs":
         try {
-          config = JSON.parse(configString.replace(/^module\.exports =/, ""));
+          config = JSONC.parse((configString.replace(/^module\.exports =/, "")));
         } catch (err) {
           config = {};
         }
@@ -33,7 +33,7 @@ module.exports = {
         break;
       case ".eslintrc.json":
       case ".eslintrc":
-        config = JSON.parse(await fsp.readFile(configPath, "utf8"));
+        config = await fsUtil.readJSONC(configPath);
         break;
       case "package.json":
         config = JSON.parse(await fsp.readFile(configPath, "utf8"));
@@ -201,18 +201,9 @@ module.exports = {
    * (3) "Global" case adds configFile and removes rulePaths
    * @param {*} settingsPath VS Code settings file
    */
-  async sanitizeVscodeSettings(projectPath, settingsPath, lintType, customRuleExample = false) {
+  async sanitizeVscodeSettings(projectPath, settingsPath, lintType, lintFileTypes, customRuleExample = false) {
     let settings = (await this.readVscodeSettings(settingsPath)) || {};
-    const lintFileTypes = ["cds", "csn"];
     const rulePaths = [path.join(".eslint/rules")];
-    const configFile = path.join(__dirname, ".eslintrc.js");
-
-    function _addArrayOrString(array) {
-      if (array.length === 1) {
-        return array[0];
-      }
-      return array;
-    }
 
     if (settings["eslint.validate"]) {
       settings["eslint.validate"] = this.mergeArrays(settings["eslint.validate"], lintFileTypes);

package/lib/watch/node-watch.js

@@ -1,3 +1,5 @@
+const DEBUG = /\bwatch\b/.test(process.env.DEBUG) && console.debug
+
 module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, options={} })=>{
 
   let child
@@ -5,19 +7,23 @@ module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, option
   // Phoning home...
   const EventEmitter = require('events')
   const emitter = new EventEmitter
-  process.on('exit', () => { gracefullyKill (child);  emitter.emit('quit') })
+  process.on('exit', () => { _kill (child);  emitter.emit('quit') })
 
   // Re-starting child process...
   const { fork } = require('child_process')
-  const restart = (evt, name)=>{
-    gracefullyKill (child, () => {
+  const restart = _coalesceEvents(delay, (events) => {
+    DEBUG && DEBUG('>> Events:', events)
+    _kill (child, () => {
       const execArgv = [...process.execArgv]
-      if (evt && evt.startsWith('--')) execArgv.push(evt)
-      if (name && name.startsWith('--')) execArgv.push(name)
+      events.forEach(evt => {
+        if (evt.type && evt.type.startsWith('--')) execArgv.push(evt.type)
+        if (evt.name && evt.name.startsWith('--')) execArgv.push(evt.name)
+      })
       if (options.debug) execArgv.push('--inspect')
       if (options['debug-brk']) execArgv.push('--inspect-brk')
-      const files = evt === "update" ? [ name ] : undefined
-      emitter.emit ('restart', files)
+
+      const updated = events.filter(evt => evt.type && evt.type === 'update').map(evt => evt.name)
+      emitter.emit ('restart', updated)
       child = fork (script, { cwd, env, stdio:'inherit', execArgv }, (err)=>{
         if (err) console.error (err)
       })
@@ -26,14 +32,16 @@ module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, option
         emitter.emit('message', msg)
       })
     })
-  }
+
+  })
+
   restart()
 
   // Watching for touched files...
   const watch = require('node-watch')
   const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$`)
   const filter = f => !ignore.test(f) && include.test(f)
-  watch (process.cwd(),{ recursive:true, filter, delay }, restart)
+  watch (process.cwd(),{ recursive:true, filter, delay:0 }, restart)
 
   // Live commands...
   const readline = require('readline')
@@ -44,12 +52,12 @@ module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, option
     else if (input === 'break' || input === 'brk')  restart('--inspect-brk')
     else if (input === 'debug-brk')  restart('--inspect-brk')
     else if (input === 'ps') ps(child,env)
-    else if (input === 'bye' || input.match(/^n$/i)) { gracefullyKill (child, () => process.exit())  }
+    else if (input === 'bye' || input.match(/^n$/i)) { _kill (child, () => process.exit())  }
     else console.log ('?\n')
   })
 
   emitter.restart = restart
-  emitter.stop    = () => { gracefullyKill(child, () => false); child = undefined; }
+  emitter.stop    = () => { _kill(child, () => false); child = undefined; }
   emitter.setEnv = (name, value) => {
     if (typeof value === "undefined") {
       delete env[name]
@@ -67,14 +75,32 @@ const ps = (child,env) => console.log (`\x1b[32m
   \x1b[0m`
 )
 
-// On Windows, kill() abruptly kills the child process (https://nodejs.org/api/child_process.html#subprocesskillsignal)
-// Send a custom message an wait a bit to give cleanup code a chance to execute.
-const isWindows = (process.platform === 'win32')
-const waitTime = parseInt(process.env.CDS_WATCH_KILL_DELAY) || (isWindows ? 500 : 0)
-function gracefullyKill (proc, fn=()=>{}) {
-  if (proc)  {
-    proc.send({ exit: true }, () => { /* ignore */ })
-    setTimeout(()=> { proc.kill(); fn()}, waitTime)
+// reduces mutiple node-watch events in a time frame into a bulk
+function _coalesceEvents(delay, fn) {
+  let timer, cache = []
+  function handle() {
+    fn(cache)
+    timer = null
+    cache = []
+  }
+  return function(type, name) { // node-watch callback signature
+    cache.push({type, name})
+    if (!timer) {
+      timer = setTimeout(handle, delay);
+    }
+  }
+}
+
+function _kill (proc, fn=()=>{}) {
+  if (!proc)  return fn()
+
+  // On Windows, child_process.kill() abruptly kills the process (https://nodejs.org/api/child_process.html#subprocesskillsignal)
+  // Server has cleanup code to run, so send a custom message and give it a bit time.
+  if (process.platform === 'win32') {
+    proc.send({ exit: true }, () => {})
+    const waitTime = parseInt(process.env.CDS_WATCH_KILL_DELAY) || 500
+    setTimeout(()=> { proc.kill(); fn() }, waitTime)
+  } else {
+    proc.kill(); fn()
   }
-  else fn()
 }