Tern.js 开源项目安装与使用指南
一、项目目录结构及介绍
Tern.js 是一个JavaScript智能感知引擎,用于提供代码补全和错误提示等高级编辑功能。其GitHub仓库位于 https://github.com/ternjs/tern.git。以下是Tern的核心目录结构概览:
lib
: 包含核心库文件,是Tern的发动机,负责主要的解析和推理逻辑。plugin
: 存放插件,这些插件扩展了Tern的功能,比如对特定框架或库的支持。contrib
: 社区贡献的额外插件和工具,可能包括与其他编辑器集成的脚本。doc
: 文档目录,包含了一些基础的说明和开发指南。test
: 单元测试和示例代码,确保Tern的稳定性和正确性。
二、项目启动文件介绍
Tern本身不直接作为一个独立应用运行,它设计为集成到各种编辑器或IDE中以提供服务。因此,并没有传统意义上的“启动文件”。然而,如果你想要在本地环境中搭建并运行Tern的测试或开发环境,主要通过npm命令来驱动,例如,通过npm install
安装依赖,以及npm test
运行测试套件。
对于开发者想在自己的编辑器中启用Tern,通常需要配置对应的编辑器插件,并且该插件会管理Tern的调用和初始化过程。
三、项目的配置文件介绍
Tern支持自定义配置来调整其行为和增加特定的支持。配置通常是在使用Tern的编辑器或工具内部完成的,而不是直接在Tern项目中设置。不过,可以通过创建.tern-project
文件在项目根目录来定制项目级别的设置。这个文件是JSON格式,例子如下:
{
"libs": ["ecma5", "browser"],
"loadEagerly": [],
"plugins": {
"requirejs": {},
"es6": {},
"node": {}
}
}
libs
: 指定Tern应该使用的库,影响代码分析的基础环境。loadEagerly
: 空数组意味着不预先加载任何文件。plugins
: 配置激活的插件,这里列出了requirejs
,es6
,node
等,用来支持特定语言特性或框架。
请注意,具体的配置选项可能会随着Tern版本的更新而变化,建议参考最新版的文档进行配置。