Refactor CDS extractor for dedicated "cds" package

This commit:

- Implements an initial version of a project-aware CDS parser.
- Creates a dedicated "cds" package at "extractors/cds/tools/src/cds".
- Converts existing unit tests to use the new path for functions
  related to parsing and/or compiling .cds files.

Author: data-douser

extractors/cds/tools/index-files.ts

@@ -1,4 +1,4 @@
-import { compileCdsToJson, determineCdsCommand } from './src/cdsCompiler';
+import { compileCdsToJson, determineCdsCommand } from './src/cds';
 import { runJavaScriptExtractor } from './src/codeql';
 import { addCompilationDiagnostic } from './src/diagnostics';
 import { configureLgtmIndexFilters, setupAndValidateEnvironment } from './src/environment';

extractors/cds/tools/package.json

@@ -18,6 +18,7 @@
   "dependencies": {
     "child_process": "^1.0.2",
     "fs": "^0.0.1-security",
+    "glob": "^11.0.2",
     "os": "^0.1.2",
     "path": "^0.12.7",
     "shell-quote": "^1.8.2"
@@ -26,7 +27,9 @@
     "@eslint/compat": "^1.2.8",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.25.1",
+    "@types/glob": "^8.1.0",
     "@types/jest": "^29.5.14",
+    "@types/mock-fs": "^4.13.4",
     "@types/node": "^22.15.3",
     "@types/shell-quote": "^1.7.5",
     "@typescript-eslint/eslint-plugin": "^8.31.1",
@@ -39,6 +42,7 @@
     "eslint-plugin-prettier": "^5.2.6",
     "globals": "^16.0.0",
     "jest": "^29.7.0",
+    "mock-fs": "^5.5.0",
     "prettier": "^3.5.3",
     "ts-jest": "^29.3.2",
     "typescript": "^5.8.3"

extractors/cds/tools/src/cdsCompiler.ts renamed to extractors/cds/tools/src/cds/compiler.ts

@@ -1,7 +1,7 @@
 import { execFileSync, spawnSync, SpawnSyncReturns } from 'child_process';
 import { resolve } from 'path';
 
-import { fileExists, dirExists, recursivelyRenameJsonFiles } from './filesystem';
+import { fileExists, dirExists, recursivelyRenameJsonFiles } from '../filesystem';
 
 /**
  * Result of a CDS compilation
@@ -12,6 +12,26 @@ export interface CdsCompilationResult {
   outputPath?: string;
 }
 
+/**
+ * Determine the `cds` command to use based on the environment.
+ * @returns A string representing the CLI command to run to invoke the
+ * CDS compiler.
+ */
+export function determineCdsCommand(): string {
+  let cdsCommand = 'cds';
+  // TODO : create a mapping of project sub-directories to the correct
+  // cds command to use, which will also determine the version of the cds
+  // compiler that will be used for compiling `.cds` files to `.cds.json`
+  // files for that sub-directory / project.
+  try {
+    execFileSync('cds', ['--version'], { stdio: 'ignore' });
+  } catch {
+    // If 'cds' command is not available, use npx to run it
+    cdsCommand = 'npx -y --package @sap/cds-dk cds';
+  }
+  return cdsCommand;
+}
+
 /**
  * Compile a CDS file to JSON
  * @param cdsFilePath Path to the CDS file
@@ -81,35 +101,3 @@ export function compileCdsToJson(
     return { success: false, message: String(error) };
   }
 }
-/**
- * Determine the `cds` command to use based on the environment.
- * @returns A string representing the CLI command to run to invoke the
- * CDS compiler.
- */
-export function determineCdsCommand(): string {
-  let cdsCommand = 'cds';
-  // TODO : create a mapping of project sub-directories to the correct
-  // cds command to use, which will also determine the version of the cds
-  // compiler that will be used for compiling `.cds` files to `.cds.json`
-  // files for that sub-directory / project.
-  try {
-    execFileSync('cds', ['--version'], { stdio: 'ignore' });
-  } catch (error) {
-    // Check if the error is specifically about the command not being found
-    const errorMsg = String(error);
-    if (errorMsg.includes('command not found')) {
-      // If 'cds' command is not available, use npx to run it
-      console.log('CDS command not found, falling back to npx...');
-    } else if (errorMsg.includes('ENOENT') || errorMsg.includes('not recognized')) {
-      // If the error is related to the command not being recognized, use npx
-      console.log('CDS command not recognized, falling back to npx...');
-    } else {
-      // For other errors, log them but still fall back to npx
-      console.warn(
-        `WARN: determining CDS command failed with error: ${errorMsg}. Falling back to npx...`,
-      );
-    }
-    cdsCommand = 'npx -y --package @sap/cds-dk cds';
-  }
-  return cdsCommand;
-}

extractors/cds/tools/src/cds/index.ts

@@ -0,0 +1,3 @@
+export * from './compiler';
+export * from './parser';
+export * from './parserTypes';