@sap/cds-dk 8.9.5 → 9.0.5

package/lib/lint/generators.js

@@ -1,36 +1,36 @@
-const os = require("os");
-const cp = require("child_process");
-const term = require("../util/term");
+const os = require('node:os')
+const cp = require('node:child_process')
+const term = require('../util/term')
 
-const IS_WIN = os.platform() === "win32";
-
-const REGEX_FLAGS = /--[a-z,a-z-]+[,\s+]\s+/gm;
-const REGEX_OPTIONS = /--[a-z,a-z-]+\s[^\s]/gm;
-const REGEX_SHORTCUT_MAPPINGS = /\s-[a-zA-Z]+, --[a-zA-Z-]+/gm;
+const IS_WIN = os.platform() === 'win32'
+const REGEX_FLAGS = /--[a-z,a-z-]+[,\s+]\s+/gm
+const REGEX_OPTIONS = /--[a-z,a-z-]+\s[^\s]/gm
+const REGEX_SHORTCUT_MAPPINGS = /\s-[a-zA-Z]+, --[a-zA-Z-]+/gm
 
 module.exports = {
   /**
    * Generates `cds lint` help string to print when calling `cds lint [-h, --help]`
    * by getting available options/shortcuts from installed version of ESLint
-   * @returns `cds lint` help string
+   * @param {string} eslintCmd - ESLint command to call
+   * @returns {string} `cds lint` help string
    */
   genEslintHelp: function (eslintCmd) {
-    let eslintHelp;
+    let eslintHelp
     try {
       eslintHelp = cp
         .execSync(`${eslintCmd} -h`, {
           cwd: process.cwd(),
           shell: IS_WIN,
-          stdio: "pipe",
+          stdio: 'pipe',
         })
-        .toString();
-    } catch (err) {
+        .toString()
+    } catch {
       console.log(
-        `${term.error("Cannot call 'eslint -h', install and try again.")}\n`
-      );
+        `${term.error('Cannot call "eslint -h", install and try again.')}\n`
+      )
     }
-    let eslintOpts = eslintHelp.split("\n");
-    let cdslintCmd = eslintOpts[0].replace("eslint", "*cds lint*");
+    const eslintOpts = eslintHelp.split('\n')
+    const cdslintCmd = eslintOpts[0].replace('eslint', '*cds lint*')
     eslintOpts[0] = `
         # SYNOPSIS
 
@@ -39,8 +39,8 @@ module.exports = {
             Runs environment checks and/or checks the specified models
             based on the ESLint framework
 
-        # OPTIONS`;
-    return `${eslintOpts.join("\n    ")}\n`;
+        # OPTIONS`
+    return `${eslintOpts.join('\n    ')}\n`
   },
 
   /**
@@ -49,38 +49,45 @@ module.exports = {
    * Shortcut order must match order of [options, flags]
    * Any options without an shortcut must act as filler (undefined)
    * until the shortcuts for the flags start
-   * @param help help string and shortcuts array for `cds lint`
-   * @param flags help string and shortcuts array for `cds lint`
-   * @returns `cds lint` allowed options
+   * @param {string} help - help string and shortcuts array for `cds lint`
+   * @param {string[]} flags help string and shortcuts array for `cds lint`
+   * @returns {{
+   *  help: string,
+   *  options: string[],
+   *  shortcuts: string[],
+   *  flags: string[]
+   * }} `cds lint` allowed options
    */
   genEslintShortcutsAndOpts: function (help, flags) {
     const allOptions = help
       .match(REGEX_OPTIONS)
-      .map((str) => str.split(' ')[0].trim().replace(",", ""));
+      .map((str) => str.split(' ')[0].trim().replace(',', ''))
     const shortcutMappings = help
       .match(REGEX_SHORTCUT_MAPPINGS)
-      .map((str) => str.trim().split(/,\s?/));
-    let optionsWithShortcuts = [];
-    let shortcuts = [];
-    let shortcutsForFlags = [];
-    shortcutMappings.forEach((m) => {
-      if (!flags.includes(m[1])) {
-        optionsWithShortcuts.push(m[1]);
-        shortcuts.push(m[0]);
+      .map((str) => str.trim().split(/,\s?/))
+    const optionsWithShortcuts = []
+    /** @type {string[]} */
+    let shortcuts = []
+    const shortcutsForFlags = []
+    shortcutMappings.forEach(([short, long]) => {
+      if (!flags.includes(long)) {
+        optionsWithShortcuts.push(long)
+        shortcuts.push(short)
       } else {
-        const index = flags.indexOf(m[1]);
-        flags.splice(index, 1);
-        flags.unshift(m[1]);
-        shortcutsForFlags.unshift(m[0]);
+        const index = flags.indexOf(long)
+        flags.splice(index, 1)
+        flags.unshift(long)
+        shortcutsForFlags.unshift(short)
       }
-    });
-    const optionsWithoutShortcuts = allOptions.filter((o) => !optionsWithShortcuts.includes(o));
+    })
+    const optionsWithoutShortcuts = allOptions.filter((o) => !optionsWithShortcuts.includes(o))
     optionsWithoutShortcuts.forEach(() => {
       shortcuts.push(undefined)
-    });
-    let options = optionsWithShortcuts.concat(optionsWithoutShortcuts);
-    shortcuts = shortcuts.concat(shortcutsForFlags);
-    return [help, options, shortcuts, flags];
+    })
+    /** @type {string[]} */
+    const options = optionsWithShortcuts.concat(optionsWithoutShortcuts)
+    shortcuts = shortcuts.concat(shortcutsForFlags)
+    return [help, options, shortcuts, flags]
   },
 
   /**
@@ -90,8 +97,7 @@ module.exports = {
    * @param help string from `cds lint [-h, --help]`
    * @returns ESLint flags
    */
-  genEslintFlags: function (help) {
-    return help.match(REGEX_FLAGS).map((str) => str.trim().replace(",", ""));
-  }
-
-};
+  genEslintFlags: help => help
+    .match(REGEX_FLAGS)
+    .map(str => str.trim().replace(',', ''))
+}

package/lib/lint/io.js

@@ -1,271 +1,93 @@
-const { read, write, exists, yaml } = require('../cds').utils;
-const cds = require("../cds");
+const { write, exists } = require('../cds').utils
+const cds = require('../cds')
 
-const { readJSONC } = require("../util/fs");
-const path = require("path");
-const term = require("../util/term");
-const JSONC = require('../util/jsonc');
+const { readJSONC } = require('../util/fs')
+const path = require('node:path')
+const term = require('../util/term')
 
-const { COMMAND_INIT } = require("../init/constants");
+const { pathToFileURL } = require('node:url')
 
-module.exports = {
-  /**
-   * Reads ESLint config contents from file
-   * @param {*} configPath config file path to read from
-   * @returns {object[] | object} config file contents
-   */
-  async readEslintConfigLegacy(configPath) {
-    let config;
-    const configFile = path.basename(configPath);
-    const configString = await read(configPath, "utf8");
-    switch (configFile) {
-      case ".eslintrc.js":
-      case ".eslintrc.cjs":
-        try {
-          config = JSONC.parse((configString.replace(/^module\.exports =/, "")));
-        } catch {
-          config = {};
-        }
-        break;
-      case ".eslintrc.yaml":
-      case ".eslintrc.yml":
-        config = yaml.parse(await read(configPath, "utf8"));
-        break;
-      case ".eslintrc.json":
-      case ".eslintrc":
-        config = await readJSONC(configPath);
-        break;
-      case "package.json":
-        config = await read(configPath, "json");
-        if ("eslintConfig" in config) {
-          config = config["eslintConfig"];
-        } else {
-          config = {}
-        }
-        break;
-      default:
-        break;
-    }
-    return config;
-  },
+const { COMMAND_INIT } = require('../init/constants')
 
-  /**
+const installationHint = (logger, configFile, importStatement) => logger.log(
+  `${term.warn(
+    `\n\nPlease add the following to your '${configFile}':` +
+    '\n\n  1. At the top of your file, import the following:')}` +
+    `\n\n     ${term.bold(importStatement)}` +
+  `${term.warn(
+    '\n\n  2. In your export, add the following to the front of the array:')}` +
+  `\n\n     ${term.bold('cdsPlugin.configs.recommended')}`
+)
+
+module.exports = {
+ /**
  * Reads ESLint config contents from file
- * @param {*} configPath config file path to read from
- * @returns config file contents
+ * @param {import('fs').PathLike} configPath config file path to read from
+ * @returns {Promise<object>} config file contents
  */
   async readEslintConfig(configPath) {
-    let config;
+    let config
     switch (path.basename(configPath)) {
-      case "eslint.config.mjs":
-        try { config = await import (configPath) } catch { config = null }
+      case 'eslint.config.mjs':
+        // pathToFileURL is used to convert the path to a file URL on Windows
+        try { config = (await import (pathToFileURL(configPath))).default } catch(e) { config = null }
         break
-      case "eslint.config.js":
-      case "eslint.config.cjs":
+      case 'eslint.config.js':
+      case 'eslint.config.cjs':
         try { config = require (configPath) } catch { config = null }
     }
-    return config;
+    return config
   },
 
   /**
    * Checks ESLint config file contents for locally installed
    * plugin with:
-   * (1) All CDS recommended rules "on"
+   * (1) All CDS recommended rules 'on'
    * (2) Add's custom rule example 'no-entity-moo' if requested
-   * @param {*} configPath ESLint config file
-   * @returns {void}
+   * @param {object | string} configPath - ESLint config file or path
+   * @param {import('console').Console} logger - logger to use
+   * @returns {object}
    */
-  async sanitizeEslintConfig(configIn, customRuleExample = false, logger = console) {
-    let configContents;
-    const isFilePath = typeof configIn === "string";
+  async sanitizeEslintConfig(configIn, logger = console) {
+    let configContents
+    const isFilePath = typeof configIn === 'string'
     if (isFilePath) {
       configContents = await this.readEslintConfig(configIn)
     }
 
-    configContents ??= { ...configIn };
-
-    if (customRuleExample) {
-      const ruleName = "no-entity-moo";
-      const ruleValue = 2;
-      if ("rules" in configContents) {
-        configContents["rules"][ruleName] = ruleValue;
-      } else {
-        configContents["rules"] = { [ruleName]: ruleValue };
-      }
-    }
+    configContents ??= { ...configIn }
     if (isFilePath) {
-      await this.writeEslintConfig(configIn, cds.cli?.command === COMMAND_INIT, logger);
-    }
-    return configContents;
-  },
-
-  /**
- * Checks ESLint config file contents for locally installed
- * plugin with:
- * (1) All CDS recommended rules "on"
- * (2) Option "root": false to stop further config merging
- * (3) Add's custom rule example 'no-entity-moo' if requested
- * @param {*} configPath ESLint config file
- */
-  async sanitizeEslintConfigLegacy(configIn, customRuleExample = false, logger = console) {
-    let configContents = {};
-    const isFilePath = typeof configIn === "string";
-    if (isFilePath) {
-      if (exists(configIn)) {
-        configContents = (await this.readEslintConfig(configIn)) || {};
-      }
-    } else {
-      configContents = { ...configIn };
-    }
-    const configType = "recommended";
-    const extendsValue = `plugin:@sap/cds/${configType}`;
-    if ("extends" in configContents) {
-      if (Array.isArray(configContents["extends"])) {
-        if (!configContents["extends"].includes(extendsValue)) {
-          configContents["extends"].push(extendsValue);
-        }
-      } else if (configContents["extends"] !== extendsValue) {
-        configContents["extends"] = [configContents["extends"], extendsValue];
-      }
-    } else {
-      configContents["extends"] = extendsValue;
-    }
-    if ("root" in configContents) {
-      configContents["root"] = false;
-    }
-    if (customRuleExample) {
-      const ruleName = "no-entity-moo";
-      const ruleValue = 2;
-      if ("rules" in configContents) {
-        configContents["rules"][ruleName] = ruleValue;
-      } else {
-        configContents["rules"] = { [ruleName]: ruleValue };
-      }
-    }
-    if (isFilePath) {
-      await this.writeEslintConfigLegacy(configIn, configContents, logger);
-    }
-    return configContents;
-  },
-
-
-  /**
-   * Writes ESLint config contents to file
-   * @param {*} configContents config file contents
-   * @param {*} configPath config file path to write to
-   * @returns {Promise<void>}
-   */
-  async writeEslintConfigLegacy(configPath, configContents, logger = console) {
-    const configType = "recommended-legacy";
-    const extendsValue = `plugin:@sap/cds/${configType}`;
-    let contents = {};
-    let configFile = path.basename(configPath);
-    let configToAdd = {};
-    switch (configFile) {
-      case ".eslintrc.js":
-      case ".eslintrc.cjs":
-        try {
-          configContents = await this.readEslintConfigLegacy(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":
-        await write(configPath, yaml.stringify(configContents));
-        break;
-      case ".eslintrc.json":
-      case ".eslintrc":
-        await write(configPath, configContents, { spaces: 2 });
-        break;
-      case "package.json":
-        if (exists(configPath)) {
-          contents = await read(configPath, "json");
-        } else {
-          contents = {};
-        }
-        if (!("eslintConfig" in configContents)) {
-          contents["eslintConfig"] = configContents;
-        } else {
-          contents["eslintConfig"] = [...configContents, ...contents["eslintConfig"]];
-        }
-        await write(configPath, contents, { spaces: 2 });
-        break;
-      default:
-        break;
+      await this.writeEslintConfig(configIn, cds.cli?.command === COMMAND_INIT, logger)
     }
+    return configContents
   },
 
   /**
    * Suggest ESLint config contents to file
    * @param {*} configContents config file contents
-   * @param {*} configPath config file path to write to
+   * @param {import('node:fs').PathLike} configPath config file path to write to
    * @returns {Promise<void>}
    */
   async writeEslintConfig(configPath, force = false, logger = console) {
-    let configFile = path.basename(configPath);
+    let configFile = path.basename(configPath)
     switch (configFile) {
-      case "eslint.config.js":
-      case "eslint.config.cjs":
+      case 'eslint.config.js':
+      case 'eslint.config.cjs':
         if (!force && exists(configPath)) {
-          logger.log(
-            `${term.warn(
-              `\n\nPlease add the following to your "${configFile}":` +
-              '\n\n  1. At the top of your file, import the following:')}` +
-            `\n\n     ${term.bold('const cds = require(\'@sap/eslint-plugin-cds\')')}` +
-            `${term.warn(
-              '\n\n  2. In your export, add the following to the top of the array:')}` +
-            `\n\n     ${term.bold('cds.configs.recommended')}`
-          );
+          installationHint(logger, configFile, 'const cdsPlugin = require(\'@sap/eslint-plugin-cds\')')
         } else {
           await write(configPath, `
 const cds = require('@sap/eslint-plugin-cds')
 
-module.exports = [
-  cds.configs.recommended,
-  {
-    plugins: {
-      '@sap/cds': cds
-    },
-    files: [
-      ...cds.configs.recommended.files
-    ],
-    rules: {
-      ...cds.configs.recommended.rules
-    }
-  }
-]
+module.exports = [...cds.recommended, cdsPlugin.configs.recommended]
 `)
         }
-        break;
-      case "eslint.config.mjs":
+        logger.log(term.warn('\nMake sure to also run npm i to install the newly added dependencies.'))
+        break
+
+      case 'eslint.config.mjs':
         if (!force && exists(configPath)) {
-          logger.log(
-            `${term.warn(
-              `\n\nPlease add the following to your "${configFile}":` +
-              '\n\n  1. At the top of your file, import the following:')}` +
-              `\n\n     ${term.bold('import cdsPlugin from \'@sap/eslint-plugin-cds\'')}` +
-            `${term.warn(
-              '\n\n  2. In your export, add the following to the front of the array:')}` +
-            `\n\n     ${term.bold('cdsPlugin.configs.recommended')}`
-          );
+          installationHint(logger, configFile, 'import cdsPlugin from \'@sap/eslint-plugin-cds\'')
         } else {
           await write(configPath, `
 import cds from '@sap/cds/eslint.config.mjs'
@@ -274,9 +96,8 @@ import cdsPlugin from '@sap/eslint-plugin-cds'
 export default [...cds.recommended, cdsPlugin.configs.recommended]
 `)
         }
-        break;
-      default:
-        break;
+        logger.log(term.warn('\nMake sure to also run npm i to install the newly added dependencies.'))
+        break
     }
   },
 
@@ -286,15 +107,15 @@ export default [...cds.recommended, cdsPlugin.configs.recommended]
    * @returns settings file contents
    */
   async readVscodeSettings(settingsPath) {
-    let settings;
+    let settings
     if (exists(settingsPath)) {
       try {
-        settings = await readJSONC(settingsPath);
-      } catch (err) {
-        settings = {};
+        settings = await readJSONC(settingsPath)
+      } catch {
+        settings = {}
       }
     }
-    return settings;
+    return settings
   },
 
   /**
@@ -304,71 +125,38 @@ export default [...cds.recommended, cdsPlugin.configs.recommended]
    * @returns merged array (without duplicates)
    */
   mergeArrays(array, arrayToMerge) {
-    let arrayMerged = array.concat(arrayToMerge);
-    if (typeof array === "string") {
-      array = [array];
+    let arrayMerged = array.concat(arrayToMerge)
+    if (typeof array === 'string') {
+      array = [array]
     }
-    if (typeof arrayToMerge === "string") {
-      arrayToMerge = [arrayToMerge];
+    if (typeof arrayToMerge === 'string') {
+      arrayToMerge = [arrayToMerge]
     }
-    arrayMerged = [...new Set([...array, ...arrayToMerge])];
-    return arrayMerged;
+    arrayMerged = [...new Set([...array, ...arrayToMerge])]
+    return arrayMerged
   },
 
   /**
    * Add VS Code ESLint extension settings required for CDS linting:
    * (1) Extension file types: [cds, csn]
-   * (2) "Custom" case adds rulePaths and removes configFile
-   * (3) "Global" case adds configFile and removes rulePaths
+   * (2) 'Custom' case adds rulePaths and removes configFile
+   * (3) 'Global' case adds configFile and removes rulePaths
    * @param {*} settingsPath VS Code settings file
    */
-  async sanitizeVscodeSettings(settingsPath, lintType, lintFileTypes, customRuleExample = false) {
-    let settings = (await this.readVscodeSettings(settingsPath)) || {};
-    const rulePaths = [path.join(".eslint/rules")];
+  async sanitizeVscodeSettings(settingsPath, lintFileTypes, customRuleExample = false) {
+    const settings = (await this.readVscodeSettings(settingsPath)) ?? {}
+    const rulePaths = [path.join('.eslint/rules')]
 
-    if (settings["eslint.validate"]) {
-      settings["eslint.validate"] = this.mergeArrays(settings["eslint.validate"], lintFileTypes);
-    } else {
-      settings["eslint.validate"] = lintFileTypes;
-    }
+    settings['eslint.validate'] = settings['eslint.validate']
+      ? this.mergeArrays(settings['eslint.validate'], lintFileTypes)
+      : lintFileTypes
 
-    if (lintType === "local") {
-      if (settings["eslint.options"]) {
-        if (customRuleExample) {
-          settings["eslint.options"]["rulePaths"] = rulePaths;
-        }
-      } else {
-        if (customRuleExample) {
-          settings["eslint.options"] = {
-            rulePaths: rulePaths,
-          };
-        }
-      }
+    if (settings['eslint.options'] && customRuleExample) {
+      settings['eslint.options'].rulePaths = rulePaths
+    } else if (customRuleExample) {
+      settings['eslint.options'] = { rulePaths: rulePaths }
     }
 
-    await write(settingsPath, settings, { spaces: 2 });
-  },
-
-  /**
-   * Joins or creates prescribed options with that of user
-   * - Value for 'config' key will be overwritten if assigned by `cds lint`
-   * @param {*} propKey option key property
-   * @param {*} propsToAdd option values to add for key property
-   * @returns {void}
-   */
-  mergeWithUserOpts(userOpts, propKey = "", propsToAdd = "") {
-    if (propsToAdd) {
-      if (Object.keys(userOpts).includes(propKey)) {
-        if (!["config", "format"].includes(propKey)) {
-          propsToAdd = this.mergeArrays(userOpts[propKey].split(","), propsToAdd.split(",")).join(
-            ","
-          );
-        }
-      }
-      userOpts[propKey] = propsToAdd;
-    } else {
-      userOpts[propKey] = true;
-    }
-    return userOpts;
+    await write(settingsPath, settings, { spaces: 2 })
   },
-};
+}

package/lib/util/fs.js

@@ -1,4 +1,5 @@
-const { read, write, yaml: YAML } = require('../cds').utils
+const YAML = require('yaml')
+const { read, write } = require('../cds').utils
 const JSONC = require('./jsonc');
 
 // REVISIT: Consider merging with template util

package/lib/util/git.js

@@ -5,7 +5,7 @@ const util = require('util');
 const os = require('os');
 
 const cds = require('../cds');
-const DEBUG = cds.debug('cli');
+const DEBUG = /\b(y|all|cli)\b/.test (process.env.DEBUG) ? ((..._) => console.debug ('[cli] -', ..._)) : undefined
 
 const GIT_IGNORE_FILE = '.gitignore';