TypeScript Interactive Development Environment for Emacs (Tide) 使用教程

TypeScript Interactive Development Environment for Emacs (Tide) 使用教程

tide Tide - TypeScript Interactive Development Environment for Emacs 项目地址: https://gitcode.com/gh_mirrors/tide11/tide

1. 项目介绍

Tide 是一个为 Emacs 编辑器打造的开源 TypeScript 交互式开发环境。它通过集成 TypeScript 的语言服务器（tsserver），为开发者提供了一套完整的 TypeScript 开发工具，包括代码补全、语法检查、跳转到定义、重构、组织导入等功能。Tide 的目标是提升 Emacs 用户在 TypeScript 开发中的效率和体验。

2. 项目快速启动

安装

• 确保你的 Emacs 版本为 25 或以上，推荐使用 27 版本及以上，并支持原生 JSON。
• 安装 node.js，版本为 v0.14.0 或以上。
• 确保项目根目录下存在 tsconfig.json 或 jsconfig.json 文件。

在 Emacs 中，可以使用以下命令安装 Tide：

M-x package-install [ret] tide

配置

在 Emacs 配置文件中（通常是 .emacs 或 .emacs.d/init.el），添加以下配置：

(defun setup-tide-mode ()
  (interactive)
  (tide-setup)
  (flycheck-mode +1)
  (setq flycheck-check-syntax-automatically '(save mode-enabled))
  (eldoc-mode +1)
  (tide-hl-identifier-mode +1)
  ; company 是可选依赖，需要单独安装
  (company-mode +1)
  ; 对齐注释到右侧
  (setq company-tooltip-align-annotations t)
  ; 保存前格式化缓冲区
  (add-hook 'before-save-hook 'tide-format-before-save)
  ; 如果使用 typescript-mode
  (add-hook 'typescript-mode-hook #'(lambda () (setup-tide-mode)))
  ; 如果使用 treesitter based typescript-ts-mode (emacs 29+)
  (add-hook 'typescript-ts-mode-hook #'(lambda () (setup-tide-mode)))
)

;; 其他配置...

使用

启动 Emacs，打开 TypeScript 文件，配置的 Tide 功能将自动生效。

3. 应用案例和最佳实践

代码补全

当你在 TypeScript 文件中输入代码时，Tide 会提供智能的代码补全功能。

// 在 Emacs 中输入以下内容时，Tide 将提供补全
const nu = new Date();

语法检查

Tide 集成了 Flycheck，可以实时检查 TypeScript 语法错误。

// 错误的语法将高亮显示，并在 minibuffer 中显示错误信息
const wrongVariable = UnDefinedVariable;

跳转到定义

你可以使用快捷键 M-. 跳转到当前光标所在符号的定义。

// 将光标放在某个变量或函数上，使用 M-. 跳转到其定义
function myFunction() {
  // ...
}

4. 典型生态项目

Tide 作为 Emacs 中的一个 TypeScript 开发环境，可以与多个 Emacs 插件和工具集成，例如：

• company: 提供代码补全的插件。
• flycheck: 实时语法检查。
• eldoc: 显示函数文档和类型信息。
• typescript-mode: Emacs 中的 TypeScript 模式。
• web-mode: 用于编辑 TypeScript JSX 文件的模式。

以上是 Tide 的基础使用教程，希望对您的开发工作有所帮助。

tide Tide - TypeScript Interactive Development Environment for Emacs 项目地址: https://gitcode.com/gh_mirrors/tide11/tide