@sap/cds-dk 4.6.0 → 4.6.2

package/CHANGELOG.md

@@ -6,6 +6,27 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 4.6.2 - 2021-11-09
+
+### Fixed
+
+- `cds add lint` now correctly detects missing local `eslint`
+- `cds add lint` no longer removes parts of `package.json`
+- `cds add lint` no longer creates duplicate configuration entries
+
+## Version 4.6.1 - 2021-11-08
+
+### Changed
+
+- `cds init` uses latest `Maven Java archetype` version `1.20.0` for creating Java projects.
+- `cds watch` now resolves local node modules like `hdb` even though `@sap/cds` is not installed locally.  This is useful during development where `@sap/cds` shall only be installed in a 'central' location, while extra modules shall still be found in the app's dir.
+
+### Fixed
+
+- `cds repl` now finds modules like `hdb` that are installed locally in the app folder
+- `cds repl` now enables the `await` statement also on Windows
+- `cds lint` now limits all file extensions to those allowed by the @sap/eslint-plugin-cds ESLint configuration
+
 ## Version 4.6.0 - 2021-11-02
 ### Added
 

package/bin/compile/index.js

@@ -38,6 +38,7 @@ module.exports = Object.assign ( compile, {
     - json, yml
     - edm, edmx, edmx-v2, edmx-v4, edmx-w4, edmx-x4
     - sql, hdbcds, hdbtable
+    - cdl [beta]
     - xsuaa
     - openapi
 
@@ -261,7 +262,7 @@ function compile (models, options={}) {
 
   function suffix4 (x) { return x && ({
     edmx: '.xml',
-    "edmx-v2": '.xml', 
+    "edmx-v2": '.xml',
     "edmx-v4": '.xml',
     openapi: '.openapi3.json', //'.yml',
     cdl: '.cds',

package/bin/repl.js

@@ -14,8 +14,12 @@ module.exports = Object.assign (repl, { options: [], help: `
 
 function repl (_, options={}) {
 
-  if (module.parent && module.parent.filename.endsWith('/bin/cds.js')) {
-    return require('child_process').spawn('node',['--experimental-repl-await', __filename ],{stdio:'inherit'})
+  // enable `await` statement for Node.js < 16
+  if (!process.env['CDS_REPL_SPAWNED'] && process.version.split('.')[0].slice(1) < '16') {
+    process.env['CDS_REPL_SPAWNED'] = true
+    return require('child_process').spawn('node',['--experimental-repl-await',
+      ...process.argv.slice(1) ], {stdio:'inherit'}
+    )
   }
 
   const cds = require('@sap/cds/lib')

package/bin/watch.js

@@ -43,7 +43,7 @@ module.exports = Object.assign ( watch, {
 `})
 
 const DEBUG = /\bwatch\b/.test(process.env.DEBUG) && console.debug
-const path = require ('path')
+const {delimiter,dirname,relative,resolve,sep} = require ('path')
 const fs = require ('fs')
 const t = module.exports.codes = {
   reset: '\x1b[0m', // Default
@@ -71,8 +71,11 @@ async function watch ([cwd], {
     _args: JSON.stringify(args),
     _options: JSON.stringify(options)
   })
+
+  // allow running w/o or partial local node_modules, also add cds-dk for its sqlite
+  env.NODE_PATH = [...paths(cwd||process.cwd()), ...paths(__dirname)].join(delimiter)
+
   if (typeof ext !== 'string')  ext = extDefaults
-  env.NODE_PATH = path.resolve (__dirname,'../node_modules') // allow global sqlite to be resolved
 
   let liveReload //= ...
   let firstTime = true
@@ -83,7 +86,7 @@ async function watch ([cwd], {
     env.CDS_LIVERELOAD_URL = await liveReload.start (options['livereload'])
       .catch(err => { console.log(`Error starting live reload: ${err.message}`); liveReload = null })
   } else {
-    ignore = RegExp(`app${path.sep}.*\\.(js|ts)|`+ignore.source) // exclude more frontend stuff
+    ignore = RegExp(`app${sep}.*\\.(js|ts)|`+ignore.source) // exclude more frontend stuff
   }
 
   const log = (first,...more) => console.log (t.yellow + (first||''), ...more, t.reset)
@@ -91,8 +94,8 @@ async function watch ([cwd], {
     const ocwd = process.env._original_cwd = process.cwd()
     if (fs.existsSync(cwd)) log (`cd ${cwd}`)
     else try {
-      const resolved = path.dirname (require.resolve(cwd+'/package.json', {paths:[ocwd]}))
-      log (`cd ${path.relative(ocwd,cwd = resolved)}`)
+      const resolved = dirname (require.resolve(cwd+'/package.json', {paths:[ocwd]}))
+      log (`cd ${relative(ocwd,cwd = resolved)}`)
     } catch(_){ throw new Error(`No such folder or package: '${ocwd}' -> '${cwd}'`) }
   }
   log ()
@@ -172,6 +175,12 @@ function removeArgsIn (toRemove) {
   }
 }
 
+// builds paths from dir + its parent node_modules
+function paths (dir) {
+  const parts = resolve(dir).split(sep), n = parts.length, nm = sep+'node_modules'
+  return parts.map ((_,i,a)=> a.slice(0,n-i).join(sep)+nm).filter(p => fs.existsSync(p))
+}
+
 //
 // Child process impl launched by watch
 //

package/lib/client/settings_manager.js

@@ -138,7 +138,7 @@ class SettingsManager {
         if (params.get('clearOtherTokenStorage')) {
             // Delete token from the other storage.
             params.delete('clearOtherTokenStorage');
-            await this.deleteToken(params, other(params.get('tokenStorage')));
+            await this.deleteToken(params, true);
         }
 
         if (params.get('tokenStorage') === 'plain') {
@@ -303,15 +303,16 @@ class SettingsManager {
         }
     }
 
-    static async deleteToken(params, fromStorage) {
+    static async deleteToken(params, fromOtherStorage = false) {
         const allParams = params.clone();
         await this.loadAndMergeSettings(allParams, true);
 
         const target = `URL ${allParams.get('appUrl')}, subdomain '${allParams.get('subdomain')}'`;
-        Logger.debug(`Deleting authentication data for ${target}`);
-
+        let fromStorage = fromOtherStorage && other(params.get('tokenStorage'))
         const deleteBoth = !fromStorage && allParams.get('tokenStorage') && allParams.get('clearOtherTokenStorage');
 
+        Logger.debug(`Deleting authentication data${fromOtherStorage ? ' from other storage' : ''} for ${target}`);
+
         fromStorage = fromStorage || allParams.get('tokenStorage');
         if (!fromStorage) {
             Logger.log(`No authentication data found for ${target}`);

package/lib/init/constants.js

@@ -1,6 +1,6 @@
 const os = require('os');
 
-const MAVEN_ARCHETYPE_VERSION = '1.19.0';
+const MAVEN_ARCHETYPE_VERSION = '1.20.0';
 
 const constants = {
     IS_WIN: (os.platform() === 'win32'),

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

@@ -42,12 +42,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 +66,16 @@ module.exports = class LintTemplate extends TemplateBase {
         // Generate custom lint rules docs
         await generators.genDocs(this.projectPath);
       }
+
+      // Generate VS Code extension settings
+      await io.sanitizeVscodeSettings(
+        this.projectPath,
+        path.join(this.projectPath, ".vscode/settings.json"),
+        this.lintType,
+        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 +109,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/nodejs/files/.gitignore.hbs

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

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,25 +139,14 @@ class Linter {
     return;
   }
 
-  _addExtensions(addFormatter) {
+  _addExtensions() {
     // Add CDS file extensions to lint
+    const extensions = ALLOWED_FILE_EXTENSIONS.map((ext) => ext.replace('*.', '.'));
     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");
@@ -193,7 +180,6 @@ class Linter {
         }
       }
       // Only lint file extensions prescribed by plugin
-      const fileExtensions = getFileExtensions();
       eslintCmdOpts.push("--ignore-pattern");
       let ignorePattern = "*.*";
       if (IS_WIN) {
@@ -202,7 +188,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) {

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
    */

package/lib/lint/io.js

@@ -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;
@@ -138,7 +140,7 @@ module.exports = {
       case ".eslintrc":
       case "package.json":
         if (configFile === "package.json") {
-          if (await fsp.access(configPath)) {
+          if (await fsUtil.pathExists(configPath)) {
             contents = JSON.parse(await fsp.readFile(configPath, "utf8"));
           } else {
             contents = {};