Skip to content

feat(vscode): Add a help button in the language server error dialog box #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Groupguanfang merged 2 commits into from
Feb 2, 2026
Merged

feat(vscode): Add a help button in the language server error dialog box #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
564ae35
feat(vscode): Add a help button in the language server error dialog box
Lightning-Lion Jan 29, 2026
0f1f6c8
chore: fix lint
Groupguanfang Feb 2, 2026
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
1 change: 1 addition & 0 deletions packages/vscode/package.nls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
"sdk.error.downloadOrChoiceSdkPath": "Download or choose a OpenHarmony SDK path",
"sdk.error.languageServerError": "ArkTS Language Server Start Failed, please try to restart the IDE or check the OpenHarmony SDK path is correct. Error detail: {0}",
"sdk.error.validSdkPath": "OpenHarmony SDK path is not set in global IDE configuration and local workspace local.properties file, the ETS Language Server will not work properly.",
"sdk.error.helpLabel": "Help",
"sdk.guess.install.no": "No",
"sdk.guess.install.title": "The current workspace likely use OpenHarmony SDK {0}, are you want to install this SDK?",
"sdk.guess.install.yes": "Yes",
Expand Down
1 change: 1 addition & 0 deletions packages/vscode/package.nls.zh-cn.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
"sdk.error.downloadOrChoiceSdkPath": "下载或选择一个 OpenHarmony SDK 路径",
"sdk.error.languageServerError": "ArkTS 语言服务器启动失败, 请尝试重启 IDE 或检查 OpenHarmony SDK 路径是否正确。错误详情: {0}",
"sdk.error.validSdkPath": "OpenHarmony SDK 路径未设置在全局 IDE 配置和本地工作区 local.properties 文件中，ETS 语言服务器可能将无法正常工作。",
"sdk.error.helpLabel": "帮助",
"sdk.guess.install.no": "否",
"sdk.guess.install.title": "当前工作区可能使用 OpenHarmony SDK {0}，您是否想要安装此 SDK？",
"sdk.guess.install.yes": "是",
Expand Down
27 changes: 21 additions & 6 deletions packages/vscode/src/context/server-context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,28 @@ export abstract class LanguageServerContext extends AbstractWatcher implements I
console.error(error)
const choiceSdkPath = this.translator.t('sdk.error.choiceSdkPathMasually')
const downloadOrChoiceSdkPath = this.translator.t('sdk.error.downloadOrChoiceSdkPath')
const helpLabel = this.translator.t('sdk.error.helpLabel')
const detail = this.errorToString(error)
const result = await vscode.window.showWarningMessage(
'ArkTS Language Server Warning',
{ modal: true, detail },
choiceSdkPath,
downloadOrChoiceSdkPath,
)

// 循环显示对话框，直到用户选择操作
let result: string | undefined
do {
result = await vscode.window.showWarningMessage(
'ArkTS Language Server Warning',
{ modal: true, detail },
choiceSdkPath,
downloadOrChoiceSdkPath,
helpLabel,
)

if (result === helpLabel) {
// 打开帮助文档，但不关闭对话框
const helpUrl = vscode.Uri.parse('https://arkcode.dev/arkts/install/#方法一-选择自带在-deveco-studio-中的-sdk-推荐')
await vscode.env.openExternal(helpUrl)
// 继续循环，重新显示对话框
result = undefined
}
} while (result === undefined)

if (result === choiceSdkPath) {
const [sdkPath] = await vscode.window.showOpenDialog({
Expand Down
Loading