@sap-ux/fiori-generator-shared 0.5.0 → 0.6.0

package/dist/cap/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCapFolderPathsSync = void 0;
+exports.getCapFolderPathsSync = getCapFolderPathsSync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 /**
@@ -41,5 +41,4 @@ function getCapFolderPathsSync(capProjectPath) {
     }
     return capPaths;
 }
-exports.getCapFolderPathsSync = getCapFolderPathsSync;
 //# sourceMappingURL=index.js.map

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const YEOMANUI_TARGET_FOLDER_CONFIG_PROP = "ApplicationWizard.TargetFolder";
+export declare const LOGGING_LEVEL_CONFIG_PROP = "ApplicationWizard.loggingLevel";
+export declare const DEFAULT_PROJECTS_FOLDER: string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_PROJECTS_FOLDER = exports.LOGGING_LEVEL_CONFIG_PROP = exports.YEOMANUI_TARGET_FOLDER_CONFIG_PROP = void 0;
+const os_1 = __importDefault(require("os"));
+const path_1 = require("path");
+exports.YEOMANUI_TARGET_FOLDER_CONFIG_PROP = 'ApplicationWizard.TargetFolder';
+exports.LOGGING_LEVEL_CONFIG_PROP = 'ApplicationWizard.loggingLevel';
+exports.DEFAULT_PROJECTS_FOLDER = (0, path_1.join)(os_1.default.homedir(), 'projects');
+//# sourceMappingURL=constants.js.map

package/dist/environment.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCli = void 0;
+exports.isCli = isCli;
 /**
  * Determine if the current prompting environment is cli .
  *
@@ -14,5 +14,4 @@ function isCli() {
         return false;
     }
 }
-exports.isCli = isCli;
 //# sourceMappingURL=environment.js.map

package/dist/getPackageScripts.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPackageScripts = void 0;
+exports.getPackageScripts = getPackageScripts;
 const i18n_1 = require("./i18n");
 /**
  * Builds the command for the `start-noflp` script in `package.json`.
@@ -129,5 +129,4 @@ function getPackageScripts({ localOnly, addMock = true, addTest = false, sapClie
         : getVariantPreviewAppScript(sapClient);
     return scripts;
 }
-exports.getPackageScripts = getPackageScripts;
 //# sourceMappingURL=getPackageScripts.js.map

package/dist/helpers.d.ts

@@ -10,4 +10,11 @@ export declare function getBootstrapResourceUrls(isEdmxProjectType: boolean, fra
     uShellBootstrapResourceUrl: string;
     uiBootstrapResourceUrl: string;
 };
+/**
+ * Determines the target folder for the project.
+ *
+ * @param vscode - the vscode instance
+ * @returns The default path, if it can be determined otherwise undefined.
+ */
+export declare function getDefaultTargetFolder(vscode: any): string | undefined;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBootstrapResourceUrls = void 0;
+exports.getBootstrapResourceUrls = getBootstrapResourceUrls;
+exports.getDefaultTargetFolder = getDefaultTargetFolder;
+const fs_1 = require("fs");
+const constants_1 = require("./constants");
 /**
  * Get the resource URLs for the UShell bootstrap and UI5 bootstrap based on project type and UI5 framework details.
  *
@@ -23,5 +26,27 @@ function getBootstrapResourceUrls(isEdmxProjectType, frameworkUrl, version) {
     const uiBootstrapResourceUrl = isEdmxProjectType || !frameworkUrl ? `..${relativeUiPath}` : `${frameworkUrl}${versionPath}${relativeUiPath}`;
     return { uShellBootstrapResourceUrl, uiBootstrapResourceUrl };
 }
-exports.getBootstrapResourceUrls = getBootstrapResourceUrls;
+/**
+ * Determines the target folder for the project.
+ *
+ * @param vscode - the vscode instance
+ * @returns The default path, if it can be determined otherwise undefined.
+ */
+function getDefaultTargetFolder(vscode) {
+    // CLI use will not define vscode
+    if (!vscode) {
+        return undefined;
+    }
+    const targetFolder = vscode.workspace?.getConfiguration().get(constants_1.YEOMANUI_TARGET_FOLDER_CONFIG_PROP);
+    if (targetFolder) {
+        return targetFolder;
+    }
+    const workspace = vscode.workspace;
+    // If this is not a workspace default to the first folder (`rootPath` is deprecated)
+    if (workspace.workspaceFolders?.length > 0 && workspace.workspaceFolders[0].uri.scheme === 'file') {
+        return workspace.workspaceFolders[0].uri.fsPath;
+    }
+    // Otherwise use <home-dir>/projects,
+    return (0, fs_1.existsSync)(constants_1.DEFAULT_PROJECTS_FOLDER) ? constants_1.DEFAULT_PROJECTS_FOLDER : undefined;
+}
 //# sourceMappingURL=helpers.js.map

package/dist/i18n.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.initI18n = void 0;
+exports.initI18n = initI18n;
+exports.t = t;
 const i18next_1 = __importDefault(require("i18next"));
 const fiori_generator_shared_i18n_json_1 = __importDefault(require("./translations/fiori-generator-shared.i18n.json"));
 const NS = 'fiori-freestyle-writer';
@@ -23,7 +24,6 @@ async function initI18n() {
         ns: [NS]
     });
 }
-exports.initI18n = initI18n;
 /**
  * Helper function facading the call call to i18next.
  *
@@ -34,7 +34,6 @@ exports.initI18n = initI18n;
 function t(key, options) {
     return i18next_1.default.t(key, options);
 }
-exports.t = t;
 initI18n().catch(() => {
     // Ignore any errors since the write will still work
 });

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export * from './cap';
 export * from './environment';
 export { getPackageScripts } from './getPackageScripts';
-export { getBootstrapResourceUrls } from './helpers';
+export { getBootstrapResourceUrls, getDefaultTargetFolder } from './helpers';
 export { generateReadMe } from './read-me';
 export * from './system-utils';
-export { PackageJsonScripts } from './types';
+export { PackageJsonScripts, YeomanEnvironment, VSCodeInstance } from './types';
+export * from './logWrapper';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,14 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReadMe = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
+exports.generateReadMe = exports.getDefaultTargetFolder = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
 __exportStar(require("./cap"), exports);
 __exportStar(require("./environment"), exports);
 var getPackageScripts_1 = require("./getPackageScripts");
 Object.defineProperty(exports, "getPackageScripts", { enumerable: true, get: function () { return getPackageScripts_1.getPackageScripts; } });
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "getBootstrapResourceUrls", { enumerable: true, get: function () { return helpers_1.getBootstrapResourceUrls; } });
+Object.defineProperty(exports, "getDefaultTargetFolder", { enumerable: true, get: function () { return helpers_1.getDefaultTargetFolder; } });
 var read_me_1 = require("./read-me");
 Object.defineProperty(exports, "generateReadMe", { enumerable: true, get: function () { return read_me_1.generateReadMe; } });
 __exportStar(require("./system-utils"), exports);
+__exportStar(require("./logWrapper"), exports);
 //# sourceMappingURL=index.js.map

package/dist/logWrapper.d.ts

@@ -0,0 +1,95 @@
+import type { IVSCodeExtLogger, LogLevel, IChildLogger as ILogWrapper } from '@vscode-logging/logger';
+import type { Logger } from 'yeoman-environment';
+export type { ILogWrapper };
+/**
+ * Empty Implementation of the Logger, this is not strictly necessary in app gen but
+ * other modules consuming parts of app gen need a dummy implementation (logs to console)
+ */
+export declare const DefaultLogger: LogWrapper;
+/**
+ * Creates a CLI logger based on the IChildLogger interface. This means we can use the
+ * same log functions for extension and cli logging. No files generated for CLI use currently.
+ *
+ * @param logName - name of the logger
+ * @param logLevel - defaults to off on cli
+ * @returns {ILogWrapper} - the logger
+ */
+export declare function createCLILogger(logName: string, logLevel?: LogLevel): ILogWrapper;
+/**
+ * Log to vscode extension logger and yeoman logger simultaneously.
+ * This allows use of Application Wizard log config and log file use but still have a single output channel for
+ * App Gen logging.
+ */
+export declare class LogWrapper implements ILogWrapper {
+    private static _vscodeLogger;
+    private static _yoLogger;
+    private static _logLevel;
+    static readonly consoleFormat: import("logform").Format;
+    /**
+     * Create a new LogWrapper instance.
+     *
+     * @param logName - name of the logger
+     * @param yoLogger - yeoman logger
+     * @param logLevel - log level
+     * @param extLogger - vscode extension logger
+     * @param vscode - vscode instance
+     */
+    constructor(logName: string, yoLogger?: Logger, logLevel?: LogLevel, extLogger?: IVSCodeExtLogger, vscode?: any);
+    static readonly logAtLevel: (level: LogLevel, message: string, ...args: any[]) => void;
+    /**
+     * Log a message at the fatal level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    fatal(msg: string, ...args: any[]): void;
+    /**
+     * Log a message at the error level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    error(msg: string, ...args: any[]): void;
+    /**
+     * Log a message at the warn level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    warn(msg: string, ...args: any[]): void;
+    /**
+     * Log a message at the info level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    info(msg: string, ...args: any[]): void;
+    /**
+     * Log a message at the debug level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    debug(msg: string, ...args: any[]): void;
+    /**
+     * Log a message at the trace level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    trace(msg: string, ...args: any[]): void;
+    /**
+     * Log a message at the info level.
+     *
+     * @param msg - message to log
+     */
+    static log(msg: string): void;
+    /**
+     * Get the currently configured log level.
+     *
+     * @returns {LogLevel} The current log level.
+     */
+    getLogLevel(): LogLevel;
+    getChildLogger(): ILogWrapper;
+}
+//# sourceMappingURL=logWrapper.d.ts.map

package/dist/logWrapper.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogWrapper = exports.DefaultLogger = void 0;
+exports.createCLILogger = createCLILogger;
+const logger_1 = require("@vscode-logging/logger");
+const logform_1 = require("logform");
+const i18n_1 = require("./i18n");
+const constants_1 = require("./constants");
+/**
+ * Empty Implementation of the Logger, this is not strictly necessary in app gen but
+ * other modules consuming parts of app gen need a dummy implementation (logs to console)
+ */
+exports.DefaultLogger = {
+    fatal: (msg) => {
+        console.log(msg);
+    },
+    error: (msg) => {
+        console.error(msg);
+    },
+    warn: (msg) => {
+        console.warn(msg);
+    },
+    info: (msg) => {
+        console.log(msg);
+    },
+    debug: (msg) => {
+        console.log(msg);
+    },
+    trace: (msg) => {
+        console.trace(msg);
+    },
+    getChildLogger: () => exports.DefaultLogger,
+    getLogLevel: () => 'off'
+};
+const LOG_LEVEL_KEYS = {
+    off: -1,
+    fatal: 0,
+    error: 1,
+    warn: 2,
+    info: 3,
+    debug: 4,
+    trace: 5
+};
+/**
+ * Creates a CLI logger based on the IChildLogger interface. This means we can use the
+ * same log functions for extension and cli logging. No files generated for CLI use currently.
+ *
+ * @param logName - name of the logger
+ * @param logLevel - defaults to off on cli
+ * @returns {ILogWrapper} - the logger
+ */
+function createCLILogger(logName, logLevel = 'off') {
+    const extensionLoggerOpts = {
+        extName: logName,
+        level: logLevel,
+        logConsole: true
+    };
+    return (0, logger_1.getExtensionLogger)(extensionLoggerOpts);
+}
+/**
+ * Log to vscode extension logger and yeoman logger simultaneously.
+ * This allows use of Application Wizard log config and log file use but still have a single output channel for
+ * App Gen logging.
+ */
+class LogWrapper {
+    static _vscodeLogger;
+    static _yoLogger;
+    static _logLevel;
+    static consoleFormat = logform_1.format.combine(logform_1.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), logform_1.format.printf((msgJson) => {
+        return `[${msgJson.timestamp}] ${msgJson.level.toUpperCase()}: ${msgJson.message}`;
+    }));
+    /**
+     * Create a new LogWrapper instance.
+     *
+     * @param logName - name of the logger
+     * @param yoLogger - yeoman logger
+     * @param logLevel - log level
+     * @param extLogger - vscode extension logger
+     * @param vscode - vscode instance
+     */
+    constructor(logName, yoLogger, logLevel, extLogger, vscode) {
+        LogWrapper._yoLogger = yoLogger;
+        if (extLogger) {
+            LogWrapper._logLevel = vscode
+                ? vscode.workspace.getConfiguration().get(constants_1.LOGGING_LEVEL_CONFIG_PROP)
+                : logLevel ?? 'info';
+            LogWrapper._vscodeLogger = extLogger.getChildLogger({ label: logName });
+        }
+        else {
+            if (!LogWrapper._yoLogger) {
+                LogWrapper._vscodeLogger = createCLILogger(logName, logLevel);
+            }
+            LogWrapper._logLevel = logLevel === 'off' || !logLevel ? 'info' : logLevel;
+        }
+        LogWrapper._vscodeLogger?.debug((0, i18n_1.t)('debug.loggingConfigured', { logLevel: LogWrapper._logLevel }));
+    }
+    static logAtLevel = (level, message, ...args) => {
+        if (LogWrapper._vscodeLogger && level !== 'off') {
+            LogWrapper._vscodeLogger[level](message, ...args);
+        }
+        if (LogWrapper._yoLogger) {
+            if (LOG_LEVEL_KEYS[level] <= LOG_LEVEL_KEYS[LogWrapper._logLevel]) {
+                LogWrapper._yoLogger(LogWrapper.consoleFormat.transform({
+                    level,
+                    message
+                })[Symbol.for('message')]);
+            }
+        }
+        else {
+            exports.DefaultLogger.error((0, i18n_1.t)('error.logWrapperNotInitialised'));
+        }
+    };
+    /**
+     * Log a message at the fatal level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    fatal(msg, ...args) {
+        LogWrapper.logAtLevel('fatal', msg, ...args);
+    }
+    /**
+     * Log a message at the error level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    error(msg, ...args) {
+        LogWrapper.logAtLevel('error', msg, ...args);
+    }
+    /**
+     * Log a message at the warn level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    warn(msg, ...args) {
+        LogWrapper.logAtLevel('warn', msg, ...args);
+    }
+    /**
+     * Log a message at the info level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    info(msg, ...args) {
+        LogWrapper.logAtLevel('info', msg, ...args);
+    }
+    /**
+     * Log a message at the debug level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    debug(msg, ...args) {
+        LogWrapper.logAtLevel('debug', msg, ...args);
+    }
+    /**
+     * Log a message at the trace level.
+     *
+     * @param msg - message to log
+     * @param {...any} args - additional arguments
+     */
+    trace(msg, ...args) {
+        LogWrapper.logAtLevel('trace', msg, ...args);
+    }
+    /**
+     * Log a message at the info level.
+     *
+     * @param msg - message to log
+     */
+    static log(msg) {
+        LogWrapper.logAtLevel('info', msg);
+    }
+    /**
+     * Get the currently configured log level.
+     *
+     * @returns {LogLevel} The current log level.
+     */
+    getLogLevel() {
+        return LogWrapper._logLevel;
+    }
+    getChildLogger( /* opts: { label: string } */) {
+        throw new Error((0, i18n_1.t)('error.methodNotImplemented'));
+    }
+}
+exports.LogWrapper = LogWrapper;
+//# sourceMappingURL=logWrapper.js.map

package/dist/read-me.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReadMe = void 0;
+exports.generateReadMe = generateReadMe;
 const path_1 = require("path");
 /**
  * Generates a README file at the specified destination path using the provided configuration and file system editor.
@@ -18,5 +18,4 @@ function generateReadMe(destPath, readMe, fs) {
     fs.copyTpl(templateSourcePath, templateDestPath, readMe);
     return fs;
 }
-exports.generateReadMe = generateReadMe;
 //# sourceMappingURL=read-me.js.map

package/dist/system-utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSystemDisplayName = exports.Suffix = void 0;
+exports.Suffix = void 0;
+exports.getSystemDisplayName = getSystemDisplayName;
 /**
  * Relevant values for display extended system properties to the UI
  */
@@ -52,5 +53,4 @@ function getSystemDisplayName(systemName, displayUsername, isBtp = false, isS4HC
     }
     return `${systemDisplayName}${userDisplayName}`;
 }
-exports.getSystemDisplayName = getSystemDisplayName;
 //# sourceMappingURL=system-utils.js.map

package/dist/translations/fiori-generator-shared.i18n.json

@@ -1,5 +1,12 @@
 {
     "info": {
         "mockOnlyWarning": "This application was generated with a local metadata file and does not reference a live server. Please add the required server configuration or start this application with mock data using the target: npm run start-mock"
+    },
+    "error": {
+        "logWrapperNotInitialised": "LogWrapper is not initialised",
+        "methodNotImplemented": "Method not implemented"
+    },
+    "debug": {
+        "loggingConfigured": "Logging has been configured at log level: {{logLevel}}"
     }
 }

package/dist/types.d.ts

@@ -53,6 +53,25 @@ export interface ReadMe {
     /** Additional custom entries for the application. */
     additionalEntries?: AdditionalEntries[];
 }
+/**
+ * Interface for the yeoman environment.
+ */
+export interface YeomanEnvironment {
+    conflicter: {
+        force: boolean;
+    };
+    adapter: {
+        actualAdapter: unknown;
+    };
+}
+/**
+ * Interface for the VSCode instance.
+ */
+export interface VSCodeInstance {
+    commands: {
+        executeCommand: (command: string, ...rest: any[]) => Promise<void>;
+    };
+}
 /**
  * Defines the structure for the `package.json` scripts section.
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-generator-shared",
   "description": "Commonly used shared functionality and types to support the fiori generator.",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -17,15 +17,18 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "@vscode-logging/logger": "2.0.0",
     "i18next": "20.6.1",
+    "logform": "2.4.0",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/project-access": "1.27.4"
+    "@sap-ux/project-access": "1.27.5"
   },
   "devDependencies": {
     "@types/mem-fs-editor": "7.0.1",
-    "@types/mem-fs": "1.1.2"
+    "@types/mem-fs": "1.1.2",
+    "@types/yeoman-environment": "2.10.11"
   },
   "engines": {
     "node": ">=18.x"