@sap/cds-dk 4.6.0 → 4.7.1

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

@@ -11,16 +11,12 @@ module.exports = class DataTemplate extends TemplateBase {
   async run() {
     const env = await this.getEnv();
 
-    const prefix = (typeof this.options.for === 'string') // --for <prefix>
-      ? this.options.for
-      : '';
-    const prefixedWith = (definition) => definition.name === prefix || definition.name.startsWith(prefix);
-
     let dest = (typeof this.options.out === 'string') // target folder
       ? this.options.out
       : getDefaultTargetFolder(env, this.projectPath);
     dest = resolve(this.projectPath, dest);
 
+    const nameFilter = asRegex(this.options.for)
     const force = this.options.force;
     const logger = this.logger;
 
@@ -29,18 +25,44 @@ module.exports = class DataTemplate extends TemplateBase {
 
     // Also include 'external' entities w/ cds.persistence.skip (similar to 'mocked' option of serve).
     // Could be too much sometimes, but don't want to bother users w/ a separate option for this.
-    cds.deploy.include_external_entities_in(csn)
+    includeExternalEntities(csn, logger)
 
     csn = cds.compile.for.sql(csn, { names:env.sql.names, messages:[] })  // CSN w/ persistence information
     csn = cds.reflect(csn); // reflected model (adds additional helper functions)
 
     csn.all('entity')
-      .filter(prefixedWith)
+      .filter (e => e.name.match(nameFilter)) // --for prefix|regex
       .filter (e => !e.query) // exclude entities with queries (projection on, select from ...)
       .filter (e => e.name !== 'DRAFT.DraftAdministrativeData' && !e.name.endsWith('.drafts')) // exclude draft stuff
       .forEach(e => processEntity(e, dest, this.projectPath, csn, force, logger));
   }
+}
+
+function includeExternalEntities(model, logger) {
+  for (let each in model.definitions) {
+    const def = model.definitions[each]
+    if (def['@cds.persistence.skip'] === true) {
+      logger.debug ('Including skipped entity '+each)
+      delete def['@cds.persistence.skip']
+    }
+  }
+  return model
+}
 
+function asRegex(spec) {
+  if (typeof spec === 'string') {
+    try {
+      if (spec.match(/[\^$|*]/))
+        return new RegExp(spec)
+      else { // no meta chars -> prefix semantics
+        spec = spec.replace(/\./g, '\\.') // escape dot
+        return new RegExp('^'+spec+'.*')
+      }
+    } catch (err) {
+      throw new Error (err.message) // user error, so cut off stack trace
+    }
+  }
+  return /.*/
 }
 
 function processEntity (entity, dest, projectPath, csn, force, logger) {

package/lib/init/template/hana/files/common/undeploy.json

@@ -0,0 +1,5 @@
+[
+    "src/gen/**/*.hdbview",
+    "src/gen/**/*.hdbindex",
+    "src/gen/**/*.hdbconstraint"
+]

package/lib/init/template/hana/files/java/package.json

@@ -3,6 +3,9 @@
   "dependencies": {
     "@sap/hdi-deploy": "^4"
   },
+  "engines": {
+    "node": "^16"
+  },
   "scripts": {
     "start": "node node_modules/@sap/hdi-deploy/deploy.js"
   }

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

@@ -13,8 +13,6 @@ const { nullLogger } = require('../../util/logger');
 module.exports = class HanaTemplate extends TemplateBase {
     constructor(projectPath, generator) {
         super(projectPath, generator, __dirname);
-
-        this.env = null;
     }
 
     async checkEnabled() {
@@ -22,34 +20,32 @@ module.exports = class HanaTemplate extends TemplateBase {
             return true;
         }
 
-        this.env = await this.getEnv(true);
+        const env = await this.getEnv();
 
-        const hdiConfigPath = path.join(this.projectPath, this.env.folders.db, 'src/.hdiconfig');
-        if (await this.fsUtil.pathExists(hdiConfigPath)) {
-            const configFilePath = path.join(this.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;
     }
 
     // read env from project
-    async getEnv(force) {
+    async getEnv() {
         const cdsEnvVar = process.env.CDS_ENV;
         process.env.CDS_ENV = 'production'
-        let env
         try {
-            env = await super.getEnv(force);
+            return await super.getEnv();
         } finally {
             cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
         }
-        return env
     }
 
     async run() {
-        this.env = await this.getEnv(true);
+        const env = await this.getEnv();
 
-        await this.templateUtil.copyFiles('common', path.join(this.projectPath, this.env.folders.db), {
+        await this.templateUtil.copyFiles('common', path.join(this.projectPath, env.folders.db), {
             projectName: this.projectName
         }, this.options.force);
 
@@ -57,13 +53,13 @@ module.exports = class HanaTemplate extends TemplateBase {
         const projectType = await this.getProjectType();
         switch (projectType) {
             case PROJECT_TYPE.java:
-                await this.templateUtil.copyFiles('java', path.join(this.projectPath, this.env.folders.db), {}, this.options.force);
+                await this.templateUtil.copyFiles('java', path.join(this.projectPath, env.folders.db), {}, this.options.force);
                 await this._updatePomXml();
-                await this._updateCdsrcJson(cdsrcJsonPath, this.env.folders.db);
+                await this._updateCdsrcJson(cdsrcJsonPath, env.folders.db, env);
                 break;
 
             case PROJECT_TYPE.nodejs:
-                await this._updatePackageJson(path.join(this.projectPath, 'package.json'), this.env.folders.db);
+                await this._updatePackageJson(path.join(this.projectPath, 'package.json'), env.folders.db, env);
                 break;
 
             default: break;
@@ -87,7 +83,7 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    async _updatePackageJson(packageJsonPath, modelName) { //NOSONAR
+    async _updatePackageJson(packageJsonPath, modelName, env) { //NOSONAR
         modelName = path.basename(modelName);
 
         if (!await this.fsUtil.pathExists(packageJsonPath)) {
@@ -109,7 +105,7 @@ module.exports = class HanaTemplate extends TemplateBase {
             changed = true
         }
 
-        if (!this._isUsingHana(modelName)) {
+        if (!this._isUsingHana(modelName, env)) {
             packageJson.cds = packageJson.cds || {};
             packageJson.cds.requires = packageJson.cds.requires || {};
             packageJson.cds.requires[modelName] = packageJson.cds.requires[modelName] || {};
@@ -130,7 +126,7 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    async _updateCdsrcJson(cdsrcJsonPath, modelName) {
+    async _updateCdsrcJson(cdsrcJsonPath, modelName, env) {
         modelName = path.basename(modelName);
 
         let changed;
@@ -143,7 +139,7 @@ module.exports = class HanaTemplate extends TemplateBase {
 
         this.logger.isDebug && this.logger.debug(`_updateCdsrcJson before: ${JSON.stringify(cdsrcJson, null, 2)}`);
 
-        if (!this._isUsingHana(modelName)) {
+        if (!this._isUsingHana(modelName, env)) {
             cdsrcJson.requires = cdsrcJson.requires || {};
             cdsrcJson.requires[modelName] = cdsrcJson.requires[modelName] || {};
             cdsrcJson.requires[modelName].kind = KIND_SQL;
@@ -161,7 +157,7 @@ module.exports = class HanaTemplate extends TemplateBase {
         }
     }
 
-    _isUsingHana(db) {
-        return this.env.get(`requires.${db}.kind`) === KIND_HANA || this.env.get(`requires.${db}.dialect`) === KIND_HANA || this.env.get(`requires.${db}.use`) === KIND_HANA;
+    _isUsingHana(db, env) {
+        return env.get(`requires.${db}.kind`) === KIND_HANA || env.get(`requires.${db}.dialect`) === KIND_HANA || env.get(`requires.${db}.use`) === KIND_HANA;
     }
 }

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);
@@ -42,12 +47,9 @@ module.exports = class LintTemplate extends TemplateBase {
   }
 
   async run() {
-    const cdsdkPath = path.join(__dirname, "../../../..");
-    const globalPath = path.join(cdsdkPath, "../..");
-
     // Require ESLint v>=7.0.0
     if (!this.isTest) {
-      this._checkEslint(globalPath);
+      this._checkEslint();
     }
 
     // To enable custom lint rules ('lint' or 'lint:dev')
@@ -69,15 +71,27 @@ module.exports = class LintTemplate extends TemplateBase {
         // Generate custom lint rules docs
         await generators.genDocs(this.projectPath);
       }
+
+      // 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
+      );
     }
 
-    // Generate VS Code extension settings
-    await io.sanitizeVscodeSettings(
-      this.projectPath,
-      path.join(this.projectPath, ".vscode/settings.json"),
-      this.lintType,
-      this.customRuleExample
-    );
   }
 
   async finalize() {
@@ -111,12 +125,8 @@ module.exports = class LintTemplate extends TemplateBase {
 
   }
 
-  _checkEslint(globalPath) {
-    const eslintInfo = checks.resolveEslint(this.projectPath, globalPath);
-    let eslintCmd;
-    if (eslintInfo) {
-      eslintCmd = eslintInfo.cmd;
-    }
+  _checkEslint() {
+    const eslintCmd = checks.resolveEslint(this.projectPath, '');
     if (!eslintCmd) {
       this.missingNpmDependencies["names"].push("eslint");
       this.missingNpmDependencies["msgs"].push("ESLint v>=7.0.0");

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/template/mta/projectReader.js

@@ -22,13 +22,11 @@ module.exports = class ProjectReader {
     async getEnv(profile = 'production') {
         const cdsEnvVar = process.env.CDS_ENV
         process.env.CDS_ENV = profile
-        let env
         try {
-            env = await this.template.getEnv(true);
+            return await this.template.getEnv();
         } finally {
             cdsEnvVar ? process.env.CDS_ENV = cdsEnvVar : delete process.env.CDS_ENV
         }
-        return env
     }
 
     get fsUtil() {

package/lib/init/template/nodejs/files/.gitignore.hbs

@@ -28,5 +28,3 @@ mta_archives/
 # IDEs
 # .vscode
 # .idea
-
-.cdsrc-private.json

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

@@ -58,7 +58,7 @@ module.exports = class SamplesTemplate extends TemplateBase {
     }
 
     async _addNodejsSamples() {
-        const folders = (await this.getEnv(true)).folders;
+        const folders = (await this.getEnv()).folders;
         const dbFolder = path.join(this.projectPath, folders.db);
         await this.templateUtil.copyFiles('nodejs/db', dbFolder, {}, this.options.force);
 

package/lib/init/template/templateBase.js

@@ -1,11 +1,9 @@
 const path = require('path');
-const cds = require('@sap/cds/lib');
+const Config = require('@sap/cds/lib/env');
 
 const TemplateUtil = require('../util/templateUtil');
-const commandUtil = require('../util/commandUtil');
-const { nullLogger } = require('../util/logger');
 
-const { IS_WIN, PROJECT_TYPE } = require('../constants');
+const { PROJECT_TYPE } = require('../constants');
 
 
 module.exports = class TemplateBase {
@@ -43,49 +41,20 @@ module.exports = class TemplateBase {
         return true;
     }
 
-    getCdsModulePath() {
-        return path.join(__dirname, '../../../bin/cds.js');
-    }
-
     /**
      * calls cds env and caches result
      * @param {boolean} force, ignore cached value
      * @returns {object} the current cds env
      */
-    async getEnv(force = false) {
-        if (!this.env || force) {
-            let projectPath;
-            if (await this.fsUtil.pathExists(this.projectPath)) {
-                projectPath = this.projectPath;
-            } else {
-                projectPath = this.cwd;
-            }
-
-            const logger = (this.logger.isDebug ? this.logger : nullLogger);
-
-            let modPath = this.getCdsModulePath();
-            if (IS_WIN) {
-                modPath = `"${modPath}"`;
-            }
-
-            let envJsonOutput = await commandUtil.spawnCommand('node', [modPath, 'env', 'json'], {
-                cwd: projectPath,
-                env: process.env
-            }, logger, true);
-
-            if (envJsonOutput) {
-                // cheap check to see if json is valid
-                if (envJsonOutput.indexOf('":') < 0) {
-                    // eslint-disable-next-line no-control-regex
-                    envJsonOutput = envJsonOutput.replace(/'/g, '"').replace(/\s(\w+):\s/g, ' "$1": ').replace(/\x1b\[\w+m/g, '');
-                }
-
-                this.env = JSON.parse(envJsonOutput);
-                // env has additional getters and setters
-                Object.setPrototypeOf(this.env, cds.env.__proto__);
-            }
+    async getEnv() {
+        let projectPath;
+        if (await this.fsUtil.pathExists(this.projectPath)) {
+            projectPath = this.projectPath;
+        } else {
+            projectPath = this.cwd;
         }
-        return this.env;
+
+        return Config.for('cds', projectPath);
     }
 
     /**

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/lint/Linter.js

@@ -14,6 +14,8 @@ const {
 } = require("@sap/eslint-plugin-cds/lib/api");
 
 const IS_WIN = os.platform() === "win32";
+const ALLOWED_FILE_EXTENSIONS = getFileExtensions();
+
 class Linter {
   constructor() {
     this.eslintCmd = "";
@@ -45,11 +47,7 @@ class Linter {
    * @returns object continaing help, options, flags and shortcuts
    */
   init(help = "", options = [], flags = [], shortcuts = []) {
-    const eslintInfo = checks.resolveEslint(this.cdsdkPath, this.globalPath);
-    if (eslintInfo) {
-      this.eslintCmd = eslintInfo.cmd;
-    }
-    this.addFormatter = eslintInfo.addFormatter;
+    this.eslintCmd = checks.resolveEslint(this.cdsdkPath, this.globalPath);
     if (this.eslintCmd) {
       help = generators.genEslintHelp(this.eslintCmd);
       flags = generators.genEslintFlags(help);
@@ -98,7 +96,7 @@ class Linter {
       }
 
       // Limit to CDS file extensions
-      this._addExtensions(this.addFormatter);
+      this._addExtensions();
       // Run ESLint with collected options
       try {
         await this._runEslint();
@@ -141,29 +139,16 @@ class Linter {
     return;
   }
 
-  _addExtensions(addFormatter) {
+  _addExtensions() {
     // Add CDS file extensions to lint
+    const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => path.extname(ext));
     this.eslintCmdOpts = io.mergeWithUserOpts(
       this.eslintCmdOpts,
       "ext",
-      ".cds,.csn"
+      extensions.join(',')
     );
-    // Add custom CDS formatter (for ESLint v<8)
-    if (addFormatter) {
-      const formatterPath = this.pluginPath.replace(
-        "index.js",
-        "../api/formatter.js"
-      );
-      this.eslintCmdOpts = io.mergeWithUserOpts(
-        this.eslintCmdOpts,
-        "format",
-        path.relative(".", formatterPath)
-      );
-    }
     // Enable colored output
-    if (process.stdout.isTTY) {
-      this.eslintCmdOpts = io.mergeWithUserOpts(this.eslintCmdOpts, "color");
-    }
+    this.eslintCmdOpts = io.mergeWithUserOpts(this.eslintCmdOpts, "color");
     return;
   }
 
@@ -193,7 +178,6 @@ class Linter {
         }
       }
       // Only lint file extensions prescribed by plugin
-      const fileExtensions = getFileExtensions();
       eslintCmdOpts.push("--ignore-pattern");
       let ignorePattern = "*.*";
       if (IS_WIN) {
@@ -202,7 +186,7 @@ class Linter {
         ignorePattern = `'${ignorePattern}'`;
       }
       eslintCmdOpts.push(ignorePattern);
-      fileExtensions.forEach((ext) => {
+      ALLOWED_FILE_EXTENSIONS.forEach((ext) => {
         eslintCmdOpts.push("--ignore-pattern");
         ignorePattern = `!${ext}`;
         if (IS_WIN) {
@@ -219,22 +203,18 @@ class Linter {
       } else {
         input = `'${this.eslintCmdFileExpr.join("' '")}'`;
       }
-      const eslintCmdSplit = this.eslintCmd.split(" ");
-      this.eslintCmd = eslintCmdSplit[0];
-      eslintCmdOpts.unshift(eslintCmdSplit[1]);
-      eslintCmdOpts.push(input);
       // Run ESLint with given cmd line options
-      // - Show 'eslint' instead of 'node ...eslint.js' cmd
-      // - Remove debug flag for printed cmd
+      // - Show 'eslint' instead of actual eslint cmd ('node .../.eslint.js')
+      // - Remove debug flag for printed cmd line
       if (this.eslintCmdOpts.debug) {
         eslintCmdOpts.splice(eslintCmdOpts.indexOf('--debug'), 1);
         console.log(
-          `Linting:\n ${term.info(`eslint ${eslintCmdOpts.slice(1).join(' ')}`)}\n`
+          `Linting:\n ${term.info(`eslint ${eslintCmdOpts.concat(input).join(' ')}`)}\n`
         );
         eslintCmdOpts.push('--debug');
       }
       if (!dryRun) {
-        return commandUtil.spawnCommand(this.eslintCmd, eslintCmdOpts, {
+        return commandUtil.spawnCommand(this.eslintCmd, eslintCmdOpts.concat(input), {
           cwd: process.cwd(),
           shell: true,
           stdio: process.env.NODE_ENV === 'test' ? 'pipe' : 'inherit',

package/lib/lint/checks.js

@@ -21,7 +21,6 @@ module.exports = {
     let cmd;
     let version;
     let errMessage;
-    let addFormatter = false;
     try {
       const eslintPath = require.resolve("eslint/package.json", {
         paths: [inputPath, globalPath],
@@ -29,9 +28,6 @@ module.exports = {
       const packageJson = require(eslintPath);
       if (packageJson.version > "7") {
         version = packageJson.version;
-        if (version < "8") {
-          addFormatter = true;
-        }
       } else {
         errMessage =
           `ESLint v>=6.0.0 required!\n\n` +
@@ -55,7 +51,7 @@ module.exports = {
         )}\n`;
     }
     if (cmd && version) {
-      return  { cmd, addFormatter };
+      return cmd;
     }
     if (logger) {
       logger.error(errMessage);

package/lib/lint/generators.js

@@ -3,6 +3,7 @@ const os = require("os");
 const cp = require("child_process");
 const path = require("path");
 const { mkdirp } = require("@sap/cds/lib/utils");
+const term = require("../util/term");
 
 const IS_WIN = os.platform() === "win32";
 
@@ -35,12 +36,12 @@ module.exports = {
     let cdslintCmd = eslintOpts[0].replace("eslint", "*cds lint*");
     eslintOpts[0] = `
         # SYNOPSIS
-    
+
             ${cdslintCmd} [beta]
-    
+
             Runs environment checks and/or checks the specified models
             based on the ESLint framework
-    
+
         # OPTIONS`;
     return `${eslintOpts.join("\n    ")}\n`;
   },
@@ -97,7 +98,7 @@ module.exports = {
   },
 
   /**
-   * Generates custom rules documentation for user 
+   * Generates custom rules documentation for user
    * according to contents of rules files
    * @param {*} projectPath
    */