SuperAPI AI 工具集

paths

编程与开发

查看项目

更新于 10-16 06:55

技能介绍

用途

paths 是一条面向 forcedotcom/salesforcedx-vscode 项目的编码规范技能,作用范围限定为 /src 目录下的 .ts 文件。其核心目的是引导开发者在处理文件路径时优先使用 vscode-uri 的 URI,而不是 node:path 的路径字符串,从而获得跨平台一致性和对 file、memfs 等多种文件系统的支持。

主要能力

该技能提供了一套从 node:path 迁移到 vscode-uri 的对应关系:

  • Utils.joinPath(baseUri, 'a', 'b') 对应 path.join
  • Utils.basename(uri)、Utils.dirname(uri)、Utils.extname(uri) 对应 path.basename、path.dirname、path.extname
  • Utils.resolvePath(baseUri, 'rel') 对应 path.resolve

此外,技能说明 URI 与路径之间的转换可通过 FsService 完成:toUri(filePath) 与 uriToPath(uri)。该转换基于 Effect,适用于带有 salesforcedx-vscode-services 的扩展。对于原始路径转 URI,可使用 URI.file(path);在 Web 环境下处理 memfs 时,可使用 toUri。

使用方式

在 /src 下的 .ts 文件中,当出现导入 node:path 或使用 path.join、path.basename、path.dirname、path.resolve、URI.file 或 memfs 路径的情况时,应改用 vscode-uri 提供的 URI 与工具函数。FsService 的配置可参考 services-extension-consumption。

适用场景

适用于需要跨平台路径处理、使用 file 或 memfs 文件系统、以及使用 FsService 或 workspace.fs(二者均接受 URI)的扩展开发场景。

限制

技能明确列出了例外情况(exit hatch):构建脚本、esbuild 配置、测试、仅桌面端的扩展以及仅使用宿主文件系统的工具,在这些场景下使用 node:path 是可以接受的。