当前位置：首页 > news >正文

Django框架下html文件无法格式化的解决方案

news 来源：原创 2025/5/10 21:45:30

在 Django 项目中，.html 文件通常包含 Django 模板语言（DTL，如 {% %} 和 {{ }}），这可能导致一些格式化工具无法正确解析。以下是几种方法可以帮助你格式化 Django HTML 文件：

方法 1：使用 VS Code 并安装 Prettier 插件

步骤

安装 Prettier 插件：
- 在 VS Code 中，打开 扩展（Extensions） (Ctrl + Shift + X)。
- 搜索 Prettier - Code formatter 并安装。

配置 Prettier 兼容 Django 模板

在项目的 .vscode/settings.json 文件（如果没有，就创建一个）中添加：

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "prettier.parser": "html",
  "editor.formatOnSave": true
}

格式化 HTML
- 右键 .html 文件，选择 “Format Document”，或者使用快捷键：
  - Windows: Shift + Alt + F
  - Mac: Shift + Option + F

方法 2：使用 Django 扩展插件

VS Code 专用

如果 Prettier 不能正确格式化 Django 模板，你可以安装 Django 相关插件：

安装 Django 插件（适用于 VS Code）
- Django (官方插件)
- Django Template Formatter
- Django HTML
- Django Snippets

配置 VS Code

在 .vscode/settings.json 中添加：

{
  "editor.defaultFormatter": "Prettier",
  "[django-html]": {
    "editor.defaultFormatter": "Prettier"
  },
  "files.associations": {
    "*.html": "django-html"
  }
}

方法 3：使用 Django 自带格式化工具

步骤

安装 djlint
```
pip install djlint
```
格式化 Django HTML 文件
```
djlint templates/ --reformat
```
格式化单个 HTML 文件
```
djlint templates/index.html --reformat
```

方法 4：手动使用 HTML + Jinja 格式化

如果你的格式化工具不支持 Django 语法，可以尝试使用 Jinja 格式化，因为 Django 模板语法和 Jinja2 语法类似：

设置 .html 文件的语言模式
- 在 VS Code 右下角 切换文件语言 → 选择 Jinja 或 Django HTML
尝试格式化
- 右键 “Format Document”，或使用快捷键 Shift + Alt + F

方法 5：使用 PyCharm（JetBrains）

如果你使用 PyCharm，可以启用 Django 模板支持：

在 PyCharm 中安装 Django 插件
- File → Settings → Plugins → 搜索 Django
- 安装后，重启 PyCharm。
启用 Django 模板支持
- File → Settings → Languages & Frameworks → Django
- 勾选 “Enable Django Support”
格式化 HTML
- Ctrl + Alt + L（Windows/Linux）
- Cmd + Option + L（Mac）

总结

方法	工具	适用场景
方法 1	Prettier	适用于 VS Code，适合一般 HTML 文件
方法 2	Django 插件	适用于 VS Code，支持 Django 模板语法
方法 3	`djlint`	适用于所有编辑器，命令行格式化
方法 4	Jinja 语言模式	适用于 VS Code
方法 5	PyCharm	适用于 JetBrains 全家桶