@sap-ux/create 0.15.24 → 0.15.25

package/README.md

@@ -105,7 +105,7 @@ Options:
 
 ## [`add eslint-config`](#add-eslint-config)
 
-Add an `eslint` configuration to a project including the SAP Fiori tools lint plugin (`@sap-ux/eslint-plugin-fiori-tools`).
+Add an ESLint configuration to a project including the SAP Fiori tools lint plugin (`@sap-ux/eslint-plugin-fiori-tools`).
 
 Example:
 
@@ -114,7 +114,8 @@ Example:
 Options:
 - `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
 - `-v, --verbose` - Show verbose information.
-- `-c, --config <string>` _(required)_ - The name of the SAP Fiori tools eslint plugin configuration to be used (default is `recommended`).
+- `-c, --config <string>` - The name of the SAP Fiori tools eslint plugin configuration to be used. _(default: `recommended`)_
+- `-n, --skip-install` - Skip the `npm install` step.
 
 --------------------------------
 
@@ -144,7 +145,7 @@ Example:
 Options:
 - `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
 - `-v, --verbose` - Show verbose information.
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 
 --------------------------------
 
@@ -157,7 +158,7 @@ Example:
 `npx --yes @sap-ux/create@latest add cards-editor`
 
 Options:
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 - `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
 - `-v, --verbose` - Show verbose information.
 
@@ -192,7 +193,7 @@ Example:
 
 Options:
 - `-s, --simulate` - Simulate only. Do not write or install.
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 
 --------------------------------
 
@@ -205,7 +206,7 @@ Example:
 `npx --yes @sap-ux/create@latest add html`
 
 Options:
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 - `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
 - `-v, --verbose` - Show verbose information.
 
@@ -233,11 +234,11 @@ Example:
 `npx --yes @sap-ux/create@latest add deploy-config`
 
 Options:
-- `-t, --target <string>` _(required)_ - Target for deployment: ABAP or Cloud Foundry (not yet implemented)
+- `-t, --target <string>` - Target for deployment: ABAP or Cloud Foundry (not yet implemented)
 - `-s, --simulate` - Simulate only. Do not write. Also, sets `--verbose`
 - `-v, --verbose` - Show verbose information.
-- `-b, --base-file <string>` _(required)_ - The base config file of the project. _(default: "ui5.yaml")_
-- `-d, --deploy-file <string>` _(required)_ - The name of the deploy config file to be written. _(default: "ui5-deploy.yaml")_
+- `-b, --base-file <string>` - The base config file of the project. _(default: "ui5.yaml")_
+- `-d, --deploy-file <string>` - The name of the deploy config file to be written. _(default: "ui5-deploy.yaml")_
 
 --------------------------------
 
@@ -250,7 +251,7 @@ Example:
 `npx --yes @sap-ux/create@latest add variants-config`
 
 Options:
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 - `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
 - `-v, --verbose` - Show verbose information.
 
@@ -269,7 +270,7 @@ Example:
 
 Options:
 - `-v, --verbose` - Show verbose information.
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 
 --------------------------------
 
@@ -279,7 +280,7 @@ Command group for converting existing SAP Fiori applications. A subcommand is re
 
 Usage: `npx --yes @sap-ux/create@latest convert [subcommand] [options]`
 
-The available subcommands are: `preview-config`
+The available subcommands are: `preview-config` and `eslint-config`
 
 
 --------------------------------
@@ -295,9 +296,25 @@ Examples:
 `npx --yes @sap-ux/create@latest convert preview-config`
 
 Options:
-- `-s, --simulate <boolean>` _(required)_ - Simulate only. Do not write.
+- `-s, --simulate <boolean>` - Simulate only. Do not write.
 - `-v, --verbose` - Show verbose information.
-- `-t, --tests <boolean>` _(required)_ - Also, convert test suite and test runners.
+- `-t, --tests <boolean>` - Also, convert test suite and test runners.
+
+--------------------------------
+
+## [`convert eslint-config`](#convert-eslint-config)
+
+Executed in the root folder of an app, it converts the ESLint configuration of the respective app to flat config format (ESLint version 9).
+
+Examples:
+
+`npx --yes @sap-ux/create@latest convert eslint-config`
+
+Options:
+- `-s, --simulate` - Simulate only. Do not write to the config file. Also, sets `--verbose`
+- `-v, --verbose` - Show verbose information.
+- `-c, --config <string>` - The name of the SAP Fiori tools ESLint plugin configuration to be used. _(default: `recommended`)_
+- `-n, --skip-install` - Skip the `npm install` step.
 
 --------------------------------
 
@@ -349,7 +366,7 @@ Example:
 
 Options:
 - `-s, --simulate` - Simulate only. Do not write or install.
-- `-c, --config <string>` _(required)_ - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
+- `-c, --config <string>` - Path to the project configuration file in YAML format. _(default: `ui5.yaml`)_
 
 --------------------------------
 

package/dist/cli/add/eslint-config.js

@@ -5,6 +5,7 @@ const app_config_writer_1 = require("@sap-ux/app-config-writer");
 const tracing_1 = require("../../tracing");
 const validation_1 = require("../../validation");
 const project_access_1 = require("@sap-ux/project-access");
+const common_1 = require("../../common");
 /**
  * Add the "add eslint config" command to a passed command.
  *
@@ -12,17 +13,18 @@ const project_access_1 = require("@sap-ux/project-access");
  */
 function addAddEslintConfigCommand(cmd) {
     cmd.command('eslint-config [path]')
-        .description(`Add an \`eslint\` configuration to a project including the SAP Fiori tools lint plugin (\`@sap-ux/eslint-plugin-fiori-tools\`).\n
+        .description(`Add an ESLint configuration to a project including the SAP Fiori tools lint plugin (\`@sap-ux/eslint-plugin-fiori-tools\`).\n
 Example:
     \`npx --yes @sap-ux/create@latest add eslint-config\``)
         .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
         .option('-v, --verbose', 'Show verbose information.')
-        .option('-c, --config <string>', 'The name of the SAP Fiori tools eslint plugin configuration to be used (default is `recommended`).')
+        .option('-c, --config <string>', 'The name of the SAP Fiori tools eslint plugin configuration to be used.', 'recommended')
+        .option('-n, --skip-install', 'Skip the `npm install` step.')
         .action(async (path, options) => {
         if (options.verbose === true || options.simulate) {
             (0, tracing_1.setLogLevelVerbose)();
         }
-        await addEslintConfig(path || process.cwd(), !!options.simulate, options.config);
+        await addEslintConfig(path || process.cwd(), !!options.simulate, options.config, !!options.skipInstall);
     });
 }
 /**
@@ -31,8 +33,9 @@ Example:
  * @param basePath - path to application root
  * @param simulate - if true, do not write but just show what would be changed; otherwise write
  * @param config - the name of the SAP Fiori tools eslint plugin config to be used
+ * @param skipInstall - if true, skips the `npm install` step after adding the eslint config
  */
-async function addEslintConfig(basePath, simulate, config = 'recommended') {
+async function addEslintConfig(basePath, simulate, config, skipInstall = false) {
     const logger = (0, tracing_1.getLogger)();
     try {
         logger.debug(`Called add eslint-config for path '${basePath}', simulate is '${simulate}'`);
@@ -40,11 +43,20 @@ async function addEslintConfig(basePath, simulate, config = 'recommended') {
         const fs = await (0, app_config_writer_1.generateEslintConfig)(basePath, { logger, config });
         await (0, tracing_1.traceChanges)(fs);
         if (!simulate) {
-            fs.commit(() => logger.info(`Eslint configuration written. Ensure you install the new dependency by executing 'npm install'.`));
+            fs.commit(() => {
+                logger.info(`ESlint configuration written. Ensure you install the new dependency by executing 'npm install'.`);
+                if (skipInstall) {
+                    logger.info(`\`npm install\` will be skipped. Please make sure to install the dependencies before executing any linting commands.`);
+                }
+                else {
+                    logger.info(`Executing \`npm install\`.`);
+                    (0, common_1.runNpmInstallCommand)(basePath, undefined, { logger });
+                }
+            });
         }
     }
     catch (error) {
-        logger.error(`Error while executing add eslint-config '${error.message}'`);
+        logger.error(`Error while executing add eslint-config. '${error.message}'`);
         logger.debug(error);
     }
     if ((await (0, project_access_1.getProjectType)(basePath)) !== 'EDMXBackend') {

package/dist/cli/convert/eslint-config.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add a new sub-command to convert the eslint configuration of a project to flat config format (eslint version 9).
+ *
+ * @param {Command} cmd - The command to add the convert sub-command to.
+ */
+export declare function addConvertEslintCommand(cmd: Command): void;
+//# sourceMappingURL=eslint-config.d.ts.map

package/dist/cli/convert/eslint-config.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addConvertEslintCommand = addConvertEslintCommand;
+const tracing_1 = require("../../tracing");
+const validation_1 = require("../../validation");
+const app_config_writer_1 = require("@sap-ux/app-config-writer");
+const common_1 = require("../../common");
+/**
+ * Add a new sub-command to convert the eslint configuration of a project to flat config format (eslint version 9).
+ *
+ * @param {Command} cmd - The command to add the convert sub-command to.
+ */
+function addConvertEslintCommand(cmd) {
+    cmd.command('eslint-config [path]')
+        .description(`Executed in the root folder of an app, it converts the ESLint configuration of the respective app to flat config format (ESLint version 9).\n
+Examples:
+    \`npx --yes @sap-ux/create@latest convert eslint-config\``)
+        .option('-s, --simulate', 'Simulate only. Do not write to the config file. Also, sets `--verbose`')
+        .option('-v, --verbose', 'Show verbose information.')
+        .option('-c, --config <string>', 'The name of the SAP Fiori tools ESLint plugin configuration to be used.', 'recommended')
+        .option('-n, --skip-install', 'Skip the `npm install` step.')
+        .action(async (path, options) => {
+        if (options.verbose === true || options.simulate) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        await convertEslintConfig(path || process.cwd(), !!options.simulate, options.config, !!options.skipInstall);
+    });
+}
+/**
+ * Converts an eslint config to flat config format (eslint version 9).
+ *
+ * @param basePath - path to application root
+ * @param simulate - if true, simulates the conversion without writing to the config file. Also, sets `--verbose`
+ * @param config - the name of the SAP Fiori tools eslint plugin config to be used
+ * @param skipInstall - if true, skips the `npm install` step after converting the eslint config
+ */
+async function convertEslintConfig(basePath, simulate, config, skipInstall = false) {
+    const logger = (0, tracing_1.getLogger)();
+    try {
+        logger.debug(`Called add eslint-config for path '${basePath}', simulate is '${simulate}'`);
+        await (0, validation_1.validateBasePath)(basePath);
+        const fs = await (0, app_config_writer_1.convertEslintConfig)(basePath, { logger, config });
+        await (0, tracing_1.traceChanges)(fs);
+        if (!simulate) {
+            fs.commit(() => {
+                logger.info(`ESlint configuration converted. Ensure the new configuration is working correctly before deleting old configuration files like '.eslintrc.json' or '.eslintignore'.`);
+                if (skipInstall) {
+                    logger.info(`\`npm install\` was skipped. Ensure you install the dependencies before executing any linting commands.`);
+                }
+                else {
+                    logger.info(`Executing \`npm install\`.`);
+                    (0, common_1.runNpmInstallCommand)(basePath, undefined, { logger });
+                }
+            });
+        }
+    }
+    catch (error) {
+        logger.error(`Error while executing convert eslint-config. '${error.message}'`);
+        logger.debug(error);
+    }
+}
+//# sourceMappingURL=eslint-config.js.map

package/dist/cli/convert/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConvertCommands = getConvertCommands;
 const commander_1 = require("commander");
 const preview_1 = require("./preview");
+const eslint_config_1 = require("./eslint-config");
 /**
  * Return 'create-fiori convert *' commands. Commands include also the handler action.
  *
@@ -11,6 +12,7 @@ const preview_1 = require("./preview");
 function getConvertCommands() {
     const convertCommands = new commander_1.Command('convert');
     (0, preview_1.addConvertPreviewCommand)(convertCommands);
+    (0, eslint_config_1.addConvertEslintCommand)(convertCommands);
     return convertCommands;
 }
 //# sourceMappingURL=index.js.map

package/dist/cli/index.js

@@ -116,7 +116,7 @@ function parseOption(opt) {
     return {
         name: opt.flags,
         description: opt.description,
-        required: opt.required,
+        required: opt.mandatory === true, // Only true for .requiredOption() not for required values (.option('<value>'))
         ...(opt.defaultValue !== undefined && { defaultValue: opt.defaultValue })
     };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.15.24",
+  "version": "0.15.25",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -34,7 +34,7 @@
     "@sap-ux/abap-deploy-config-inquirer": "1.7.15",
     "@sap-ux/abap-deploy-config-writer": "0.2.87",
     "@sap-ux/adp-tooling": "0.18.82",
-    "@sap-ux/app-config-writer": "0.6.113",
+    "@sap-ux/app-config-writer": "0.6.114",
     "@sap-ux/cap-config-writer": "0.12.75",
     "@sap-ux/logger": "0.8.2",
     "@sap-ux/mockserver-config-writer": "0.9.60",