@sap/cds-compiler 2.10.4 → 2.11.0

package/CHANGELOG.md

@@ -7,6 +7,56 @@
 Note: `beta` fixes, changes and features are usually not listed in this ChangeLog but [here](doc/CHANGELOG_BETA.md).
 The compiler behavior concerning `beta` features can change at any time without notice.
 
+## Version 2.11.0 - 2021-12-02
+
+### Added
+
+- Option `defaultBinaryLength` to set a `length` type facet for all definitions with type `cds.Binary`. This option
+  overrides the default binary length in the database backends and is also used as `MaxLength` attribute in Odata.
+- If doc-comments are ignored by the compiler, an info message is now emitted.  A doc-comment is ignored,
+  if it can't be assigned to an artifact.  For example for two subsequent doc-comments, the first doc-comment
+  is ignored.  To suppress these info messages, explicitly set option `docComment` to `false`.
+- `cdsc`:
+  - `cdsc explain list` can now be used to get a list of message IDs with explanation texts.
+  - `cdsc` now respects the environment variable `NO_COLOR`. If set, no ANSI escape codes will be used.
+    Can be overwritten by `cdsc --color always`.
+- to.sql/hdi: Support SQL Window Functions
+- to.sql/hdi/hdbcds:
+  + Support configuration of `$session` and `$user` via option `variableReplacements`.
+  + Restricted support for SQL foreign key constraints if option `assertIntegrityType` is set to `"DB"`.
+    The behavior of this feature might change in the future.
+
+### Changed
+
+- Updated OData vocabularies 'Common' and 'UI'.
+- to.sql/hdi/hdbcds: The default length of `cds.Binary` is set to `5000` similar to `cds.String`.
+
+### Removed
+
+- to.hdbcds: Doc comments on view columns are not rendered anymore. Doc comments on string literals will make the deployment fail
+  as the SAP HANA CDS compiler concatenates the doc comment with the string literal. Besides that, doc comments on view columns
+  are not transported to the database by SAP HANA CDS.
+- to.hdbcds/sql/hdi: Forbid associations in filters after `exists` (except for nested `exists`), as the final behavior is not yet specified.
+
+### Fixed
+
+- CSN parser: doc-comment extensions are no longer ignored.
+- Properly check for duplicate annotation definitions.
+- Correctly apply annotations on inherited enum symbols.
+- Correctly apply annotations on elements in an inherited structure array.
+- Fix a bug in API `defaultStringLength` value evaluation.
+- Fix crash if named arguments are used in a function that's inside a `CASE` statement.
+- to.sql/hdi/hdbcds:
+  + Properly flatten ad-hoc defined elements in `returns` / `params` of `actions` and `functions`.
+  + Correctly handle `*` in non-first position.
+  + Correctly handle action return types
+  + Correctly handle mixin association named `$self`
+- to.cdl: doc-comments are no longer rendered twice.
+- to.edm(x):
+  + Fix a bug in V2/V4 partner ship calculation.
+  + Remove warning of unknown types for Open Types in `@Core.Dictionary`.
+  + An empty CSN no longer results in a JavaScript type error
+
 ## Version 2.10.4 - 2021-11-05
 
 ### Fixed

package/bin/cdsc.js

@@ -26,8 +26,10 @@ const path = require('path');
 const { reveal } = require('../lib/model/revealInternalProperties');
 const enrichCsn = require('../lib/model/enrichCsn');
 const { optionProcessor } = require('../lib/optionProcessor');
-const { explainMessage, hasMessageExplanation, sortMessages } = require('../lib/base/messages');
-const term = require('../lib/utils/term');
+const {
+  explainMessage, hasMessageExplanation, sortMessages, messageIdsWithExplanation,
+} = require('../lib/base/messages');
+const { term } = require('../lib/utils/term');
 const { splitLines } = require('../lib/utils/file');
 const { addLocalizationViews } = require('../lib/transform/localized');
 const { availableBetaFlags } = require('../lib/base/model');
@@ -52,9 +54,11 @@ function remapCmdOptions(options, cmdOptions) {
         options.sqlMapping = value;
         break;
       case 'user':
-        if (!options.magicVars)
-          options.magicVars = {};
-        options.magicVars.user = value;
+        if (!options.variableReplacements)
+          options.variableReplacements = {};
+        if (!options.variableReplacements.$user)
+          options.variableReplacements.$user = {};
+        options.variableReplacements.$user.id = value;
         break;
       case 'dialect':
         options.sqlDialect = value;
@@ -63,9 +67,11 @@ function remapCmdOptions(options, cmdOptions) {
         options.odataVersion = value;
         break;
       case 'locale':
-        if (!options.magicVars)
-          options.magicVars = {};
-        options.magicVars.locale = value;
+        if (!options.variableReplacements)
+          options.variableReplacements = {};
+        if (!options.variableReplacements.$user)
+          options.variableReplacements.$user = {};
+        options.variableReplacements.$user.locale = value;
         break;
       default:
         options[key] = value;
@@ -124,8 +130,6 @@ try {
       global.cds = {};
     global.cds.home = cmdLine.options.cdsHome;
   }
-  // Default color mode is 'auto'
-  term.useColor(cmdLine.options.color || 'auto');
 
   // Set default command if required
   cmdLine.command = cmdLine.command || 'toCsn';
@@ -137,10 +141,7 @@ try {
   if (cmdLine.command === 'parseCdl') {
     cmdLine.command = 'toCsn';
     cmdLine.options.parseCdl = true;
-    if (cmdLine.args.files.length > 1) {
-      const err = `'parseCdl' expects exactly one file! ${cmdLine.args.files.length} provided.`;
-      displayUsage(err, optionProcessor.commands.parseCdl.helpText, 2);
-    }
+    cmdLine.args.files = [ cmdLine.args.file ];
   }
 
   if (cmdLine.options.directBackend)
@@ -155,6 +156,14 @@ try {
     });
   }
 
+  // remap string values for `assertIntegrity` option to boolean
+  if (cmdLine.options.assertIntegrity &&
+      cmdLine.options.assertIntegrity === 'true' ||
+      cmdLine.options.assertIntegrity === 'false'
+  )
+    cmdLine.options.assertIntegrity = Boolean(cmdLine.options.assertIntegrity);
+
+
   // Enable all beta-flags if betaMode is set to true
   if (cmdLine.options.betaMode)
     cmdLine.options.beta = availableBetaFlags;
@@ -231,6 +240,8 @@ function executeCommandLine(command, options, args) {
   if (options.out && options.out !== '-' && !fs.existsSync(options.out))
     fs.mkdirSync(options.out);
 
+  // Default color mode is 'auto'
+  const colorTerm = term(options.color || 'auto');
 
   // Add implementation functions corresponding to commands here
   const commands = {
@@ -393,14 +404,15 @@ function executeCommandLine(command, options, args) {
   }
 
   function explain() {
-    if (args.length !== 1)
-      displayUsage('Command \'explain\' expects exactly one message-id.', optionProcessor.commands.explain.helpText, 2);
+    if (args.messageId === 'list') {
+      console.log(messageIdsWithExplanation().join('\n'));
+      throw new ProcessExitError(0);
+    }
 
-    const id = args.files[0];
-    if (!hasMessageExplanation(id))
-      console.error(`Message '${id}' does not have an explanation!`);
+    if (!hasMessageExplanation(args.messageId))
+      console.error(`Message '${args.messageId}' does not have an explanation!`);
     else
-      console.log(explainMessage(id));
+      console.log(explainMessage(args.messageId));
   }
 
   // Display error messages in `err` resulting from a compilation.  Also set
@@ -464,16 +476,20 @@ function executeCommandLine(command, options, args) {
         hasAtLeastOneExplanation = hasAtLeastOneExplanation || main.hasMessageExplanation(msg.messageId);
         const name = msg.location && msg.location.file;
         const fullFilePath = name ? path.resolve('', name) : undefined;
-        const context = fullFilePath && sourceLines(fullFilePath);
+        const context = fullFilePath ? sourceLines(fullFilePath) : [];
         log(main.messageStringMultiline(msg, {
-          normalizeFilename, noMessageId: !options.showMessageId, withLineSpacer: true, hintExplanation: true,
+          normalizeFilename,
+          noMessageId: !options.showMessageId,
+          withLineSpacer: true,
+          hintExplanation: true,
+          color: options.color,
         }));
         if (context)
-          log(main.messageContext(context, msg));
+          log(main.messageContext(context, msg, { color: options.color }));
         log(); // newline
       });
       if (options.showMessageId && hasAtLeastOneExplanation)
-        log(`${term.help('help')}: Messages marked with '…' have an explanation text. Use \`cdsc explain <message-id>\` for a more detailed error description.`);
+        log(`${colorTerm.help('help')}: Messages marked with '…' have an explanation text. Use \`cdsc explain <message-id>\` for a more detailed error description.`);
     }
     return model;
   }
@@ -549,10 +565,11 @@ function executeCommandLine(command, options, args) {
   }
 
   function catchErrors(err) {
+    // @ts-ignore
     if (err instanceof Error && err.hasBeenReported)
       return;
     console.error( '' );
-    console.error( 'INTERNAL ERROR: %s', err );
+    console.error( 'INTERNAL ERROR:' );
     console.error( util.inspect(err, false, null) );
     console.error( '' );
     process.exitCode = 70;

package/bin/cdsse.js

@@ -11,6 +11,7 @@
 // Planned are: gotoDefinition, highlight (for syntax highighting).
 
 /* eslint no-console:off */
+// @ts-nocheck
 
 'use strict';
 

package/doc/CHANGELOG_BETA.md

@@ -8,6 +8,10 @@ Note: `beta` fixes, changes and features are listed in this ChangeLog just for i
 The compiler behavior concerning `beta` features can change at any time without notice.
 **Don't use `beta` fixes, changes and features in productive mode.**
 
+## Version 2.11.0
+
+### Removed `foreignKeyConstraints`
+
 ## Version 2.10.4
 
 ### Fixed `nestedProjections`

package/lib/api/.eslintrc.json

@@ -14,6 +14,8 @@
     "jsdoc"
   ],
   "rules": {
+    // Does not recognize TS types
+    "jsdoc/no-undefined-types": "off",
     // eslint-plugin-jsdoc warning
     "jsdoc/require-property": 0,
     // =airbnb, >eslint:

package/lib/api/main.js

@@ -14,7 +14,7 @@ const { toSqlDdl } = require('../render/toSql');
 const { compareModels } = require('../modelCompare/compare');
 const sortViews = require('../model/sortViews');
 const { getResultingName } = require('../model/csnUtils');
-const timetrace = require('../utils/timetrace');
+const { timetrace } = require('../utils/timetrace');
 const { transformForHanaWithCsn } = require('../transform/forHanaNew');
 
 /**
@@ -135,7 +135,7 @@ function odataInternal(csn, internalOptions) {
  * Return a odata-transformed CSN
  *
  * @param {CSN.Model} csn Clean input CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {oDataCSN} Return an oData-pre-processed CSN
  */
 function odata(csn, options = {}) {
@@ -454,7 +454,7 @@ function hdbcds(csn, options = {}) {
  * Generate a edm document for the given service
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edm} The JSON representation of the service
  */
 function edm(csn, options = {}) {
@@ -484,7 +484,7 @@ edm.all = edmall;
  * Generate edm documents for all services
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edms} { <service>:<JSON representation>, ...}
  */
 function edmall(csn, options = {}) {
@@ -516,7 +516,7 @@ function edmall(csn, options = {}) {
  * Generate a edmx document for the given service
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edmx} The XML representation of the service
  */
 function edmx(csn, options = {}) {
@@ -547,7 +547,7 @@ edmx.all = edmxall;
  * Generate edmx documents for all services
  *
  * @param {CSN|oDataCSN} csn Clean input CSN or a pre-transformed CSN
- * @param {oDataOptions} [options={}] Options
+ * @param {ODataOptions} [options={}] Options
  * @returns {edmxs} { <service>:<XML representation>, ...}
  */
 function edmxall(csn, options = {}) {
@@ -709,20 +709,6 @@ function publishCsnProcessor( processor, _name ) {
  * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
  */
 
-/**
- * Options available for all oData-based functions
- *
- * @typedef {object} oDataOptions
- * @property {object} [beta] Enable experimental features - not for productive use!
- * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
- * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message
- * @property {Array} [messages] Allows collecting all messages in the options instead of printing them to stderr.
- * @property {oDataVersion} [odataVersion='v4'] Odata version to use
- * @property {oDataFormat} [odataFormat='flat'] Wether to generate oData as flat or as structured. Structured only with v4.
- * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
- * @property {string} [service] If a single service is to be rendered
- */
-
 /**
  * Options available for to.hdi
  *
@@ -753,9 +739,9 @@ function publishCsnProcessor( processor, _name ) {
  * @typedef {object} sqlOptions
  * @property {NamingMode} [sqlMapping='plain'] Naming mode to use
  * @property {SQLDialect} [sqlDialect='sqlite'] SQL dialect to use
- * @property {object} [magicVars] Object containing values for magic variables like "$user"
- * @property {string} [magicVars.locale] Value for the "$user.locale" in "sqlite" dialect
- * @property {string} [magicVars.user] Value for the "$user" variable in "sqlite" dialect
+ * @property {object} [variableReplacements] Object containing values for magic variables like "$user"
+ * @property {string} [variableReplacements.$user.locale] Value for the "$user.locale" variable
+ * @property {string} [variableReplacements.$user.id] Value for the "$userid" variable
  * @property {object} [beta] Enable experimental features - not for productive use!
  * @property {boolean} [longAutoexposed=false] Deprecated: Produce long names (with underscores) for autoexposed entities
  * @property {Map<string, number>} [severities={}] Map of message-id and severity that allows setting the severity for the given message

package/lib/api/options.js

@@ -15,6 +15,7 @@ const publicOptionsNewAPI = [
   'severities',
   'messages',
   'withLocations',
+  'defaultBinaryLength',
   'defaultStringLength',
   'csnFlavor',
   // DB
@@ -23,7 +24,8 @@ const publicOptionsNewAPI = [
   'sqlChangeMode',
   'allowCsnDowngrade',
   'joinfk',
-  'magicVars',
+  'magicVars', // deprecated
+  'variableReplacements',
   // ODATA
   'odataVersion',
   'odataFormat',
@@ -47,9 +49,10 @@ const privateOptions = [
   'traceParserAmb',
   'testMode',
   'testSortCsn',
-  'constraintsNotEnforced',
-  'constraintsNotValidated',
-  'skipDbConstraints',
+  'integrityNotEnforced',
+  'integrityNotValidated',
+  'assertIntegrity',
+  'assertIntegrityType',
   'noRecompile',
   'internalMsg',
   'disableHanaComments',      // in case of issues with hana comment rendering
@@ -109,6 +112,10 @@ function translateOptions(input = {}, defaults = {}, hardRequire = {},
     mapToOldNames(optionName, optionValue);
   }
 
+  // Convenience for $user -> $user.id replacement
+  if (options.variableReplacements && options.variableReplacements.$user && typeof options.variableReplacements.$user === 'string')
+    options.variableReplacements.$user = { id: options.variableReplacements.$user };
+
   /**
    * Map a new-style option to it's old format
    *
@@ -130,6 +137,7 @@ function translateOptions(input = {}, defaults = {}, hardRequire = {},
       case 'sqlMapping':
         options.names = optionValue;
         break;
+      // No need to remap variableReplacements here - we use the new mechanism with that directly
       case 'magicVars':
         if (optionValue.user)
           options.user = optionValue.user;

package/lib/api/validate.js

@@ -70,6 +70,14 @@ const validators = {
       return val === null ? val : `type ${ typeof val }`;
     },
   },
+  // TODO: Maybe do a deep validation of the whole object with leafs?
+  variableReplacements: {
+    validate: val => val !== null && typeof val === 'object' && !Array.isArray(val),
+    expected: () => 'type object',
+    found: (val) => {
+      return val === null ? val : `type ${ typeof val }`;
+    },
+  },
   messages: {
     validate: val => Array.isArray(val),
     expected: () => 'type array',
@@ -89,10 +97,17 @@ const validators = {
     expected: () => 'type array of string',
     found: val => `type ${ typeof val }`,
   },
+  defaultBinaryLength: {
+    validate: val => !Number.isNaN(Number(val)) && Number.isInteger(Number.parseFloat(val)),
+
+    expected: () => 'Integer literal',
+    found: val => `${ (!Number.isNaN(Number(val)) ? val : 'Not a Number') }`,
+  },
   defaultStringLength: {
-    validate: val => Number.isInteger(val),
+    validate: val => !Number.isNaN(Number(val)) && Number.isInteger(Number.parseFloat(val)),
+
     expected: () => 'Integer literal',
-    found: val => `type ${ typeof val }`,
+    found: val => `${ (!Number.isNaN(Number(val)) ? val : 'Not a Number') }`,
   },
   csnFlavor: {
     validate: val => typeof val === 'string',
@@ -102,6 +117,12 @@ const validators = {
   dictionaryPrototype: {
     validate: () => true,
   },
+  assertIntegrity: {
+    validate: val => typeof val === 'string' && val === 'individual' || typeof val === 'boolean',
+    expected: () => 'a boolean or a string with value \'individual\'',
+    found: val => (typeof val === 'string' ? val : `type ${ typeof val }`),
+  },
+  assertIntegrityType: generateStringValidator([ 'DB', 'RT' ]),
 };
 
 const allCombinationValidators = {

package/lib/backends.js

@@ -14,7 +14,7 @@ const { csn2edm, csn2edmAll } = require('./edm/csn2edm');
 const { mergeOptions }  = require('./model/csnUtils');
 const { isBetaEnabled } = require('./base/model');
 const { optionProcessor } = require('./optionProcessor')
-const timetrace = require('./utils/timetrace');
+const { timetrace } = require('./utils/timetrace');
 const { makeMessageFunction } = require('./base/messages');
 const { forEachDefinition } = require('./model/csnUtils');
 
@@ -92,9 +92,9 @@ function toOdataWithCsn(csn, options) {
 // Generate edmx for given 'service' based on 'csn' (new-style compact, already prepared for OData)
 // using 'options'
 function preparedCsnToEdmx(csn, service, options) {
-  let edmx = csn2edm(csn, service, options).toXML('all');
+  const e = csn2edm(csn, service, options)
   return {
-    edmx,
+    edmx: (e ? e.toXML('all') : undefined)
   };
 }
 
@@ -115,9 +115,9 @@ function preparedCsnToEdmxAll(csn, options) {
 function preparedCsnToEdm(csn, service, options) {
   // Merge options; override OData version as edm json is always v4
   options = mergeOptions(options, { toOdata : { version : 'v4' }});
-  const edmj = csn2edm(csn, service, options).toJSON();
+  const e = csn2edm(csn, service, options);
   return {
-    edmj,
+    edmj: (e ? e.toJSON() : undefined)
   };
 }
 
@@ -405,9 +405,6 @@ function toRenameWithCsn(csn, options) {
 
 function alterConstraintsWithCsn(csn, options) {
   const { error } = makeMessageFunction(csn, options, 'manageConstraints');
-  // Requires beta mode
-  if (!isBetaEnabled(options, 'foreignKeyConstraints'))
-    error(null, null, 'ALTER TABLE statements for adding/modifying referential constraints are only available in beta mode');
 
   const {
     drop, alter, names, src, violations
@@ -420,6 +417,10 @@ function alterConstraintsWithCsn(csn, options) {
     dialect: 'hana',
     names: names || 'plain'
   }
+
+  // Of course we want the database constraints
+  options.assertIntegrityType = 'DB';
+
   const transformedOptions = transformSQLOptions(csn, options);
   const mergedOptions = mergeOptions(transformedOptions.options, { forHana : transformedOptions.forHanaOptions });
   const forSqlCsn = transformForHanaWithCsn(csn, mergedOptions, 'to.sql');

package/lib/base/dictionaries.js

@@ -28,6 +28,7 @@ function dictAdd( dict, name, entry, duplicateCallback ) {
 }
 
 function dictForEach( dict, callback ) {
+  // TODO: probably define an extra dictForEachArray()
   for (const name in dict) {
     const entry = dict[name];
     if (Array.isArray(entry)) {
@@ -35,7 +36,7 @@ function dictForEach( dict, callback ) {
     }
     else {
       callback( entry );
-      if (Array.isArray(entry.$duplicates))
+      if (Array.isArray( entry.$duplicates ))
         entry.$duplicates.forEach( callback );
     }
   }

package/lib/base/message-registry.js

@@ -118,6 +118,7 @@ const centralMessages = {
   'syntax-anno-after-params': { severity: 'Error', configurableFor: true }, // does not hurt
   'syntax-anno-after-struct': { severity: 'Error', configurableFor: true }, // does not hurt
   'syntax-csn-expected-cardinality': { severity: 'Error' }, // TODO: more than 30 chars
+  'syntax-csn-expected-length': { severity: 'Error' },
   'syntax-csn-expected-translation': { severity: 'Error' }, // TODO: more than 30 chars
   'syntax-csn-required-subproperty': { severity: 'Error' }, // TODO: more than 30 chars
   'syntax-csn-unexpected-property': { severity: 'Error', configurableFor: true }, // is the removed
@@ -133,6 +134,7 @@ const centralMessages = {
   'odata-spec-violation-array':  { severity: 'Warning' }, // more than 30 chars
   'odata-spec-violation-constraints': { severity: 'Info' }, // more than 30 chars
   'odata-spec-violation-type': { severity: 'Error', configurableFor: [ 'to.edmx' ] },
+  'odata-spec-violation-no-key':  { severity: 'Warning' },
   'odata-spec-violation-key-array':  { severity: 'Error' }, // more than 30 chars
   'odata-spec-violation-key-null': { severity: 'Error' }, // more than 30 chars
   'odata-spec-violation-key-type': { severity: 'Warning' }, // more than 30 chars
@@ -160,6 +162,11 @@ const centralMessageTexts = {
     $tableImplicit: 'The resulting table alias starts with $(NAME) and might shadow a special variable - specify another name with $(KEYWORD)',
     mixin: 'A mixin name starting with $(NAME) might shadow a special variable - replace by another name' ,
   },
+  'syntax-csn-expected-length': {
+    std: 'Expected array in $(PROP) to have at least $(N) items',
+    one: 'Expected array in $(PROP) to have at least one item',
+    suffix: 'With sibling property $(OTHERPROP), expected array in $(PROP) to have at least one item',
+  },
   'ref-undefined-def': {
     std: 'Artifact $(ART) has not been found',
     // TODO: proposal 'No definition of $(NAME) found',
@@ -203,13 +210,13 @@ const centralMessageTexts = {
   'duplicate-definition': {
     std: 'Duplicate definition of $(NAME)',
     absolute: 'Duplicate definition of artifact $(NAME)',
-    namespace: 'Other definition blocks $(NAME) for namespace name',
+    annotation: 'Duplicate definition of annotation vocabulary $(NAME)',
     element: 'Duplicate definition of element $(NAME)',
     enum: 'Duplicate definition of enum $(NAME)',
     key: 'Duplicate definition of key $(NAME)',
     action: 'Duplicate definition of action or function $(NAME)',
     param: 'Duplicate definition of parameter $(NAME)',
-    $tableAlias: 'Duplicate definition of table alias or mixin $(NAME)',
+    alias: 'Duplicate definition of table alias or mixin $(NAME)',
   },
 
   // TODO: rename to ref-expected-XYZ
@@ -262,6 +269,7 @@ const centralMessageTexts = {
     std: 'Unexpected $(TYPE) mapped to $(ID) as type for key element $(NAME)', // structured
     scalar: 'Unexpected $(TYPE) mapped to $(ID) as type for key element' // flat
   },
+  'odata-spec-violation-no-key': 'Expected entity to have a primary key',
   'odata-spec-violation-type': 'Expected element to have a type',
   'odata-spec-violation-property-name': 'Expected element name to be different from declaring $(KIND)',
   'odata-spec-violation-namespace': 'Expected service name not to be one of the reserved names $(NAMES)',

package/lib/base/messages.js

@@ -4,7 +4,7 @@
 
 'use strict';
 
-const term = require('../utils/term');
+const { term } = require('../utils/term');
 const { locationString } = require('./location');
 const { isDeprecatedEnabled } = require('./model');
 const { centralMessages, centralMessageTexts } = require('./message-registry');
@@ -15,6 +15,8 @@ const { analyseCsnPath, traverseQuery } = require('../model/csnRefs');
 const fs = require('fs');
 const path = require('path');
 
+// term instance for messages
+const colorTerm = term();
 
 // Functions ensuring message consistency during runtime with --test-mode
 
@@ -853,19 +855,26 @@ function messageHash(msg) {
  *
  * Example:
  * ```txt
- * Error[message-id]: Can't find type `nu` in this scope (in entity:“E”/element:“e”)
+ * Error[message-id]: Can't find type `nu` in this scope
  *    |
- *   <source>.cds:3:11, at entity:“E”
+ *   <source>.cds:3:11, at entity:“E”/element:“e”
  * ```
+ *
  * @param {CSN.Message} err
  * @param {object} [config = {}]
  * @param {boolean} [config.normalizeFilename] Replace windows `\` with forward slashes `/`.
  * @param {boolean} [config.noMessageId]
  * @param {boolean} [config.hintExplanation] If true, messages with explanations will get a "…" marker.
- * @param {boolean} [config.withLineSpacer] If true, an additional line (with `|`) will be inserted between message and location.
+ * @param {boolean} [config.withLineSpacer]  If true, an additional line (with `|`) will be inserted between message and location.
+ * @param {boolean | 'auto'} [config.color]  If true, ANSI escape codes will be used for coloring the severity.  If false, no
+ *                                           coloring will be used.  If 'auto', we will decide based on certain factors such
+ *                                           as whether the shell is a TTY and whether the environment variable 'NO_COLOR' is
+ *                                           unset.
  * @returns {string}
  */
 function messageStringMultiline( err, config = {} ) {
+  colorTerm.changeColorMode(config ? config.color : 'auto');
+
   const explainHelp = (config.hintExplanation && hasMessageExplanation(err.messageId)) ? '…' : '';
   const msgId = (err.messageId && !config.noMessageId) ? `[${ err.messageId }${ explainHelp }]` : '';
   const home = !err.home ? '' : ('at ' + err.home);
@@ -878,7 +887,7 @@ function messageStringMultiline( err, config = {} ) {
       location += ', '
   }
   else if (!home)
-    return term.asSeverity(severity, severity + msgId) + ' ' + err.message;
+    return colorTerm.severity(severity, severity + msgId) + ' ' + err.message;
 
   let lineSpacer = '';
   if (config.withLineSpacer) {
@@ -886,8 +895,7 @@ function messageStringMultiline( err, config = {} ) {
     lineSpacer = `\n  ${ ' '.repeat( additionalIndent ) }|`;
   }
 
-  // TODO: use ':' before text
-  return term.asSeverity(severity, severity + msgId) + ': ' + err.message + lineSpacer + '\n  ' + location + home;
+  return colorTerm.severity(severity, severity + msgId) + ': ' + err.message + lineSpacer + '\n  ' + location + home;
 }
 
 /**
@@ -901,9 +909,15 @@ function messageStringMultiline( err, config = {} ) {
  * @param {string[]} sourceLines The source code split up into lines, e.g. by `splitLines(src)`
  *                               from `lib/utils/file.js`
  * @param {CSN.Message} err Error object containing all details like line, message, etc.
+ * @param {object} [config = {}]
+ * @param {boolean | 'auto'} [config.color] If true, ANSI escape codes will be used for coloring the `^`.  If false, no
+ *                                          coloring will be used.  If 'auto', we will decide based on certain factors such
+ *                                          as whether the shell is a TTY and whether the environment variable 'NO_COLOR' is
+ *                                          unset.
  * @returns {string}
  */
-function messageContext(sourceLines, err) {
+function messageContext(sourceLines, err, config) {
+  colorTerm.changeColorMode(config ? config.color : 'auto');
   const MAX_COL_LENGTH = 100;
 
   const loc = err.$location;
@@ -955,7 +969,7 @@ function messageContext(sourceLines, err) {
     // Indicate that the error is further to the right.
     if (endColumn === MAX_COL_LENGTH)
       highlighter = highlighter.replace('  ^', '..^');
-    msg += indent + '| ' + term.asSeverity(severity, highlighter);
+    msg += indent + '| ' + colorTerm.severity(severity, highlighter);
 
   } else if (maxLine !== endLine) {
     // error spans more lines which we don't print