Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@
"./editorApp": {
"types": "./lib/editorApp/index.d.ts",
"default": "./lib/editorApp/index.js"
},
"./debugger": {
"types": "./lib/debugger/index.d.ts",
"default": "./lib/debugger/index.js"
}
},
"typesVersions": {
Expand Down Expand Up @@ -78,6 +82,9 @@
],
"editorApp": [
"lib/editorApp/index"
],
"debugger": [
"lib/debugger/index"
]
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,57 @@
* Licensed under the MIT License. See LICENSE in the package root for license information.
* ------------------------------------------------------------------------------------------ */

import * as vscode from 'vscode';
import { RegisteredMemoryFile } from '@codingame/monaco-vscode-files-service-override';
import type { Logger } from 'monaco-languageclient/common';
import type { ExtensionConfig } from 'monaco-languageclient/vscodeApiWrapper';
import type { ConfigParams, InitMessage } from '../common/definitions.js';
import * as vscode from 'vscode';
import { Uri } from 'vscode';

// This is derived from:
// https://github.com/CodinGame/monaco-vscode-api/blob/main/demo/src/features/debugger.ts
// The client configuration is generic and can be used for a another language

export type FileDefinition = {
path: string;
code: string;
uri: Uri;
}

export type InitMessage = {
id: 'init',
files: Record<string, FileDefinition>
defaultFile: string;
debuggerExecCall: string;
};

export type ConfigParams = {
extensionName: string;
version: string;
publisher: string;
languageId: string;
documentSelector: string[];
homeDir: string;
workspaceRoot: string;
workspaceFile: Uri;
htmlContainer: HTMLElement;
protocol: 'ws' | 'wss';
hostname: string;
port: number;
files: Map<string, FileDefinition>;
defaultFile: string;
helpContainerCmd: string;
debuggerExecCall: string;
}

export const provideDebuggerExtensionConfig = (config: ConfigParams): ExtensionConfig => {
const filesOrContents = new Map<string, string | URL>();
filesOrContents.set('./extension.js', '// nothing');

return {
config: {
name: config.extensionName,
publisher: 'TypeFox',
version: '1.0.0',
publisher: config.publisher,
version: config.version,
engines: {
vscode: '*'
},
Expand Down Expand Up @@ -47,7 +81,7 @@ export const provideDebuggerExtensionConfig = (config: ConfigParams): ExtensionC
};
};

export const configureDebugging = async (api: typeof vscode, config: ConfigParams) => {
export const configureDebugging = async (api: typeof vscode, config: ConfigParams, logger?: Logger) => {
class WebsocketDebugAdapter implements vscode.DebugAdapter {
private websocket: WebSocket;

Expand Down Expand Up @@ -93,7 +127,7 @@ export const configureDebugging = async (api: typeof vscode, config: ConfigParam
debuggerExecCall: config.debuggerExecCall
};
for (const [name, fileDef] of config.files.entries()) {
console.log(`Found: ${name} Sending file: ${fileDef.path}`);
logger?.info(`Found: ${name} Sending file: ${fileDef.path}`);
initMessage.files[name] = {
path: fileDef.path,
code: fileDef.code,
Expand All @@ -105,10 +139,30 @@ export const configureDebugging = async (api: typeof vscode, config: ConfigParam
// eslint-disable-next-line @typescript-eslint/no-explicit-any
adapter.onDidSendMessage((message: any) => {
if (message.type === 'event' && message.event === 'output') {
console.log('OUTPUT', message.body.output);
logger?.info('OUTPUT', message.body.output);
}
});
return new api.DebugAdapterInlineImplementation(adapter);
}
});
};

export const createDebugLaunchConfigFile = (workspacePath: string, type: string) => {
return new RegisteredMemoryFile(
Uri.file(`${workspacePath}/.vscode/launch.json`),
JSON.stringify(
{
version: '0.2.0',
configurations: [
{
name: 'Debugger: Lauch',
type,
request: 'attach',
}
]
},
null,
2
)
);
};
4 changes: 2 additions & 2 deletions packages/examples/resources/debugger/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ FROM ghcr.io/graalvm/graalpy-community:24

RUN curl https://get.volta.sh | bash
ENV VOLTA_FEATURE_PNPM=1
ENV VOLTA_HOME "/root/.volta"
ENV PATH "$VOLTA_HOME/bin:$PATH"
ENV VOLTA_HOME="/root/.volta"
ENV PATH="$VOLTA_HOME/bin:$PATH"

RUN volta install node@22

Expand Down
1 change: 1 addition & 0 deletions packages/examples/resources/debugger/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
},
"dependencies": {
"express": "~4.21.2",
"monaco-languageclient": "~10.1.0",
"ws": "~8.18.0"
},
"devDependencies": {
Expand Down
58 changes: 0 additions & 58 deletions packages/examples/src/debugger/common/definitions.ts

This file was deleted.

2 changes: 1 addition & 1 deletion packages/examples/src/debugger/server/debugServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import * as fs from 'node:fs';
import { exec } from 'node:child_process';
import express from 'express';
import { WebSocketServer } from 'ws';
import type { InitMessage } from '../common/definitions.js';
import type { InitMessage } from 'monaco-languageclient/debugger';
import { DAPSocket } from './DAPSocket.js';

// This is derived from:
Expand Down
5 changes: 3 additions & 2 deletions packages/examples/src/python/client/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import getBannerServiceOverride from '@codingame/monaco-vscode-view-banner-servi
import getStatusBarServiceOverride from '@codingame/monaco-vscode-view-status-bar-service-override';
import getTitleBarServiceOverride from '@codingame/monaco-vscode-view-title-bar-service-override';
import { createUrl } from 'monaco-languageclient/common';
import { createDebugLaunchConfigFile, provideDebuggerExtensionConfig, type ConfigParams, type FileDefinition } from 'monaco-languageclient/debugger';
import type { EditorAppConfig } from 'monaco-languageclient/editorApp';
import type { LanguageClientConfig } from 'monaco-languageclient/lcwrapper';
import { createDefaultLocaleConfiguration } from 'monaco-languageclient/vscodeApiLocales';
Expand All @@ -34,14 +35,14 @@ import badPyCode from '../../../resources/python/bad.py?raw';
import helloPyCode from '../../../resources/python/hello.py?raw';
import hello2PyCode from '../../../resources/python/hello2.py?raw';
import { createDefaultWorkspaceContent } from '../../common/client/utils.js';
import { provideDebuggerExtensionConfig } from '../../debugger/client/debugger.js';
import { createDebugLaunchConfigFile, type ConfigParams, type FileDefinition } from '../../debugger/common/definitions.js';

export const createDefaultConfigParams = (homeDir: string, htmlContainer: HTMLElement): ConfigParams => {
const files = new Map<string, FileDefinition>();
const workspaceRoot = `${homeDir}/workspace`;
const configParams: ConfigParams = {
extensionName: 'debugger-py-client',
publisher: 'TypeFox',
version: '1.0.0',
languageId: 'python',
documentSelector: ['python', 'py'],
homeDir,
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/src/python/client/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { EditorApp } from 'monaco-languageclient/editorApp';
import { LanguageClientWrapper } from 'monaco-languageclient/lcwrapper';
import { MonacoVscodeApiWrapper } from 'monaco-languageclient/vscodeApiWrapper';
import * as vscode from 'vscode';
import { configureDebugging } from '../../debugger/client/debugger.js';
import { configureDebugging } from 'monaco-languageclient/debugger';
import { createPythonAppConfig } from './config.js';

export const runPythonWrapper = async () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/src/python/client/reactPython.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import type { MonacoVscodeApiWrapper } from 'monaco-languageclient/vscodeApiWrap
import React from 'react';
import ReactDOM from 'react-dom/client';
import * as vscode from 'vscode';
import { configureDebugging } from '../../debugger/client/debugger.js';
import { configureDebugging } from 'monaco-languageclient/debugger';
import { createPythonAppConfig } from './config.js';

export const runPythonReact = async () => {
Expand Down