@sap/cds-compiler 2.13.8 → 3.0.0

package/bin/cdsc.js

@@ -19,7 +19,7 @@ const compiler = require('../lib/compiler');
 const main = require('../lib/main');
 const { for_sql, for_hdi, for_hdbcds } = require('../lib/api/main');
 const { compactModel } = require('../lib/json/to-csn');
-const { toRenameWithCsn, alterConstraintsWithCsn } = require('../lib/backends');
+const { toRename: _toRename } = require('../lib/render/toRename');
 const util = require('util');
 const fs = require('fs');
 const path = require('path');
@@ -33,6 +33,7 @@ const { term } = require('../lib/utils/term');
 const { splitLines } = require('../lib/utils/file');
 const { addLocalizationViews } = require('../lib/transform/localized');
 const { availableBetaFlags } = require('../lib/base/model');
+const { alterConstraintsWithCsn } = require('../lib/render/manageConstraints');
 
 // Note: Instead of throwing ProcessExitError, we would rather just call process.exit(exitCode),
 // but that might truncate the output of stdout and stderr, both of which are async (or rather,
@@ -44,11 +45,23 @@ class ProcessExitError extends Error {
   }
 }
 
-function remapCmdOptions(options, cmdOptions) {
-  if (!cmdOptions)
-    return options;
+try {
+  cdsc_main();
+}
+catch (err) {
+  // This whole try/catch is only here because process.exit does not work in combination with
+  // stdout/err - see comment at ProcessExitError
+  if (err instanceof ProcessExitError)
+    process.exitCode = err.exitCode;
+  else
+    throw err;
+}
 
-  for (const [ key, value ] of Object.entries(cmdOptions)) {
+function remapCmdOptions(options, command) {
+  if (!command || !options[command])
+    return;
+
+  for (const [ key, value ] of Object.entries(options[command])) {
     switch (key) {
       case 'names':
         options.sqlMapping = value;
@@ -73,15 +86,22 @@ function remapCmdOptions(options, cmdOptions) {
           options.variableReplacements.$user = {};
         options.variableReplacements.$user.locale = value;
         break;
+      case 'serviceNames':
+        options.serviceNames = value.split(',');
+        break;
+      case 'flavor':
+        options.csnFlavor = value;
+        break;
       default:
         options[key] = value;
     }
   }
-  return options;
+  delete options[command];
 }
 
-// Parse the command line and translate it into options
-try {
+function cdsc_main() {
+  // Parse the command line and translate it into options
+
   const cmdLine = optionProcessor.processCmdLine(process.argv);
   // Deal with '--version' explicitly
   if (cmdLine.options.version) {
@@ -115,6 +135,11 @@ try {
     displayUsage(cmdLine.errors, optionProcessor.helpText, 2);
   }
 
+  if (cmdLine.options.options) {
+    if (!loadOptionsFromJson(cmdLine))
+      return;
+  }
+
   // Default warning level is 2 (info)
   // FIXME: Is that not set anywhere in the API?
   if (!cmdLine.options.warning)
@@ -125,11 +150,7 @@ try {
     cmdLine.options.out = '-';
 
   // --cds-home <dir>: modules starting with '@sap/cds/' are searched in <dir>
-  if (cmdLine.options.cdsHome) {
-    if (!global.cds)
-      global.cds = {};
-    global.cds.home = cmdLine.options.cdsHome;
-  }
+  // -> cmdLine.options.cdsHome is passed down to moduleResolve
 
   // Set default command if required
   cmdLine.command = cmdLine.command || 'toCsn';
@@ -147,8 +168,8 @@ try {
   if (cmdLine.options.directBackend)
     validateDirectBackendOption(cmdLine.command, cmdLine.options, cmdLine.args);
 
-
-  if (cmdLine.options.beta) {
+  // If set through CLI (and not options file), `beta` is a string and needs processing.
+  if (cmdLine.options.beta && typeof cmdLine.options.beta === 'string') {
     const features = cmdLine.options.beta.split(',');
     cmdLine.options.beta = {};
     features.forEach((val) => {
@@ -156,35 +177,32 @@ try {
     });
   }
 
+  const to = cmdLine.options.toSql ? 'toSql' : 'toHana';
   // remap string values for `assertIntegrity` option to boolean
-  if (cmdLine.options.assertIntegrity &&
-      cmdLine.options.assertIntegrity === 'true' ||
-      cmdLine.options.assertIntegrity === 'false'
+  if (cmdLine.options[to] && cmdLine.options[to].assertIntegrity &&
+     (cmdLine.options[to].assertIntegrity === 'true' ||
+      cmdLine.options[to].assertIntegrity === 'false')
   )
-    cmdLine.options.assertIntegrity = cmdLine.options.assertIntegrity === 'true';
+    cmdLine.options[to].assertIntegrity = cmdLine.options[to].assertIntegrity === 'true';
 
   // Enable all beta-flags if betaMode is set to true
   if (cmdLine.options.betaMode)
     cmdLine.options.beta = availableBetaFlags;
 
-  if (cmdLine.options.deprecated) {
+  // If set through CLI (and not options file), `deprecated` is a string and needs processing.
+  if (cmdLine.options.deprecated && typeof cmdLine.options.deprecated === 'string') {
     const features = cmdLine.options.deprecated.split(',');
     cmdLine.options.deprecated = {};
     features.forEach((val) => {
       cmdLine.options.deprecated[val] = true;
     });
   }
+
+  parseSeverityOptions(cmdLine);
+
   // Do the work for the selected command
   executeCommandLine(cmdLine.command, cmdLine.options, cmdLine.args);
 }
-catch (err) {
-  // This whole try/catch is only here because process.exit does not work in combination with
-  // stdout/err - see comment at ProcessExitError
-  if (err instanceof ProcessExitError)
-    process.exitCode = err.exitCode;
-  else
-    throw err;
-}
 
 /**
  * `--direct-backend` can only be used with certain backends and with certain files.
@@ -230,10 +248,10 @@ function displayUsage(error, helpText, code) {
 function executeCommandLine(command, options, args) {
   const normalizeFilename = options.testMode && process.platform === 'win32';
   const messageLevels = {
-    Error: 0, Warning: 1, Info: 2, None: 3,
+    Error: 0, Warning: 1, Info: 2, Debug: 3,
   };
   // All messages are put into the message array, even those which should not
-  // been displayed (severity 'None')
+  // been displayed (severity 'Debug')
 
   // Create output directory if necessary
   if (options.out && options.out !== '-' && !fs.existsSync(options.out))
@@ -259,6 +277,7 @@ function executeCommandLine(command, options, args) {
   if (!commands[command] && !commandsWithoutCompilation[command])
     throw new Error(`Missing implementation for command ${command}`);
 
+  remapCmdOptions( options, command );
 
   if (commandsWithoutCompilation[command]) {
     commandsWithoutCompilation[command]();
@@ -282,7 +301,7 @@ function executeCommandLine(command, options, args) {
   // Return the original model (for chaining)
   function toCdl( model ) {
     const csn = options.directBackend ? model : compactModel(model, options);
-    const cdlResult = main.to.cdl(csn, remapCmdOptions(options));
+    const cdlResult = main.to.cdl(csn, options);
     for (const name in cdlResult)
       writeToFileOrDisplay(options.out, `${name}.cds`, cdlResult[name]);
 
@@ -307,11 +326,11 @@ function executeCommandLine(command, options, args) {
   function toHana( model ) {
     const csn = options.directBackend ? model : compactModel(model, options);
 
-    if (options.toHana && options.toHana.csn) {
-      displayNamedCsn(for_hdbcds(csn, remapCmdOptions(options, options.toHana)), 'hana_csn');
+    if (options.csn) {
+      displayNamedCsn(for_hdbcds(csn, options), 'hana_csn');
     }
     else {
-      const hanaResult = main.to.hdbcds(csn, remapCmdOptions(options, options.toHana));
+      const hanaResult = main.to.hdbcds(csn, options);
       for (const name in hanaResult)
         writeToFileOrDisplay(options.out, name, hanaResult[name]);
     }
@@ -322,24 +341,23 @@ function executeCommandLine(command, options, args) {
   // Execute the command line option '--to-odata' and display the results.
   // Return the original model (for chaining)
   function toOdata( model ) {
-    if (options.toOdata &&
-      options.toOdata.version === 'v4x') {
-      options.toOdata.version = 'v4';
-      options.toOdata.odataFormat = 'structured';
-      options.toOdata.odataContainment = true;
+    if (options.odataVersion === 'v4x') {
+      options.odataVersion = 'v4';
+      options.odataFormat = 'structured';
+      options.odataContainment = true;
     }
     const csn = options.directBackend ? model : compactModel(model, options);
-    const odataCsn = main.for.odata(csn, remapCmdOptions(options, options.toOdata));
-    if (options.toOdata && options.toOdata.csn) {
+    if (options.csn) {
+      const odataCsn = main.for.odata(csn, options);
       displayNamedCsn(odataCsn, 'odata_csn');
     }
-    else if (options.toOdata && options.toOdata.json) {
-      const result = main.to.edm.all(odataCsn, options);
+    else if (options.json) {
+      const result = main.to.edm.all(csn, options);
       for (const serviceName in result)
         writeToFileOrDisplay(options.out, `${serviceName}.json`, result[serviceName]);
     }
     else {
-      const result = main.to.edmx.all(odataCsn, options);
+      const result = main.to.edmx.all(csn, options);
       for (const serviceName in result)
         writeToFileOrDisplay(options.out, `${serviceName}.xml`, result[serviceName]);
     }
@@ -353,14 +371,14 @@ function executeCommandLine(command, options, args) {
   // / DO NOT DELETE THIS TORENAME FUNCTIONALITY!!
   function toRename( model ) {
     const csn = options.directBackend ? model : compactModel(model, options);
-    const renameResult = toRenameWithCsn(csn, options);
-    let storedProcedure = `PROCEDURE RENAME_${renameResult.options.toRename.names.toUpperCase()}_TO_PLAIN LANGUAGE SQLSCRIPT AS BEGIN\n`;
+    const renameResult = _toRename(csn, options);
+    let storedProcedure = `PROCEDURE RENAME_${renameResult.options.sqlMapping.toUpperCase()}_TO_PLAIN LANGUAGE SQLSCRIPT AS BEGIN\n`;
     for (const name in renameResult.rename) {
       storedProcedure += `  --\n  -- ${name}\n  --\n`;
       storedProcedure += renameResult.rename[name];
     }
     storedProcedure += 'END;\n';
-    writeToFileOrDisplay(options.out, `storedProcedure_${renameResult.options.toRename.names}_to_plain.sql`, storedProcedure, true);
+    writeToFileOrDisplay(options.out, `storedProcedure_${renameResult.options.sqlMapping}_to_plain.sql`, storedProcedure, true);
     return model;
   }
 
@@ -382,21 +400,21 @@ function executeCommandLine(command, options, args) {
   // Return the original model (for chaining)
   function toSql( model ) {
     const csn = options.directBackend ? model : compactModel(model, options);
-    if (options.toSql && options.toSql.src === 'hdi') {
-      if (options.toSql.csn) {
-        displayNamedCsn(for_hdi(csn, remapCmdOptions(options, options.toSql)), 'hdi_csn');
+    if (options.src === 'hdi') {
+      if (options.csn) {
+        displayNamedCsn(for_hdi(csn, options), 'hdi_csn');
       }
       else {
-        const hdiResult = main.to.hdi(csn, remapCmdOptions(options, options.toSql));
+        const hdiResult = main.to.hdi(csn, options);
         for (const name in hdiResult)
           writeToFileOrDisplay(options.out, name, hdiResult[name]);
       }
     }
-    else if (options.toSql && options.toSql.csn) {
-      displayNamedCsn(for_sql(csn, remapCmdOptions(options, options.toSql)), 'sql_csn');
+    else if (options.csn) {
+      displayNamedCsn(for_sql(csn, options), 'sql_csn');
     }
     else {
-      const sqlResult = main.to.sql(csn, remapCmdOptions(options, options.toSql));
+      const sqlResult = main.to.sql(csn, options);
       writeToFileOrDisplay(options.out, 'model.sql', sqlResult.join('\n'), true);
     }
     return model;
@@ -447,7 +465,7 @@ function executeCommandLine(command, options, args) {
    * @param {CompileMessage[]} messages
    */
   function displayMessages( model, messages = options.messages ) {
-    if (!Array.isArray(messages))
+    if (!Array.isArray(messages) || options.quiet)
       return model;
 
     const log = console.error;
@@ -509,7 +527,7 @@ function executeCommandLine(command, options, args) {
     }
     else if (!options.lintMode) {
       const csn = compactModel(xsn, options);
-      if (command === 'toCsn' && options.toCsn && options.toCsn.withLocalized)
+      if (command === 'toCsn' && options.withLocalized)
         addLocalizationViews(csn, options);
       if (options.enrichCsn)
         enrichCsn( csn, options );
@@ -528,7 +546,7 @@ function executeCommandLine(command, options, args) {
       writeToFileOrDisplay(options.out, `${name}_raw.txt`, options.messages, true);
     }
     else if (!options.lintMode && !options.internalMsg) {
-      if (command === 'toCsn' && options.toCsn && options.toCsn.withLocalized)
+      if (command === 'toCsn' && options.withLocalized)
         addLocalizationViews(csn, options);
       writeToFileOrDisplay(options.out, `${name}.json`, csn, true);
     }
@@ -552,6 +570,8 @@ function executeCommandLine(command, options, args) {
       content = JSON.stringify(content, null, 2);
 
     if (dir === '-') {
+      if (options.quiet)
+        return;
       if (!omitHeadline) {
         const sqlTypes = {
           sql: true, hdbconstraint: true, hdbtable: true, hdbview: true,
@@ -569,15 +589,73 @@ function executeCommandLine(command, options, args) {
       fs.writeFileSync(path.join(dir, fileName), content);
     }
   }
+}
 
-  function catchErrors(err) {
-    // @ts-ignore
-    if (err instanceof Error && err.hasBeenReported)
-      return;
-    console.error( '' );
-    console.error( 'INTERNAL ERROR:' );
-    console.error( util.inspect(err, false, null) );
-    console.error( '' );
-    process.exitCode = 70;
+function loadOptionsFromJson(cmdLine) {
+  try {
+    let opt = JSON.parse(fs.readFileSync(cmdLine.options.options, 'utf-8'));
+    if (opt.cds)
+      opt = opt.cds;
+    if (opt.cdsc)
+      opt = opt.cdsc;
+    Object.assign(cmdLine.options, opt);
+    return true;
+  }
+  catch (e) {
+    catchErrors(e);
+    return false;
+  }
+}
+
+function catchErrors(err) {
+  // @ts-ignore
+  if (err instanceof Error && err.hasBeenReported)
+    return;
+  console.error( '' );
+  console.error( 'INTERNAL ERROR:' );
+  console.error( util.inspect(err, false, null) );
+  console.error( '' );
+  process.exitCode = 70;
+}
+
+/**
+ * Parses the options `--error` and similar.
+ * Sets the dictionary `severities` on the given options.
+ *
+ * @param {object} options
+ */
+function parseSeverityOptions({ options }) {
+  if (!options.severities)
+    options.severities = Object.create(null);
+
+  const severityMap = {
+    error: 'Error',
+    warn: 'Warning',
+    info: 'Info',
+    debug: 'Debug',
+  };
+
+  // Note: We use a for loop to ensure that the order of the options on the command line is respected, i.e.
+  //      `--warn id --error id` would lead to `id` being reclassified as an error and not a warning.
+  for (const key in options) {
+    switch (key) {
+      case 'error':
+      case 'warn':
+      case 'info':
+      case 'debug':
+        parseSeverityOption(options[key], severityMap[key]);
+        break;
+      default:
+        break;
+    }
+  }
+
+  function parseSeverityOption(list, severity) {
+    const ids = list.split(',');
+    for (let id of ids) {
+      id = id.trim();
+      if (id)
+        options.severities[id] = severity;
+    }
   }
 }