@sap/cds-compiler 4.7.6 → 4.9.0

package/share/messages/type-missing-enum-value.md

@@ -0,0 +1,59 @@
+# type-missing-enum-value
+
+An enum definition is missing explicit values for one or more of its entries.
+
+Enum definitions that aren't based on string-types do not get implicit values.
+They have therefore to be defined explicitly in the model.
+
+The message’s severity is `Warning` and is raised by the compiler.  You need
+to adapt your model to fix the warning.
+
+## Example
+
+Erroneous code example:
+
+```cds
+entity Books {
+  // …
+  category: Integer enum {
+    Fiction; // ❌
+    Action;  // ❌
+    // …
+  } default #Action;
+};
+```
+
+Both entries `#Fiction` and `#Action` of the enum `category` are missing an
+explicit value.  Because the base type `Integer` is not a string, no implicit
+values are defined for them.
+
+## How to Fix
+
+Explicitly assign a value or change the type to a string if the values are not
+important in your model.  The erroneous example above can be changed to:
+
+```cds
+entity Books {
+  // …
+  category: Integer enum {
+    Fiction = 1;
+    Action = 2;
+    // …
+  } default #Action;
+};
+```
+
+## Background
+
+Many languages support implicit values for integer-like enums.  However,
+CAP CDS does not have this feature, because otherwise, if values are persisted,
+adding a new entry in-between existing ones would lead to issues during
+deserialization later on.
+
+Assume that CAP would assign implicit values for integer enums.  If a new value
+were to be added between `Fiction` and `Action` in the erroneous example above,
+then the generated SQL statement for entity `Books` would change:  
+Instead of default value `2`, value `3` would be persisted.  Without data
+migration, existing action books would have changed their category.
+
+To avoid this scenario, always add explicit values to enums.

package/share/messages/wildcard-excluding-one.md

@@ -17,7 +17,7 @@ entity Book {
 };
 entity IsbnBook as projection on Book {
   *,
-  isbn as id,
+  isbn as id, // ❌
 };
 ```
 

package/bin/.eslintrc.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["../.eslintrc-ydkjsi.json"],
-  "rules": {
-    "prefer-const": "error",
-    "quotes": ["error", "single", "avoid-escape"],
-    "prefer-template": "error",
-    "no-trailing-spaces": "error",
-    "template-curly-spacing": ["error", "never"],
-    "max-len": "off",
-    "no-console": "off",
-    "no-process-exit": "off",
-    "camelcase": "off",
-    "radix": "off",
-    "no-shadow": "warn",
-    "global-require": "off"
-  }
-}

package/lib/api/.eslintrc.json

@@ -1,37 +0,0 @@
-{
-  "root": true,
-  "env": {
-    "es2022": true,
-    "node": true
-  },
-  // we actually do not extend airbnb-base, as it weakens some eslint:recommended rules
-  "extends": ["plugin:jsdoc/recommended", "../../.eslintrc-ydkjsi.json"],
-  "parserOptions": {
-    "ecmaVersion": 2022,
-    "sourceType": "script"
-  },
-  "plugins":  [
-    "jsdoc"
-  ],
-  "rules": {
-    // Does not recognize TS types
-    "jsdoc/no-undefined-types": "off",
-    // eslint-plugin-jsdoc warning
-    "jsdoc/require-property": 0,
-    "jsdoc/tag-lines": "off",
-    // =airbnb, >eslint:
-    "max-len": [ "error", {
-      "code": 100,
-      "tabWidth": 2,
-      "ignoreComments": true,
-      "ignoreRegExpLiterals": true,
-      "ignoreStrings": true,
-      "ignoreTemplateLiterals": true
-    }]
-  },
-  "settings": {
-    "jsdoc": {
-      "mode": "typescript"
-    }
-  }
-}

package/lib/checks/.eslintrc.json

@@ -1,31 +0,0 @@
-{
-  // we actually do not extend airbnb-base, as it weakens some eslint:recommended rules
-  "extends": ["plugin:jsdoc/recommended", "../../.eslintrc-ydkjsi.json"],
-  "plugins":  [
-    "jsdoc"
-  ],
-  "rules": {
-    "cds-compiler/message-no-quotes": "off",
-    "quotes": ["error", "single", {
-      "avoidEscape": true,
-      "allowTemplateLiterals": true
-    }],
-    "jsdoc/no-undefined-types": 0,
-    // eslint-plugin-jsdoc warning
-    "jsdoc/require-property": 0,
-    // most of the main functions have the normal forEachArtifact/Member signature anyway
-    "jsdoc/require-param-description": 0,
-    // there seem to be false positives
-    "jsdoc/require-returns-check": 0,
-    "jsdoc/tag-lines": 0,
-    // =airbnb, >eslint:
-    "max-len": [ "error", {
-      "code": 110,
-      "tabWidth": 2,
-      "ignoreComments": true,
-      "ignoreRegExpLiterals": true,
-      "ignoreStrings": true,
-      "ignoreTemplateLiterals": true
-    }]
-  }
-}

package/lib/compiler/.eslintrc.json

@@ -1,8 +0,0 @@
-{
-  "root": true,
-  "extends": "../../.eslintrc-ydkjsi.json",
-  "rules": {
-    "cds-compiler/message-no-quotes": "warn",
-    "cds-compiler/space-in-func-call": "warn"
-  }
-}

package/lib/edm/.eslintrc.json

@@ -1,46 +0,0 @@
-{
-  "root": true,
-  //"plugins": ["sonarjs", "jsdoc"],
-  //"extends": ["plugin:jsdoc/recommended", "../../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended"],
-  "plugins": ["sonarjs"],
-  "extends": ["../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended"],
-  "rules": {
-    "cds-compiler/message-no-quotes": "off",
-    "cds-compiler/message-template-string": "off",
-    "prefer-const": "error",
-    "quotes": ["error", "single", "avoid-escape"],
-    "prefer-template": "error",
-    "no-trailing-spaces": "error",
-    "template-curly-spacing":["error", "never"],
-    "complexity": ["warn", 50],
-    "max-len": "off",
-    // there seem to be false positives
-    "jsdoc/require-returns-check": "off",
-    // Don't enforce stupid descriptions
-    "jsdoc/require-param-description": "off",
-    "jsdoc/require-returns-description": "off",
-    // Sometimes if-else's are more specific
-    "sonarjs/prefer-single-boolean-return": "off",
-    // Very whiny and nitpicky
-    "sonarjs/cognitive-complexity": "off",
-    "sonarjs/no-duplicate-string": "off",
-    // Does not recognize TS types
-    "jsdoc/no-undefined-types": "off",
-    "jsdoc/tag-lines": "off",
-    "no-nested-ternary": "off",
-    "sonarjs/no-nested-template-literals": "off"
-  },
-  "parserOptions": {
-    "ecmaVersion": 2022,
-    "sourceType": "script"
-  },
-  "env": {
-    "es2022": true,
-    "node": true
-  },
-  "settings": {
-    "jsdoc": {
-      "mode": "typescript"
-    }
-  }
-}

package/lib/inspect/.eslintrc.json

@@ -1,4 +0,0 @@
-{
-  "root": true,
-  "extends": "../../.eslintrc-ydkjsi.json"
-}

package/lib/json/.eslintrc.json

@@ -1,4 +0,0 @@
-{
-  "root": true,
-  "extends": "../../.eslintrc-ydkjsi.json"
-}

package/lib/language/.eslintrc.json

@@ -1,4 +0,0 @@
-{
-  "root": true,
-  "extends": "../../.eslintrc-ydkjsi.json"
-}

package/lib/model/.eslintrc.json

@@ -1,13 +0,0 @@
-{
-  "root": true,
-  "extends": "../../.eslintrc-ydkjsi.json",
-  "rules": {
-    "max-len": [ "error", {
-      "code": 180, // TODO: Remove
-      "tabWidth": 2,
-      "ignoreRegExpLiterals": false,
-      "ignoreStrings": false,
-      "ignoreTemplateLiterals": true
-    }]
-  }
-}

package/lib/modelCompare/utils/.eslintrc.json

@@ -1,22 +0,0 @@
-{
-  "plugins": ["sonarjs"],
-  "extends": ["../../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended"],
-  "rules": {
-    "prefer-const": "error",
-    "quotes": ["error", "single", "avoid-escape"],
-    "prefer-template": "error",
-    "no-trailing-spaces": "error",
-    "sonarjs/cognitive-complexity": "off",
-    "sonarjs/no-duplicate-string": ["off"],
-    "sonarjs/no-nested-template-literals": "off",
-    "template-curly-spacing":["error", "never"],
-    "class-methods-use-this": "off",
-    // Who cares - just very whiny and in the way
-    "complexity": "off",
-    "max-len": "off",
-    "no-shadow": "warn"
-  },
-  "env": {
-    "es2022": true
-  }
-}

package/lib/render/.eslintrc.json

@@ -1,22 +0,0 @@
-{
-  "plugins": ["sonarjs"],
-  "extends": ["../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended"],
-  "rules": {
-    "cds-compiler/message-no-quotes": "off",
-    "prefer-const": "error",
-    "quotes": ["error", "single", "avoid-escape"],
-    "prefer-template": "error",
-    "no-trailing-spaces": "error",
-    "sonarjs/cognitive-complexity": "off",
-    "sonarjs/no-duplicate-string": ["off"],
-    "sonarjs/no-nested-template-literals": "off",
-    "template-curly-spacing":["error", "never"],
-    "class-methods-use-this": "off",
-    "complexity": "off",
-    "max-len": "off",
-    "no-shadow": "warn"
-  },
-  "env": {
-    "es2022": true
-  }
-}

package/lib/transform/.eslintrc.json

@@ -1,13 +0,0 @@
-{
-  "rules": {
-    "no-shadow": "off"
-  },
-  "overrides": [
-    {
-      "files": [
-        "addTenantFields.js"
-      ],
-      "extends": "../../.eslintrc-ydkjsi.json"
-    }
-  ]
-}

package/lib/transform/db/.eslintrc.json

@@ -1,41 +0,0 @@
-{
-  "root": true,
-  "plugins": ["sonarjs", "jsdoc"],
-  "extends": ["plugin:jsdoc/recommended", "../../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended"],
-  "rules": {
-    "cds-compiler/message-no-quotes": "off",
-    "prefer-const": "error",
-    "quotes": ["error", "single", "avoid-escape"],
-    "prefer-template": "error",
-    "no-trailing-spaces": "error",
-    "template-curly-spacing":["error", "never"],
-    "complexity": ["warn", 40],
-    "max-len": "off",
-    // there seem to be false positives
-    "jsdoc/require-returns-check": "off",
-    // Don't enforce stupid descriptions
-    "jsdoc/require-param-description": "off",
-    "jsdoc/require-returns-description": "off",
-    // Sometimes if-else's are more specific
-    "sonarjs/prefer-single-boolean-return": "off",
-    // Very whiny and nitpicky
-    "sonarjs/cognitive-complexity": "off",
-    "sonarjs/no-duplicate-string": "off",
-    // Does not recognize TS types
-    "jsdoc/no-undefined-types": "off",
-    "jsdoc/tag-lines": "off"
-  },
-  "parserOptions": {
-    "ecmaVersion": 2022,
-    "sourceType": "script"
-  },
-  "env": {
-    "es2022": true,
-    "node": true
-  },
-  "settings": {
-    "jsdoc": {
-      "mode": "typescript"
-    }
-  }
-}

package/lib/transform/draft/.eslintrc.json

@@ -1,4 +0,0 @@
-{
-  "root": true,
-  "extends": ["../db/.eslintrc.json"]
-}

package/lib/transform/effective/.eslintrc.json

@@ -1,4 +0,0 @@
-{
-  "root": true,
-  "extends": ["../db/.eslintrc.json"]
-}

package/lib/transform/universalCsn/.eslintrc.json

@@ -1,37 +0,0 @@
-{
-  "root": true,
-  "plugins": ["sonarjs", "jsdoc"],
-  "extends": ["plugin:jsdoc/recommended", "../../../.eslintrc-ydkjsi.json", "plugin:sonarjs/recommended"],
-  "rules": {
-    "prefer-const": "error",
-    "quotes": ["error", "single", "avoid-escape"],
-    "prefer-template": "error",
-    "no-trailing-spaces": "error",
-    "template-curly-spacing":["error", "never"],
-    "complexity": ["warn", 30],
-    "max-len": "off",
-    // Don't enforce stupid descriptions
-    "jsdoc/require-param-description": "off",
-    "jsdoc/require-returns-description": "off",
-    // Very whiny and nitpicky
-    "sonarjs/cognitive-complexity": "off",
-    // Does not recognize TS types
-    "jsdoc/no-undefined-types": "off",
-    "jsdoc/tag-lines": "off",
-    // Just annoying as hell
-    "sonarjs/no-duplicate-string": "off"
-  },
-  "parserOptions": {
-    "ecmaVersion": 2022,
-    "sourceType": "script"
-  },
-  "env": {
-    "es2022": true,
-    "node": true
-  },
-  "settings": {
-    "jsdoc": {
-      "mode": "typescript"
-    }
-  }
-}

package/lib/utils/.eslintrc.json

@@ -1,7 +0,0 @@
-{
-  "root": true,
-  "extends": "../../.eslintrc-ydkjsi.json",
-  "rules": {
-    "prefer-const": "warn"
-  }
-}