Feat(eslint-fiori-plugin): cds annotations support (#4480)

* fix: get sapux root

* fix: uncomment annotation code

* test: mock cwd in unti tests

* fix: lint

* Linting auto fix commit

* fix: default odata version

* chore: remove performance log

* feat: collect cds table sections

* refactor: remove commented code

* refactor: move get properties function

* test: cds annotation provider unit

* refactor: reduce complexity

* refactor: remove unused function

* test: cds cache unit test

* test: add cap test project

* test: cds parse app tests

* test: add cap test data

* refactor: unit test

* refactor: revert test timeout

* test: annotation provider with cds

* test: add capp app latest cds

* test: use latest cds app

* test: increase timeout

* test: update snapshots

* fix: fiori language types

* fix: ann file traversal logic

* chore: add changeset

* fix: added object fixer

* test: cap helper

* test: initial setup project

* test: add cds ann unit tests

* refactor: get property attribute

* test: cds cache cases

* test: get op sections properties

* refactor: reuse duplicate function

* refactor: add comment

* test: check cds before install

* test: fail test condition

* test: check cds file

* chore: changeset patch

* test: check cds module path

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Maruf Rasully <[email protected]>

Author: 3 people

.changeset/funny-badgers-grab.md

@@ -0,0 +1,6 @@
+---
+'@sap-ux/eslint-plugin-fiori-tools': minor
+'@sap-ux/fiori-annotation-api': patch
+---
+
+Add .cds annotations support to enable linting of CAP apps with the eslint-plugin-fiori-tools.

packages/eslint-plugin-fiori-tools/src/index.ts

@@ -8,7 +8,7 @@ import { rules } from './rules';
 import { FioriLanguage } from './language/fiori-language';
 import { createSyncFn } from 'synckit';
 import type { getPathMappings } from '@sap-ux/project-access';
-import { uniformUrl } from './project-context/utils';
+import { uniformUrl } from '@sap-ux/fiori-annotation-api';
 export { DiagnosticCache } from './language/diagnostic-cache';
 
 // Use CommonJS require for modules with resolution issues

packages/eslint-plugin-fiori-tools/src/language/annotations/source-code.ts

@@ -77,7 +77,7 @@ export class FioriAnnotationSourceCode extends TextSourceCodeBase {
                 const child = node[key];
 
                 if (!child) {
-                    return;
+                    continue;
                 }
                 if (Array.isArray(child)) {
                     for (const grandchild of child) {

packages/eslint-plugin-fiori-tools/src/language/rule-fixer.ts

@@ -230,6 +230,9 @@ function handleInsert(
     if (isEmpty) {
         // Empty object - insert without trailing comma
         textToInsert = `\n${newContent}`;
+        if (newContent.endsWith('}')) {
+            textToInsert += '\n'.padEnd(node.loc.start.column);
+        }
     } else {
         // Has existing properties - insert with trailing comma
         textToInsert = `\n${newContent},`;

packages/eslint-plugin-fiori-tools/src/project-context/artifacts.ts

@@ -10,7 +10,7 @@ import type { WorkerResult } from './types';
  */
 export async function getProjectArtifacts(filePath: string): Promise<WorkerResult> {
     try {
-        const projectRoot = await findProjectRoot(filePath, false);
+        const projectRoot = await findProjectRoot(filePath, true); // sapuxRequired for CAP apps to locate the project root
         const projectType = await getProjectType(projectRoot);
         const artifacts = await findFioriArtifacts({
             wsFolders: [projectRoot],

packages/eslint-plugin-fiori-tools/src/project-context/linker/annotations.ts

@@ -1,4 +1,4 @@
-import type { AliasInformation, Element, MetadataElement } from '@sap-ux/odata-annotation-core';
+import type { AliasInformation, Element, ElementChild, MetadataElement } from '@sap-ux/odata-annotation-core';
 import {
     Edm,
     elementsWithName,
@@ -161,15 +161,13 @@ function processReferenceFacetRecord(
         return undefined;
     }
 
-    const properties = getRecordPropertyValue(record);
-    const id = properties['ID']?.value;
-    const target = properties['Target'];
+    const id = getId(record);
+    const annotationPath = getTargetAnnotationPath(record);
 
-    if (!id || target?.kind !== Edm.AnnotationPath) {
+    if (!id || !annotationPath) {
         return undefined;
     }
 
-    const annotationPath = target.value;
     if (annotationPath.startsWith('/')) {
         // absolute path is not supported
         return undefined;
@@ -350,45 +348,66 @@ export function getRecordType(aliasInfo: AliasInformation, element: Element): st
     }
 }
 
-interface RecordProperty {
-    name: string;
-    value: string;
-    kind: Edm.String | Edm.AnnotationPath;
-}
+const findContentByName = (content: ElementChild[], name: string): ElementChild | undefined =>
+    content.find((c) => (c as Element).name === name);
+
+const getElementText = (element: ElementChild): string | undefined =>
+    (element as Element).content.find((c) => c.type === 'text')?.text;
 
 /**
- * Extracts property values from a record element.
+ * Returns AnnotationPath property value.
  *
- * @param record - The record element to extract properties from
+ * @param record -The record element
+ * @returns - Annotation path string
  */
-function getRecordPropertyValue(record: Element): Record<string, RecordProperty> {
-    const properties: Record<string, RecordProperty> = {};
-    for (const child of record.content) {
-        if (child.type !== ELEMENT_TYPE) {
-            continue;
-        }
-        if (child.name === Edm.PropertyValue) {
+function getTargetAnnotationPath(record: Element): string | undefined {
+    const target = record.content.find((child) => {
+        if (child.type === ELEMENT_TYPE && child.name === Edm.PropertyValue) {
             const name = getElementAttributeValue(child, Edm.Property);
-            const annotationPathAttribute = getElementAttribute(child, Edm.AnnotationPath);
-            if (annotationPathAttribute) {
-                properties[name] = {
-                    name,
-                    value: annotationPathAttribute.value,
-                    kind: Edm.AnnotationPath
-                };
-                continue;
+            return name === 'Target';
+        }
+        return false;
+    });
+    if (target?.type === ELEMENT_TYPE) {
+        const stringAttribute = getElementAttribute(target, Edm.AnnotationPath);
+        if (stringAttribute) {
+            return stringAttribute.value;
+        } else {
+            const annotationPathContent = findContentByName(target.content, Edm.AnnotationPath);
+            if (annotationPathContent) {
+                return getElementText(annotationPathContent);
             }
-            const stringAttribute = getElementAttribute(child, Edm.String);
-            if (stringAttribute) {
-                properties[name] = {
-                    name,
-                    value: stringAttribute.value,
-                    kind: Edm.String
-                };
+        }
+    }
+    return undefined;
+}
+
+/**
+ * Returns ID property value.
+ *
+ * @param record - The record element
+ * @returns - String ID value
+ */
+function getId(record: Element): string | undefined {
+    const id = record.content.find((child) => {
+        if (child.type === ELEMENT_TYPE && child.name === Edm.PropertyValue) {
+            const name = getElementAttributeValue(child, Edm.Property);
+            return name === 'ID';
+        }
+        return false;
+    });
+    if (id?.type === ELEMENT_TYPE) {
+        const stringAttribute = getElementAttribute(id, Edm.String);
+        if (stringAttribute) {
+            return stringAttribute.value;
+        } else {
+            const idContent = findContentByName(id.content, Edm.String);
+            if (idContent) {
+                return getElementText(idContent);
             }
         }
     }
-    return properties;
+    return undefined;
 }
 
 /**

packages/eslint-plugin-fiori-tools/src/project-context/parser/parser.ts

@@ -7,10 +7,10 @@ import { getMainService } from '@sap-ux/project-access';
 import { CdsAnnotationProvider, getXmlServiceArtifacts, type ServiceArtifacts } from '@sap-ux/fiori-annotation-api';
 
 import type { LocalFile, RemoteFileWithLocalServiceCache } from '../types';
-import { uniformUrl } from '../utils';
 import type { Diagnostic } from '../../language/diagnostics';
 import { buildServiceIndex } from './service';
 import type { ParsedProject, ParsedApp, ParsedManifest, FoundODataService, CustomViews, MinUI5Version } from './types';
+import { uniformUrl } from '@sap-ux/fiori-annotation-api';
 
 export interface ParseResult {
     index: ParsedProject;
@@ -257,7 +257,7 @@ export class ApplicationParser {
                     type: 'cap',
                     name: dataSourceName,
                     path: uniformUrl(dataSource.uri),
-                    version: dataSource.settings?.odataVersion ?? '2.0'
+                    version: dataSource.settings?.odataVersion ?? '4.0'
                 });
                 continue;
             }

packages/eslint-plugin-fiori-tools/src/project-context/utils.ts

@@ -1,18 +1,5 @@
 import type { ParsedApp, ParsedService } from './parser';
 
-/**
- * Normalizes a URL by replacing backslashes with forward slashes and removing leading slashes.
- *
- * @param url - The URL to normalize.
- * @returns The normalized URL.
- */
-export function uniformUrl(url: string): string {
-    return url
-        .replaceAll('\\', '/')
-        .replaceAll('//', '/')
-        .replaceAll(/(?:^\/)/g, '');
-}
-
 /**
  * Get parsed service by name from parsed application.
  *

packages/eslint-plugin-fiori-tools/src/types.ts

@@ -1,10 +1,9 @@
 import type { CustomRuleDefinitionType, CustomRuleTypeDefinitions, RuleVisitor } from '@eslint/core';
 import type { AnyNode } from '@humanwhocodes/momoa';
 import type { JSONLanguageOptions, JSONSourceCode } from '@eslint/json';
-import type { FioriJSONSourceCode } from './language/json/source-code';
-import type { FioriXMLSourceCode } from './language/xml/source-code';
 import type { XMLToken, XMLAstNode } from '@xml-tools/ast';
 import type { AnyNode as AnyAnnotationNode } from '@sap-ux/odata-annotation-core';
+import type { FioriLanguageOptions, FioriSourceCode } from './language/fiori-language';
 
 /**
  * Type definition for manifest.json specific ESLint rules.
@@ -32,8 +31,8 @@ export type ManifestRuleDefinition<Options extends Partial<CustomRuleTypeDefinit
  */
 export type FioriRuleDefinition<Options extends Partial<CustomRuleTypeDefinitions> = object> = CustomRuleDefinitionType<
     {
-        LangOptions: JSONLanguageOptions;
-        Code: FioriJSONSourceCode | FioriXMLSourceCode;
+        LangOptions: FioriLanguageOptions;
+        Code: FioriSourceCode;
         Visitor: RuleVisitor;
         Node: AnyNode | XMLAstNode | XMLToken | AnyAnnotationNode;
     },

packages/eslint-plugin-fiori-tools/test/data/cap-start/.cdsrc.json

@@ -0,0 +1 @@
+{}