如何让 Tern 插件和类型定义仅对指定文件生效?
结论
Tern 的标准 .tern-project 配置不支持按文件路径模式分别启用 libs 和 plugins。要让浏览器脚本和 Jest 测试文件使用不同的补全环境,可以将它们放在不同目录,各自配置 .tern-project,再由 Emacs 连接对应的 Tern server。Tern 配置文档
如果测试文件必须与源码放在同一目录,只修改现有 JSON 无法实现所需的隔离。此时需要定制编辑器端的 server 路由,或开发相应的 Tern 扩展。
为什么现有配置会同时提供两种环境
libs 中的类型定义会加载到项目的分析环境中,plugins 用于初始化 server 的插件。这两项都没有按文件匹配的内置配置层。
当前配置同时加载 browser 和 node 后,同一个 server 分析的文件会共享这些环境定义。node 插件初始化时会调用 server.addDefs(defs),不会先检查文件名是否以 .test.js 结尾。node 插件源码
loadEagerly 和顶层 dontLoad 支持 glob,但它们控制的是文件加载,不能用来切换某个文件的类型环境。文件加载配置
按目录拆分 Tern 项目
如果可以调整目录结构,可以参考下面的布局。实际调整时,还需要同步修改 HTML 引用、测试导入路径和 Jest 配置:
project/
index.html
src/
.tern-project
app.js
tests/
.tern-project
app.test.js
在 src/.tern-project 中保留浏览器环境:
{
"libs": [
"ecmascript",
"browser"
],
"plugins": {
"es_modules": {}
}
}
在 tests/.tern-project 中配置 Node.js 环境:
{
"libs": [
"ecmascript"
],
"plugins": {
"es_modules": {},
"node": {}
}
}
示例保留了原配置中的 es_modules,它负责分析 import 和 export,与浏览器或 Node.js 环境的选择是两回事。ES modules 插件说明
Tern 自带的 Emacs 集成会从当前文件所在目录向上查找最近的 .tern-project,并使用该项目目录下的 .tern-port 查找 server。只要没有通过 tern-explicit-port 强制连接到同一个端口,上述两个目录就可以分别使用不同的 server。Emacs 集成源码
添加或修改配置后,应重启相关 Tern server。如果已打开的 buffer 仍沿用旧项目路径,可以关闭后重新打开对应文件。
测试文件与源码混放时怎么办
如果 app.js 和 app.test.js 都位于 src/ 中,它们会找到同一个 .tern-project。标准配置没有按文件覆盖 libs 和 plugins 的机制。
这时可以根据需要选择:
- 如果主要目的是获得补全,可以保留同时启用
browser和node的配置,接受补全中出现另一种环境的变量。 - 如果必须严格区分环境,可以在 Emacs 端根据文件名将请求发送到两个独立 server。这需要处理项目路径、连接和 buffer 状态,不能只给
node插件添加一个匹配参数。
使用独立 server 时,测试导入 src/app.js 后,该源码会在测试 server 的环境中再次分析,不会自动转交给浏览器 server。两个 server 之间也不会共享推断结果。
文件匹配和 Jest 补全的注意事项
原问题中的 .*.test.js 需要区分正则表达式和 glob:
- 如果要用正则表达式匹配以
.test.js结尾的文件,可写作.*\.test\.js$。 - 如果要用 glob 匹配任意子目录下的文件,可写作
**/*.test.js。
即使模式写对了,也只有明确支持该模式的配置项才会使用它。
node 插件提供 Node.js 定义,不包含 Jest 的 describe、test、expect 等 API。要获得这些 API 的补全,还需要另外提供与所用 Tern、Jest 版本兼容的定义或插件,仅启用 node 不够。node 插件定义
备注:内容仅供参考。
