Ts支持 旧标题 > Language Server 启动失败警告以及SDK搜索方式建议

[Vwings]

问题描述

在使用 ArkTS VSCode 扩展时，当未配置 SDK 路径的情况下，扩展会在所有项目（包括非 HarmonyOS类项目）中弹出 Language Server 启动失败警告。

建议

基于上述问题，这里有一些改进的想法：

1. 自动项目类型识别

考虑让扩展能够自动识别项目类型，只在 HarmonyOS NEXT 或 OpenHarmony 项目中执行扩展逻辑，避免在非相关项目中弹出警告。

项目类型判断方式：

1. 判断是否是 HarmonyOS类项目：检查项目根目录是否存在 oh-package.json5 和 build-profile.json5 文件。如果不是HarmonyOS类项目，则默认不执行扩展逻辑。

2. 判断是 HarmonyOS NEXT 还是 OpenHarmony：读取 build-profile.json5 中 app.products[index].runtimeOS 字段

   • HarmonyOS：表示 HarmonyOS NEXT
   • OpenHarmony：表示 OpenHarmony

   如果 app.products 中存在多个 product，可以通过读取 DevEco Studio 缓存判断当前激活的是哪个 product：读取 .idea/.deveco/project.cache.json 中 CommonInfo['current.select.product']，如果没有缓存，可以默认读取第一个

2. 自动 SDK 路径检测

考虑根据项目类型自动检测 SDK 路径，减少用户手动配置的工作量。

检测策略：

考虑到很多开发者都会安装 DevEco Studio，可以基于 DevEco Studio 的安装路径进行检测。这里假设为 ${DEVECO_HOME}，表示 DevEco Studio 的安装目录。

DevEco Studio 安装路径获取方式：

• 手动配置：提供配置项让用户直接指定
• 自动检测：例如在 Windows 上可以通过注册表获取

根据上一步获取到的项目类型，尝试自动检测 SDK 路径：

• HarmonyOS NEXT：IDE 通常自带默认 SDK，位于 ${DEVECO_HOME}/sdk/default，其中包含 openharmony 和 hms
• OpenHarmony：建议用户使用 DevEco Studio 配置好 SDK 根路径后，扩展进行读取。路径可在 DevEco Studio 的 设置 → OpenHarmony SDK 中配置。配置后 SDK 根路径会保存在本地文件中，例如 Windows 上在 C:\Users\<用户名>\AppData\Roaming\Huawei\DevEcoStudio<版本号>\options\other.xml 中的 oh.sdk.location 保存 SDK 根路径。DevEco Studio 版本号可从 ${DEVECO_HOME}/product-info.json 中获取。具体的API版本可以读取build-profile.json5中的app.products[index].compileSdkVersion获取, 这样可以最终组装出SDK路径

现在的 SDK 路径配置方式可以作为自动识别无法获取 SDK 路径时的备选方案，且优先级最高，确保用户的手动配置始终有效。

[Groupguanfang]

我考虑缩小一下，不用modal弹窗，用一个普通的notification弹窗就好了qwq

[Groupguanfang]

改成warning message，就不会弹窗了，但是这样真的好吗？

[Vwings]

改成warning message，就不会弹窗了，但是这样真的好吗？

个人感觉非HarmonyOS类项目不应该有任何提示（包括这个warning message），甚至可以不启动扩展，用户需要可以手动启动。
HarmonyOS类项目这样的warning message看上去没问题，缺失SDK本身不应该引发一个阻塞用户操作的弹窗

“是否是HarmonyOS类项目”这个判断逻辑可能需要考虑下，如果只根据项目工程根目录的文件（比如oh-package.json5, build-profile.json5）判断，无法覆盖用户单独打开一个工程子目录的场景，如果再加上存在ets文件补充判断可能也无法全面覆盖，一些har模块有可能全部使用ts、js开发...

[Groupguanfang]

嗯😐插件的启动时机目前实际是vscode控制的，具体就是使用package.json中的activationEvents属性：

arkTS/packages/vscode/package.json

Lines 32 to 37 in c18dd8e

	"activationEvents": [
	"onLanguage:typescript",
	"onLanguage:typescriptreact",
	"onStartupFinished",
	"onFileSystem:file"
	],

我之前由于调试debug以及出于保险起见（怕自定义配置没有传递给vscode内置的TS服务器），所以添加了这几个事件。但是现在我发现目前的版本已经完善好了，不需要这个了，我准备将这些事件去除，这样就能在没有打开.ets/.d.ets文件的时候不启动当前插件了，也就不会出现上述弹窗了。

只有当你打开了一个.ets文件，并且没有配置ets.sdkPath或者该路径有误的时候，才会出现该弹窗。这样可能会更人性化一些（？

---

另外，我觉得改成warning message其实也不是特别的好。原因在于：这种小型浮窗适合短消息，一些小提示之类的；但是我最好就是详细描述出当前插件无法正常工作的具体原因，这样会比较好一些

而且我说实话哪怕是现在这么长的报错信息，也有很多人不知道该如何配置这个sdkPath路径，我想我还要继续优化一下弹窗的内容。

[Vwings]

只有当你打开了一个.ets文件，并且没有配置ets.sdkPath或者该路径有误的时候，才会出现该弹窗。这样可能会更人性化一些（？

这样体验会更好~

另外除了打开.ets文件启动扩展的逻辑，是否可以考虑增加鸿蒙类项目的ts文件检测并启动扩展的逻辑。一些鸿蒙项目内会使用ts开发，而这些ts文件中也会使用系统模块:

当前扩展似乎不会处理ts文件，这可能不在这个issue的讨论范围内

[Groupguanfang]

这个我也考虑过想加进去，不是不能做，而是最好不要影响到vscode内置的TS服务器的行为。我得好好考虑考虑如何实现它。

目前我的想法是，添加一个设置选项，类型为boolean，并且仅限于工作区内该设置才有效（这意味着，你必须要在工作区内创建.vscode/settings.json文件）。当该设置为true时，才会通过TS插件更改相关的编译器选项，让内置TS服务器支持导入这些模块，这个是第一步；

第二步就是，我目前暂时还需待研究的就是该如何让内置的TS服务器支持导入/识别.d.ets文件。可以看到sdk内部是有一些组件使用.d.ets写的，这部分的代码我该怎么支持它们，这又是一个问题。

[sanchuanhehe]

"files.associations": {
"*.ts": "arkts"
}
可以通过在设置里使用这种设置劫持
建议用户为arkts或鸿蒙开发单独开一个配置文件就好了，不影响平常使用

[sanchuanhehe]

或者在项目根目录这样设置