跳转到主要内容
在本页

设置您的环境

Deno 自带许多应用程序开发常用的工具，包括一个完整的语言服务器 (LSP)，可以为您的 IDE 提供支持。本页面将帮助您设置环境，以便在开发过程中充分利用 Deno。

我们将涵盖

  • 如何在您喜欢的编辑器/IDE 中使用 Deno
  • 如何生成 Shell 命令补全

设置您的编辑器/IDE 跳转到标题

Visual Studio Code 跳转到标题

如果您还没有安装 Visual Studio Code，请从官方网站下载并安装。

在“扩展”选项卡中，搜索“Deno”并安装Denoland 的扩展。

接下来，按 Ctrl+Shift+P 打开命令面板，然后输入 Deno: Initialize Workspace Configuration。选择此选项为您的工作区配置 Deno。

The VSCode command palette with the Deno: Initialize Workspace Configuration option selected.

将在您的工作区中创建一个名为 .vscode/settings.json 的文件，其中包含以下配置

{
  "deno.enable": true,
  "deno.lint": true,
  "deno.unstable": true
}

就是这样！您已使用 VSCode 成功设置了 Deno 的开发环境。现在您可以获得 Deno 的 LSP 的所有优势，包括 IntelliSense、代码格式化、代码检查等。

JetBrains IDE 跳转到标题

要安装 Deno 插件，请打开您的 IDE 并转到文件 > 设置。导航到插件并搜索 Deno。安装官方 Deno 插件。

The WebStorm plugins settings

要配置插件，请再次转到文件 > 设置。导航到语言和框架 > Deno。选中为您的项目启用 Deno 并指定 Deno 可执行文件的路径（如果尚未自动检测到）。

查看这篇博文，了解如何在 Jetbrains IDE 中开始使用 Deno 的更多信息。

通过插件使用 Vim/Neovim 跳转到标题

Deno 在 Vim 和 Neovim 上都通过 coc.nvim、vim-easycomplete 和 ALE 得到很好的支持。coc.nvim 提供了与 Deno 语言服务器集成的插件，而 ALE 则*开箱即用*地支持它。

使用内置语言服务器的 Neovim 0.6+ 跳转到标题

要使用 Deno 语言服务器，请安装 nvim-lspconfig 并按照说明启用提供的 Deno 配置。

请注意，如果您还将 ts_ls 作为 LSP 客户端，则可能会遇到 ts_ls 和 denols 都附加到当前缓冲区的问题。要解决此问题，请确保为 ts_ls 和 denols 设置一些唯一的 root_dir。您可能还需要将 ts_ls 的 single_file_support 设置为 false，以防止它在*单文件模式*下运行。以下是此类配置的示例

local nvim_lsp = require('lspconfig')
nvim_lsp.denols.setup {
  on_attach = on_attach,
  root_dir = nvim_lsp.util.root_pattern("deno.json", "deno.jsonc"),
}

nvim_lsp.ts_ls.setup {
  on_attach = on_attach,
  root_dir = nvim_lsp.util.root_pattern("package.json"),
  single_file_support = false
}

对于 Deno，上面的示例假设在项目的根目录中存在 deno.json 或 deno.jsonc 文件。

coc.nvim 跳转到标题

安装 coc.nvim 后，您需要通过 :CocInstall coc-deno 安装所需的 coc-deno。

安装插件后，如果要为工作区启用 Deno，请运行命令 :CocCommand deno.initializeWorkspace，您应该能够使用 gd（转到定义）和 gr（转到/查找引用）等命令。

ALE 跳转到标题

ALE 通过内置的 Deno 语言服务器支持 Deno，在许多情况下不需要额外的配置。安装 ALE 后，您可以执行命令 :help ale-typescript-deno 来获取可用的配置选项信息。

有关如何设置 ALE（例如按键绑定）的更多信息，请参阅官方文档。

Vim-EasyComplete 跳转到标题

Vim-EasyComplete 无需任何其他配置即可支持 Deno。安装 vim-easycomplete 后，如果您尚未安装 deno，则需要通过 :InstallLspServer deno 安装 deno。您可以从官方文档获取更多信息。

Emacs 跳转到标题

lsp-mode 跳转到标题

Emacs 通过使用 lsp-mode 的 Deno 语言服务器支持 Deno。安装 lsp-mode 后，它应该支持 Deno，并且可以进行 配置 以支持各种设置。

eglot 跳转到标题

您也可以使用 eglot 来使用内置的 Deno 语言服务器。

通过 eglot 配置 Deno 的示例

(add-to-list 'eglot-server-programs '((js-mode typescript-mode) . (eglot-deno "deno" "lsp")))

  (defclass eglot-deno (eglot-lsp-server) ()
    :documentation "A custom class for deno lsp.")

  (cl-defmethod eglot-initialization-options ((server eglot-deno))
    "Passes through required deno initialization options"
    (list :enable t
    :lint t))

Pulsar 跳转到标题

Pulsar 编辑器（前身为 Atom） 支持通过 atom-ide-deno 包与 Deno 语言服务器集成。 atom-ide-deno 需要安装 Deno CLI 和 atom-ide-base 包。

Sublime Text 跳转到标题

Sublime Text 支持通过 LSP 包 连接到 Deno 语言服务器。您可能还需要安装 TypeScript 包 以获得完整的语法高亮显示。

安装 LSP 包后，您需要在 .sublime-project 配置文件中添加如下配置

{
  "settings": {
    "LSP": {
      "deno": {
        "command": ["deno", "lsp"],
        "initializationOptions": {
          // "config": "", // Sets the path for the config file in your project
          "enable": true,
          // "importMap": "", // Sets the path for the import-map in your project
          "lint": true,
          "unstable": false
        },
        "enabled": true,
        "languages": [
          {
            "languageId": "javascript",
            "scopes": ["source.js"],
            "syntaxes": [
              "Packages/Babel/JavaScript (Babel).sublime-syntax",
              "Packages/JavaScript/JavaScript.sublime-syntax"
            ]
          },
          {
            "languageId": "javascriptreact",
            "scopes": ["source.jsx"],
            "syntaxes": [
              "Packages/Babel/JavaScript (Babel).sublime-syntax",
              "Packages/JavaScript/JavaScript.sublime-syntax"
            ]
          },
          {
            "languageId": "typescript",
            "scopes": ["source.ts"],
            "syntaxes": [
              "Packages/TypeScript-TmLanguage/TypeScript.tmLanguage",
              "Packages/TypeScript Syntax/TypeScript.tmLanguage"
            ]
          },
          {
            "languageId": "typescriptreact",
            "scopes": ["source.tsx"],
            "syntaxes": [
              "Packages/TypeScript-TmLanguage/TypeScriptReact.tmLanguage",
              "Packages/TypeScript Syntax/TypeScriptReact.tmLanguage"
            ]
          }
        ]
      }
    }
  }
}

Nova 跳转到标题

Nova 编辑器 可以通过 Deno 扩展 集成 Deno 语言服务器。

GitHub Codespaces 跳转到标题

GitHub Codespaces 允许您完全在线开发或在本地计算机上远程开发，而无需配置或安装 Deno。它目前处于早期访问阶段。

如果项目是启用 Deno 的项目并且包含存储库中的 .devcontainer 配置，则在 GitHub Codespaces 中打开该项目应该可以“正常工作”。如果您正在启动一个新项目，或者想要向现有代码空间添加 Deno 支持，可以通过从命令面板中选择“Codespaces: 添加开发容器配置文件...” ，然后选择“显示所有定义...” ，然后搜索“Deno”定义来添加。

选择后，您需要重建容器，以便将 Deno CLI 添加到容器中。重建容器后，代码空间将支持 Deno。

Kakoune 跳转到标题

Kakoune 编辑器支持通过 kak-lsp 客户端连接到 Deno 语言服务器。一旦 安装了 kak-lsp，您可以通过将以下内容添加到 kak-lsp.toml 文件来配置它以连接到 Deno 语言服务器：

[language.typescript]
filetypes = ["typescript", "javascript"]
roots = [".git"]
command = "deno"
args = ["lsp"]
[language.typescript.settings.deno]
enable = true
lint = true

Helix 跳转到标题

Helix 编辑器内置了语言服务器支持。要启用与 Deno 语言服务器的连接，需要修改 languages.toml 配置文件。

[[language]]
name = "typescript"
language-id = "typescript"
scope = "source.ts"
injection-regex = "^(ts|typescript)$"
file-types = ["ts"]
shebangs = ["deno"]
roots = ["deno.json", "deno.jsonc", "package.json"]
auto-format = true
language-servers = ["deno-lsp"]

[language-server.deno-lsp]
command = "deno"
args = ["lsp"]

[language-server.deno-lsp.config.deno]
enable = true

Shell 命令补全 跳转到标题

Deno CLI 内置了为自身生成 shell 命令补全信息的功能。通过使用 deno completions <shell>，Deno CLI 会将补全信息输出到标准输出。当前支持的 shell 有：

  • bash
  • elvish
  • fish
  • powershell
  • zsh

bash 示例 跳转到标题

输出补全信息并将其添加到环境变量中

> deno completions bash > /usr/local/etc/bash_completion.d/deno.bash
> source /usr/local/etc/bash_completion.d/deno.bash

PowerShell 示例 跳转到标题

输出补全信息

> deno completions powershell >> $profile
> .$profile

这将在 $HOME\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 创建一个 PowerShell 配置文件，每次启动 PowerShell 时都会运行该文件。

zsh 示例 跳转到标题

您应该有一个目录来保存补全信息

> mkdir ~/.zsh

然后输出补全信息

> deno completions zsh > ~/.zsh/_deno

并确保在您的 ~/.zshrc 文件中加载补全信息

fpath=(~/.zsh $fpath)
autoload -Uz compinit
compinit -u

如果重新加载 shell 后仍然无法加载补全信息，您可能需要删除 ~/.zcompdump/ 以移除先前生成的补全信息，然后运行 compinit 重新生成它们。

使用 ohmyzsh 和 antigen 的 zsh 示例 跳转到标题

ohmyzsh 是一个 zsh 的配置框架，可以更轻松地管理您的 shell 配置。antigen 是 zsh 的插件管理器。

创建用于存储补全信息的目录并输出补全信息

> mkdir ~/.oh-my-zsh/custom/plugins/deno
> deno completions zsh > ~/.oh-my-zsh/custom/plugins/deno/_deno

然后，您的 .zshrc 文件可能如下所示

source /path-to-antigen/antigen.zsh

# Load the oh-my-zsh's library.
antigen use oh-my-zsh

antigen bundle deno

fish 示例 跳转到标题

将补全信息输出到 fish 配置文件夹中 completions 目录下的 deno.fish 文件中

> deno completions fish > ~/.config/fish/completions/deno.fish

其他工具 跳转到标题

如果您正在编写或支持使用 Deno 语言服务器的社区集成，您可以在 Deno CLI 代码仓库中找到文档，也可以随时加入我们的 Discord 社区的 #dev-lsp 频道。