Open user guide from Keil Studio pack extension folder or redirect to online version (#40)

JonatanAntoni · web-flow · commit 3873534a3d12 · 2026-03-13T10:03:34.000+01:00
* Open user guide from Keil Studio pack extension folder or redirect to online version

* Fixup: Download tools script

* Fixup: Unit tests

* Fixup: Open README.md in preview mode

* Fixup: Joining help path and unit test for Windows

* Fixup: Copilot review feedback

* Fixup: Unit tests
diff --git a/.github/workflows/download-tools.sh b/.github/workflows/download-tools.sh
@@ -13,7 +13,6 @@ function usage() {
 
 function download_tools() {
     npm run download:uv2csolution -- --target "$1"
-    npm run download:guide
     npm run download:toolbox -- --target "$1"
     npm run download:debug-adapters
     npm run download:node-pty -- --target "$1"
diff --git a/package.json b/package.json
@@ -41,7 +41,7 @@
   },
   "scripts": {
     "preprepare": "npm run download:rpc-interface",
-    "prepare": "concurrently npm:download:uv2csolution npm:download:guide npm:download:debug-adapters npm:download:toolbox",
+    "prepare": "concurrently npm:download:uv2csolution npm:download:debug-adapters npm:download:toolbox",
     "clean": "git clean -f -x ./dist ./out ./tools",
     "prebuild": "npm run font",
     "build": "webpack --mode production",
@@ -57,7 +57,6 @@
     "compile": "tsc -p .",
     "compile:watch": "tsc -p . -w",
     "download:uv2csolution": "tsx scripts/download-tools.ts uv2csolution",
-    "download:guide": "tsx scripts/download-tools.ts guide",
     "download:debug-adapters": "tsx scripts/download-tools.ts debug-adapters",
     "download:toolbox": "tsx scripts/download-tools.ts toolbox",
     "download:rpc-interface": "tsx scripts/download-tools.ts rpc-interface",
diff --git a/scripts/download-tools.ts b/scripts/download-tools.ts
@@ -60,13 +60,6 @@ const uv2csolution : Downloadable = new Downloadable(
     },
 );
 
-const guide : Downloadable = new Downloadable(
-    'User Guide', ['..', 'guide'],
-    async () => {
-        return new GitHubRepoAsset('MDK-Packs', 'vscode-cmsis-solution-docs', { ref: 'heads/main', path: 'site', token: ghToken });
-    },
-);
-
 const debugAdapterRegistry = new Downloadable(
     'Debug Adapter Registry', ['..', 'templates', 'debug'],
     async () => {
@@ -153,7 +146,6 @@ const nodePty: Downloadable = new Downloadable(
 
 const downloader = new Downloader({
     'uv2csolution': uv2csolution,
-    'guide': guide,
     'debug-adapters': debugAdapterRegistry,
     'toolbox': toolbox,
     'rpc-interface': rpcInterface,
diff --git a/src/desktop/extension.ts b/src/desktop/extension.ts
@@ -198,7 +198,6 @@ export const activate = async (context: ExtensionContext): Promise<CsolutionExte
         commandsProvider,
         workspaceFoldersProvider,
         dataManager,
-        externalFileOpener
     );
     const manageLayers = new ManageLayersWebviewMain(
         context,
@@ -223,7 +222,6 @@ export const activate = async (context: ExtensionContext): Promise<CsolutionExte
         context,
         solutionManager,
         commandsProvider,
-        externalFileOpener,
         configurationProvider,
         csolutionService,
     );
diff --git a/src/manifest.ts b/src/manifest.ts
@@ -55,6 +55,7 @@ export const CMSIS_SOLUTION_OUTPUT_CHANNEL = 'CMSIS Solution';
 export const TEMPLATES_FOLDER = path.join(__dirname, '..', 'templates');
 export const DEBUG_TEMPLATES_FOLDER = path.join(TEMPLATES_FOLDER, 'debug');
 export const UV2CSOLUTION_FOLDER = path.join(__dirname, '..', 'tools', 'uv2csolution');
-export const GUIDE_FOLDER = path.join(__dirname, '..', 'guide');
 export const DEBUG_ADAPTERS_YAML_FILE_PATH = path.resolve(DEBUG_TEMPLATES_FOLDER, 'debug-adapters.yml');
 export const CMSIS_TOOLBOX_FOLDER = path.join(__dirname, '..', 'tools', 'cmsis-toolbox');
+
+export const README_FILE_PATH = path.join(__dirname, '..', 'README.md');
diff --git a/src/open-file-external.ts b/src/open-file-external.ts
@@ -22,23 +22,22 @@ import { tmpNameSync } from 'tmp';
 
 import { backToForwardSlashes } from './utils/path-utils';
 
-export const CMSIS_VSCODE_REDIRECTION_FILE_HTML = 'cmsis_vscode_redirectionFile.html';
-
 /**
  *  Class to call node_modules/open
  */
 export class OpenFileExternal implements IOpenFileExternal {
+
     public openFile(filePath: string) {
         const adjustedFilePath = this.adjustFilePath(filePath);
-        const child = this.doOpenFile(this.getCommand(adjustedFilePath));
+        this.doOpenFile(this.getCommand(adjustedFilePath));
         if (adjustedFilePath !== filePath) {
-            child.on('exit', () => {
+            setTimeout(() => {
                 try {
                     fs.unlinkSync(adjustedFilePath);
                 } catch (error) {
                     console.error(`Error deleting redirection file ${adjustedFilePath}:`, error);
                 }
-            });
+            }, 10000);
         }
         return adjustedFilePath;
     }
diff --git a/src/solutions/solution-manager.factories.ts b/src/solutions/solution-manager.factories.ts
@@ -26,13 +26,15 @@ export type MockSolutionManager = jest.Mocked<StubEvents<SolutionManager>> & { f
 
 export const idleSolutionLoadStateFactory = makeFactory<SolutionLoadState>({
     solutionPath: () => undefined,
+    activated: () => false,
     loaded: () => undefined,
     converted: () => undefined,
     activated: () => undefined,
 });
 
 export const activeSolutionLoadStateFactory = makeFactory<SolutionLoadState>({
     solutionPath: () => path.join(faker.system.filePath(), `${faker.word.noun()}.csolution.yml`),
+    activated: () => true,
     loaded: () => undefined,
     converted: () => undefined,
     activated: () => true,
diff --git a/src/views/create-solutions/create-solution-webview-main.test.ts b/src/views/create-solutions/create-solution-webview-main.test.ts
@@ -43,7 +43,6 @@ import { PROJECT_SUFFIX } from '../../solutions/constants';
 import { dataManagerFactory, MockDataManager } from '../../data-manager/data-manager.factories';
 import { CreateSolutionFromDataManager } from '../../solutions/create-solution-from-data-manager';
 import { pathsEqual } from '../../utils/path-utils';
-import { MockOpenFileExternal } from '../../open-file-external.factories';
 
 jest.mock('fs', () => ({
     existsSync: jest.fn(),
@@ -97,7 +96,6 @@ describe('CreateSolutionWebviewMain', () => {
     let commandsProvider: MockCommandsProvider;
     let mockReconcileSolutionFiles: jest.Mock;
     let mockSolutionInitialiser: MockSolutionInitialiser;
-    let mockExternalFileOpener: MockOpenFileExternal;
     let mockCreateSolutionFromDataManager: jest.MockedFunction<CreateSolutionFromDataManager>;
     let mockOpenDialog: jest.Mock;
     let mockSolutionCreator: SolutionCreator;
@@ -123,12 +121,11 @@ describe('CreateSolutionWebviewMain', () => {
         mockReconcileSolutionFiles = jest.fn();
         mockCreateSolutionFromDataManager = jest.fn();
         mockSolutionInitialiser = SolutionInitialiserFactory();
-        mockExternalFileOpener = new MockOpenFileExternal();
         mockOpenDialog = vscode.window.showOpenDialog as jest.Mock;
 
         mockSolutionCreator = new SolutionCreatorImp(mockCreateSolutionFromDataManager, mockSolutionInitialiser, workspaceFsProvider, mockReconcileSolutionFiles);
 
-        webviewMain = new CreateSolutionWebviewMain(mockSolutionCreator, { extensionUri: EXTENSION_URI } as unknown as ExtensionContext, messageProvider, commandsProvider, workspaceFoldersProvider, dataManager, mockExternalFileOpener, webviewManager as unknown as WebviewManager<Messages.IncomingMessage, Messages.OutgoingMessage>);
+        webviewMain = new CreateSolutionWebviewMain(mockSolutionCreator, { extensionUri: EXTENSION_URI } as unknown as ExtensionContext, messageProvider, commandsProvider, workspaceFoldersProvider, dataManager, webviewManager as unknown as WebviewManager<Messages.IncomingMessage, Messages.OutgoingMessage>);
 
         await webviewMain.activate({ subscriptions: [] } as unknown as ExtensionContext);
 
diff --git a/src/views/create-solutions/create-solution-webview-main.ts b/src/views/create-solutions/create-solution-webview-main.ts
@@ -29,7 +29,7 @@ import { WebviewManager, WebviewManagerOptions } from '../webview-manager';
 import { CreateSolutionData } from './create-solution-data';
 import * as Messages from './messages';
 import { NewSolutionMessage } from './messages';
-import { IOpenFileExternal } from '../../open-file-external-if';
+import { OpenCommand } from '../solution-outline/commands/open-command';
 
 export const CREATE_SOLUTION_WEBVIEW_OPTIONS: Readonly<WebviewManagerOptions> =
   {
@@ -44,28 +44,23 @@ export const CREATE_SOLUTION_WEBVIEW_OPTIONS: Readonly<WebviewManagerOptions> =
   };
 
 export class CreateSolutionWebviewMain {
-    public static readonly HELP_URL = path.join(
-        manifest.GUIDE_FOLDER,
-        'create_app.html',
-    );
     private readonly webviewManager: WebviewManager<
     Messages.IncomingMessage,
     Messages.OutgoingMessage
   >;
     private readonly dataModel: CreateSolutionData;
 
     constructor(
-    private readonly solutionCreator: SolutionCreator,
-    private readonly context: vscode.ExtensionContext,
-    private readonly messageProvider: MessageProvider,
-    private readonly commandsProvider: CommandsProvider,
-    private readonly workspaceFoldersProvider: WorkspaceFoldersProvider,
-    private readonly dataManager: DataManager,
-    private readonly openFileExternal: IOpenFileExternal,
-    webviewManager?: WebviewManager<
-      Messages.IncomingMessage,
-      Messages.OutgoingMessage
-    >,
+        private readonly solutionCreator: SolutionCreator,
+        private readonly context: vscode.ExtensionContext,
+        private readonly messageProvider: MessageProvider,
+        private readonly commandsProvider: CommandsProvider,
+        private readonly workspaceFoldersProvider: WorkspaceFoldersProvider,
+        private readonly dataManager: DataManager,
+        webviewManager?: WebviewManager<
+            Messages.IncomingMessage,
+            Messages.OutgoingMessage
+        >,
     ) {
         this.webviewManager =
       webviewManager ||
@@ -90,17 +85,6 @@ export class CreateSolutionWebviewMain {
         this.webviewManager.onDidDispose(this.dataModel.reset.bind(this.dataModel));
     }
 
-    private openFile(path: string, openExternal?: boolean): void {
-        if (openExternal) {
-            this.openFileExternal.openFile(path);
-        } else {
-            this.commandsProvider.executeCommand(
-                'vscode.open',
-                vscode.Uri.file(path),
-            );
-        }
-    }
-
     private async handleMessage(
         message: Messages.OutgoingMessage,
     ): Promise<void> {
@@ -176,7 +160,7 @@ export class CreateSolutionWebviewMain {
                     await this.getDraftProjectInfo(message.id);
                     break;
                 case 'HELP_OPEN':
-                    this.openFile(CreateSolutionWebviewMain.HELP_URL, true);
+                    await this.commandsProvider.executeCommand(OpenCommand.openHelpCommandId, 'create_app.html');
                     break;
             }
             this.webviewManager.sendMessage({
diff --git a/src/views/manage-solution/manage-solution-custom-editor.ts b/src/views/manage-solution/manage-solution-custom-editor.ts
@@ -22,7 +22,6 @@ import { MANAGE_SOLUTION_WEBVIEW_OPTIONS } from './manage-solution-webview-main'
 import { IncomingMessage, OutgoingMessage } from './messages';
 import { SolutionManager } from '../../solutions/solution-manager';
 import { CommandsProvider } from '../../vscode-api/commands-provider';
-import { IOpenFileExternal } from '../../open-file-external-if';
 import { ConfigurationProvider } from '../../vscode-api/configuration-provider';
 import { CsolutionService } from '../../json-rpc/csolution-rpc-client';
 import { SolutionData } from './view/state/manage-solution-state';
@@ -117,7 +116,6 @@ export class ManageSolutionCustomEditorProvider implements vscode.CustomEditorPr
         private readonly context: vscode.ExtensionContext,
         private readonly solutionManager: SolutionManager,
         private readonly commandsProvider: CommandsProvider,
-        private readonly openFileExternal: IOpenFileExternal,
         private readonly configurationProvider: ConfigurationProvider,
         private readonly csolutionService: CsolutionService,
     ) { }
@@ -136,7 +134,6 @@ export class ManageSolutionCustomEditorProvider implements vscode.CustomEditorPr
                 this.context,
                 this.solutionManager,
                 this.commandsProvider,
-                this.openFileExternal,
                 this.configurationProvider,
                 this.csolutionService,
                 (label, before, after) => this.activeDocument?.recordEdit(label, before, after),
diff --git a/src/views/manage-solution/manage-solution-webview-main.factories.ts b/src/views/manage-solution/manage-solution-webview-main.factories.ts
@@ -24,7 +24,6 @@ import { WebviewManager } from '../webview-manager';
 import { solutionManagerFactory } from '../../solutions/solution-manager.factories';
 import { DataManager } from '../../data-manager/data-manager';
 import { DebugAdaptersYamlFile } from '../../debug/debug-adapters-yaml-file';
-import { IOpenFileExternal } from '../../open-file-external-if';
 import { configurationProviderFactory } from '../../vscode-api/configuration-provider.factories';
 import { ETextFileResult } from '../../generic/text-file';
 import { SolutionData } from './view/state/manage-solution-state';
@@ -38,7 +37,6 @@ export type ManageSolutionWebviewMainFactoryOptions = {
     dataManager?: DataManager;
     debugAdaptersYmlFile?: DebugAdaptersYamlFile;
     configurationProvider?: ReturnType<typeof configurationProviderFactory>;
-    openFileExternal?: IOpenFileExternal,
     csolutionService?: CsolutionService,
     onEdit?: (label: string, before: SolutionData, after: SolutionData) => void,
 }
@@ -78,7 +76,6 @@ export function manageSolutionWebviewMainFactory(options?: ManageSolutionWebview
         { subscriptions: [] } as unknown as vscode.ExtensionContext,
         options?.solutionManager ?? solutionManagerFactory(),
         options?.commandsProvider ?? commandsProviderFactory(),
-        options?.openFileExternal ?? jest.mocked<IOpenFileExternal>({ openFile: function (path: string) { throw new Error(`Function not implemented. ${path}`); } }),
         options?.configurationProvider ?? configurationProviderFactory(),
         options?.csolutionService ?? jest.mocked<CsolutionService>({
             getDeviceList: async function (_args: GetDeviceListParams): Promise<DeviceList> { throw new Error('Function not implemented.'); },
diff --git a/src/views/manage-solution/manage-solution-webview-main.test.ts b/src/views/manage-solution/manage-solution-webview-main.test.ts
@@ -33,6 +33,7 @@ import { SolutionLoadStateChangeEvent } from '../../solutions/solution-manager';
 import { ETextFileResult } from '../../generic/text-file';
 import { configurationProviderFactory } from '../../vscode-api/configuration-provider.factories';
 import { csolutionFactory } from '../../solutions/csolution.factory';
+import { OpenCommand } from '../solution-outline/commands/open-command';
 
 
 // Helper for firing a message and waiting (now inside describe, uses local webviewManager)
@@ -395,7 +396,6 @@ describe('ContextSelectionWebviewMain', () => {
             const main = manageSolutionWebviewMainFactory({
                 webviewManager,
                 commandsProvider,
-                openFileExternal
             });
             await main.activate(context as unknown as vscode.ExtensionContext);
 
@@ -407,21 +407,18 @@ describe('ContextSelectionWebviewMain', () => {
             expect(openFileExternal.openFile).not.toHaveBeenCalled();
         });
 
-        it('calls external opener on OPEN_HELP and not vscode.open', async () => {
+        it('calls openHelp command for manager settings', async () => {
             const commandsProvider = commandsProviderFactory();
-            const openFileExternal = { openFile: jest.fn() };
             const main = manageSolutionWebviewMainFactory({
                 webviewManager,
                 commandsProvider,
-                openFileExternal
             });
             await main.activate(context as unknown as vscode.ExtensionContext);
 
             webviewManager.didReceiveMessageEmitter.fire({ type: 'OPEN_HELP' as any });
             await waitTimeout();
 
-            expect(openFileExternal.openFile).toHaveBeenCalledWith(expect.stringContaining('manage_settings.html'));
-            expect(commandsProvider.executeCommand).not.toHaveBeenCalled();
+            expect(commandsProvider.executeCommand).toHaveBeenCalledWith(OpenCommand.openHelpCommandId, 'manage_settings.html#active-target');
         });
     });
 
diff --git a/src/views/manage-solution/manage-solution-webview-main.ts b/src/views/manage-solution/manage-solution-webview-main.ts
@@ -20,7 +20,6 @@ import { ExtensionContext } from 'vscode';
 import { URI } from 'vscode-uri';
 import { ETextFileResult } from '../../generic/text-file';
 import * as manifest from '../../manifest';
-import { IOpenFileExternal } from '../../open-file-external-if';
 import { SolutionLoadStateChangeEvent, SolutionManager } from '../../solutions/solution-manager';
 import { backToForwardSlashes } from '../../utils/path-utils';
 import { CommandsProvider } from '../../vscode-api/commands-provider';
@@ -33,6 +32,7 @@ import { initialState } from './view/state/reducer';
 import debounce from 'lodash.debounce';
 import { CsolutionService } from '../../json-rpc/csolution-rpc-client';
 import { isDeepStrictEqual } from 'util';
+import { OpenCommand } from '../solution-outline/commands/open-command';
 import { FileSelectorOptionsType } from './types';
 
 export const MANAGE_SOLUTION_WEBVIEW_OPTIONS: Readonly<WebviewManagerOptions> = {
@@ -49,7 +49,6 @@ export const MANAGE_SOLUTION_WEBVIEW_OPTIONS: Readonly<WebviewManagerOptions> =
 
 
 export class ManageSolutionWebviewMain {
-    private readonly HELP_URL = path.join(manifest.GUIDE_FOLDER, 'manage_settings.html#active-target');
     private readonly webviewManager: WebviewManager<IncomingMessage, OutgoingMessage>;
 
     private readonly onEdit?: (label: string, before: SolutionData, after: SolutionData) => void;
@@ -61,7 +60,6 @@ export class ManageSolutionWebviewMain {
         context: ExtensionContext,
         protected readonly solutionManager: SolutionManager, // solutionManager is only used for didChange events. Other calls to csolution must be done using the csolution getter/setter
         private readonly commandsProvider: CommandsProvider,
-        private readonly openFileExternal: IOpenFileExternal,
         private readonly configurationProvider: ConfigurationProvider,
         private readonly csolutionService: CsolutionService,
         onEdit?: (label: string, before: SolutionData, after: SolutionData) => void,
@@ -196,21 +194,13 @@ export class ManageSolutionWebviewMain {
         ]);
     }
 
-    private async openFile(path: string, openExternal?: boolean): Promise<void> {
-        if (openExternal) {
-            this.openFileExternal.openFile(path);
-        } else {
-            await this.commandsProvider.executeCommand('vscode.open', vscode.Uri.file(path));
-        }
-    }
-
     private async handleMessage(message: OutgoingMessage): Promise<void> {
         switch (message.type) {
             case 'GET_CONTEXT_SELECTION_DATA':
                 await this.sendContextData();
                 break;
             case 'OPEN_FILE':
-                await this.openFile(message.path, false);
+                await this.commandsProvider.executeCommand('vscode.open', vscode.Uri.file(message.path));
                 break;
             case 'SET_SELECTED_CONTEXTS':
                 await this.setSelectedContexts(message.data);
@@ -243,7 +233,7 @@ export class ManageSolutionWebviewMain {
                 await this.commandsProvider.executeCommand('workbench.action.files.save');
                 break;
             case 'OPEN_HELP':
-                await this.openFile(this.HELP_URL, true);
+                await this.commandsProvider.executeCommand(OpenCommand.openHelpCommandId, 'manage_settings.html#active-target');
                 break;
             case 'SET_DEBUG_ADAPTER_PROPERTY':
                 await this.updateDebuggerParameter(message.service, message.key, message.value, message.pname);
diff --git a/src/views/solution-outline/commands/open-command.test.ts b/src/views/solution-outline/commands/open-command.test.ts
diff --git a/src/views/solution-outline/commands/open-command.ts b/src/views/solution-outline/commands/open-command.ts
