Django模板语言服务器（LSP）

Django模板语言服务器（LSP）通过强大的功能增强您的Django开发体验，以导航和编辑模板文件。此LSP支持

完成

• 自定义标签和过滤器：为您自定义模板标签和过滤器提供自动完成。
• 模板：为extends和includes语句提供建议。
• 加载标签：{% load %}标签的自动完成。
• 静态文件：{% static %}标签的路径建议。
• URLs：{% url %}标签的自动完成。

转到定义

• 模板：直接跳转到使用extends和includes的模板。
• URL标签：导航到{% url %}标签中引用的视图。
• 标签和过滤器：快速访问自定义标签和过滤器的定义。
• 上下文变量：部分支持跳转到上下文定义。

悬停文档

• URLs：{% url %}标签的行内文档。
• 标签和过滤器：模板标签和过滤器的详细描述。

支持（已测试）

• Python：3.10, 3.11, 3.12
• Django：3.2, 4.2, 5.0

安装

pip install django-template-lsp

选项

• docker_compose_file（字符串）默认：“docker-compose.yml”
• docker_compose_service（字符串）默认：“django”
• django_settings_module（字符串）默认（当为空时自动检测）：""

类型提示

由于Python和Django的高度动态性，在模板中识别可用的上下文数据可能具有挑战性。为此，在模板文件中直接提供基本类型提示支持

{# type blog: blogs.models.Blog #}

编辑器

Helix

在您的全局或项目languages.toml中添加以下内容

[language-server.djlsp]
command = "djlsp"

[[language]]
name = "html"
language-servers = [ "vscode-html-language-server", "djlsp" ]

项目设置.helix/languages.toml

[language-server.djlsp.config]
django_settings_modules="<your.settings.module>"

Neovim

在您的lspconfig中添加以下内容

require'lspconfig'.djlsp.setup{
    cmd = { "<path-to-djlsp>" },
    init_options = {
        djlsp = {
            django_settings_module = "<your.settings.module>"
            docker_compose_file = "docker-compose.yml",
            docker_compose_service = "django"
        }
    }
}

VSCode

要使用VSCode中的Django模板LSP，请阅读以下readme