@sap-ux/app-config-writer 0.6.4 → 0.6.6

package/dist/cards-config/index.js

@@ -66,7 +66,7 @@ async function updatePackageJson(basePath, fs, yamlPath, logger) {
     const cliForPreview = await (0, utils_1.getCLIForPreview)(basePath, yamlPath ?? '', fs);
     const dependencyName = '@sap-ux/cards-editor-middleware';
     packageJson.scripts ??= {};
-    packageJson.scripts['start-cards-generator'] = `${cliForPreview} --open '${cardGeneratorPath}${intent}'`;
+    packageJson.scripts['start-cards-generator'] = `${cliForPreview} --open "${cardGeneratorPath}${intent}"`;
     if (packageJson.devDependencies?.[dependencyName]) {
         delete packageJson.devDependencies[dependencyName];
         logger?.info(`Removed devDependency ${dependencyName} from package.json. It is no longer needed because this feature has been integrated into fiori-tools-preview / preview-middleware.`);

package/dist/common/package-json.d.ts

@@ -0,0 +1,95 @@
+import type { FlpConfig, MiddlewareConfig as PreviewConfig } from '@sap-ux/preview-middleware';
+import type { Editor } from 'mem-fs-editor';
+export type Script = {
+    name: string;
+    value: string;
+};
+/**
+ * Reads the scripts from the package.json file.
+ * Scripts will be buffered in map 'scriptsFromPackageJson' to avoid multiple reads of the package.json file.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used for the conversion
+ * @returns the scripts from the package.json file
+ */
+export declare function getScriptsFromPackageJson(fs: Editor, basePath: string): Map<string, string>;
+/**
+ * Extracts the URL details from a given script.
+ *
+ * It extracts the used mount point for the preview and the used intent.
+ *
+ * @param script - the content of the script
+ * @returns the URL details
+ */
+export declare function extractUrlDetails(script: string): {
+    path: string | undefined;
+    intent: FlpConfig['intent'] | undefined;
+};
+/**
+ * Check if the script/-name is valid for the conversion.
+ *
+ * The script:
+ * - must contain 'ui5 serve' or 'fiori run' command
+ * - must not be a test script
+ * - must not relate to 'webapp/index.html'.
+ *
+ * The script name:
+ * - must not be 'start-variants-management'
+ * - must not be 'start-control-property-editor'
+ * - must not be 'start-cards-generator'.
+ *
+ * @param script - the script from the package.json file
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion (default: false)
+ * @returns indicator if the script is valid
+ */
+export declare function isValidPreviewScript(script: Script, convertTests?: boolean): boolean;
+/**
+ * Get the first valid preview script from package.json that uses the given yaml config.
+ *
+ * @param yamlConfigName - name of the yaml config to be used
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to project root, where package.json is
+ * @returns the run script or undefined
+ */
+export declare function getRunScriptForYamlConfig(yamlConfigName: string, fs: Editor, basePath: string): Script | undefined;
+/**
+ * Extract the UI5 yaml configuration file name from the script.
+ *
+ * @param script - the content of the script from the package.json file
+ * @returns the UI5 yaml configuration file name or 'ui5.yaml' as default
+ */
+export declare function extractYamlConfigFileName(script: string): string;
+/**
+ * Check if the path is a test path.
+ * 1) path matches pattern '**.qunit.html'
+ * 2) path is being used as test configuration path in yaml configuration.
+ *
+ * @param script - the script content
+ * @param configuration - the preview configuration
+ * @returns indicator if the path is a test path
+ */
+export declare function isTestPath(script: Script, configuration?: PreviewConfig): boolean;
+/**
+ * Checks if the passed path is an FLP path.
+ *
+ * @param script - the script content
+ * @param configuration - the preview configuration
+ * @returns indicator if the path is an FLP path
+ */
+export declare function isFlpPath(script: Script, configuration: PreviewConfig): boolean;
+/**
+ * Extracts the test path of a given script name from the related ui5-test-runner script.
+ * The relation is defined as usage in another script that references the given script name directly or via max. one indirection.
+ *
+ * Example:
+ * - 'ui:test-server': 'ui5 serve --config ./ui5-deprecated-tools-preview-theme.yaml'
+ * - 'ui:test-runner': 'ui5-test-runner --port 8081 --url http://localhost:8080/test/testsuite.qunit.html --report-dir ./target/'
+ * - 'ui:test': 'start-server-and-test ui:test-server http://localhost:8080/ ui:test-runner'
+ *
+ * The test path for script 'ui:test-server' is 'http://localhost:8080/test/testsuite.qunit.html' from 'ui:test-runner' as they are connected via one indirection ('ui:test').
+ *
+ * @param scriptName - the name of the script from the package.json file
+ * @returns the related test path
+ */
+export declare function getTestPathForUi5TestRunner(scriptName: string): string | undefined;
+//# sourceMappingURL=package-json.d.ts.map

package/dist/common/package-json.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getScriptsFromPackageJson = getScriptsFromPackageJson;
+exports.extractUrlDetails = extractUrlDetails;
+exports.isValidPreviewScript = isValidPreviewScript;
+exports.getRunScriptForYamlConfig = getRunScriptForYamlConfig;
+exports.extractYamlConfigFileName = extractYamlConfigFileName;
+exports.isTestPath = isTestPath;
+exports.isFlpPath = isFlpPath;
+exports.getTestPathForUi5TestRunner = getTestPathForUi5TestRunner;
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
+/**
+ * Map of scripts from the package.json file.
+ */
+const scriptsFromPackageJson = new Map();
+/**
+ * Reads the scripts from the package.json file.
+ * Scripts will be buffered in map 'scriptsFromPackageJson' to avoid multiple reads of the package.json file.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used for the conversion
+ * @returns the scripts from the package.json file
+ */
+function getScriptsFromPackageJson(fs, basePath) {
+    const packageJsonPath = (0, path_1.join)(basePath, 'package.json');
+    const packageJson = fs.readJSON(packageJsonPath);
+    scriptsFromPackageJson.clear();
+    Object.entries(packageJson?.scripts ?? {}).forEach(([scriptName, scriptContent]) => {
+        scriptsFromPackageJson.set(scriptName, scriptContent ?? '');
+    });
+    return scriptsFromPackageJson;
+}
+/**
+ * Extracts the URL details from a given script.
+ *
+ * It extracts the used mount point for the preview and the used intent.
+ *
+ * @param script - the content of the script
+ * @returns the URL details
+ */
+function extractUrlDetails(script) {
+    //extract the URL from the 'open' command of the script
+    let url = / (?:--open|-o|--o) (\S*)/.exec(script)?.[1] ?? undefined;
+    //delete double or single quotes from the URL
+    url = url?.replace(/['"]/g, '');
+    //extract the path from the URL
+    const path = /^[^?#]+\.html/.exec(url ?? '')?.[0] ?? undefined;
+    //extract the intent from the URL
+    const intent = /(?<=#)\w+-\w+/.exec(url ?? '')?.[0] ?? undefined;
+    return {
+        path,
+        intent: intent
+            ? {
+                object: intent?.split('-')[0],
+                action: intent?.split('-')[1]
+            }
+            : undefined
+    };
+}
+/**
+ * Check if the script/-name is valid for the conversion.
+ *
+ * The script:
+ * - must contain 'ui5 serve' or 'fiori run' command
+ * - must not be a test script
+ * - must not relate to 'webapp/index.html'.
+ *
+ * The script name:
+ * - must not be 'start-variants-management'
+ * - must not be 'start-control-property-editor'
+ * - must not be 'start-cards-generator'.
+ *
+ * @param script - the script from the package.json file
+ * @param convertTests - indicator if test suite and test runner should be included in the conversion (default: false)
+ * @returns indicator if the script is valid
+ */
+function isValidPreviewScript(script, convertTests = false) {
+    const isValidScriptName = script.name != 'start-variants-management' &&
+        script.name != 'start-control-property-editor' &&
+        script.name != 'start-cards-generator';
+    //eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+    const startsWebServer = !!(script.value.includes('ui5 serve') || script.value.includes('fiori run'));
+    const { path } = extractUrlDetails(script.value);
+    const opensTest = isTestPath(script ?? '');
+    const opensIndexHtml = path === 'index.html';
+    //tests are only relevant if the conversion of test runners is excluded
+    return isValidScriptName && startsWebServer && !opensIndexHtml && (convertTests ? true : !opensTest);
+}
+/**
+ * Get the first valid preview script from package.json that uses the given yaml config.
+ *
+ * @param yamlConfigName - name of the yaml config to be used
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to project root, where package.json is
+ * @returns the run script or undefined
+ */
+function getRunScriptForYamlConfig(yamlConfigName, fs, basePath) {
+    const packageJsonPath = (0, path_1.join)(basePath, 'package.json');
+    const packageJson = fs.readJSON(packageJsonPath);
+    if (!packageJson) {
+        return undefined;
+    }
+    for (const [scriptName, scriptValue] of getScriptsFromPackageJson(fs, basePath)) {
+        if (isValidPreviewScript({ name: scriptName, value: scriptValue }) &&
+            extractYamlConfigFileName(scriptValue) === yamlConfigName) {
+            return {
+                name: scriptName,
+                value: scriptValue
+            };
+        }
+    }
+    return undefined;
+}
+/**
+ * Extract the UI5 yaml configuration file name from the script.
+ *
+ * @param script - the content of the script from the package.json file
+ * @returns the UI5 yaml configuration file name or 'ui5.yaml' as default
+ */
+function extractYamlConfigFileName(script) {
+    return / (?:--config|-c) (\S*)/.exec(script)?.[1] ?? project_access_1.FileName.Ui5Yaml;
+}
+/**
+ * Check if the path is a test path.
+ * 1) path matches pattern '**.qunit.html'
+ * 2) path is being used as test configuration path in yaml configuration.
+ *
+ * @param script - the script content
+ * @param configuration - the preview configuration
+ * @returns indicator if the path is a test path
+ */
+function isTestPath(script, configuration) {
+    const { path } = extractUrlDetails(script.value);
+    if (!path) {
+        return !!getTestPathForUi5TestRunner(script.name);
+    }
+    if (path.includes('.qunit.html')) {
+        return true;
+    }
+    return configuration?.test?.some((testConfig) => testConfig.path === path) ?? false;
+}
+/**
+ * Checks if the passed path is an FLP path.
+ *
+ * @param script - the script content
+ * @param configuration - the preview configuration
+ * @returns indicator if the path is an FLP path
+ */
+function isFlpPath(script, configuration) {
+    const { path } = extractUrlDetails(script.value);
+    if (!path) {
+        return false;
+    }
+    const isRtaEditorPath = configuration.rta?.editors?.some((editor) => editor.path === path) ?? //NOSONAR
+        configuration.editors?.rta?.endpoints?.some((editor) => editor.path === path) ??
+        false;
+    const isCardsGeneratorPath = configuration.editors?.cardGenerator?.path === path;
+    return !isRtaEditorPath && !isCardsGeneratorPath && !isTestPath(script, configuration);
+}
+/**
+ * Extracts the test path of a given script name from the related ui5-test-runner script.
+ * The relation is defined as usage in another script that references the given script name directly or via max. one indirection.
+ *
+ * Example:
+ * - 'ui:test-server': 'ui5 serve --config ./ui5-deprecated-tools-preview-theme.yaml'
+ * - 'ui:test-runner': 'ui5-test-runner --port 8081 --url http://localhost:8080/test/testsuite.qunit.html --report-dir ./target/'
+ * - 'ui:test': 'start-server-and-test ui:test-server http://localhost:8080/ ui:test-runner'
+ *
+ * The test path for script 'ui:test-server' is 'http://localhost:8080/test/testsuite.qunit.html' from 'ui:test-runner' as they are connected via one indirection ('ui:test').
+ *
+ * @param scriptName - the name of the script from the package.json file
+ * @returns the related test path
+ */
+function getTestPathForUi5TestRunner(scriptName) {
+    const TEST_RUNNER_COMMAND = 'ui5-test-runner';
+    const extractUrl = (script) => {
+        return / (?:--url|-u|--testsuite) (\S*)/.exec(script)?.[1] ?? undefined;
+    };
+    const findReferencingScriptByScriptName = (scriptName) => {
+        return [...scriptsFromPackageJson.values()].find((tmpScriptValue) => tmpScriptValue.includes(` ${scriptName} `));
+    };
+    const findReferencingUi5TestRunnerScriptByScriptValue = (script) => {
+        for (const scriptPart of script.split(' ')) {
+            const scriptValue = scriptsFromPackageJson.get(scriptPart);
+            if (scriptValue?.includes(TEST_RUNNER_COMMAND)) {
+                return scriptValue;
+            }
+        }
+        return undefined;
+    };
+    let testRunnerScript = findReferencingScriptByScriptName(scriptName);
+    let url = testRunnerScript?.includes(TEST_RUNNER_COMMAND) ? extractUrl(testRunnerScript) : undefined;
+    if (!url) {
+        testRunnerScript = findReferencingUi5TestRunnerScriptByScriptValue(testRunnerScript ?? '');
+        url = extractUrl(testRunnerScript ?? '');
+    }
+    return url ? new URL(url).pathname : undefined;
+}
+//# sourceMappingURL=package-json.js.map

package/dist/common/ui5-yaml.d.ts

@@ -2,6 +2,12 @@ import type { Editor } from 'mem-fs-editor';
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { PreviewConfigOptions } from '../types';
 import type { CustomMiddleware, FioriAppReloadConfig, UI5Config } from '@sap-ux/ui5-config';
+import { type DefaultFlpPath, type MiddlewareConfig as PreviewConfig, type TestConfig } from '@sap-ux/preview-middleware';
+import { type Script } from './package-json';
+type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];
+type PreviewTestConfig = ArrayElement<Required<PreviewConfig>['test']>;
+export declare const DEFAULT_FLP_PATH: DefaultFlpPath;
+export declare const TEST_CONFIG_DEFAULTS: Record<string, Readonly<Required<PreviewTestConfig>>>;
 /**
  * Gets the reload middleware form the provided yamlConfig.
  * The middleware can either be named 'fiori-tools-appreload' or 'reload-middleware'.
@@ -29,4 +35,53 @@ export declare function createPreviewMiddlewareConfig(fs: Editor, basePath: stri
  * @param logger - logger
  */
 export declare function updateMiddlewaresForPreview(fs: Editor, basePath: string, yamlPath?: string, logger?: ToolsLogger): Promise<void>;
+/**
+ * Sanitizes the preview middleware configuration.
+ *
+ * In case the deprecated 'rta.editors' config is being used it is moves to 'editors.rta'.
+ * In case of an outdated preview configuration, the following changes will be applied:
+ * - property 'ui5Theme' will be moved to 'flp.theme'.
+ * - no longer used property 'component' will be removed.
+ *
+ * @param previewMiddleware - the preview middleware
+ * @returns the sanitized preview middleware
+ */
+export declare function sanitizePreviewMiddleware(previewMiddleware: CustomMiddleware<PreviewConfigOptions>): CustomMiddleware<PreviewConfig | undefined>;
+/**
+ * Creates a preview middleware configuration.
+ *
+ * It will sanitize the given preview middleware configuration and construct the flp configuration out of the given intent and path.
+ *
+ * @param previewMiddleware - the preview middleware configuration
+ * @param script - the content of the script from the package.json file
+ * @param basePath - the base path
+ * @param fs - file system reference
+ * @param logger logger to report info to the user
+ * @returns the preview middleware configuration
+ */
+export declare function updatePreviewMiddlewareConfig(previewMiddleware: CustomMiddleware<PreviewConfigOptions>, script: Script, basePath: string, fs: Editor, logger?: ToolsLogger): Promise<CustomMiddleware<PreviewConfigOptions>>;
+/**
+ * Update the test configuration.
+ *
+ * @param testConfiguration - the test configuration
+ * @param path - the path
+ * @param basePath - the base path
+ * @param fs - file system reference
+ * @param logger logger to report info to the user
+ * @returns the updated test configuration
+ */
+export declare function updateTestConfig(testConfiguration: PreviewConfig['test'], path: string | undefined, basePath: string, fs: Editor, logger?: ToolsLogger): Promise<PreviewConfig['test']>;
+/**
+ * Sanitize the test script (*.qunit.[jt]s)
+ * If the OPA5 test script uses the JourneyRunner, it will be renamed and added as pattern to the respective UI5 yaml configuration.
+ * If the test script does not use the JourneyRunner, it will be deleted.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used
+ * @param path - the path to the test runner html file
+ * @param newConfig - the new test configuration
+ * @param logger logger to report info to the user
+ */
+export declare function sanitizeTestScript(fs: Editor, basePath: string, path: string, newConfig: TestConfig, logger?: ToolsLogger): Promise<void>;
+export {};
 //# sourceMappingURL=ui5-yaml.d.ts.map

package/dist/common/ui5-yaml.js

@@ -1,12 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TEST_CONFIG_DEFAULTS = exports.DEFAULT_FLP_PATH = void 0;
 exports.getEnhancedReloadMiddleware = getEnhancedReloadMiddleware;
 exports.createPreviewMiddlewareConfig = createPreviewMiddlewareConfig;
 exports.updateMiddlewaresForPreview = updateMiddlewaresForPreview;
+exports.sanitizePreviewMiddleware = sanitizePreviewMiddleware;
+exports.updatePreviewMiddlewareConfig = updatePreviewMiddlewareConfig;
+exports.updateTestConfig = updateTestConfig;
+exports.sanitizeTestScript = sanitizeTestScript;
 const path_1 = require("path");
 const types_1 = require("../types");
 const project_access_1 = require("@sap-ux/project-access");
-const utils_1 = require("../common/utils");
+const utils_1 = require("./utils");
+const preview_middleware_1 = require("@sap-ux/preview-middleware");
+const package_json_1 = require("./package-json");
+const DEFAULT_INTENT = {
+    object: 'app',
+    action: 'preview'
+};
+exports.DEFAULT_FLP_PATH = '/test/flp.html';
+exports.TEST_CONFIG_DEFAULTS = {
+    qunit: {
+        path: '/test/unitTests.qunit.html',
+        framework: 'QUnit'
+    },
+    opa5: {
+        path: '/test/opaTests.qunit.html',
+        framework: 'OPA5'
+    },
+    testsuite: {
+        path: '/test/testsuite.qunit.html',
+        framework: 'Testsuite'
+    }
+};
 /**
  * Gets the reload middleware form the provided yamlConfig.
  * The middleware can either be named 'fiori-tools-appreload' or 'reload-middleware'.
@@ -56,11 +82,21 @@ async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
     const ui5YamlFile = yamlPath ? (0, path_1.basename)(yamlPath) : project_access_1.FileName.Ui5Yaml;
     const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, ui5YamlFile, fs);
     let previewMiddleware = await (0, utils_1.getPreviewMiddleware)(ui5YamlConfig);
-    const reloadMiddleware = await getEnhancedReloadMiddleware(ui5YamlConfig);
     if (!previewMiddleware) {
         logger?.warn(`No preview middleware found in ${ui5YamlFile}. Preview middleware will be added.`);
         previewMiddleware = createPreviewMiddlewareConfig(fs, basePath);
     }
+    else {
+        const script = (0, package_json_1.getRunScriptForYamlConfig)(ui5YamlFile, fs, basePath);
+        if (script) {
+            previewMiddleware = await updatePreviewMiddlewareConfig(previewMiddleware, script, basePath, fs, logger);
+        }
+        else {
+            //if we don't find a script for flp.path and intent we assume the default values and sanitize the config
+            previewMiddleware = sanitizePreviewMiddleware(previewMiddleware);
+        }
+    }
+    const reloadMiddleware = await getEnhancedReloadMiddleware(ui5YamlConfig);
     if (reloadMiddleware) {
         previewMiddleware.afterMiddleware = reloadMiddleware.name;
         ui5YamlConfig.updateCustomMiddleware(reloadMiddleware);
@@ -70,4 +106,172 @@ async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
     fs.write((0, path_1.join)(basePath, ui5YamlFile), ui5YamlConfig.toString());
     logger?.debug(`Updated preview middleware in ${ui5YamlFile}.`);
 }
+/**
+ * Sanitizes the preview middleware configuration.
+ *
+ * In case the deprecated 'rta.editors' config is being used it is moves to 'editors.rta'.
+ * In case of an outdated preview configuration, the following changes will be applied:
+ * - property 'ui5Theme' will be moved to 'flp.theme'.
+ * - no longer used property 'component' will be removed.
+ *
+ * @param previewMiddleware - the preview middleware
+ * @returns the sanitized preview middleware
+ */
+function sanitizePreviewMiddleware(previewMiddleware) {
+    if (!previewMiddleware.configuration) {
+        return previewMiddleware;
+    }
+    //if we find the deprecated 'rta.editors' config, we will sanitize it
+    if ('rta' in previewMiddleware.configuration) {
+        const rtaConfig = (0, preview_middleware_1.sanitizeRtaConfig)(previewMiddleware.configuration.rta); //NOSONAR
+        delete previewMiddleware.configuration.rta; //NOSONAR
+        previewMiddleware.configuration.editors ??= {};
+        previewMiddleware.configuration.editors.rta = rtaConfig;
+    }
+    if (!(0, utils_1.isFioriToolsDeprecatedPreviewConfig)(previewMiddleware.configuration)) {
+        return previewMiddleware;
+    }
+    const ui5Theme = previewMiddleware.configuration.ui5Theme;
+    delete previewMiddleware.configuration;
+    if (!ui5Theme) {
+        return previewMiddleware;
+    }
+    const configuration = {};
+    configuration.flp = {};
+    configuration.flp.theme = ui5Theme;
+    previewMiddleware.configuration = configuration;
+    return previewMiddleware;
+}
+/**
+ * Creates a preview middleware configuration.
+ *
+ * It will sanitize the given preview middleware configuration and construct the flp configuration out of the given intent and path.
+ *
+ * @param previewMiddleware - the preview middleware configuration
+ * @param script - the content of the script from the package.json file
+ * @param basePath - the base path
+ * @param fs - file system reference
+ * @param logger logger to report info to the user
+ * @returns the preview middleware configuration
+ */
+async function updatePreviewMiddlewareConfig(previewMiddleware, script, basePath, fs, logger) {
+    const { path, intent } = (0, package_json_1.extractUrlDetails)(script.value);
+    const defaultIntent = `${DEFAULT_INTENT.object}-${DEFAULT_INTENT.action}`;
+    const newMiddlewareConfig = sanitizePreviewMiddleware(previewMiddleware);
+    //copy of configuration to avoid ending up with an empty configuration object in some cases
+    const configuration = { ...newMiddlewareConfig.configuration };
+    let writeConfig = false;
+    if ((0, package_json_1.isFlpPath)(script, configuration)) {
+        //adjust path but respect defaults
+        if (!path?.includes(exports.DEFAULT_FLP_PATH)) {
+            configuration.flp = configuration.flp ?? {};
+            configuration.flp.path = path;
+            writeConfig = true;
+        }
+        //adjust intent but respect defaults
+        if (intent && `${intent?.object}-${intent?.action}` !== defaultIntent) {
+            configuration.flp = configuration.flp ?? {};
+            configuration.flp.intent = {
+                object: intent.object,
+                action: intent.action
+            };
+            writeConfig = true;
+        }
+    }
+    else if (path && (0, package_json_1.isTestPath)(script, configuration)) {
+        configuration.test = await updateTestConfig(configuration.test, path, basePath, fs, logger);
+        writeConfig = true;
+    }
+    else if (!path) {
+        const ui5TestRunnerPath = (0, package_json_1.getTestPathForUi5TestRunner)(script.name);
+        if (ui5TestRunnerPath) {
+            configuration.test = await updateTestConfig(configuration.test, ui5TestRunnerPath, basePath, fs);
+            writeConfig = true;
+        }
+    }
+    if (writeConfig) {
+        newMiddlewareConfig.configuration = configuration;
+    }
+    return newMiddlewareConfig;
+}
+/**
+ * Update the test configuration.
+ *
+ * @param testConfiguration - the test configuration
+ * @param path - the path
+ * @param basePath - the base path
+ * @param fs - file system reference
+ * @param logger logger to report info to the user
+ * @returns the updated test configuration
+ */
+async function updateTestConfig(testConfiguration, path, basePath, fs, logger) {
+    const hasTestsuite = (config) => {
+        return config?.some((test) => test.framework === 'Testsuite') ?? false;
+    };
+    testConfiguration = testConfiguration ?? [];
+    let framework;
+    if (path?.includes('testsuite.qunit.html')) {
+        framework = 'Testsuite';
+    }
+    else if (path?.includes('opaTests.qunit.html')) {
+        framework = 'OPA5';
+    }
+    else if (path?.includes('unitTests.qunit.html')) {
+        framework = 'QUnit';
+    }
+    if (!framework) {
+        return testConfiguration;
+    }
+    const defaultPath = exports.TEST_CONFIG_DEFAULTS[framework.toLowerCase()].path;
+    const testConfig = testConfiguration.find((test) => test.framework === framework);
+    if (testConfig) {
+        testConfig.path = path;
+        if (testConfig.path === defaultPath) {
+            //sanitize default path
+            delete testConfig.path;
+        }
+    }
+    else {
+        const newConfig = {
+            framework,
+            ...(path && defaultPath !== (path.startsWith('/') ? path : `/${path}`) && { path })
+        };
+        await sanitizeTestScript(fs, basePath, path ?? defaultPath, newConfig, logger);
+        testConfiguration.push({ ...newConfig });
+        if (!hasTestsuite(testConfiguration)) {
+            testConfiguration.push({ framework: 'Testsuite' });
+            logger?.info(`The test framework 'Testsuite' has been added because at least one test runner has been found.`);
+        }
+    }
+    return testConfiguration;
+}
+/**
+ * Sanitize the test script (*.qunit.[jt]s)
+ * If the OPA5 test script uses the JourneyRunner, it will be renamed and added as pattern to the respective UI5 yaml configuration.
+ * If the test script does not use the JourneyRunner, it will be deleted.
+ *
+ * @param fs - file system reference
+ * @param basePath - base path to be used
+ * @param path - the path to the test runner html file
+ * @param newConfig - the new test configuration
+ * @param logger logger to report info to the user
+ */
+async function sanitizeTestScript(fs, basePath, path, newConfig, logger) {
+    const jsTestScriptPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath), path.replace('.html', '.js'));
+    const tsTestScriptPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath), path.replace('.html', '.ts'));
+    const testScriptPath = fs.exists(jsTestScriptPath) ? jsTestScriptPath : tsTestScriptPath;
+    if (fs.exists(testScriptPath)) {
+        const file = fs.read(testScriptPath);
+        const usesJourneyRunner = file.includes('sap/fe/test/JourneyRunner');
+        if (usesJourneyRunner) {
+            const filePathRenamed = testScriptPath.replace(/(\.([jt])s)$/, '.custom$1');
+            fs.move(testScriptPath, filePathRenamed);
+            newConfig.pattern = `/test/**/${(0, path_1.basename)(filePathRenamed)}`;
+            logger?.info(`Renamed '${(0, path_1.basename)(testScriptPath)}' to '${(0, path_1.basename)(filePathRenamed)}'. This file creates the JourneyRunner for OPA5 tests. As the handling of journey runners is not part of the virtual OPA5 test runner endpoint, this file has been renamed and added to the respective UI5 YAML configuration.`);
+        }
+        else {
+            await (0, utils_1.deleteFiles)(fs, [testScriptPath]);
+        }
+    }
+}
 //# sourceMappingURL=ui5-yaml.js.map

package/dist/common/utils.d.ts

@@ -1,6 +1,7 @@
 import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
 import type { PreviewConfigOptions, FioriToolsDeprecatedPreviewConfig } from '../types';
 import type { Editor } from 'mem-fs-editor';
+import type { ToolsLogger } from '@sap-ux/logger';
 /**
  * Type guard to check if the given configuration is a deprecated preview middleware configuration.
  *
@@ -38,4 +39,12 @@ export declare function getIntentFromPreviewConfig(previewMiddlewareConfig: Prev
  * @returns - preview serve or undefined
  */
 export declare function getCLIForPreview(basePath: string, yamlFileName: string, fs: Editor): Promise<string | undefined>;
+/**
+ * Deletes the given file.
+ *
+ * @param fs - file system reference
+ * @param files - files to be deleted
+ * @param logger logger to report info to the user
+ */
+export declare function deleteFiles(fs: Editor, files: string[], logger?: ToolsLogger): Promise<void>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/common/utils.js

@@ -4,8 +4,10 @@ exports.isFioriToolsDeprecatedPreviewConfig = isFioriToolsDeprecatedPreviewConfi
 exports.getPreviewMiddleware = getPreviewMiddleware;
 exports.getIntentFromPreviewConfig = getIntentFromPreviewConfig;
 exports.getCLIForPreview = getCLIForPreview;
+exports.deleteFiles = deleteFiles;
 const project_access_1 = require("@sap-ux/project-access");
 const types_1 = require("../types");
+const path_1 = require("path");
 /**
  * Type guard to check if the given configuration is a deprecated preview middleware configuration.
  *
@@ -61,4 +63,19 @@ async function getCLIForPreview(basePath, yamlFileName, fs) {
     const previewMiddleware = await getPreviewMiddleware(undefined, basePath, yamlFileName, fs);
     return previewMiddleware?.name === types_1.MiddlewareConfigs.PreviewMiddleware ? 'ui5 serve' : 'fiori run';
 }
+/**
+ * Deletes the given file.
+ *
+ * @param fs - file system reference
+ * @param files - files to be deleted
+ * @param logger logger to report info to the user
+ */
+async function deleteFiles(fs, files, logger) {
+    files.forEach((path) => {
+        if (fs.exists(path)) {
+            fs.delete(path);
+            logger?.info(`Deleted the '${(0, path_1.basename)(path)}' file. This file is no longer needed for the virtual endpoints.`);
+        }
+    });
+}
 //# sourceMappingURL=utils.js.map