@sap-ux/app-config-writer 0.6.96 → 0.6.98

package/dist/eslint-config/index.d.ts

@@ -0,0 +1,21 @@
+import { type Editor } from 'mem-fs-editor';
+import { type ToolsLogger } from '@sap-ux/logger';
+/**
+ * Adds eslint configuration to the project.
+ *
+ * It checks the prerequisites and confirms an explicit approval to add the configuration.
+ * If the prerequisites and approval are met, the corresponding eslint configuration and packages are added.
+ *
+ * @param basePath - base path to be used for the conversion
+ * @param options - options for the conversion
+ * @param options.logger - logger to report info to the user
+ * @param options.fs - file system reference
+ * @param options.config - the name of the SAP Fiori tools eslint plugin config to be used
+ * @returns file system reference
+ */
+export declare function generateEslintConfig(basePath: string, options: {
+    logger?: ToolsLogger;
+    fs?: Editor;
+    config?: string;
+}): Promise<Editor>;
+//# sourceMappingURL=index.d.ts.map

package/dist/eslint-config/index.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateEslintConfig = generateEslintConfig;
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const project_access_1 = require("@sap-ux/project-access");
+const node_path_1 = require("node:path");
+/**
+ * Adds eslint configuration to the project.
+ *
+ * It checks the prerequisites and confirms an explicit approval to add the configuration.
+ * If the prerequisites and approval are met, the corresponding eslint configuration and packages are added.
+ *
+ * @param basePath - base path to be used for the conversion
+ * @param options - options for the conversion
+ * @param options.logger - logger to report info to the user
+ * @param options.fs - file system reference
+ * @param options.config - the name of the SAP Fiori tools eslint plugin config to be used
+ * @returns file system reference
+ */
+async function generateEslintConfig(basePath, options) {
+    const fs = options.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+    const logger = options.logger;
+    if (!(await checkPrerequisites(basePath, fs, logger))) {
+        throw new Error('The prerequisites are not met. For more information, see the log messages above.');
+    }
+    await updatePackageJson(basePath, fs, logger);
+    await addEslintConfig(basePath, fs, options?.config);
+    return fs;
+}
+/**
+ * Checks the prerequisites for adding an eslint configuration to the project.
+ *
+ * @param basePath - base path to be used for the conversion
+ * @param fs - file system reference
+ * @param logger - logger to report info to the user
+ * @returns true if the prerequisites are met, false otherwise
+ */
+async function checkPrerequisites(basePath, fs, logger) {
+    const packageJsonPath = (0, node_path_1.join)(basePath, project_access_1.FileName.Package);
+    const packageJson = fs.readJSON(packageJsonPath);
+    if (!packageJson) {
+        logger?.error(`No package.json found at path '${packageJsonPath}'`);
+        return false;
+    }
+    const eslintExists = (0, project_access_1.hasDependency)(packageJson, 'eslint');
+    if (eslintExists) {
+        logger?.error(`EsLint already exists in this project. Found 'eslint' dependency in package.json at path '${packageJsonPath}'`);
+        return false;
+    }
+    return true;
+}
+/**
+ * Updates the package.json file of the project by adding the required eslint dependency.
+ *
+ * @param basePath - base path to be used for the conversion
+ * @param fs - file system reference
+ * @param logger - logger to report info to the user
+ */
+async function updatePackageJson(basePath, fs, logger) {
+    const packageJsonPath = (0, node_path_1.join)(basePath, project_access_1.FileName.Package);
+    const packageJson = fs.readJSON(packageJsonPath);
+    packageJson.devDependencies ??= {};
+    packageJson.devDependencies['eslint'] = '^9.0.0';
+    packageJson.devDependencies['@sap-ux/eslint-plugin-fiori-tools'] = '^9.0.0';
+    packageJson.scripts ??= {};
+    if (packageJson.scripts['lint']) {
+        logger?.warn(`A 'lint' script already exists in package.json at path '${packageJsonPath}'. Adding lint script skipped.`);
+    }
+    else {
+        packageJson.scripts['lint'] = 'eslint .';
+    }
+    fs.writeJSON(packageJsonPath, packageJson);
+}
+/**
+ * Adds the eslint configuration file to the project.
+ *
+ * @param basePath - base path to be used for the conversion
+ * @param fs - file system reference
+ * @param config - the name of the SAP Fiori tools eslint plugin config to be used
+ */
+async function addEslintConfig(basePath, fs, config = 'recommended') {
+    const templatePath = require.resolve('@sap-ux/ui5-application-writer/templates/optional/eslint/eslint.config.mjs');
+    let templateContent = await fs.read(templatePath);
+    if (config === 'recommended-for-s4hana') {
+        templateContent = templateContent.replace('...fioriTools.configs.recommended', "...fioriTools.configs['recommended-for-s4hana']");
+    }
+    await fs.write((0, node_path_1.join)(basePath, 'eslint.config.mjs'), templateContent);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { getSmartLinksTargetFromPrompt, simulatePrompt, includeTestRunnersPrompt } from './prompt';
 export { generateSmartLinksConfig } from './smartlinks-config';
+export { generateEslintConfig } from './eslint-config';
 export { generateInboundNavigationConfig, readManifest } from './navigation-config';
 export { generateVariantsConfig } from './variants-config';
 export { convertToVirtualPreview } from './preview-config';

package/dist/index.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableCardGeneratorConfig = exports.convertToVirtualPreview = exports.generateVariantsConfig = exports.readManifest = exports.generateInboundNavigationConfig = exports.generateSmartLinksConfig = exports.includeTestRunnersPrompt = exports.simulatePrompt = exports.getSmartLinksTargetFromPrompt = void 0;
+exports.enableCardGeneratorConfig = exports.convertToVirtualPreview = exports.generateVariantsConfig = exports.readManifest = exports.generateInboundNavigationConfig = exports.generateEslintConfig = exports.generateSmartLinksConfig = exports.includeTestRunnersPrompt = exports.simulatePrompt = exports.getSmartLinksTargetFromPrompt = void 0;
 var prompt_1 = require("./prompt");
 Object.defineProperty(exports, "getSmartLinksTargetFromPrompt", { enumerable: true, get: function () { return prompt_1.getSmartLinksTargetFromPrompt; } });
 Object.defineProperty(exports, "simulatePrompt", { enumerable: true, get: function () { return prompt_1.simulatePrompt; } });
 Object.defineProperty(exports, "includeTestRunnersPrompt", { enumerable: true, get: function () { return prompt_1.includeTestRunnersPrompt; } });
 var smartlinks_config_1 = require("./smartlinks-config");
 Object.defineProperty(exports, "generateSmartLinksConfig", { enumerable: true, get: function () { return smartlinks_config_1.generateSmartLinksConfig; } });
+var eslint_config_1 = require("./eslint-config");
+Object.defineProperty(exports, "generateEslintConfig", { enumerable: true, get: function () { return eslint_config_1.generateEslintConfig; } });
 var navigation_config_1 = require("./navigation-config");
 Object.defineProperty(exports, "generateInboundNavigationConfig", { enumerable: true, get: function () { return navigation_config_1.generateInboundNavigationConfig; } });
 Object.defineProperty(exports, "readManifest", { enumerable: true, get: function () { return navigation_config_1.readManifest; } });

package/dist/preview-config/index.js

@@ -26,7 +26,7 @@ async function convertToVirtualPreview(basePath, options) {
     const logger = options.logger;
     const convertTests = options.convertTests ?? false;
     if (!(await (0, prerequisites_1.checkPrerequisites)(basePath, fs, convertTests, logger))) {
-        throw Error('The prerequisites are not met. For more information, see the log messages above.');
+        throw new Error('The prerequisites are not met. For more information, see the log messages above.');
     }
     await (0, ui5_yaml_1.updatePreviewMiddlewareConfigs)(fs, basePath, convertTests, logger);
     await (0, preview_files_1.renameDefaultSandboxes)(fs, basePath, logger);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/app-config-writer",
   "description": "Add or update configuration for SAP Fiori tools application",
-  "version": "0.6.96",
+  "version": "0.6.98",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -27,12 +27,13 @@
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
     "semver": "7.7.3",
-    "@sap-ux/axios-extension": "1.25.11",
     "@sap-ux/btp-utils": "1.1.8",
     "@sap-ux/logger": "0.8.1",
+    "@sap-ux/axios-extension": "1.25.11",
+    "@sap-ux/store": "1.5.6",
+    "@sap-ux/ui5-config": "0.29.16",
     "@sap-ux/project-access": "1.35.3",
-    "@sap-ux/store": "1.5.5",
-    "@sap-ux/ui5-config": "0.29.16"
+    "@sap-ux/ui5-application-writer": "1.7.8"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -42,7 +43,7 @@
     "@types/semver": "7.7.1",
     "axios": "1.13.5",
     "nock": "13.4.0",
-    "@sap-ux/preview-middleware": "0.23.119"
+    "@sap-ux/preview-middleware": "0.23.120"
   },
   "engines": {
     "node": ">=20.x"