@sap/cds-dk 4.5.3 → 4.6.3

package/lib/lint/io.js

@@ -1,7 +1,8 @@
 const os = require("os");
-const fs = require("fs");
+const fsp = require("fs").promises;
 const path = require("path");
 const yaml = require("@sap/cds-foss")("yaml");
+const term = require("../util/term");
 const FsUtil = require("../init/util/fsUtil");
 const fsUtil = new FsUtil();
 
@@ -13,28 +14,33 @@ module.exports = {
    * @param {*} configPath config file path to read from
    * @returns config file contents
    */
-  readEslintConfig(configPath) {
+  async readEslintConfig(configPath) {
     let config;
     let configFile = path.basename(configPath);
+    let configString = await fsp.readFile(configPath, "utf8");
     switch (configFile) {
       case ".eslintrc.js":
       case ".eslintrc.cjs":
-        config = require(configPath);
+        try {
+          config = JSON.parse(configString.replace(/^module\.exports =/, ""));
+        } catch (err) {
+          config = {};
+        }
         break;
       case ".eslintrc.yaml":
       case ".eslintrc.yml":
-        config = yaml.parse(fs.readFileSync(configPath, "utf8"));
+        config = yaml.parse(await fsp.readFile(configPath, "utf8"));
         break;
       case ".eslintrc.json":
       case ".eslintrc":
+        config = JSON.parse(await fsp.readFile(configPath, "utf8"));
+        break;
       case "package.json":
-        try {
-          config = JSON.parse(fs.readFileSync(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:
@@ -52,8 +58,11 @@ module.exports = {
    * @param {*} configPath ESLint config file
    * @returns {void}
    */
-  async sanitizeEslintConfig(configPath, customRuleExample=false) {
-    let configContents = this.readEslintConfig(configPath) || {};
+  async sanitizeEslintConfig(configPath, customRuleExample = false, logger = console) {
+    let configContents = {};
+    if (await fsUtil.pathExists(configPath)) {
+      configContents = (await this.readEslintConfig(configPath)) || {};
+    }
     const configType = "recommended";
     const extendsValue = `plugin:@sap/cds/${configType}`;
     if ("extends" in configContents) {
@@ -62,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;
@@ -79,7 +90,7 @@ module.exports = {
         configContents["rules"] = { [ruleName]: ruleValue };
       }
     }
-    await this.writeEslintConfig(configContents, configPath);
+    await this.writeEslintConfig(configPath, configContents, logger);
     return;
   },
 
@@ -89,16 +100,37 @@ module.exports = {
    * @param {*} configPath config file path to write to
    * @returns {void}
    */
-  async writeEslintConfig(configContents, configPath) {
+  async writeEslintConfig(configPath, configContents, logger=console) {
+    const configType = "recommended";
+    const extendsValue = `plugin:@sap/cds/${configType}`;
     let contents = {};
     let configFile = path.basename(configPath);
+    let configToAdd = {};
     switch (configFile) {
       case ".eslintrc.js":
       case ".eslintrc.cjs":
-        await fsUtil.writeFile(
-          configPath,
-          `module.exports = ${JSON.stringify(configContents, null, 2)}`
-        );
+        try {
+          configContents = await this.readEslintConfig(configPath);
+        } catch (err) {
+          configContents = {};
+        }
+        if (configContents && configContents["extends"]) {
+          if (
+            !configContents["extends"] === extendsValue ||
+            !configContents["extends"].includes(extendsValue)
+          ) {
+            configToAdd["extends"] = extendsValue;
+          }
+        } else {
+          configToAdd["extends"] = extendsValue;
+        }
+        if (configToAdd["extends"]) {
+          logger.log(
+            `${term.warn(
+              `\n\nPlease add the following to your "${configFile}":\n\nmodule.exports = ${JSON.stringify(configToAdd, null, 2)}`
+            )}\n`
+          );
+        }
         break;
       case ".eslintrc.yaml":
       case ".eslintrc.yml":
@@ -106,27 +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 (fs.existsSync(configPath)) {
-            contents = JSON.parse(fs.readFileSync(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;
@@ -141,8 +166,12 @@ module.exports = {
    */
   async readVscodeSettings(settingsPath) {
     let settings;
-    if (fs.existsSync(settingsPath)) {
-      settings = await fsUtil.readJSONC(settingsPath);
+    if (fsUtil.pathExists(settingsPath)) {
+      try {
+        settings = await fsUtil.readJSONC(settingsPath);
+      } catch (err) {
+        settings = {};
+      }
     }
     return settings;
   },
@@ -186,10 +215,7 @@ module.exports = {
     }
 
     if (settings["eslint.validate"]) {
-      settings["eslint.validate"] = this.mergeArrays(
-        settings["eslint.validate"],
-        lintFileTypes
-      );
+      settings["eslint.validate"] = this.mergeArrays(settings["eslint.validate"], lintFileTypes);
     } else {
       settings["eslint.validate"] = lintFileTypes;
     }
@@ -208,7 +234,7 @@ module.exports = {
       }
     }
 
-    await this.writeVscodeSettings(settings, settingsPath);
+    await this.writeVscodeSettings(settingsPath, settings);
   },
 
   /**
@@ -217,7 +243,7 @@ module.exports = {
    * @param {*} settingsPath settings file path to write to
    * @returns {void}
    */
-  async writeVscodeSettings(settings, settingsPath) {
+  async writeVscodeSettings(settingsPath, settings) {
     if (!settings) {
       await fsUtil.mkdirp(path.dirname(settingsPath));
     }
@@ -236,10 +262,9 @@ module.exports = {
     if (propsToAdd) {
       if (Object.keys(userOpts).includes(propKey)) {
         if (!["config", "format"].includes(propKey)) {
-          propsToAdd = this.mergeArrays(
-            userOpts[propKey].split(","),
-            propsToAdd.split(",")
-          ).join(",");
+          propsToAdd = this.mergeArrays(userOpts[propKey].split(","), propsToAdd.split(",")).join(
+            ","
+          );
         }
       }
       userOpts[propKey] = propsToAdd;

package/lib/util/term.js

@@ -8,6 +8,7 @@ const t = module.exports.codes = {
   link: '\x1b[4m', // underline
   red: '\x1b[91m', // Bright Foreground Red
   green: '\x1b[32m', // Foreground Green
+  blue: '\x1b[34m', // Foreground Blue
   orange: '\x1b[38;2;255;140;0m' // darker orange, works with bright and dark background
 }
 
@@ -24,6 +25,7 @@ module.exports.warn  = o => as(t.orange, o)
 module.exports.info  = o => as(t.green, o)
 module.exports.link  = o => as(t.link, o)
 module.exports.bold  = o => as(t.bold, o)
+module.exports.highlight  = o => as(t.blue,as(t.bold, o))
 
 const format = module.exports.format = (o, severity='Error', asInternalError=false, withStack=false) => {
   switch (severity) {

package/lib/watch/node-watch.js

@@ -5,28 +5,26 @@ module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, option
   // Phoning home...
   const EventEmitter = require('events')
   const emitter = new EventEmitter
-  process.on('exit', () => {
-    if (child)  child.kill()  // propagate exit to child
-    emitter.emit('quit') // listener might exit(), so expect this to be the last statement here
-  })
+  process.on('exit', () => { gracefullyKill (child);  emitter.emit('quit') })
 
   // Re-starting child process...
   const { fork } = require('child_process')
   const restart = (evt, name)=>{
-    const execArgv = [...process.execArgv]
-    if (child) child.kill()
-    if (evt && evt.startsWith('--')) execArgv.push(evt)
-    if (name && name.startsWith('--')) execArgv.push(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)
-    child = fork (script, { cwd, env, stdio:'inherit', execArgv }, (err)=>{
-      if (err) console.error (err)
-    })
-    child.on('message', msg => {
-      if (msg === 'restart') return restart()
-      emitter.emit('message', msg)
+    gracefullyKill (child, () => {
+      const execArgv = [...process.execArgv]
+      if (evt && evt.startsWith('--')) execArgv.push(evt)
+      if (name && name.startsWith('--')) execArgv.push(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)
+      child = fork (script, { cwd, env, stdio:'inherit', execArgv }, (err)=>{
+        if (err) console.error (err)
+      })
+      child.on('message', msg => {
+        if (msg === 'restart') return restart()
+        emitter.emit('message', msg)
+      })
     })
   }
   restart()
@@ -46,10 +44,19 @@ 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)) { child.kill(); process.exit() }
+    else if (input === 'bye' || input.match(/^n$/i)) { gracefullyKill (child, () => process.exit())  }
     else console.log ('?\n')
   })
 
+  emitter.restart = restart
+  emitter.stop    = () => { gracefullyKill(child, () => false); child = undefined; }
+  emitter.setEnv = (name, value) => {
+    if (typeof value === "undefined") {
+      delete env[name]
+    } else {
+      env[name]
+    }
+  }
   return emitter
 }
 
@@ -59,3 +66,15 @@ const ps = (child,env) => console.log (`\x1b[32m
   ${  child.pid}   child     cds ${JSON.parse(env._args).join(' ')}
   \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)
+  }
+  else fn()
+}