@sap-ux/fe-fpm-writer 0.18.3 → 0.18.4

package/dist/action/index.js

@@ -10,6 +10,7 @@ const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
 const templates_1 = require("../templates");
+const file_1 = require("../common/file");
 /**
  * Enhances the provided custom action configuration with default data.
  *
@@ -82,7 +83,7 @@ function generateCustomAction(basePath, actionConfig, fs) {
     // enhance manifest with action definition and controller reference
     const actions = enhanceManifestAndGetActionsElementReference(manifest, config.target);
     Object.assign(actions, JSON.parse(ejs_1.render(fs.read(templates_1.getTemplatePath(`action/manifest.action.json`)), config, {})));
-    fs.writeJSON(manifestPath, manifest);
+    fs.writeJSON(manifestPath, manifest, undefined, file_1.getJsonSpace(fs, manifestPath, actionConfig.tabInfo));
     return fs;
 }
 exports.generateCustomAction = generateCustomAction;

package/dist/column/index.js

@@ -8,6 +8,7 @@ const path_1 = require("path");
 const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
 const event_handler_1 = require("../common/event-handler");
+const file_1 = require("../common/file");
 const templates_1 = require("../templates");
 const semver_1 = require("semver");
 /**
@@ -74,7 +75,11 @@ function generateCustomColumn(basePath, customColumn, fs) {
     // enhance manifest with column definition
     const manifestRoot = getManifestRoot(customColumn.minUI5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeColumn, {});
-    fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
+    file_1.extendJSON(fs, {
+        filepath: manifestPath,
+        content: filledTemplate,
+        tabInfo: customColumn.tabInfo
+    });
     // add fragment
     const viewPath = path_1.join(completeColumn.path, `${completeColumn.name}.fragment.xml`);
     if (completeColumn.control || !fs.exists(viewPath)) {

package/dist/common/file.d.ts

@@ -0,0 +1,36 @@
+import type { Editor } from 'mem-fs-editor';
+import type { TabInfo } from '../common/types';
+declare type WriteJsonReplacer = ((key: string, value: any) => any) | Array<string | number>;
+declare type WriteJsonSpace = number | string;
+interface ExtendJsonParams {
+    filepath: string;
+    content: string;
+    replacer?: WriteJsonReplacer;
+    tabInfo?: TabInfo;
+}
+/**
+ * Method calculates tab space info for passed file content.
+ *
+ * @param content - file content.
+ * @returns tab size information.
+ */
+export declare function detectTabSpacing(content: string): TabInfo | undefined;
+/**
+ * Method calculates tab spacing parameter for 'JSON.stringify' method.
+ *
+ * @param fs - the mem-fs editor instance.
+ * @param filePath - path to file to read.
+ * @param tabInfo - External tab configuration.
+ * @returns tab size information.
+ */
+export declare function getJsonSpace(fs: Editor, filePath: string, tabInfo?: TabInfo | undefined): WriteJsonSpace | undefined;
+/**
+ * Method extends target JSON file with passed JSOn content.
+ * Method uses 'fs.extendJSON', but applies additional calculation to reuse existing content tab sizing information.
+ *
+ * @param fs - the mem-fs editor instance.
+ * @param params - options for JSON extend.
+ */
+export declare function extendJSON(fs: Editor, params: ExtendJsonParams): void;
+export {};
+//# sourceMappingURL=file.d.ts.map

package/dist/common/file.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extendJSON = exports.getJsonSpace = exports.detectTabSpacing = void 0;
+const CHAR_SPACE = ' ';
+const CHAR_TAB = '\t';
+/**
+ * Method returns tab info for passed line.
+ *
+ * @param line - line with tab spacing
+ * @returns tab size information
+ */
+function getLineTabInfo(line) {
+    let tabSize;
+    const symbol = line[0] === CHAR_TAB ? CHAR_TAB : CHAR_SPACE;
+    // get count of tabs
+    for (let i = 0; i < line.length; i++) {
+        const char = line[i];
+        if (char !== symbol) {
+            tabSize = {
+                size: i,
+                useTabSymbol: symbol === CHAR_TAB
+            };
+            break;
+        }
+    }
+    return tabSize;
+}
+/**
+ * Method calculates tab space info for passed file content.
+ *
+ * @param content - file content.
+ * @returns tab size information.
+ */
+function detectTabSpacing(content) {
+    let tabSize;
+    const tabSymbols = [CHAR_SPACE, CHAR_TAB];
+    const lines = content.split(/\r\n|\n/);
+    const lineWithSpacing = lines.find((line) => {
+        return tabSymbols.includes(line[0]);
+    });
+    if (lineWithSpacing) {
+        tabSize = getLineTabInfo(lineWithSpacing);
+    }
+    return tabSize;
+}
+exports.detectTabSpacing = detectTabSpacing;
+/**
+ * Method calculates tab spacing parameter for 'JSON.stringify' method.
+ *
+ * @param fs - the mem-fs editor instance.
+ * @param filePath - path to file to read.
+ * @param tabInfo - External tab configuration.
+ * @returns tab size information.
+ */
+function getJsonSpace(fs, filePath, tabInfo) {
+    if (!tabInfo) {
+        // 'tabInfo'  was not passed - calculate 'tabInfo' by checking existing content of target file
+        const content = fs.read(filePath);
+        tabInfo = detectTabSpacing(content);
+    }
+    let space;
+    if (tabInfo) {
+        // 'tabInfo' exists - it was passed as custom configuration or calculated from target file
+        if (tabInfo.useTabSymbol) {
+            // Tab symbol should be used as tab
+            space = CHAR_TAB.repeat(tabInfo.size || 1);
+        }
+        else {
+            // Spaces should be used as tab
+            space = tabInfo.size;
+        }
+    }
+    return space;
+}
+exports.getJsonSpace = getJsonSpace;
+/**
+ * Method extends target JSON file with passed JSOn content.
+ * Method uses 'fs.extendJSON', but applies additional calculation to reuse existing content tab sizing information.
+ *
+ * @param fs - the mem-fs editor instance.
+ * @param params - options for JSON extend.
+ */
+function extendJSON(fs, params) {
+    const { filepath, content, replacer } = params;
+    const space = getJsonSpace(fs, filepath, params.tabInfo);
+    // Write json
+    fs.extendJSON(filepath, JSON.parse(content), replacer, space);
+}
+exports.extendJSON = extendJSON;
+//# sourceMappingURL=file.js.map

package/dist/common/types.d.ts

@@ -2,10 +2,14 @@ import type { ManifestNamespace } from '@sap-ux/project-access';
 export declare type Manifest = ManifestNamespace.SAPJSONSchemaForWebApplicationManifestFile & {
     [key: string]: unknown;
 };
+export interface TabInfo {
+    size?: number;
+    useTabSymbol?: boolean;
+}
 /**
  * Common properties for any custom element of the flexible programming model.
  */
-export interface CustomElement {
+export interface CustomElement extends WriterConfig {
     /**
      * Name of the custom element that is to be added to the application.
      */
@@ -149,4 +153,11 @@ export interface EventHandler {
      */
     eventHandler?: true | string | EventHandlerConfiguration;
 }
+export interface WriterConfig {
+    /**
+     * Tab size info.
+     * Currently is used only for 'manifest.json' update.
+     */
+    tabInfo?: TabInfo;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/controller-extension/index.js

@@ -10,6 +10,7 @@ const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const templates_1 = require("../templates");
 const utils_1 = require("../common/utils");
+const file_1 = require("../common/file");
 exports.UI5_CONTROLLER_EXTENSION_LIST_REPORT = 'sap.fe.templates.ListReport.ListReportController';
 exports.UI5_CONTROLLER_EXTENSION_OBJECT_PAGE = 'sap.fe.templates.ObjectPage.ObjectPageController';
 const UI5_CONTROLLER_EXTENSIONS = 'sap.ui.controllerExtensions';
@@ -183,7 +184,12 @@ function generateControllerExtension(basePath, controllerConfig, fs) {
     const internalConfig = enhanceConfig(controllerConfig, manifestPath, manifest);
     // enhance manifest with view definition
     const filledTemplate = ejs_1.render(fs.read(templates_1.getTemplatePath('controller-extension/manifest.json')), internalConfig, {});
-    fs.extendJSON(manifestPath, JSON.parse(filledTemplate), getManifestReplacer(internalConfig));
+    file_1.extendJSON(fs, {
+        filepath: manifestPath,
+        content: filledTemplate,
+        replacer: getManifestReplacer(internalConfig),
+        tabInfo: controllerConfig.tabInfo
+    });
     // add controller js file
     const ext = controllerConfig.typescript ? 'ts' : 'js';
     const viewPath = path_1.join(internalConfig.path, `${internalConfig.name}.controller.${ext}`);

package/dist/page/common.d.ts

@@ -1,7 +1,8 @@
 import type { Editor } from 'mem-fs-editor';
 import type { ManifestNamespace } from '@sap-ux/project-access';
-import type { CustomPage, FCL, InternalCustomPage, InternalObjectPage, ObjectPage, Navigation, InternalListReport } from './types';
+import type { CustomPage, FCL, InternalCustomPage, InternalObjectPage, ObjectPage, ListReport, Navigation, InternalListReport } from './types';
 import type { Manifest } from '../common/types';
+declare type EnhancePageConfigFunction = (data: ObjectPage | ListReport, manifest: Manifest) => InternalObjectPage | InternalListReport;
 /**
  * Suffix for patterns to support arbitrary paramters
  */
@@ -49,4 +50,17 @@ export declare function getFclConfig(manifest: Manifest, navigation?: Navigation
  * @returns the updated memfs editor instance
  */
 export declare function validatePageConfig(basePath: string, config: CustomPage | ObjectPage, fs: Editor): Editor;
+/**
+ * Add an generic page to an existing UI5 application.
+ * Supported pages - ListReport or ObjectPage.
+ *
+ * @param basePath - the base path
+ * @param data - the page configuration
+ * @param enhanceDataFn - Callback function for data enhancement
+ * @param templatePath - path to 'manifest.json' template
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+export declare function extendPageJSON(basePath: string, data: ObjectPage, enhanceDataFn: EnhancePageConfigFunction, templatePath: string, fs?: Editor): Editor;
+export {};
 //# sourceMappingURL=common.d.ts.map

package/dist/page/common.js

@@ -1,9 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePageConfig = exports.getFclConfig = exports.getManifestJsonExtensionHelper = exports.generateRouteTarget = exports.generateRoutePattern = exports.PATTERN_SUFFIX = void 0;
+exports.extendPageJSON = exports.validatePageConfig = exports.getFclConfig = exports.getManifestJsonExtensionHelper = exports.generateRouteTarget = exports.generateRoutePattern = exports.PATTERN_SUFFIX = void 0;
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
 const path_1 = require("path");
+const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
+const file_1 = require("../common/file");
+const templates_1 = require("../templates");
 /**
  * Suffix for patterns to support arbitrary paramters
  */
@@ -154,4 +159,33 @@ function validatePageConfig(basePath, config, fs) {
     return fs;
 }
 exports.validatePageConfig = validatePageConfig;
+/**
+ * Add an generic page to an existing UI5 application.
+ * Supported pages - ListReport or ObjectPage.
+ *
+ * @param basePath - the base path
+ * @param data - the page configuration
+ * @param enhanceDataFn - Callback function for data enhancement
+ * @param templatePath - path to 'manifest.json' template
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+function extendPageJSON(basePath, data, enhanceDataFn, templatePath, fs) {
+    if (!fs) {
+        fs = mem_fs_editor_1.create(mem_fs_1.create());
+    }
+    validatePageConfig(basePath, data, fs);
+    const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
+    const manifest = fs.readJSON(manifestPath);
+    const config = enhanceDataFn(data, manifest);
+    // enhance manifest.json
+    file_1.extendJSON(fs, {
+        filepath: manifestPath,
+        content: ejs_1.render(fs.read(templates_1.getTemplatePath(templatePath)), config, {}),
+        replacer: getManifestJsonExtensionHelper(config),
+        tabInfo: data.tabInfo
+    });
+    return fs;
+}
+exports.extendPageJSON = extendPageJSON;
 //# sourceMappingURL=common.js.map

package/dist/page/custom.js

@@ -11,6 +11,7 @@ const validate_1 = require("../common/validate");
 const templates_1 = require("../templates");
 const semver_1 = require("semver");
 const utils_1 = require("../common/utils");
+const file_1 = require("../common/file");
 /**
  * Enhances the provided custom page configuration with default data.
  *
@@ -70,7 +71,12 @@ function generate(basePath, data, fs) {
     // merge content into existing files
     const root = getTemplateRoot(data.minUI5Version);
     // enhance manifest.json
-    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(path_1.join(root, `manifest.json`)), config, {})), common_1.getManifestJsonExtensionHelper(config));
+    file_1.extendJSON(fs, {
+        filepath: manifestPath,
+        content: ejs_1.render(fs.read(path_1.join(root, `manifest.json`)), config, {}),
+        replacer: common_1.getManifestJsonExtensionHelper(config),
+        tabInfo: data.tabInfo
+    });
     // add extension content
     const viewPath = path_1.join(config.path, `${config.name}.view.xml`);
     if (!fs.exists(viewPath)) {

package/dist/page/list.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
-const path_1 = require("path");
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const ejs_1 = require("ejs");
 const common_1 = require("./common");
-const templates_1 = require("../templates");
 /**
  * Enhances the provided list report configuration with default data.
  *
@@ -44,16 +39,7 @@ function enhanceData(data, manifest) {
  * @returns the updated memfs editor instance
  */
 function generate(basePath, data, fs) {
-    if (!fs) {
-        fs = mem_fs_editor_1.create(mem_fs_1.create());
-    }
-    common_1.validatePageConfig(basePath, data, fs);
-    const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
-    const manifest = fs.readJSON(manifestPath);
-    const config = enhanceData(data, manifest);
-    // enhance manifest.json
-    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(templates_1.getTemplatePath('page/list/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
-    return fs;
+    return common_1.extendPageJSON(basePath, data, enhanceData, 'page/list/manifest.json', fs);
 }
 exports.generate = generate;
 //# sourceMappingURL=list.js.map

package/dist/page/object.js

@@ -1,12 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
-const path_1 = require("path");
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const ejs_1 = require("ejs");
 const common_1 = require("./common");
-const templates_1 = require("../templates");
 /**
  * Enhances the provided list report configuration with default data.
  *
@@ -34,16 +29,7 @@ function enhanceData(data, manifest) {
  * @returns the updated memfs editor instance
  */
 function generate(basePath, data, fs) {
-    if (!fs) {
-        fs = mem_fs_editor_1.create(mem_fs_1.create());
-    }
-    common_1.validatePageConfig(basePath, data, fs);
-    const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
-    const manifest = fs.readJSON(manifestPath);
-    const config = enhanceData(data, manifest);
-    // enhance manifest.json
-    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(templates_1.getTemplatePath('/page/object/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
-    return fs;
+    return common_1.extendPageJSON(basePath, data, enhanceData, '/page/object/manifest.json', fs);
 }
 exports.generate = generate;
 //# sourceMappingURL=object.js.map

package/dist/page/types.d.ts

@@ -1,4 +1,4 @@
-import type { CustomElement, InternalCustomElement } from '../common/types';
+import type { CustomElement, InternalCustomElement, WriterConfig } from '../common/types';
 /**
  * Incoming navigation configuration.
  */
@@ -33,7 +33,7 @@ export interface ListReportSettings extends StandardPageSettings {
 /**
  * Configuration options for adding a list report page.
  */
-export interface ListReport {
+export interface ListReport extends WriterConfig {
     /**
      * Name of the entity used for the custom page.
      */
@@ -46,7 +46,7 @@ export interface ListReport {
 /**
  * Configuration options for adding an object page.
  */
-export interface ObjectPage {
+export interface ObjectPage extends WriterConfig {
     /**
      * Name of the entity used for the custom page.
      */

package/dist/section/index.js

@@ -8,6 +8,7 @@ const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
+const file_1 = require("../common/file");
 const templates_1 = require("../templates");
 const semver_1 = require("semver");
 /**
@@ -79,7 +80,11 @@ function generateCustomSection(basePath, customSection, fs) {
     // enhance manifest with section definition
     const manifestRoot = getManifestRoot(customSection.minUI5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeSection, {});
-    fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
+    file_1.extendJSON(fs, {
+        filepath: manifestPath,
+        content: filledTemplate,
+        tabInfo: customSection.tabInfo
+    });
     // add fragment
     const viewPath = path_1.join(completeSection.path, `${completeSection.name}.fragment.xml`);
     if (!fs.exists(viewPath)) {

package/dist/view/index.js

@@ -8,6 +8,7 @@ const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
+const file_1 = require("../common/file");
 const templates_1 = require("../templates");
 /**
  * Merge the new view into the list of existing views (if any).
@@ -88,7 +89,11 @@ function generateCustomView(basePath, customView, fs) {
     const completeView = enhanceConfig(fs, customView, manifestPath, manifest);
     // enhance manifest with view definition
     const filledTemplate = ejs_1.render(fs.read(templates_1.getTemplatePath('view/manifest.json')), completeView, {});
-    fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
+    file_1.extendJSON(fs, {
+        filepath: manifestPath,
+        content: filledTemplate,
+        tabInfo: customView.tabInfo
+    });
     // add fragment
     if (customView.viewUpdate !== false) {
         const viewPath = path_1.join(completeView.path, `${completeView.name}.fragment.xml`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",