Merge branch 'main' into revise-launch-config

packages/fiori-tools-settings/.eslintignore

@@ -0,0 +1,2 @@
+/test/test-output/
+dist

packages/fiori-tools-settings/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    extends: ['../../.eslintrc'],
+    parserOptions: {
+        project: './tsconfig.eslint.json',
+        tsconfigRootDir: __dirname
+    }
+};

packages/fiori-tools-settings/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @sap-ux/fiori-tools-settings
+
+## 0.1.0
+
+### Minor Changes
+
+-   04b3e6c: Added app info file handling logic to .fioritools folder

packages/fiori-tools-settings/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

packages/fiori-tools-settings/README.md

@@ -0,0 +1,10 @@
+# @sap-ux/fiori-tools-settings
+
+Package provides utilities to manage and store configuration data related to Fiori tools projects. It writes essential settings to a hidden .fioritools folder within the project workspace.
+
+## License
+
+Read [License](./LICENSE).
+
+## Keywords
+SAP

packages/fiori-tools-settings/jest.config.js

@@ -0,0 +1,2 @@
+const config = require('../../jest.base');
+module.exports = config;

packages/fiori-tools-settings/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "@sap-ux/fiori-tools-settings",
+    "description": "Utilities for managing and persisting Fiori tools configuration settings in the hidden .fioritools folder.",
+    "version": "0.1.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/SAP/open-ux-tools.git",
+        "directory": "packages/fiori-tools-settings"
+    },
+    "license": "Apache-2.0",
+    "main": "dist/index.js",
+    "scripts": {
+        "build": "tsc --build",
+        "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
+        "watch": "tsc --watch",
+        "lint": "eslint . --ext .ts",
+        "lint:fix": "eslint . --ext .ts --fix",
+        "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests --silent",
+        "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+        "link": "pnpm link --global",
+        "unlink": "pnpm unlink --global"
+    },
+    "files": [
+        "LICENSE",
+        "dist",
+        "templates",
+        "!dist/*.map",
+        "!dist/**/*.map"
+    ],
+    "dependencies": {
+        "mem-fs": "2.1.0",
+        "mem-fs-editor": "9.4.0"
+    },
+    "devDependencies": {
+        "@types/mem-fs-editor": "7.0.1",
+        "@types/mem-fs": "1.1.2"
+    },
+    "engines": {
+        "node": ">=18.x"
+    }
+}

packages/fiori-tools-settings/src/applicationInfoHandler.ts

@@ -0,0 +1,108 @@
+import { homedir } from 'os';
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import type { Editor } from 'mem-fs-editor';
+import { join } from 'path';
+
+export const appInfoFilePath = join(homedir(), '.fioritools', 'appInfo.json');
+export const defaultAppInfoContents = {
+    latestGeneratedFiles: []
+};
+
+interface AppInfoSettings {
+    latestGeneratedFiles: string[];
+}
+
+/**
+ * Returns a mem-fs editor instance. If an instance is not provided, a new one is created.
+ *
+ * @param {Editor} [fs] - An optional mem-fs editor instance.
+ * @returns {Editor} - The mem-fs editor instance.
+ */
+function getFsInstance(fs?: Editor): Editor {
+    return fs ?? create(createStorage());
+}
+
+/**
+ * Reads and parses a JSON file.
+ * If the file exists, this function reads its content, parses the JSON, and returns the resulting object.
+ * If the file does not exist, it returns the default application information settings.
+ *
+ * @param {string} filePath - The path to the JSON file.
+ * @param {Editor} fs - The mem-fs editor instance used for file system operations.
+ * @returns {AppInfoSettings} - The parsed JSON object, or the default settings if the file does not exist.
+ */
+function readJSONFile(filePath: string, fs: Editor): AppInfoSettings {
+    return fs.exists(filePath) ? JSON.parse(fs.read(filePath)) : defaultAppInfoContents;
+}
+
+/**
+ * Adds a new file path to the `latestGeneratedFiles` array in the `appInfo.json` file.
+ * If the file does not exist, it creates it. This function ensures that the provided file path is included
+ * in the list of generated files for future reference.
+ *
+ * @param {string} path - The file path to add to the `latestGeneratedFiles` array.
+ * @param {Editor} [fs] - The optional mem-fs editor instance. If not provided, a new instance is created.
+ */
+export function writeApplicationInfoSettings(path: string, fs?: Editor) {
+    fs = getFsInstance(fs);
+    const appInfoContents: AppInfoSettings = readJSONFile(appInfoFilePath, fs);
+    appInfoContents.latestGeneratedFiles.push(path);
+    fs.write(appInfoFilePath, JSON.stringify(appInfoContents, null, 2));
+    fs.commit((err) => {
+        console.log('Error in writting to AppInfo.json file', err);
+    });
+}
+
+/**
+ * Deletes the `appInfo.json` file if it exists.
+ * This function checks if the file exists and attempts to delete it. If an error occurs during deletion,
+ * it throws a new error with a descriptive message.
+ *
+ * @param {Editor} [fs] - The optional mem-fs editor instance. If not provided, a new instance is created.
+ * @throws {Error} Throws an error if there is a problem deleting the file.
+ */
+export function deleteAppInfoSettings(fs?: Editor) {
+    fs = getFsInstance(fs);
+    if (fs.exists(appInfoFilePath)) {
+        try {
+            fs.delete(appInfoFilePath);
+            fs.commit((err) => {
+                console.log('Failed to commit the deletion of the AppInfo.json file: ', err);
+            });
+        } catch (err) {
+            throw new Error(`Error deleting appInfo.json file: ${err}`);
+        }
+    }
+}
+
+/**
+ * Loads the file path from the `latestGeneratedFiles` array in the `appInfo.json` file,
+ * removes it from the array, updates the file, and executes a VS Code command to load
+ * the application info page for the generated project.
+ *
+ * This function ensures that a VS Code command is executed with the file path of the most recently
+ * generated file. If no file paths are available or if `executeCommand` is not provided, the function
+ * will skip the command execution. After processing, the `appInfo.json` file is deleted.
+ *
+ * @param {Function} [executeCommand] - An optional callback function to execute a VS Code command.
+ * The function will be called with the file path from the `latestGeneratedFiles` array.
+ * If not provided, the command execution step will be skipped.
+ * @param {Editor} [fs] - The optional mem-fs editor instance. If not provided, a new instance is created.
+ * @example
+ * loadApplicationInfoFromSettings(filePath => {
+ *     // Perform VS Code command with the file path
+ *     vscode.commands.executeCommand('fake.extension.loadInfo', filePath);
+ * });
+ */
+export function loadApplicationInfoFromSettings(executeCommand?: (filePath: string) => void, fs?: Editor): void {
+    fs = getFsInstance(fs);
+    const appInfoContents: AppInfoSettings = readJSONFile(appInfoFilePath, fs);
+    if (appInfoContents.latestGeneratedFiles.length > 0) {
+        const filePath = appInfoContents.latestGeneratedFiles.shift();
+        if (executeCommand && filePath) {
+            executeCommand(filePath);
+        }
+        deleteAppInfoSettings(fs);
+    }
+}

packages/fiori-tools-settings/src/index.ts

@@ -0,0 +1 @@
+export * from './applicationInfoHandler';