@sap/eslint-plugin-cds 2.0.4 → 2.2.1

package/lib/impl/utils/helpers.js

@@ -0,0 +1,89 @@
+const { files } = require("../constants");
+
+module.exports = {
+  /**
+   * Checks whether plugin is used in 'test' mode
+   * @returns boolean
+   */
+  isTest: function () {
+    let isTest = false;
+    if (process.argv[1].includes("jest") || process.argv[1].includes("mocha")) {
+      isTest = true;
+    }
+    return isTest;
+  },
+
+  /**
+   * Checks whether the given file path contains a file extension allowed by
+   * the plugin
+   * @param {string} filePath
+   * @returns boolean
+   */
+  isValidFile: function (filePath) {
+    const regex = new RegExp(
+      `${files
+        .map((file) => {
+          return file.replace("*", "");
+        })
+        .join("$|")}$`
+    );
+    return regex.test(filePath);
+  },
+
+  /**
+   * Checks whether the plugin is run via the VS Code ESLint extension (editor)
+   * @returns boolean
+   */
+  isEditor() {
+    return process.argv.join(" ").includes("dbaeumer.vscode-eslint");
+  },
+
+  /**
+   * Prints a formatted message string according to the styles provided
+   * @param msg message to print
+   * @param styles array of styles for apply
+   * @returns
+   */
+  styleText: function (msg, styles) {
+    const types = {
+      reset: "\x1b[0m", // Default
+      bold: "\x1b[1m", // Bold/Bright
+      link: "\x1b[4m", // underline
+      red: "\x1b[31m", // Foreground Red
+      green: "\x1b[32m", // Foreground Green
+      yellow: "\x1b[33m", // Foreground Yellow
+    };
+    let msgStyle = "";
+    styles.forEach((style) => {
+      msgStyle += types[style];
+    });
+    return `${msgStyle}${msg}${types.reset}`;
+  },
+
+  /**
+   * Checks whether the compiled cds model contains compilation errors which
+   * should only be reported via the 'cds-compile-error' rule
+   * @param cds cds object
+   * @param ruleID rule name
+   * @returns
+   */
+  hasCompilationError: function (context) {
+    const cds = context.cds;
+    const ruleID = context.ruleID;
+    if (
+      cds &&
+      cds.model &&
+      cds.model.err &&
+      cds.model.err.message.startsWith("CDS compilation failed")
+    ) {
+      if (
+        ruleID === "@sap/cds/cds-compile-error" ||
+        ruleID === "cds-compile-error"
+      ) {
+        cds.model.err;
+        return true;
+      }
+    }
+    return false;
+  },
+};

package/lib/impl/utils/jsonc.js

@@ -0,0 +1 @@
+"use strict";function peg$subclass(t,r){function e(){this.constructor=t}e.prototype=r.prototype,t.prototype=new e}function peg$SyntaxError(t,r,e,n){this.message=t,this.expected=r,this.found=e,this.location=n,this.name="SyntaxError","function"==typeof Error.captureStackTrace&&Error.captureStackTrace(this,peg$SyntaxError)}function peg$parse(t,r){r=void 0!==r?r:{};var e,n={},a={JSON:it},c=it,u=nt("{",!1),o=function(t,r,e){t[r]=e},s=nt("}",!1),h=nt("[",!1),i=function(t,r){t.push(r)},l=nt("]",!1),f=/^[+\-]/,A=at(["+","-"],!1,!1),p=/^[0-9]/,g=at([["0","9"]],!1,!1),d=nt(".",!1),C=nt("e",!1),v=ct("string"),x='"',b=nt('"',!1),y="\\",m=nt("\\",!1),E=nt("/",!1),S=nt("n",!1),$=nt("r",!1),F=nt("t",!1),w=nt("b",!1),R=nt("f",!1),j=nt("u",!1),k=/^[0-9a-f]/,M=at([["0","9"],["a","f"]],!1,!1),N=function(t){return String.fromCharCode(parseInt(t,16))},T=/^[^"]/,I=at(['"'],!0,!1),J="null",O=nt("null",!1),U="true",q=nt("true",!1),z="false",B=nt("false",!1),D=nt(":",!1),G=nt(",",!1),H=/^[ \t\n\r]/,K=at([" ","\t","\n","\r"],!1,!1),L=nt("//",!1),P=/^[\n\r\u2028\u2029]/,Q=at(["\n","\r","\u2028","\u2029"],!1,!1),V={type:"any"},W=nt("/*",!1),X="*/",Y=nt("*/",!1),Z=0,_=[{line:1,column:1}],tt=0,rt=[],et=0;if("startRule"in r){if(!(r.startRule in a))throw new Error("Can't start parsing from rule \""+r.startRule+'".');c=a[r.startRule]}function nt(t,r){return{type:"literal",text:t,ignoreCase:r}}function at(t,r,e){return{type:"class",parts:t,inverted:r,ignoreCase:e}}function ct(t){return{type:"other",description:t}}function ut(r){var e,n=_[r];if(n)return n;for(e=r-1;!_[e];)e--;for(n={line:(n=_[e]).line,column:n.column};e<r;)10===t.charCodeAt(e)?(n.line++,n.column=1):n.column++,e++;return _[r]=n,n}function ot(t,r){var e=ut(t),n=ut(r);return{start:{offset:t,line:e.line,column:e.column},end:{offset:r,line:n.line,column:n.column}}}function st(t){Z<tt||(Z>tt&&(tt=Z,rt=[]),rt.push(t))}function ht(t,r,e){return new peg$SyntaxError(peg$SyntaxError.buildMessage(t,r),t,r,e)}function it(){var t,r;return t=Z,gt()!==n&&(r=lt())!==n&&gt()!==n?(t,t=r):(Z=t,t=n),t}function lt(){var r;return(r=function(){var r,e,a,c,h,i,l,f,A;r=Z,e=Z,(a=gt())!==n?(123===t.charCodeAt(Z)?(c="{",Z++):(c=n,0===et&&st(u)),c!==n&&(h=gt())!==n?(e,e=a={}):(Z=e,e=n)):(Z=e,e=n);if(e!==n){if(a=Z,c=Z,(h=ft())!==n&&(i=At())!==n&&(l=lt())!==n?(c,c=h=o(e,h,l)):(Z=c,c=n),c!==n){for(h=[],i=Z,(l=pt())!==n&&(f=ft())!==n&&At()!==n&&(A=lt())!==n?(i,i=l=o(e,f,A)):(Z=i,i=n);i!==n;)h.push(i),i=Z,(l=pt())!==n&&(f=ft())!==n&&At()!==n&&(A=lt())!==n?(i,i=l=o(e,f,A)):(Z=i,i=n);h!==n?((i=pt())===n&&(i=null),i!==n?a=c=[c,h,i]:(Z=a,a=n)):(Z=a,a=n)}else Z=a,a=n;a===n&&(a=null),a!==n&&(c=gt())!==n?(125===t.charCodeAt(Z)?(h="}",Z++):(h=n,0===et&&st(s)),h!==n&&(i=gt())!==n?(r,r=e=e):(Z=r,r=n)):(Z=r,r=n)}else Z=r,r=n;return r}())===n&&(r=function(){var r,e,a,c,u,o,s;r=Z,e=Z,(a=gt())!==n?(91===t.charCodeAt(Z)?(c="[",Z++):(c=n,0===et&&st(h)),c!==n&&(u=gt())!==n?(e,e=a=[]):(Z=e,e=n)):(Z=e,e=n);if(e!==n){if(a=Z,c=Z,(u=lt())!==n&&(c,u=i(e,u)),(c=u)!==n){for(u=[],o=Z,pt()!==n&&(s=lt())!==n?(o,o=i(e,s)):(Z=o,o=n);o!==n;)u.push(o),o=Z,pt()!==n&&(s=lt())!==n?(o,o=i(e,s)):(Z=o,o=n);u!==n?((o=pt())===n&&(o=null),o!==n?a=c=[c,u,o]:(Z=a,a=n)):(Z=a,a=n)}else Z=a,a=n;a===n&&(a=null),a!==n&&(c=gt())!==n?(93===t.charCodeAt(Z)?(u="]",Z++):(u=n,0===et&&st(l)),u!==n&&(o=gt())!==n?(r,r=e=e):(Z=r,r=n)):(Z=r,r=n)}else Z=r,r=n;return r}())===n&&(r=function(){var r,e;r=Z,t.substr(Z,4)===J?(e=J,Z+=4):(e=n,0===et&&st(O));e!==n&&(r,e=null);return r=e}())===n&&(r=function(){var r,e;r=Z,t.substr(Z,4)===U?(e=U,Z+=4):(e=n,0===et&&st(q));e!==n&&(r,e=!0);return r=e}())===n&&(r=function(){var r,e;r=Z,t.substr(Z,5)===z?(e=z,Z+=5):(e=n,0===et&&st(B));e!==n&&(r,e=!1);return r=e}())===n&&(r=function(){var r,e,a,c,u,o,s,h,i,l,v;r=Z,e=Z,a=Z,f.test(t.charAt(Z))?(c=t.charAt(Z),Z++):(c=n,0===et&&st(A));c===n&&(c=null);if(c!==n){if(u=[],p.test(t.charAt(Z))?(o=t.charAt(Z),Z++):(o=n,0===et&&st(g)),o!==n)for(;o!==n;)u.push(o),p.test(t.charAt(Z))?(o=t.charAt(Z),Z++):(o=n,0===et&&st(g));else u=n;if(u!==n){if(o=Z,46===t.charCodeAt(Z)?(s=".",Z++):(s=n,0===et&&st(d)),s!==n){if(h=[],p.test(t.charAt(Z))?(i=t.charAt(Z),Z++):(i=n,0===et&&st(g)),i!==n)for(;i!==n;)h.push(i),p.test(t.charAt(Z))?(i=t.charAt(Z),Z++):(i=n,0===et&&st(g));else h=n;h!==n?o=s=[s,h]:(Z=o,o=n)}else Z=o,o=n;if(o===n&&(o=null),o!==n){if(s=Z,101===t.charCodeAt(Z)?(h="e",Z++):(h=n,0===et&&st(C)),h!==n)if(f.test(t.charAt(Z))?(i=t.charAt(Z),Z++):(i=n,0===et&&st(A)),i===n&&(i=null),i!==n){if(l=[],p.test(t.charAt(Z))?(v=t.charAt(Z),Z++):(v=n,0===et&&st(g)),v!==n)for(;v!==n;)l.push(v),p.test(t.charAt(Z))?(v=t.charAt(Z),Z++):(v=n,0===et&&st(g));else l=n;l!==n?s=h=[h,i,l]:(Z=s,s=n)}else Z=s,s=n;else Z=s,s=n;s===n&&(s=null),s!==n?a=c=[c,u,o,s]:(Z=a,a=n)}else Z=a,a=n}else Z=a,a=n}else Z=a,a=n;e=a!==n?t.substring(e,Z):a;e!==n&&(r,e=Number(e));return r=e}())===n&&(r=ft()),r}function ft(){var r,e,a,c,u,o,s,h,i,l,f,A,p;if(et++,r=Z,34===t.charCodeAt(Z)?(e=x,Z++):(e=n,0===et&&st(b)),e!==n){for(a=[],c=Z,92===t.charCodeAt(Z)?(u=y,Z++):(u=n,0===et&&st(m)),u!==n?(34===t.charCodeAt(Z)?(o=x,Z++):(o=n,0===et&&st(b)),o===n&&(92===t.charCodeAt(Z)?(o=y,Z++):(o=n,0===et&&st(m)),o===n&&(47===t.charCodeAt(Z)?(o="/",Z++):(o=n,0===et&&st(E)),o===n&&(o=Z,110===t.charCodeAt(Z)?(s="n",Z++):(s=n,0===et&&st(S)),s!==n&&(o,s="\n"),(o=s)===n&&(o=Z,114===t.charCodeAt(Z)?(s="r",Z++):(s=n,0===et&&st($)),s!==n&&(o,s="\r"),(o=s)===n&&(o=Z,116===t.charCodeAt(Z)?(s="t",Z++):(s=n,0===et&&st(F)),s!==n&&(o,s="\t"),(o=s)===n&&(o=Z,98===t.charCodeAt(Z)?(s="b",Z++):(s=n,0===et&&st(w)),s!==n&&(o,s="\b"),(o=s)===n&&(o=Z,102===t.charCodeAt(Z)?(s="f",Z++):(s=n,0===et&&st(R)),s!==n&&(o,s="\f"),(o=s)===n&&(o=Z,117===t.charCodeAt(Z)?(s="u",Z++):(s=n,0===et&&st(j)),s!==n?(h=Z,i=Z,k.test(t.charAt(Z))?(l=t.charAt(Z),Z++):(l=n,0===et&&st(M)),l!==n?(k.test(t.charAt(Z))?(f=t.charAt(Z),Z++):(f=n,0===et&&st(M)),f!==n?(k.test(t.charAt(Z))?(A=t.charAt(Z),Z++):(A=n,0===et&&st(M)),A!==n?(k.test(t.charAt(Z))?(p=t.charAt(Z),Z++):(p=n,0===et&&st(M)),p!==n?i=l=[l,f,A,p]:(Z=i,i=n)):(Z=i,i=n)):(Z=i,i=n)):(Z=i,i=n),(h=i!==n?t.substring(h,Z):i)!==n?(o,o=s=N(h)):(Z=o,o=n)):(Z=o,o=n))))))))),o!==n?(c,c=u=o):(Z=c,c=n)):(Z=c,c=n),c===n&&(T.test(t.charAt(Z))?(c=t.charAt(Z),Z++):(c=n,0===et&&st(I)));c!==n;)a.push(c),c=Z,92===t.charCodeAt(Z)?(u=y,Z++):(u=n,0===et&&st(m)),u!==n?(34===t.charCodeAt(Z)?(o=x,Z++):(o=n,0===et&&st(b)),o===n&&(92===t.charCodeAt(Z)?(o=y,Z++):(o=n,0===et&&st(m)),o===n&&(47===t.charCodeAt(Z)?(o="/",Z++):(o=n,0===et&&st(E)),o===n&&(o=Z,110===t.charCodeAt(Z)?(s="n",Z++):(s=n,0===et&&st(S)),s!==n&&(o,s="\n"),(o=s)===n&&(o=Z,114===t.charCodeAt(Z)?(s="r",Z++):(s=n,0===et&&st($)),s!==n&&(o,s="\r"),(o=s)===n&&(o=Z,116===t.charCodeAt(Z)?(s="t",Z++):(s=n,0===et&&st(F)),s!==n&&(o,s="\t"),(o=s)===n&&(o=Z,98===t.charCodeAt(Z)?(s="b",Z++):(s=n,0===et&&st(w)),s!==n&&(o,s="\b"),(o=s)===n&&(o=Z,102===t.charCodeAt(Z)?(s="f",Z++):(s=n,0===et&&st(R)),s!==n&&(o,s="\f"),(o=s)===n&&(o=Z,117===t.charCodeAt(Z)?(s="u",Z++):(s=n,0===et&&st(j)),s!==n?(h=Z,i=Z,k.test(t.charAt(Z))?(l=t.charAt(Z),Z++):(l=n,0===et&&st(M)),l!==n?(k.test(t.charAt(Z))?(f=t.charAt(Z),Z++):(f=n,0===et&&st(M)),f!==n?(k.test(t.charAt(Z))?(A=t.charAt(Z),Z++):(A=n,0===et&&st(M)),A!==n?(k.test(t.charAt(Z))?(p=t.charAt(Z),Z++):(p=n,0===et&&st(M)),p!==n?i=l=[l,f,A,p]:(Z=i,i=n)):(Z=i,i=n)):(Z=i,i=n)):(Z=i,i=n),(h=i!==n?t.substring(h,Z):i)!==n?(o,o=s=N(h)):(Z=o,o=n)):(Z=o,o=n))))))))),o!==n?(c,c=u=o):(Z=c,c=n)):(Z=c,c=n),c===n&&(T.test(t.charAt(Z))?(c=t.charAt(Z),Z++):(c=n,0===et&&st(I)));a!==n?(34===t.charCodeAt(Z)?(c=x,Z++):(c=n,0===et&&st(b)),c!==n?(r,r=e=a.join("")):(Z=r,r=n)):(Z=r,r=n)}else Z=r,r=n;return et--,r===n&&(e=n,0===et&&st(v)),r}function At(){var r,e;return r=Z,gt()!==n?(58===t.charCodeAt(Z)?(e=":",Z++):(e=n,0===et&&st(D)),e!==n&&gt()!==n?(r,r=void 0):(Z=r,r=n)):(Z=r,r=n),r}function pt(){var r,e;return r=Z,gt()!==n?(44===t.charCodeAt(Z)?(e=",",Z++):(e=n,0===et&&st(G)),e!==n&&gt()!==n?(r,r=void 0):(Z=r,r=n)):(Z=r,r=n),r}function gt(){var r,e,a;for(r=Z,e=[],H.test(t.charAt(Z))?(a=t.charAt(Z),Z++):(a=n,0===et&&st(K)),a===n&&(a=dt())===n&&(a=Ct());a!==n;)e.push(a),H.test(t.charAt(Z))?(a=t.charAt(Z),Z++):(a=n,0===et&&st(K)),a===n&&(a=dt())===n&&(a=Ct());return e!==n&&(r,e=void 0),r=e}function dt(){var r,e,a,c,u,o,s;if(r=Z,e=Z,"//"===t.substr(Z,2)?(a="//",Z+=2):(a=n,0===et&&st(L)),a!==n){for(c=[],u=Z,o=Z,et++,P.test(t.charAt(Z))?(s=t.charAt(Z),Z++):(s=n,0===et&&st(Q)),et--,s===n?o=void 0:(Z=o,o=n),o!==n?(t.length>Z?(s=t.charAt(Z),Z++):(s=n,0===et&&st(V)),s!==n?u=o=[o,s]:(Z=u,u=n)):(Z=u,u=n);u!==n;)c.push(u),u=Z,o=Z,et++,P.test(t.charAt(Z))?(s=t.charAt(Z),Z++):(s=n,0===et&&st(Q)),et--,s===n?o=void 0:(Z=o,o=n),o!==n?(t.length>Z?(s=t.charAt(Z),Z++):(s=n,0===et&&st(V)),s!==n?u=o=[o,s]:(Z=u,u=n)):(Z=u,u=n);c!==n?e=a=[a,c]:(Z=e,e=n)}else Z=e,e=n;return r=e!==n?t.substring(r,Z):e}function Ct(){var r,e,a,c,u,o,s;if(r=Z,e=Z,"/*"===t.substr(Z,2)?(a="/*",Z+=2):(a=n,0===et&&st(W)),a!==n){for(c=[],u=Z,o=Z,et++,t.substr(Z,2)===X?(s=X,Z+=2):(s=n,0===et&&st(Y)),et--,s===n?o=void 0:(Z=o,o=n),o!==n?(t.length>Z?(s=t.charAt(Z),Z++):(s=n,0===et&&st(V)),s!==n?u=o=[o,s]:(Z=u,u=n)):(Z=u,u=n);u!==n;)c.push(u),u=Z,o=Z,et++,t.substr(Z,2)===X?(s=X,Z+=2):(s=n,0===et&&st(Y)),et--,s===n?o=void 0:(Z=o,o=n),o!==n?(t.length>Z?(s=t.charAt(Z),Z++):(s=n,0===et&&st(V)),s!==n?u=o=[o,s]:(Z=u,u=n)):(Z=u,u=n);c!==n?(t.substr(Z,2)===X?(u=X,Z+=2):(u=n,0===et&&st(Y)),u!==n?e=a=[a,c,u]:(Z=e,e=n)):(Z=e,e=n)}else Z=e,e=n;return r=e!==n?t.substring(r,Z):e}if((e=c())!==n&&Z===t.length)return e;throw e!==n&&Z<t.length&&st({type:"end"}),ht(rt,tt<t.length?t.charAt(tt):null,tt<t.length?ot(tt,tt+1):ot(tt,tt))}peg$subclass(peg$SyntaxError,Error),peg$SyntaxError.buildMessage=function(t,r){var e={literal:function(t){return'"'+a(t.text)+'"'},class:function(t){var r,e="";for(r=0;r<t.parts.length;r++)e+=t.parts[r]instanceof Array?c(t.parts[r][0])+"-"+c(t.parts[r][1]):c(t.parts[r]);return"["+(t.inverted?"^":"")+e+"]"},any:function(t){return"any character"},end:function(t){return"end of input"},other:function(t){return t.description}};function n(t){return t.charCodeAt(0).toString(16).toUpperCase()}function a(t){return t.replace(/\\/g,"\\\\").replace(/"/g,'\\"').replace(/\0/g,"\\0").replace(/\t/g,"\\t").replace(/\n/g,"\\n").replace(/\r/g,"\\r").replace(/[\x00-\x0F]/g,(function(t){return"\\x0"+n(t)})).replace(/[\x10-\x1F\x7F-\x9F]/g,(function(t){return"\\x"+n(t)}))}function c(t){return t.replace(/\\/g,"\\\\").replace(/\]/g,"\\]").replace(/\^/g,"\\^").replace(/-/g,"\\-").replace(/\0/g,"\\0").replace(/\t/g,"\\t").replace(/\n/g,"\\n").replace(/\r/g,"\\r").replace(/[\x00-\x0F]/g,(function(t){return"\\x0"+n(t)})).replace(/[\x10-\x1F\x7F-\x9F]/g,(function(t){return"\\x"+n(t)}))}return"Expected "+function(t){var r,n,a,c=new Array(t.length);for(r=0;r<t.length;r++)c[r]=(a=t[r],e[a.type](a));if(c.sort(),c.length>0){for(r=1,n=1;r<c.length;r++)c[r-1]!==c[r]&&(c[n]=c[r],n++);c.length=n}switch(c.length){case 1:return c[0];case 2:return c[0]+" or "+c[1];default:return c.slice(0,-1).join(", ")+", or "+c[c.length-1]}}(t)+" but "+function(t){return t?'"'+a(t)+'"':"end of input"}(r)+" found."},module.exports={SyntaxError:peg$SyntaxError,parse:peg$parse};

package/lib/impl/utils/model.js

@@ -0,0 +1,485 @@
+
+/**
+ * @typedef { import("eslint").AST.SourceLocation } SourceLocation
+ */
+
+ const fs = require("fs");
+ const path = require("path");
+ const cds = require("@sap/cds");
+ const { SourceCode } = require("eslint");
+ const { isTest } = require("./helpers");
+ 
+ const cache = new Map();
+ 
+ module.exports = {
+   /**
+    * Simple cache to store model and any cds calls made in the rule creation 
+    * api to modify the model
+    */
+   Cache: {
+     has(key) {
+       return cache.has(key);
+     },
+     set(key, value) {
+       return cache.set(key, [value, Date.now()]);
+     },
+     get(key) {
+       if (cache.get(key)) {
+         return cache.get(key)[0];
+       } else {
+         return;
+       }
+     },
+     dump() {
+       const dump = {};
+       for (const [key, value] of cache.entries()) {
+         const timestamp = new Date(value[1]);
+         dump[key] = { key, value: JSON.stringify(value[0]), timestamp };
+       }
+       return dump;
+     },
+     getModels() {
+       const models = [];
+       for (const key of cache.keys()) {
+         if (key.startsWith("model:")) {
+           models.push(key.replace("model:", ""));
+         }
+       }
+       return models;
+     },
+     remove(key) {
+       if (cache.has(key)) {
+         cache.delete(key);
+       }
+       return;
+     },
+     clear() {
+       cache.clear();
+       return;
+     },
+   },
+ 
+   /**
+    * Takes care of all of the cds modeling:
+    * - Loads the model and assigns relevant files to it
+    * - Updates the model (according to 'type' events in the editor) 
+    * - Updates the ESLint configuration file path (i.e. mono-repo with 
+    *   multiple models) 
+    * @param context 
+    * @returns 
+    */
+   updateCache: function (context) {
+     const filePath = context.filePath;
+     const code = context.code;
+     const cds = context.cds;
+     // Set configPath according to filePath
+     let configPath = path.dirname(module.exports.getConfigPath(filePath));
+     if (configPath) {
+       module.exports.Cache.set("projectpath", configPath);
+       module.exports.Cache.set("configpath", configPath);
+     } else {
+       throw new Error("Failed to find an ESLint configuration file!");
+     }
+ 
+     // Get cds model for current project
+     module.exports.loadModel(code, configPath, filePath);
+ 
+     // Update config path (any files not part of the above model)
+     // Can only do this if model.$sources are known, otherwise no
+     // way to distinguish between 'model' vs 'outsider' files
+     if (cds && cds.model && !cds.model.err) {
+       module.exports.updateConfigPath(code, configPath, filePath);
+       configPath = module.exports.Cache.get("configpath");
+     }
+ 
+     // Update cds model on every 'type' event (from the editor)
+     if (
+       module.exports.Cache.has(`file:${filePath}`) &&
+       code !== module.exports.Cache.get(`file:${filePath}`)
+     ) {
+       // Update file contents in Cache
+       module.exports.Cache.set(`file:${filePath}`, code);
+       module.exports.Cache.remove(`done:${configPath}:${context.ruleID}`);
+       context.code = code;
+       context.sourcecode = new SourceCode(code, module.exports.getAST(code));
+       module.exports.updateModel(context);
+     }
+ 
+     // Get cds environment (when called from ESLint's ruleTester)
+     if (
+       context.options &&
+       context.options[0] &&
+       context.options[0].environment
+     ) {
+       module.exports.Cache.set(`environment`, context.options[0].environment);
+     }
+ 
+     context.configPath = configPath;
+     return context;
+   },
+ 
+   /**
+    * Generates dummy AST with just single Program node
+    * @param code Parse file contents
+    * @returns AST
+    */
+   getAST: function (code) {
+     return {
+       type: "Program",
+       body: [],
+       sourceType: "module",
+       tokens: [],
+       comments: [],
+       range: [0, code.length],
+       loc: {
+         start: {
+           line: 1,
+           column: 0,
+         },
+         end: {
+           line: 1,
+           column: 0,
+         },
+       },
+     };
+   },
+ 
+   /**
+    * Generates proxy for cds object which adds caching
+    * @param obj cds object
+    * @returns Proxy for cds
+    */
+   getCDSProxy: function (obj) {
+     const handler = {
+       get(target, prop, receiver) {
+         const value = Reflect.get(target, prop, receiver);
+         if (["model", "environment"].includes(prop)) {
+           if (prop === "model") {
+             prop = `model:${module.exports.Cache.get("configpath")}`;
+           }
+           return module.exports.Cache.get(prop);
+         }
+         if (typeof value !== "object") {
+           return value;
+         }
+         /*eslint no-extra-boolean-cast: "off"*/
+         if (!!value) {
+           return new Proxy(value, handler);
+         }
+         return {
+           err: `Property ${prop} prop does not exist on object ${obj}!`,
+         };
+       },
+       apply(target, thisArg, argumentsList) {
+         const result = Reflect.apply(target, this, argumentsList);
+         return result;
+       },
+     };
+     return new Proxy(obj, handler);
+   },
+ 
+   /**
+    * Converts code with {line, column} to ESLint's 'range' property:
+    * https://eslint.org/docs/developer-guide/working-with-custom-parsers#all-nodes
+    * code.slice(node.range[0], node.range[1]) must be the text of the node!
+    * @param code source code
+    * @param line line number
+    * @param column column number
+    * @returns ESLint range
+    */
+   getRange: function (code, line, column) {
+     let lines;
+     if (typeof code === "string") {
+       lines = SourceCode.splitLines(code);
+     } else {
+       lines = code;
+     }
+     const ranges = [0];
+     lines.forEach((line, i) => {
+       if (i === 0) {
+         ranges[i + 1] = line.length + 1;
+       } else {
+         ranges[i + 1] = ranges[i] + line.length + 1;
+       }
+     });
+     if (line > 1) {
+       return ranges[line - 1] + column;
+     } else {
+       return column;
+     }
+   },
+ 
+   /**
+    * Uses ESLint's static function splitLines() to split the source code text 
+    * into an array of lines:
+    * https://eslint.org/docs/developer-guide/nodejs-api#sourcecodesplitlines
+    * Returns the index of the last line
+    * @param code
+    * @returns Last line index
+    */
+   getLastLine: function (code) {
+     let lines;
+     if (typeof code === "string") {
+       lines = SourceCode.splitLines(code);
+     } else {
+       lines = code;
+     }
+     return lines.length - 1;
+   },
+ 
+   /**
+    * Generates ESlint's 'loc' from artifact string and cds $location property:
+    * https://eslint.org/docs/developer-guide/working-with-rules-deprecated#contextreport
+    * @param name
+    * @param {SoureLocation} obj
+    * @returns ESLint's 'loc' object
+    */
+   getLocation: function (name, obj) {
+     const loc = {
+       start: { line: 0, column: 0 },
+       end: { line: 1, column: 0 },
+     };
+     if (obj.$location) {
+       const nameloc = obj.$location;
+       // CSN entry with column 0 is equivalent to 'undefined'
+       // It means that the column in that line cannot be determined,
+       // so we assign a value 1 so as not to get a negative value
+       if (nameloc.col === 0) {
+         nameloc.col = 1;
+       }
+       loc.start.column = nameloc.col - 1;
+       loc.start.line = nameloc.line;
+       loc.end.column = nameloc.col - 1 + name.length;
+       loc.end.line = nameloc.line;
+     }
+     return loc;
+   },
+ 
+   /**
+    * Searches for ESLint config file types (in order or precedence)
+    * and returns corresponding directory (usually project's root dir)
+    * https://eslint.org/docs/user-guide/configuring#configuration-file-formats
+    * @param {string} currentDir start here and search until root dir
+    * @returns {string} dir containing ESLint config file (empty if not exists)
+    */
+   getConfigPath: function (currentDir = ".") {
+     const configFiles = [
+       ".eslintrc.js",
+       ".eslintrc.cjs",
+       ".eslintrc.yaml",
+       ".eslintrc.yml",
+       ".eslintrc.json",
+       ".eslintrc",
+       "package.json",
+     ];
+     let configDir = path.resolve(currentDir);
+     while (configDir !== path.resolve(configDir, "..")) {
+       for (let i = 0; i < configFiles.length; i++) {
+         const configPath = path.join(configDir, configFiles[i]);
+         if (fs.existsSync(configPath) && fs.statSync(configPath).isFile()) {
+           return configPath;
+         }
+       }
+       configDir = path.join(configDir, "..");
+     }
+     return "";
+   },
+ 
+   /**
+    * Loads LinkedCSN cds model by:
+    * (1) Determining config path if does not exist
+    * (2) Running cds.load('*') to resolve full model
+    * (3) If 2. also fails, passing on the error object
+    * @param code
+    * @returns
+    */
+   loadModel: function (code = "", configPath, filePath) {
+     let compiledModel;
+     let reflectedModel;
+     if (isTest()) {
+       if (code) {
+         try {
+           if (isTest()) {
+             compiledModel = cds.compile.to.csn(code, {
+               sync: true,
+               locations: true,
+             });
+           } else {
+             compiledModel = cds.compile.to.csn([filePath], {
+               sync: true,
+               locations: true,
+             });
+           }
+           if (compiledModel) {
+             reflectedModel = cds.linked(compiledModel);
+           }
+         } catch (err) {
+           reflectedModel = { err };
+         }
+       }
+     } else {
+       // Loads new model (must clear cache in order to be able to change root with every configPath)
+       cds.resolve.cache = {};
+       const roots = cds.resolve("*", { root: configPath });
+       if (
+         !module.exports.Cache.has(`model:${configPath}`) &&
+         configPath !== filePath
+       ) {
+         if (roots) {
+           try {
+             compiledModel = cds.load(roots, {
+               cwd: configPath,
+               sync: true,
+               locations: true,
+             });
+             if (compiledModel) {
+               reflectedModel = cds.linked(compiledModel);
+             }
+           } catch (err) {
+             reflectedModel = { err };
+           }
+         } else {
+           try {
+             compiledModel = cds.compile.to.csn([filePath], {
+               sync: true,
+               locations: true,
+             });
+             if (compiledModel) {
+               reflectedModel = cds.linked(compiledModel);
+             }
+           } catch (err) {
+             reflectedModel = { err };
+           }
+         }
+       } else {
+         reflectedModel = module.exports.Cache.get(`model:${configPath}`);
+       }
+     }
+     // Cache model files
+     if (
+       reflectedModel &&
+       reflectedModel.$sources &&
+       !module.exports.Cache.has(`modelfiles:${configPath}`)
+     ) {
+       const files = reflectedModel.$sources;
+       if (files && files.length > 0) {
+         module.exports.Cache.set(`modelfiles:${configPath}`, files);
+         if (!isTest()) {
+           files.forEach((file) => {
+             if (!module.exports.Cache.has(`file:${file}`)) {
+               module.exports.Cache.set(
+                 `file:${file}`,
+                 fs.readFileSync(file, "utf8")
+               );
+             }
+           });
+         }
+       }
+     }
+     module.exports.Cache.set(`model:${configPath}`, reflectedModel);
+     return;
+   },
+ 
+   /**
+    * Updates configPath (usually ESLint's configPath) for a given project if:
+    * - File is not part of the compiled project model
+    * It then defaults to filePath and compiles the file stand-alone
+    * @param code
+    * @param configPath
+    * @param filePath
+    */
+   updateConfigPath: function (code, configPath, filePath) {
+     let compiledModel;
+     let reflectedModel;
+     const files = module.exports.Cache.has(`modelfiles:${configPath}`)
+       ? module.exports.Cache.get(`modelfiles:${configPath}`)
+       : [];
+     // 'Ousider' files: If a file is not part of cds model for this dir, 
+     // it is compiled individually
+     if (!files || !files.includes(filePath)) {
+       module.exports.Cache.set(`configpath`, filePath);
+       module.exports.Cache.set(`modelfiles:${filePath}`, [filePath]);
+       module.exports.Cache.set(
+         `file:${filePath}`,
+         fs.readFileSync(filePath, "utf8")
+       );
+       if (!module.exports.Cache.has(`model:${filePath}`)) {
+         try {
+           if (isTest()) {
+             compiledModel = cds.compile.to.csn(code, {
+               sync: true,
+               locations: true,
+             });
+           } else {
+             compiledModel = cds.compile.to.csn([filePath], {
+               sync: true,
+               locations: true,
+             });
+           }
+           if (compiledModel) {
+             reflectedModel = cds.linked(compiledModel);
+           }
+         } catch (err) {
+           reflectedModel = { err };
+         }
+       } else {
+         reflectedModel = module.exports.Cache.get(`model:${filePath}`);
+       }
+     }
+     module.exports.Cache.set(`model:${filePath}`, reflectedModel);
+   },
+ 
+   /**
+    * Updates compiled model (CSN) by:
+    * 1. Getting model files from CSN.$sources (cached)
+    * 2. Running compile.to.csn with updated sources dictionary
+    * @param code
+    */
+   updateModel: function (context) {
+     const configPath = context.configPath;
+     const code = context.code;
+     let compiledModel;
+     let reflectedModel;
+     let files = [];
+     const dictFiles = {};
+     if (module.exports.Cache.has(`modelfiles:${configPath}`)) {
+       files = module.exports.Cache.get(`modelfiles:${configPath}`);
+       if (files.length > 1) {
+         files.forEach((file) => {
+           if (module.exports.Cache.has(`file:${file}`)) {
+             dictFiles[file] = module.exports.Cache.get(`file:${file}`);
+           } else {
+             dictFiles[file] = fs.readFileSync(file, "utf8");
+           }
+         });
+         try {
+           /** Ignore typings here as the options 'sync' and 'cwd'
+            *  should not be visible in the public api! */
+           compiledModel = cds.compile.to.csn(dictFiles, {
+             sync: true,
+             locations: true,
+           });
+           if (compiledModel) {
+             reflectedModel = cds.linked(compiledModel);
+           }
+         } catch (err) {
+           reflectedModel = { err };
+         }
+       } else if (files.length === 1) {
+         try {
+           compiledModel = cds.compile.to.csn(code, {
+             sync: true,
+             locations: true,
+           });
+           if (compiledModel) {
+             reflectedModel = cds.linked(compiledModel);
+           }
+         } catch (err) {
+           reflectedModel = { err };
+         }
+       }
+       module.exports.Cache.set(`model:${configPath}`, reflectedModel);
+     }
+   },
+ };
+