@sap/cds-dk 4.6.0 → 4.7.1

package/lib/lint/io.js

@@ -33,14 +33,14 @@ module.exports = {
         break;
       case ".eslintrc.json":
       case ".eslintrc":
+        config = JSON.parse(await fsp.readFile(configPath, "utf8"));
+        break;
       case "package.json":
-        try {
-          config = JSON.parse(await fsp.readFile(configPath, "utf8"));
-          if (configFile === "package.json" && "eslintConfig" in config) {
-            config = config["eslintConfig"];
-          }
-        } catch (err) {
-          // Do nothing
+        config = JSON.parse(await fsp.readFile(configPath, "utf8"));
+        if ("eslintConfig" in config) {
+          config = config["eslintConfig"];
+        } else {
+          config = {}
         }
         break;
       default:
@@ -71,7 +71,9 @@ module.exports = {
           configContents["extends"].push(extendsValue);
         }
       } else {
-        configContents["extends"] = [configContents["extends"], extendsValue];
+        if (configContents["extends"] !== extendsValue) {
+          configContents["extends"] = [configContents["extends"], extendsValue];
+        }
       }
     } else {
       configContents["extends"] = extendsValue;
@@ -136,21 +138,20 @@ module.exports = {
         break;
       case ".eslintrc.json":
       case ".eslintrc":
+        await fsUtil.writeFile(configPath, `${JSON.stringify(configContents, null, 2)}`);
+        break;
       case "package.json":
-        if (configFile === "package.json") {
-          if (await fsp.access(configPath)) {
-            contents = JSON.parse(await fsp.readFile(configPath, "utf8"));
-          } else {
-            contents = {};
-          }
-          if (!("eslintConfig" in configContents)) {
-            contents["eslintConfig"] = configContents;
-          } else {
-            contents["eslintConfig"] = [...configContents, ...contents["eslintConfig"]];
-          }
-          configContents = contents;
+        if (await fsUtil.pathExists(configPath)) {
+          contents = JSON.parse(await fsp.readFile(configPath, "utf8"));
+        } else {
+          contents = {};
         }
-        await fsUtil.writeFile(configPath, `${JSON.stringify(configContents, null, 2)}`);
+        if (!("eslintConfig" in configContents)) {
+          contents["eslintConfig"] = configContents;
+        } else {
+          contents["eslintConfig"] = [...configContents, ...contents["eslintConfig"]];
+        }
+        await fsUtil.writeFile(configPath, `${JSON.stringify(contents, null, 2)}`);
         break;
       default:
         break;
@@ -200,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 })
-    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()
 }