@sap-ux/ui5-library-sub-generator 0.0.1 → 0.0.2

package/generators/app/defaults.d.ts

@@ -0,0 +1,6 @@
+export declare const defaultLibraryName = "library1";
+export declare const defaultNamespace = "com.myorg";
+export declare const defaultFramework = "SAPUI5";
+export declare const defaultUi5Version = "1.79.0";
+export declare const defaultAuthor = "Fiori tools";
+//# sourceMappingURL=defaults.d.ts.map

package/generators/app/defaults.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultAuthor = exports.defaultUi5Version = exports.defaultFramework = exports.defaultNamespace = exports.defaultLibraryName = void 0;
+const ui5_info_1 = require("@sap-ux/ui5-info");
+// Default values for the UI5 library writer
+exports.defaultLibraryName = 'library1';
+exports.defaultNamespace = 'com.myorg';
+exports.defaultFramework = 'SAPUI5';
+exports.defaultUi5Version = ui5_info_1.minUI5VersionForLocalDev;
+exports.defaultAuthor = 'Fiori tools';
+//# sourceMappingURL=defaults.js.map

package/generators/app/index.d.ts

@@ -0,0 +1,30 @@
+import Generator from 'yeoman-generator';
+import { AppWizard, Prompts } from '@sap-devx/yeoman-ui-types';
+import { type UI5LibraryAnswers } from '@sap-ux/ui5-library-inquirer';
+import type { Ui5LibGenerator } from './types';
+/**
+ * Generator for creating a new UI5 library.
+ *
+ * @extends Generator
+ */
+export default class extends Generator implements Ui5LibGenerator {
+    answers: UI5LibraryAnswers;
+    prompts: Prompts;
+    appWizard: AppWizard;
+    targetFolder: string;
+    vscode: unknown;
+    projectPath: string;
+    setPromptsCallback: (fn: any) => void;
+    /**
+     * Constructor for the generator.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args: string | string[], opts: Generator.GeneratorOptions);
+    prompting(): Promise<void>;
+    writing(): Promise<void>;
+    install(): Promise<void>;
+    end(): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/generators/app/index.js

@@ -0,0 +1,111 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const path_1 = require("path");
+const logger_1 = __importDefault(require("../utils/logger"));
+const utils_1 = require("../utils");
+const fiori_tools_settings_1 = require("@sap-ux/fiori-tools-settings");
+const os_1 = require("os");
+const nodejs_utils_1 = require("@sap-ux/nodejs-utils");
+const defaults_1 = require("./defaults");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const ui5_library_writer_1 = require("@sap-ux/ui5-library-writer");
+const ui5_library_inquirer_1 = require("@sap-ux/ui5-library-inquirer");
+/**
+ * Generator for creating a new UI5 library.
+ *
+ * @extends Generator
+ */
+class default_1 extends yeoman_generator_1.default {
+    answers = {};
+    prompts;
+    appWizard;
+    targetFolder;
+    vscode;
+    projectPath;
+    setPromptsCallback;
+    /**
+     * Constructor for the generator.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args, opts) {
+        super(args, opts);
+        this.appWizard = yeoman_ui_types_1.AppWizard.create(opts);
+        this.vscode = opts.vscode;
+        logger_1.default.configureLogging(this.options.logger, this.rootGeneratorName(), this.log, this.options.vscode, this.options.logLevel);
+        this.targetFolder = (0, fiori_generator_shared_1.getDefaultTargetFolder)(this.options.vscode) ?? process.cwd();
+        this.appWizard.setHeaderTitle(utils_1.generatorTitle);
+        this.prompts = new yeoman_ui_types_1.Prompts(utils_1.prompts);
+        this.setPromptsCallback = (fn) => {
+            if (this.prompts) {
+                this.prompts.setCallback(fn);
+            }
+        };
+    }
+    async prompting() {
+        const promptCli = (0, fiori_generator_shared_1.isCli)();
+        let inquirerAdaptor;
+        if (this.env?.adapter?.actualAdapter) {
+            inquirerAdaptor = this.env.adapter.actualAdapter;
+        }
+        else {
+            inquirerAdaptor = this.env?.adapter;
+        }
+        const answers = await (0, ui5_library_inquirer_1.prompt)({
+            targetFolder: this.targetFolder,
+            includeSeparators: !promptCli,
+            useAutocomplete: promptCli
+        }, inquirerAdaptor);
+        Object.assign(this.answers, answers);
+    }
+    async writing() {
+        const ui5Lib = {
+            libraryName: this.answers.libraryName ?? defaults_1.defaultLibraryName,
+            namespace: this.answers.namespace ?? defaults_1.defaultNamespace,
+            framework: defaults_1.defaultFramework,
+            frameworkVersion: this.answers.ui5Version ?? defaults_1.defaultUi5Version,
+            author: defaults_1.defaultAuthor,
+            typescript: this.answers.enableTypescript
+        };
+        if (this.answers.targetFolder) {
+            this.targetFolder = this.answers.targetFolder;
+        }
+        try {
+            await (0, ui5_library_writer_1.generate)(this.targetFolder, ui5Lib, this.fs);
+        }
+        catch (e) {
+            logger_1.default.logger.error(e);
+            throw new Error((0, utils_1.t)('error.generatingUi5Lib'));
+        }
+    }
+    async install() {
+        if (!this.options.skipInstall) {
+            try {
+                const runner = new nodejs_utils_1.CommandRunner();
+                const npm = (0, os_1.platform)() === 'win32' ? 'npm.cmd' : 'npm';
+                logger_1.default.logger.info((0, utils_1.t)('info.installingDependencies'));
+                this.projectPath = (0, path_1.join)(this.targetFolder, `${this.answers.namespace}.${this.answers.libraryName}`);
+                await runner.run(npm, ['install'], { cwd: this.projectPath });
+                logger_1.default.logger.info((0, utils_1.t)('info.dependenciesInstalled'));
+            }
+            catch (error) {
+                logger_1.default.logger.error(error || (0, utils_1.t)('error.unknown'));
+            }
+        }
+    }
+    async end() {
+        (0, fiori_tools_settings_1.writeApplicationInfoSettings)(this.projectPath, this.fs);
+        await (0, utils_1.runPostLibGenHook)({
+            path: this.projectPath,
+            vscodeInstance: this.vscode
+        });
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=index.js.map

package/generators/app/types.d.ts

@@ -0,0 +1,8 @@
+import type { Prompts, AppWizard } from '@sap-devx/yeoman-ui-types';
+import type { UI5LibraryAnswers } from '@sap-ux/ui5-library-inquirer';
+export interface Ui5LibGenerator {
+    appWizard: AppWizard;
+    answers: UI5LibraryAnswers;
+    prompts: Prompts;
+}
+//# sourceMappingURL=types.d.ts.map

package/generators/app/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/generators/translations/ui5-lib-generator.i18n.json

@@ -0,0 +1,11 @@
+{
+    "info": {
+        "installingDependencies": "Installing dependencies...",
+        "dependenciesInstalled": "Library dependencies have been installed."
+    },
+    "error": {
+        "unknown": "Unknown error",
+        "generatingUi5Lib": "Error generating reusable UI5 library",
+        "postLibGenHook": "Failed to run hook after library generation {{- error}}"
+    }
+}

package/generators/utils/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const UI5_LIB_GEN = "UI5_LIB_GEN";
+export declare const generatorTitle = "SAP Fiori Reusable Library";
+export declare const prompts: {
+    name: string;
+    description: string;
+}[];
+//# sourceMappingURL=constants.d.ts.map

package/generators/utils/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prompts = exports.generatorTitle = exports.UI5_LIB_GEN = void 0;
+exports.UI5_LIB_GEN = 'UI5_LIB_GEN';
+exports.generatorTitle = 'SAP Fiori Reusable Library';
+exports.prompts = [
+    {
+        name: 'Generate UI5 Library',
+        description: 'Create a Reusable Library for use in SAP Fiori applications'
+    }
+];
+//# sourceMappingURL=constants.js.map

package/generators/utils/eventHook.d.ts

@@ -0,0 +1,13 @@
+import type { VSCodeInstance } from '@sap-ux/fiori-generator-shared';
+export interface LibContext {
+    path: string;
+    vscodeInstance?: VSCodeInstance;
+}
+export declare const POST_LIB_GEN_COMMAND = "sap.ux.library.generated.handler";
+/**
+ * Executes post library generation command : 'sap.ux.library.generated.handler'.
+ *
+ * @param context LibContext
+ */
+export declare function runPostLibGenHook(context: LibContext): Promise<void>;
+//# sourceMappingURL=eventHook.d.ts.map

package/generators/utils/eventHook.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPostLibGenHook = exports.POST_LIB_GEN_COMMAND = void 0;
+const logger_1 = __importDefault(require("./logger"));
+const i18n_1 = require("./i18n");
+exports.POST_LIB_GEN_COMMAND = 'sap.ux.library.generated.handler';
+/**
+ * Executes post library generation command : 'sap.ux.library.generated.handler'.
+ *
+ * @param context LibContext
+ */
+async function runPostLibGenHook(context) {
+    try {
+        await context.vscodeInstance?.commands?.executeCommand?.(exports.POST_LIB_GEN_COMMAND, {
+            fsPath: context.path
+        });
+    }
+    catch (e) {
+        logger_1.default.logger.error((0, i18n_1.t)('error.postLibGenHook', { error: e }));
+    }
+}
+exports.runPostLibGenHook = runPostLibGenHook;
+//# sourceMappingURL=eventHook.js.map

package/generators/utils/i18n.d.ts

@@ -0,0 +1,10 @@
+import type { TOptions } from 'i18next';
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/generators/utils/i18n.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const ui5_lib_generator_i18n_json_1 = __importDefault(require("../translations/ui5-lib-generator.i18n.json"));
+const ui5LibGeneratorNs = 'ui5-lib-generator';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+async function initI18n() {
+    await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', ui5LibGeneratorNs, ui5_lib_generator_i18n_json_1.default));
+}
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    if (!options?.ns) {
+        options = Object.assign(options ?? {}, { ns: ui5LibGeneratorNs });
+    }
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/generators/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './i18n';
+export { prompts, generatorTitle } from './constants';
+export { runPostLibGenHook } from './eventHook';
+//# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.runPostLibGenHook = exports.generatorTitle = exports.prompts = void 0;
+__exportStar(require("./i18n"), exports);
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "prompts", { enumerable: true, get: function () { return constants_1.prompts; } });
+Object.defineProperty(exports, "generatorTitle", { enumerable: true, get: function () { return constants_1.generatorTitle; } });
+var eventHook_1 = require("./eventHook");
+Object.defineProperty(exports, "runPostLibGenHook", { enumerable: true, get: function () { return eventHook_1.runPostLibGenHook; } });
+//# sourceMappingURL=index.js.map

package/generators/utils/logger.d.ts

@@ -0,0 +1,32 @@
+import { type ILogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { Logger } from 'yeoman-environment';
+import type { IVSCodeExtLogger, LogLevel } from '@vscode-logging/logger';
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+export default class ReuseLibGenLogger {
+    private static _logger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger(): ILogWrapper;
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value: ILogWrapper);
+    /**
+     * Configures the vscode logger.
+     *
+     * @param vscLogger - the vscode logger
+     * @param loggerName - the logger name
+     * @param yoLogger - the yeoman logger
+     * @param vscode - the vscode instance
+     * @param logLevel - the log level
+     */
+    static configureLogging(vscLogger: IVSCodeExtLogger, loggerName: string, yoLogger: Logger, vscode?: unknown, logLevel?: LogLevel): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/generators/utils/logger.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+class ReuseLibGenLogger {
+    static _logger = fiori_generator_shared_1.DefaultLogger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger() {
+        return ReuseLibGenLogger._logger;
+    }
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value) {
+        ReuseLibGenLogger._logger = value;
+    }
+    /**
+     * Configures the vscode logger.
+     *
+     * @param vscLogger - the vscode logger
+     * @param loggerName - the logger name
+     * @param yoLogger - the yeoman logger
+     * @param vscode - the vscode instance
+     * @param logLevel - the log level
+     */
+    static configureLogging(vscLogger, loggerName, yoLogger, vscode, logLevel) {
+        const logWrapper = new fiori_generator_shared_1.LogWrapper(loggerName, yoLogger, logLevel, vscLogger, vscode);
+        ReuseLibGenLogger.logger = logWrapper;
+    }
+}
+exports.default = ReuseLibGenLogger;
+//# sourceMappingURL=logger.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/ui5-library-sub-generator",
   "description": "Generator for creating UI5 libraries",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -23,10 +23,10 @@
     "i18next": "23.5.1",
     "yeoman-generator": "5.10.0",
     "@sap-ux/fiori-generator-shared": "0.6.0",
-    "@sap-ux/fiori-tools-settings": "0.1.0",
     "@sap-ux/nodejs-utils": "0.1.0",
-    "@sap-ux/ui5-info": "0.8.1",
+    "@sap-ux/fiori-tools-settings": "0.1.0",
     "@sap-ux/ui5-library-inquirer": "0.3.7",
+    "@sap-ux/ui5-info": "0.8.1",
     "@sap-ux/ui5-library-writer": "0.5.22"
   },
   "devDependencies": {