@sap/cds-compiler 2.15.8 → 3.1.0

package/bin/.eslintrc.json

@@ -11,6 +11,7 @@
     "no-process-exit": "off",
     "camelcase": "off",
     "radix": "off",
-    "no-shadow": "warn"
+    "no-shadow": "warn",
+    "global-require": "off"
   }
 }

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,
@@ -56,15 +57,12 @@ catch (err) {
     throw err;
 }
 
-function remapCmdOptions(options, cmdOptions) {
-  if (!cmdOptions)
-    return options;
+function remapCmdOptions(options, command) {
+  if (!command || !options[command])
+    return;
 
-  for (const [ key, value ] of Object.entries(cmdOptions)) {
+  for (const [ key, value ] of Object.entries(options[command])) {
     switch (key) {
-      case 'names':
-        options.sqlMapping = value;
-        break;
       case 'user':
         if (!options.variableReplacements)
           options.variableReplacements = {};
@@ -72,12 +70,6 @@ function remapCmdOptions(options, cmdOptions) {
           options.variableReplacements.$user = {};
         options.variableReplacements.$user.id = value;
         break;
-      case 'dialect':
-        options.sqlDialect = value;
-        break;
-      case 'version':
-        options.odataVersion = value;
-        break;
       case 'locale':
         if (!options.variableReplacements)
           options.variableReplacements = {};
@@ -92,7 +84,7 @@ function remapCmdOptions(options, cmdOptions) {
         options[key] = value;
     }
   }
-  return options;
+  delete options[command];
 }
 
 function cdsc_main() {
@@ -154,12 +146,17 @@ function cdsc_main() {
   if (cmdLine.options.rawOutput)
     cmdLine.options.attachValidNames = true;
 
-  // Internally, parseCdl is an option so we map the command to it.
+  // Internally, parseCdl/parseOnly are options, so we map the command to it.
   if (cmdLine.command === 'parseCdl') {
     cmdLine.command = 'toCsn';
     cmdLine.options.parseCdl = true;
     cmdLine.args.files = [ cmdLine.args.file ];
   }
+  else if (cmdLine.command === 'parseOnly') {
+    cmdLine.command = 'toCsn';
+    cmdLine.options.parseOnly = true;
+    cmdLine.args.files = [ cmdLine.args.file ];
+  }
 
   if (cmdLine.options.directBackend)
     validateDirectBackendOption(cmdLine.command, cmdLine.options, cmdLine.args);
@@ -265,6 +262,7 @@ function executeCommandLine(command, options, args) {
     toRename,
     manageConstraints,
     toSql,
+    inspect,
   };
   const commandsWithoutCompilation = {
     explain,
@@ -273,6 +271,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]();
@@ -296,7 +295,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]);
 
@@ -321,11 +320,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]);
     }
@@ -336,25 +335,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 odataOptions = remapCmdOptions(options, options.toOdata);
-    if (options.toOdata && options.toOdata.csn) {
-      const odataCsn = main.for.odata(csn, odataOptions);
+    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(csn, odataOptions);
+    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(csn, odataOptions);
+      const result = main.to.edmx.all(csn, options);
       for (const serviceName in result)
         writeToFileOrDisplay(options.out, `${serviceName}.xml`, result[serviceName]);
     }
@@ -368,14 +365,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;
   }
 
@@ -397,21 +394,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;
@@ -429,6 +426,24 @@ function executeCommandLine(command, options, args) {
       console.log(explainMessage(args.messageId));
   }
 
+  function inspect(model) {
+    const inspectModel = require('../lib/inspect');
+
+    if (options.statistics) {
+      const result = inspectModel.inspectModelStatistics(model, options);
+      if (result)
+        console.log(result);
+    }
+
+    if (options.propagation) {
+      const result = inspectModel.inspectPropagation(model, options, options.propagation);
+      if (result)
+        console.log(result);
+    }
+
+    return model;
+  }
+
   // Display error messages in `err` resulting from a compilation.  Also set
   // process.exitCode - process.exit() will force the process to exit as quickly
   // as possible = is problematic, since console.error() might be asynchronous
@@ -522,9 +537,9 @@ function executeCommandLine(command, options, args) {
     else if (options.internalMsg) {
       writeToFileOrDisplay(options.out, `${name}_raw.txt`, util.inspect(reveal(xsn).messages, { depth: null, maxArrayLength: null }), true);
     }
-    else if (!options.lintMode) {
+    else if (!options.parseOnly) { // no output if parseOnly but not rawOutput
       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 );
@@ -542,8 +557,8 @@ function executeCommandLine(command, options, args) {
     if (options.internalMsg) {
       writeToFileOrDisplay(options.out, `${name}_raw.txt`, options.messages, true);
     }
-    else if (!options.lintMode && !options.internalMsg) {
-      if (command === 'toCsn' && options.toCsn && options.toCsn.withLocalized)
+    else if (!options.internalMsg) {
+      if (command === 'toCsn' && options.withLocalized)
         addLocalizationViews(csn, options);
       writeToFileOrDisplay(options.out, `${name}.json`, csn, true);
     }
@@ -555,7 +570,7 @@ function executeCommandLine(command, options, args) {
   // If displaying to stdout, prepend a headline containing 'filename', unless 'omitHeadline' is set.
   // For filenames, illegal characters (slash, backslash, colon) are replaced by '_'.
   function writeToFileOrDisplay(dir, fileName, content, omitHeadline = false) {
-    if (options.lintMode && !options.rawOutput || options.internalMsg)
+    if (options.internalMsg)
       return;
     fileName = fileName.replace(/[:/\\]/g, '_');
 

package/doc/API.md

@@ -0,0 +1,11 @@
+# CDS Compiler API Documentation
+
+The API of `@sap/cds-compiler` is described in a TypeScript declaration file
+[`main.d.ts`](../lib/main.d.ts).
+
+Refer to that file for documentation on option names, API calls, and more.
+
+You can use [TypeDoc] to render an HTML documentation from it.
+
+
+[TypeDoc]: https://typedoc.org/