#refactor Rename helpers dir to utils and outsource UserManualUtil

dangelic · dangelic · commit 8950084eb19d · 2023-09-12T23:39:54.000+02:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -16,7 +16,7 @@ Please provide a reference to the issue or the bug that you filed for the issue
 Check item, if activities have been performed as part of this PR or delete, if not relevant.
 -->
 
-* [ ] Extension was build and testes in the VSCode extension mode
+* [ ] Extension was build and testes in the Visual Studio Code extension mode
 * [ ] Additional packages in package.json are documented and tested
 * [ ] Created/updated tests, if necessary. Code Coverage percentage on new code shall be >= 70%.
 * [ ] Extended the documentation in README.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# How to Contribute to Leda App Deployer (LAD) – an Eclipse Leda Extension for VSCode
+# How to Contribute to Leda App Deployer (LAD) – an Eclipse Leda Extension for Visual Studio Code
 
 First of all, thanks for considering to contribute to Eclipse Velocitas. We really
 appreciate the time and effort you want to spend helping to improve things around here.
@@ -89,12 +89,12 @@ In this project, we have set up pre-commit hooks using Husky to ensure code qual
 
 4. **Jest Tests:** Finally, the Jest tests are executed to validate the functionality of your code. If any tests fail, the commit process will be aborted.
 
-## How to develop this VSCode-Extension
+## How to develop this Extension for Visual Studio Code
 
 0. Clone this repository.
 1. Run ```npm install```.
-2. Run ```npm run watch``` to start Dev-Mode. This opens a separate Window with a VSCode-Environment running the Extension for development.
+2. Run ```npm run watch``` to start Dev-Mode. This opens a separate Window with a Visual Studio Code environment running the Extension for development.
 3. Refer to the User Manual (displayable in the plugin via info-button) or [README](README.md) to add target devices for testing.
 
-*Hint:* Refer to the [official VSCode Plugin Development Documentation](https://code.visualstudio.com/api/get-started/your-first-extension) to get further information on how to develop using the VSCode extension API.
+*Hint:* Refer to the [official Visual Studio Code Plugin Development Documentation](https://code.visualstudio.com/api/get-started/your-first-extension) to get further information on how to develop using the Visual Studio Code Extension API.
 
diff --git a/src/LedaAppDeployer.ts b/src/LedaAppDeployer.ts
@@ -21,7 +21,7 @@ import { StageOne } from './cmd/StageOne';
 import { StageTwo } from './cmd/StageTwo';
 import { StageThree } from './cmd/StageThree';
 import { Credentials } from './svc/Credentials';
-import { openUserManual } from './helpers/helpers';
+import { openUserManual } from './utils/openUserManual';
 
 export default class LedaAppDeployer {
   private context: vscode.ExtensionContext;
diff --git a/src/cmd/DeviceCommands.ts b/src/cmd/DeviceCommands.ts
@@ -16,7 +16,7 @@
 
 import * as vscode from 'vscode';
 import { DeviceDataProvider, LedaDeviceTreeItem } from '../provider/DeviceDataProvider';
-import { saveLedaDevice, removeLedaDevice, loadLedaDevices } from '../helpers/helpers';
+import { saveLedaDevice, removeLedaDevice, loadLedaDevices } from '../utils/helpers';
 import { LedaDevice } from '../interfaces/LedaDevice';
 import { LedaDeviceQuickPickItem } from '../interfaces/QuickPickItem';
 
diff --git a/src/cmd/StageOne.ts b/src/cmd/StageOne.ts
@@ -27,7 +27,7 @@ import { PackageQuickPickItem } from '../interfaces/QuickPickItem';
 
 // Import setup constants from properties file.
 import { CONTAINER_REGISTRY, TMP_KANTO_CONFIG_PATH, KANTO_CONFIG_REMOTE_REG_JSON_PATH, TEMPLATE_FILE_PATH, OUTPUT_FILE_PATH, MANIFEST_DIR, STAGE_ONE_CONSOLE_HEADER } from '../setup/cmdProperties';
-import { getExtensionResourcePath } from '../helpers/helpers';
+import { getExtensionResourcePath } from '../utils/helpers';
 
 /**
  * Implements Deployment Functionality for Stage 1:
diff --git a/src/cmd/StageThree.ts b/src/cmd/StageThree.ts
@@ -24,7 +24,7 @@ import { DockerOperations } from '../svc/DockerOperations';
 
 // Import setup constants from properties file.
 import { CONTAINER_REGISTRY, TMP_KANTO_CONFIG_PATH, KANTO_CONFIG_LOCAL_REG_JSON_PATH, TEMPLATE_FILE_PATH, OUTPUT_FILE_PATH, MANIFEST_DIR, STAGE_THREE_CONSOLE_HEADER } from '../setup/cmdProperties';
-import { getExtensionResourcePath } from '../helpers/helpers';
+import { getExtensionResourcePath } from '../utils/helpers';
 
 /**
  * Implements Deployment Functionality for Stage 3:
diff --git a/src/cmd/StageTwo.ts b/src/cmd/StageTwo.ts
@@ -20,7 +20,7 @@ import { chooseDeviceFromListOrContext } from './DeviceCommands';
 import { ManifestGeneratorJson } from '../svc/ManifestGeneratorJson';
 import { ServiceSsh } from '../svc/ServiceSsh';
 import { TopConfig } from '../provider/TopConfig';
-import { checkAndHandleTarSource, getExtensionResourcePath } from '../helpers/helpers';
+import { checkAndHandleTarSource, getExtensionResourcePath } from '../utils/helpers';
 
 // Import setup constants from properties file.
 import { TMP_KANTO_CONFIG_PATH, KANTO_CONFIG_LOCAL_REG_JSON_PATH, TEMPLATE_FILE_PATH, OUTPUT_FILE_PATH, MANIFEST_DIR, STAGE_TWO_CONSOLE_HEADER } from '../setup/cmdProperties';
diff --git a/src/provider/DeviceDataProvider.ts b/src/provider/DeviceDataProvider.ts
@@ -16,7 +16,7 @@
 
 import * as vscode from 'vscode';
 import { LedaDevice } from '../interfaces/LedaDevice';
-import { loadLedaDevices } from '../helpers/helpers';
+import { loadLedaDevices } from '../utils/helpers';
 
 /**
  * Data provider for the device tree view.
diff --git a/src/svc/DockerOperations.ts b/src/svc/DockerOperations.ts
@@ -18,7 +18,7 @@ import * as vscode from 'vscode';
 import * as fs from 'fs';
 import path from 'path';
 import { TopConfig } from '../provider/TopConfig';
-import { executeShellCmd, getExtensionResourcePath } from '../helpers/helpers';
+import { executeShellCmd, getExtensionResourcePath } from '../utils/helpers';
 import { CONTAINER_REGISTRY, TARBALL_OUTPUT_PATH, TARGET_CONTAINER_PLATFORM } from '../setup/cmdProperties';
 import { DockerBuildFailedError, DockerExportImageError, DockerfileNotFoundError, GenericInternalError, logToChannelAndErrorConsole } from '../error/customErrors';
 
diff --git a/src/svc/GitHubOperations/ConfigStringExtractor.ts b/src/svc/GitHubOperations/ConfigStringExtractor.ts
@@ -16,7 +16,7 @@
 
 import * as fs from 'fs';
 import { RemoteOriginNotFoundError, InvalidRemoteOriginError, GenericInternalError } from '../../error/customErrors';
-import { getExtensionResourcePath } from '../../helpers/helpers';
+import { getExtensionResourcePath } from '../../utils/helpers';
 
 /**
  * Helper to get the organization and repository name out of the current Git working context.
diff --git a/src/svc/ManifestGeneratorJson.ts b/src/svc/ManifestGeneratorJson.ts
@@ -16,7 +16,7 @@
 
 import * as fs from 'fs';
 import * as path from 'path';
-import { getExtensionResourcePath, readFileAsync } from '../helpers/helpers';
+import { getExtensionResourcePath, readFileAsync } from '../utils/helpers';
 import * as vscode from 'vscode';
 import { LADAlterJSONError, LADLoadTemplateJSONError, LADSaveModifiedJSONError, logToChannelAndErrorConsole } from '../error/customErrors';
 
diff --git a/src/svc/ServiceSsh.ts b/src/svc/ServiceSsh.ts
@@ -16,7 +16,7 @@
 
 import { NodeSSH } from 'node-ssh';
 import { JSONPath } from 'jsonpath-plus';
-import { readFileAsync, deleteTmpFile, getExtensionResourcePath } from '../helpers/helpers';
+import { readFileAsync, deleteTmpFile, getExtensionResourcePath } from '../utils/helpers';
 import * as vscode from 'vscode';
 import { TopConfig } from '../provider/TopConfig';
 import { KANTO_CONFIG_FILE, CONTAINER_REGISTRY, LOCAL_KANTO_REGISTRY, TARBALL_OUTPUT_PATH, NECESSARY_DEVICE_CLI_TOOLINGS } from '../setup/cmdProperties';
diff --git a/src/test/jest/helper.executeShellCommand.test.js b/src/test/jest/helper.executeShellCommand.test.js
@@ -16,7 +16,7 @@
 
 const {
   executeShellCmd,
-} = require('../../helpers/helpers'); // Passe den Importpfad an
+} = require('../../utils/helpers'); // Passe den Importpfad an
 
 describe('Shell Command Execution', () => {
   it('executeShellCmd should execute shell command', async () => {
diff --git a/src/test/jest/helper.tarHandling.test.js b/src/test/jest/helper.tarHandling.test.js
@@ -18,7 +18,7 @@ const { vscode } = require('vscode'); // Import the mocked vscode module
 const {
   checkAndHandleTarSource,
   downloadTarFileFromWeb,
-} = require('../../helpers/helpers');
+} = require('../../utils/helpers');
 
 describe('Tar Source Handling', () => {
   it('checkAndHandleTarSource should handle local TAR file', async () => {
diff --git a/src/utils/helpers.ts b/src/utils/helpers.ts
@@ -43,38 +43,6 @@ export function getExtensionResourcePath(resourceUri: string): string {
   return vscode.Uri.joinPath(WORKSPACE_DIR, resourceUri).fsPath;
 }
 
-/**
- * Open a new WebView after the Extesion is installed or updated.
- * @param context Give the Extesion Context to look for the global State
- * @param disableFirstTimeCheck Disables the check if opens the first time, to open it via command
- */
-export function openUserManual(context: vscode.ExtensionContext, disableFirstTimeCheck = false): void {
-  const version = context.extension.packageJSON.version ?? '1.0.0';
-  const previousVersion = context.globalState.get(context.extension.id);
-  // Check if a new version is installed
-  if (previousVersion === version && disableFirstTimeCheck === false) {
-    return;
-  }
-
-  //Create a new WebView instance
-  const panel = vscode.window.createWebviewPanel('userManual', 'Introduction to Leda App Deployer', vscode.ViewColumn.One, {});
-
-  //Load the WebView Content from HTML file
-  const filePath = vscode.Uri.joinPath(context.extensionUri, 'resources', 'userManual.html');
-  let webViewContent = fs.readFileSync(filePath.fsPath, 'utf8');
-
-  //Replace the image placeholder with local URL's to the images. (Its not possile to display images directly via directory path)
-  webViewContent = webViewContent.replace('${stage_1}', panel.webview.asWebviewUri(vscode.Uri.joinPath(context.extensionUri, 'resources', 'stage_1.png')).toString());
-  webViewContent = webViewContent.replace('${stage_2}', panel.webview.asWebviewUri(vscode.Uri.joinPath(context.extensionUri, 'resources', 'stage_2.png')).toString());
-  webViewContent = webViewContent.replace('${stage_3}', panel.webview.asWebviewUri(vscode.Uri.joinPath(context.extensionUri, 'resources', 'stage_3.png')).toString());
-
-  //Set the content to the WebView
-  panel.webview.html = webViewContent;
-
-  //Update the extension versin in the global state, to avoid a reopening of User Manual erverytime
-  context.globalState.update(context.extension.id, version);
-}
-
 /**
  * Save a new Leda device to the configuration.
  * @param newDevice The LedaDevice object to be saved.
diff --git a/src/utils/openUserManual.ts b/src/utils/openUserManual.ts
@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as vscode from 'vscode';
+import * as fs from 'fs';
+
+/**
+ * Open a new WebView after the Extesion is installed or updated.
+ * @param context Give the Extesion Context to look for the global State
+ * @param disableFirstTimeCheck Disables the check if opens the first time, to open it via command
+ */
+export function openUserManual(context: vscode.ExtensionContext, disableFirstTimeCheck = false): void {
+  const version = context.extension.packageJSON.version ?? '1.0.0';
+  const previousVersion = context.globalState.get(context.extension.id);
+  // Check if a new version is installed
+  if (previousVersion === version && disableFirstTimeCheck === false) {
+    return;
+  }
+
+  //Create a new WebView instance
+  const panel = vscode.window.createWebviewPanel('userManual', 'Introduction to Leda App Deployer', vscode.ViewColumn.One, {});
+
+  //Load the WebView Content from HTML file
+  const filePath = vscode.Uri.joinPath(context.extensionUri, 'resources', 'userManual.html');
+  let webViewContent = fs.readFileSync(filePath.fsPath, 'utf8');
+
+  //Replace the image placeholder with local URL's to the images. (Its not possile to display images directly via directory path)
+  webViewContent = webViewContent.replace('${stage_1}', panel.webview.asWebviewUri(vscode.Uri.joinPath(context.extensionUri, 'resources', 'stage_1.png')).toString());
+  webViewContent = webViewContent.replace('${stage_2}', panel.webview.asWebviewUri(vscode.Uri.joinPath(context.extensionUri, 'resources', 'stage_2.png')).toString());
+  webViewContent = webViewContent.replace('${stage_3}', panel.webview.asWebviewUri(vscode.Uri.joinPath(context.extensionUri, 'resources', 'stage_3.png')).toString());
+
+  //Set the content to the WebView
+  panel.webview.html = webViewContent;
+
+  //Update the extension versin in the global state, to avoid a reopening of User Manual erverytime
+  context.globalState.update(context.extension.id, version);
+}
