@sap-ux/create 0.14.62 → 0.14.64

package/README.md

@@ -68,7 +68,7 @@ Command group for adding features to existing SAP Fiori applications. A subcomma
 
 Usage: `npx --yes @sap-ux/create@latest add [subcommand] [options]`
 
-The available subcommands are: `mockserver-config`, `smartlinks-config`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config`, `variants-config` and `adp-cf-config`
+The available subcommands are: `mockserver-config`, `smartlinks-config`, `eslint-config`, `cds-plugin-ui5`, `inbound-navigation`, `cards-editor`, `model`, `annotations`, `html`, `component-usages`, `deploy-config`, `variants-config` and `adp-cf-config`
 
 
 --------------------------------
@@ -103,6 +103,21 @@ 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`).
+
+Example:
+
+`npx --yes @sap-ux/create@latest add 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>` _(required)_ - The name of the SAP Fiori tools eslint plugin configuration to be used (default is `recommended`).
+
+--------------------------------
+
 ## [`add cds-plugin-ui5`](#add-cds-plugin-ui5)
 
 Add the `cds-plugin-ui5` module and all prerequisites to a CAP project for UI5 server integration.

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

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add the "add eslint config" command to a passed command.
+ *
+ * @param cmd - commander command for adding eslint config command
+ */
+export declare function addAddEslintConfigCommand(cmd: Command): void;
+//# sourceMappingURL=eslint-config.d.ts.map

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addAddEslintConfigCommand = addAddEslintConfigCommand;
+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");
+/**
+ * Add the "add eslint config" command to a passed command.
+ *
+ * @param cmd - commander command for adding eslint config command
+ */
+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
+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`).')
+        .action(async (path, options) => {
+        if (options.verbose === true || options.simulate) {
+            (0, tracing_1.setLogLevelVerbose)();
+        }
+        await addEslintConfig(path || process.cwd(), !!options.simulate, options.config);
+    });
+}
+/**
+ * Adds an eslint config to an app.
+ *
+ * @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
+ */
+async function addEslintConfig(basePath, simulate, config = 'recommended') {
+    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.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'.`));
+        }
+    }
+    catch (error) {
+        logger.error(`Error while executing add eslint-config '${error.message}'`);
+        logger.debug(error);
+    }
+    if ((await (0, project_access_1.getProjectType)(basePath)) !== 'EDMXBackend') {
+        logger.info(`You can execute \`npm run lint --workspaces --if-present\` from the CAP project root to lint app.`);
+        logger.info(`You can add a command such as \`&& npm run lint --workspaces --if-present\` to an existing command in the CAP project root where linting is executed.
+            A complete command is similar to the following:
+        //  \`"lint": "cds lint  && npm run lint --workspaces --if-present"\``);
+    }
+}
+//# sourceMappingURL=eslint-config.js.map

package/dist/cli/add/index.js

@@ -14,6 +14,7 @@ const component_usages_1 = require("./component-usages");
 const deploy_config_1 = require("./deploy-config");
 const variants_config_1 = require("./variants-config");
 const adp_cf_config_1 = require("./adp-cf-config");
+const eslint_config_1 = require("./eslint-config");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
  *
@@ -23,6 +24,7 @@ function getAddCommands() {
     const addCommands = new commander_1.Command('add');
     (0, mockserver_config_1.addAddMockserverConfigCommand)(addCommands);
     (0, smartlinks_config_1.addAddSmartLinksConfigCommand)(addCommands);
+    (0, eslint_config_1.addAddEslintConfigCommand)(addCommands);
     (0, cds_plugin_ui_1.addAddCdsPluginUi5Command)(addCommands);
     (0, navigation_config_1.addInboundNavigationConfigCommand)(addCommands);
     (0, cards_generator_1.addCardsEditorConfigCommand)(addCommands);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.14.62",
+  "version": "0.14.64",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,19 +31,19 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
-    "@sap-ux/abap-deploy-config-inquirer": "1.6.98",
-    "@sap-ux/abap-deploy-config-writer": "0.2.71",
-    "@sap-ux/adp-tooling": "0.18.62",
-    "@sap-ux/app-config-writer": "0.6.96",
-    "@sap-ux/cap-config-writer": "0.12.61",
+    "@sap-ux/adp-tooling": "0.18.63",
+    "@sap-ux/app-config-writer": "0.6.98",
+    "@sap-ux/cap-config-writer": "0.12.62",
     "@sap-ux/logger": "0.8.1",
     "@sap-ux/mockserver-config-writer": "0.9.50",
     "@sap-ux/odata-service-writer": "0.29.18",
-    "@sap-ux/preview-middleware": "0.23.119",
+    "@sap-ux/preview-middleware": "0.23.120",
+    "@sap-ux/system-access": "0.6.51",
+    "@sap-ux/abap-deploy-config-writer": "0.2.72",
+    "@sap-ux/abap-deploy-config-inquirer": "1.6.99",
     "@sap-ux/project-access": "1.35.3",
-    "@sap-ux/system-access": "0.6.50",
     "@sap-ux/ui5-config": "0.29.16",
-    "@sap-ux/flp-config-inquirer": "0.4.121",
+    "@sap-ux/flp-config-inquirer": "0.4.122",
     "@sap-ux/nodejs-utils": "0.2.14"
   },
   "devDependencies": {
@@ -52,8 +52,8 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/prompts": "2.4.4",
-    "@sap-ux/inquirer-common": "0.11.4",
-    "@sap-ux/store": "1.5.5"
+    "@sap-ux/inquirer-common": "0.11.5",
+    "@sap-ux/store": "1.5.6"
   },
   "scripts": {
     "build": "tsc --build && node ./scripts/generate-readme.js",