@sap/cds-dk 6.1.4 → 6.2.0

package/lib/init/util/projectReader.js

@@ -1,7 +1,8 @@
 const path = require('path')
 const { nullLogger } = require('../util/logger')
-const { BuildTaskFactory } = require('@sap/cds/bin/build')
-const { fs } = require('@sap/cds').utils
+const cds = require('../../cds')
+const { BuildTaskFactory } = cds.build
+const { fs } = cds.utils
 const P_LANGUAGE_JAVA = 'java'
 const P_LANGUAGE_NODEJS = 'nodejs'
 const DEFAULT_P_LANGUAGE = P_LANGUAGE_NODEJS
@@ -72,15 +73,13 @@ module.exports = class ProjectReader {
             requires: [],
             get isMultitenant() {
                 return options?.add?.has('mtx') || options?.add?.has('multitenancy') ||
-                    env.requires.multitenancy ||
-                    env.requires.db?.multiTenant ||
+                    env.requires.multitenancy || env.requires.db?.multiTenant ||
                     this.isJava && fs.existsSync(path.join('mtx', 'sidecar')) ||
                     false
             },
             get isExtensible() {
-                const sidecarPackage = path.join('mtx', 'sidecar', 'package.json')
                 return options?.add?.has('mtx') || options?.add?.has('extensibility') || env.requires.extensibility ||
-                    fs.existsSync(sidecarPackage) && JSON.parse(fs.readFileSync(sidecarPackage, 'utf8')).cds.requires.extensibility === true
+                    this.isJava && fs.existsSync('.cdsrc.json') && JSON.parse(fs.readFileSync('.cdsrc.json', 'utf8'))?.requires?.extensibility === true
             },
             get isNodejs() {
                 return this.pLanguage === P_LANGUAGE_NODEJS
@@ -100,14 +99,32 @@ module.exports = class ProjectReader {
             get hasXsuaa() {
                 return this.requires.some(({ resource }) => resource.isXsuaa)
             },
+            get hasAuditlog() {
+                return false // TODO: Need a `cds.requires.auditlog` or some other way to detect if enabled.
+            },
             get needsSidecar() {
-                return (options && options.add.has('hana') || this.db.length > 0) && (this.isJava || !this.isMultitenant)
+                return (options?.add.has('hana') || this.db.length > 0) && (this.isJava || !this.isMultitenant)
             },
             get hasApprouter() {
                 return !!env.requires.approuter
             },
+            get hasMessaging() {
+                return !!env.requires.messaging
+            },
+            get hasDestination() {
+                const kinds = { odata: 1, 'odata-v2': 1, 'odata-v4': 1, rest: 1 }
+                return Object.entries(env.requires).some(([service, require]) => !kinds[service] && kinds[require.kind])
+            },
+            get hasHtml5Repo() {
+                return fs.existsSync(path.join(projectPath, 'chart', 'templates', 'html5-apps-repo-host.yaml'))
+            },
             get hasMtaDeployment() {
+                if (!options?.add.has('mta') && options?.add.has('helm')) return false
                 return fs.existsSync(path.join(projectPath, 'mta.yaml'))
+            },
+            get hasHelmDeployment() {
+                if (options?.add.has('mta') && !options?.add.has('helm')) return false
+                return fs.existsSync(path.join(projectPath, 'chart', 'values.yaml'))
             }
         }
 
@@ -213,31 +230,6 @@ module.exports = class ProjectReader {
             throw Error(`${capDescriptor.pLanguage} not supported`)
         }
 
-        // TODO - shall we use project related data from existing mta like version, name, id or description
-        // and overwrite everything else?
-        //
-        // const mtaFile = path.join(this.projectPath, 'mta.yaml')
-        // let mta
-        // if (await this.fsUtil.pathExists(mtaFile)) {
-        //     try {
-        //         const {yaml} = require('@sap/cds-foss')
-        //         const content = await this.fsUtil.readFile(mtaFile, 'utf-8')
-        //         mta = yaml.parse(content)
-        //     } catch (e) {
-        //         this.logger.error(`Failed to load ${mtaFile} - skip mta data`)
-        //         this.logger.error(e)
-        //     }
-        // }
-
-        // if (mta) {
-        //     details.id = mta.ID
-        //     details.description = mta.description
-        //     details.version = mta.version
-        //     if (mta.ID) {
-        //         details.name = mta.ID.replace('.', '-')
-        //     }
-        // }
-
         // 1.1. java - use parent pom.xml
         if (capDescriptor.pLanguage === P_LANGUAGE_JAVA) {
             const pomXmlPath = path.join(this.projectPath, 'pom.xml')

package/lib/init/util/templateUtil.js

@@ -1,6 +1,7 @@
 const path = require('path');
-const YAML = require('@sap/cds-foss')('yaml');
+const YAML = require('@sap/cds-foss').yaml;
 const Mustache = require('mustache');
+const { fs } = require('../../cds').utils;
 
 const TEMPLATE_EXTENSION = '.hbs';
 const TEMPLATE_EXTENSION_REGEX = new RegExp(`${TEMPLATE_EXTENSION}$`);
@@ -111,10 +112,21 @@ module.exports = class TemplateUtil {
     }
 
     async mergeYAML(into, from, projectDescriptor, semantics) {
-        const target = typeof into === 'string' ? await this.fsUtil.readYAML(into) : into
-        const source = typeof from === 'string' ? await this.fsUtil.readYAML(from, projectDescriptor) : from
-
-        if (!target || !target.contents) return // Has no YAML file
+        const target =
+            typeof into === 'string' ? await this.fsUtil.readYAML(into) :
+            into instanceof YAML.Document ? into :
+            new YAML.Document(into)
+        const source =
+            typeof from === 'string' ? await this.fsUtil.readYAML(from, projectDescriptor)
+            : from instanceof YAML.Document ? from :
+            new YAML.Document(from)
+
+        if (!target || !target.contents) {
+            if (typeof into === 'string' && typeof from === 'string') {
+                return projectDescriptor ? this.fsUtil.writeYAML(into, source) : fs.copy(from, into)
+            }
+            return /* has no YAML */
+        }
 
         const existenceMap = new Map()
         const templateExistenceMap = new Map()

package/lib/lint/Linter.js

@@ -70,9 +70,6 @@ class Linter {
       // Determine if case "local" or "global" and resolve plugin accordingly
       await this._getConfigFileAndSetProjectPath(args);
 
-      // Add custom rules
-      await this._addRulePaths();
-
       const overwriteRules = checks.hasEslintConfigContent(this.configContents, "rules");
       if (overwriteRules) {
         await this._overwriteRuleSeverities();
@@ -105,16 +102,6 @@ class Linter {
     return options;
   }
 
-  async _addRulePaths() {
-    const rulesPath = path.relative(".", ".eslint/rules");
-    if (await exists(rulesPath) && await isdir(rulesPath)) {
-      const opts = io.mergeWithUserOpts(this.eslintCmdOpts, "rulesdir", path.relative(".", rulesPath));
-      this.customRulesOpts = opts.rulesdir;
-      await generators.genDocs(this.projectPath.replace(rulesPath, ""));
-    }
-    return;
-  }
-
   /**
    * Searches for ESLint config file types (in order or precedence)
    * and returns corresponding directory (usually project's root dir)
@@ -136,8 +123,13 @@ class Linter {
     while (configDir !== path.resolve(configDir, "..")) {
       for (let i = 0; i < configFiles.length; i++) {
         const configPath = path.join(configDir, configFiles[i]);
-        if (await exists(configPath) && await isfile(configPath)) {
-          return configPath;
+        if (configFiles[i] !== "package.json" || (
+          configFiles[i] !== "package.json" && require(configPath).eslintConfig
+        )) {
+          if (await exists(configPath) && await isfile(configPath)) {
+
+            return configPath;
+          }
         }
       }
       configDir = path.join(configDir, "..");
@@ -191,13 +183,13 @@ class Linter {
       LOG_CONFIG && LOG_CONFIG(eslintOpts);
 
       let lintString = `eslint`;
-      if (this.fileExtensions) { lintString += ` --ext "${this.fileExtensions.join(",")}"`};
+      if (this.fileExtensions) { lintString += ` --ext "${this.fileExtensions.join(",")}"`}
       for (const ruleOpt of Object.entries(this.ruleOpts)) {
         lintString += ` --rule ${ruleOpt[0]}:${ruleOpt[1]}`;
       }
       if (this.customRulesOpts && this.customRulesOpts.length > 0) {
         lintString += ` --rulesdir "${this.customRulesOpts}"`
-      };
+      }
 
       LOG && LOG(lintString);
 

package/lib/lint/checks.js

@@ -3,7 +3,6 @@ const os = require("os");
 const path = require("path");
 const term = require("../util/term");
 const commandUtil = require("../init/util/commandUtil");
-const io = require("./io");
 
 const IS_WIN = os.platform() === "win32";
 const { URLS } = require("../init/constants");

package/lib/lint/generators.js

@@ -1,8 +1,5 @@
-const fs = require("fs");
 const os = require("os");
 const cp = require("child_process");
-const path = require("path");
-const { mkdirp } = require("@sap/cds").utils;
 const term = require("../util/term");
 
 const IS_WIN = os.platform() === "win32";
@@ -78,7 +75,7 @@ module.exports = {
       }
     });
     const optionsWithoutShortcuts = allOptions.filter((o) => !optionsWithShortcuts.includes(o));
-    optionsWithoutShortcuts.forEach((opt) => {
+    optionsWithoutShortcuts.forEach(() => {
       shortcuts.push(undefined)
     });
     let options = optionsWithShortcuts.concat(optionsWithoutShortcuts);
@@ -95,193 +92,6 @@ module.exports = {
    */
   genEslintFlags: function (help) {
     return help.match(REGEX_FLAGS).map((str) => str.trim().replace(",", ""));
-  },
-
-  /**
-   * Generates custom rules documentation for user
-   * according to contents of rules files
-   * @param {*} projectPath
-   */
-  async genDocs(projectPath) {
-    let mdRule, mdRuleSources, mdRuleContents;
-    const testPath = path.join(projectPath, ".eslint/tests");
-    const rulePath = path.join(projectPath, ".eslint/rules");
-    const docsPath = path.join(projectPath, ".eslint/docs");
-
-    if (!fs.existsSync(testPath)) {
-      await mkdirp(testPath);
-    }
-    if (!fs.existsSync(rulePath)) {
-      await mkdirp(rulePath);
-    }
-    if (!fs.existsSync(docsPath)) {
-      await mkdirp(docsPath);
-    }
-
-    const ruleDocsPath = path.join(docsPath, "Rules.md");
-    const ruleListDocsPath = path.join(docsPath, "RuleList.md");
-    const ruleDict = {};
-
-    if (!fs.existsSync(ruleDocsPath)) {
-      fs.writeFileSync(ruleDocsPath, "", "utf8");
-    }
-    if (!fs.existsSync(ruleListDocsPath)) {
-      fs.writeFileSync(ruleListDocsPath, "", "utf8");
-    }
-
-    function getKeyFromMeta(text, key) {
-      const regexQuote = new RegExp(`${key}:[\\s]+[\\', \\\`, \\"]`, "gm");
-      const matchQuote = regexQuote.exec(text);
-      if (matchQuote) {
-        const quote = matchQuote[0].slice(-1);
-        const exprStart = `${key}:[\\s]+\\${quote}`;
-        const exprEnd = `(\\${quote},?)`;
-        const regexKey = new RegExp(`${exprStart}[\\s\\S]*?${exprEnd}`, "gm");
-        const matchKey = regexKey.exec(text);
-        if (matchKey) {
-          const regexStart = new RegExp(`${exprStart}`, "gm");
-          const regexEnd = new RegExp(`${exprEnd}`, "gm");
-          return matchKey[0]
-            .replace(regexStart, "")
-            .replace(regexEnd, "")
-            .replace("fixable:", "")
-            .trim();
-        } else {
-          return "";
-        }
-      } else {
-        return "";
-      }
-    }
-
-    function getKeyFromTest(text, key) {
-      let dissallowPrefix = "";
-      if (key === "valid") {
-        dissallowPrefix = "[^n]";
-      }
-      const exprStart = `${dissallowPrefix}${key}:[\\s]+\\[[\\s\\n]+{[\\s\\n]+code:[\\s\\n]+`;
-      const regexTestKey = new RegExp(`${exprStart}[\\', \\\`, \\"]`, "gm");
-      const matchTestKey = regexTestKey.exec(text);
-      if (matchTestKey) {
-        const quote = matchTestKey[0].slice(-1);
-        const exprStart = `${dissallowPrefix}${key}:[\\s]+\\[[\\s\\n]+{[\\s\\n]+code:[\\s\\n]+`;
-        const regexStart = new RegExp(exprStart, "gm");
-        const regexCode = new RegExp(
-          `${exprStart}${quote}[\\s\\S]*?(\\${quote},?)`,
-          "gm"
-        );
-        const matchCode = regexCode.exec(text);
-        const code = matchCode[0].replace(regexStart, "");
-        const regex = new RegExp(`${quote},`, "gm");
-        const regex2 = new RegExp(`${quote}`, "gm");
-        return code.replace(regex, "").replace(regex2, "");
-      } else {
-        return "";
-      }
-    }
-
-    function genMdRules(release, table = true) {
-      let version = "latest";
-      if (release) {
-        version = release;
-      }
-      let mdRules = `# @sap/eslint-plugin-cds [${version}]\n\n`;
-      if (table) {
-        Object.entries(ruleDict).forEach(([category, rules]) => {
-          mdRules += `## Category: ${category}\n\n`;
-          mdRules += "<table>";
-          mdRules += "<tr><th>Rule</th><th>Fixable</th><th>Version</th></tr>";
-          rules.forEach(function (rule) {
-            mdRules += `<tr><td><a href="./Rules.md#rule-${rule.name}">${rule.name}</a></td><td>${rule.fix}</td><td>${rule.version}</td></tr>`;
-          });
-          mdRules += "</table>\n\n<br>\n\n";
-        });
-      }
-      return mdRules;
-    }
-
-    const mdRulesCur = fs.readFileSync(ruleDocsPath, "utf8");
-    const mdRuleListCur = fs.readFileSync(ruleListDocsPath, "utf8");
-    fs.readdirSync(rulePath).filter(function (file) {
-      if (path.extname(file).toLowerCase() === ".js") {
-        const rule = path.basename(file).replace(path.extname(file), "");
-        const ruleTestPath = path.join(testPath, `${rule}.test.js`);
-
-        // Get rule meta information
-        const ruleMeta = fs.readFileSync(path.join(rulePath, file), "utf8");
-        const details = getKeyFromMeta(ruleMeta, "description");
-        const category = getKeyFromMeta(ruleMeta, "category");
-        const fixable = getKeyFromMeta(ruleMeta, "fixable");
-        let isFixable = "";
-        if (["code", "whitespace"].includes(fixable)) {
-          isFixable = ":wrench:";
-        }
-        const version = getKeyFromMeta(ruleMeta, "version");
-
-        // Get rule valid/invalid tests
-        mdRule = "";
-        if (fs.existsSync(ruleTestPath)) {
-          const ruleTest = fs.readFileSync(ruleTestPath, "utf8");
-          const valid = getKeyFromTest(ruleTest, "valid");
-          const invalid = getKeyFromTest(ruleTest, "invalid");
-
-          mdRule +=
-            `<span>:heavy_check_mark:&nbsp;&nbsp; Example of ` +
-            `<font style="color:green">correct</font> ` +
-            `code for this rule:</span>\n\n\`\`\`\n${valid}\n\`\`\`\n\n`;
-          mdRule +=
-            `<span>:x:&nbsp;&nbsp; Example of ` +
-            `<font style="color:red">incorrect</font> ` +
-            `code for this rule:</span>\n\n\`\`\`\n${invalid}\n\`\`\``;
-        }
+  }
 
-        mdRuleContents = `## Rule: ${rule}\n`;
-        mdRuleContents += `<span class='label shifted'>${category}</span>\n\n`;
-        mdRuleContents += `### Rule Details\n${details}\n\n`;
-        if (mdRule) {
-          mdRuleContents += `### Examples\n${mdRule}\n\n`;
-        }
-        mdRuleContents += `### Version\nThis rule was introduced in \`@sap/eslint-plugin-cds ${version}\`.\n\n`;
-        mdRuleSources = `### Resources\n[Rule & Documentation source](${path.relative(
-          docsPath,
-          path.join(rulePath, `${rule}.js`)
-        )})\n\n`;
-
-        if (Object.keys(ruleDict).includes(category)) {
-          ruleDict[category].push({
-            name: rule,
-            fix: isFixable,
-            version: version,
-            contents: mdRuleContents,
-            sources: mdRuleSources,
-          });
-        } else {
-          ruleDict[category] = [
-            {
-              name: rule,
-              fix: isFixable,
-              version: version,
-              contents: mdRuleContents,
-              sources: mdRuleSources,
-            },
-          ];
-        }
-      }
-    });
-
-    let mdRules = genMdRules(undefined, false);
-    let mdRuleList = genMdRules();
-
-    /* eslint-disable-next-line no-unused-vars */
-    Object.entries(ruleDict).forEach(([category, rules]) => {
-      rules.forEach(function (rule) {
-        mdRules += `${rule.contents}\n\n${rule.sources}\n\n---\n\n`;
-      });
-    });
-
-    if (mdRuleListCur !== mdRuleList || mdRulesCur !== mdRules) {
-      fs.writeFileSync(ruleDocsPath, mdRules, "utf8");
-      fs.writeFileSync(ruleListDocsPath, mdRuleList, "utf8");
-    }
-  },
 };

package/lib/lint/io.js

@@ -1,12 +1,10 @@
-const os = require("os");
 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();
-
-const IS_WIN = os.platform() === "win32";
+const JSONC = require("../util/jsonc")
 
 module.exports = {
   /**

package/lib/watch/node-watch.js

@@ -1,6 +1,6 @@
 const DEBUG = /\bwatch\b/.test(process.env.DEBUG) && console.debug
 
-module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, options={} })=>{
+module.exports = ({ cwd, script, ext, includes=RegExp(), ignore=RegExp(), env={}, delay=200, options={} })=>{
 
   let child
 
@@ -46,7 +46,7 @@ module.exports = ({ cwd, script, ext, ignore=RegExp(), env={}, delay=200, option
 
   // Watching for touched files...
   const watch = require('node-watch')
-  const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$`)
+  const include = RegExp(`\\.(${ext.replace(/,/g,'|')})$|${includes.source}`)
   const filter = f => !ignore.test(f) && include.test(f)
   watch (cwd||process.cwd(),{ recursive:true, filter, delay:0 }, restart)