@sap-ux/fiori-generator-shared 0.0.17 → 0.1.0

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './cap';
+export { generateReadMe } from './read-me';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,5 +14,8 @@ 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 = void 0;
 __exportStar(require("./cap"), exports);
+var read_me_1 = require("./read-me");
+Object.defineProperty(exports, "generateReadMe", { enumerable: true, get: function () { return read_me_1.generateReadMe; } });
 //# sourceMappingURL=index.js.map

package/dist/read-me.d.ts

@@ -0,0 +1,12 @@
+import type { ReadMe } from './types';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Generates a README file at the specified destination path using the provided configuration and file system editor.
+ *
+ * @param {string} destPath - The desitination path where the README file will be created.
+ * @param {ReadMe} readMe - The configuration object containing the details to be included in the README file.
+ * @param {Editor} fs - The file system editor instance used to write the README file.
+ * @returns {Editor} The file system editor instance used to write the README file.
+ */
+export declare function generateReadMe(destPath: string, readMe: ReadMe, fs: Editor): Editor;
+//# sourceMappingURL=read-me.d.ts.map

package/dist/read-me.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateReadMe = void 0;
+const path_1 = require("path");
+/**
+ * Generates a README file at the specified destination path using the provided configuration and file system editor.
+ *
+ * @param {string} destPath - The desitination path where the README file will be created.
+ * @param {ReadMe} readMe - The configuration object containing the details to be included in the README file.
+ * @param {Editor} fs - The file system editor instance used to write the README file.
+ * @returns {Editor} The file system editor instance used to write the README file.
+ */
+function generateReadMe(destPath, readMe, fs) {
+    // Apply the configuration to generate the README file
+    const templateSourcePath = (0, path_1.join)(__dirname, '..', 'templates/README.md');
+    const templateDestPath = `${destPath}/README.md`;
+    // copy template
+    fs.copyTpl(templateSourcePath, templateDestPath, readMe);
+    return fs;
+}
+exports.generateReadMe = generateReadMe;
+//# sourceMappingURL=read-me.js.map

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Interface representing additional entries for the README file.
+ */
+interface AdditionalEntries {
+    /** The label for the additional entry. */
+    label: string;
+    /** The value corresponding to the label of the additional entry. */
+    value: string;
+}
+/**
+ * Interface representing the configuration for generating a README file.
+ * Extends OptionalEntries to include dynamic properties along with the core properties.
+ */
+export interface ReadMe {
+    /** The name of the application. */
+    appName: string;
+    /** The title of the application. */
+    appTitle: string;
+    /** The namespace of the application. */
+    appNamespace: string;
+    /** The description of the application. */
+    appDescription: string;
+    /** The UI5 theme used in the application. */
+    ui5Theme: string;
+    /** The name of generator used. */
+    generatorName: string;
+    /** The version of the generator used. */
+    generatorVersion: string;
+    /** The ui5 version used in the application. */
+    ui5Version: string;
+    /** The floorplan template name used to generate the application. */
+    template: string;
+    /** The date when the generator was run. */
+    generationDate?: string;
+    /** The service URL of the application */
+    serviceUrl?: string;
+    /** The service type for the application. */
+    serviceType?: string;
+    /** The platform on which the generator was run.  */
+    generatorPlatform?: string;
+    /** The filename of the metadata file */
+    metadataFilename?: string;
+    /** Flag indicating whether code assistance is enabled. */
+    enableCodeAssist?: boolean;
+    /** Flag indicating whether TypeScript is enabled. */
+    enableTypeScript?: boolean;
+    /** Flag indicating whether ESLint is enabled. */
+    enableEslint?: boolean;
+    /** Flag indicating whether to show mock data info. */
+    showMockDataInfo?: boolean;
+    /** Text used to launch the application */
+    launchText?: string;
+    /** Additional custom entries for the application. */
+    additionalEntries?: AdditionalEntries[];
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

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

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.0.17",
+  "version": "0.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -16,8 +16,14 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0",
     "@sap-ux/project-access": "1.22.3"
   },
+  "devDependencies": {
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/mem-fs": "1.1.2"
+  },
   "engines": {
     "node": ">=18.x"
   },