https://github.com/fourdigits/django-template-lsp
https://github.com/fourdigits/django-template-lsp
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/fourdigits/django-template-lsp
- Owner: fourdigits
- License: gpl-3.0
- Created: 2024-05-17T13:04:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-05T13:39:14.000Z (about 1 year ago)
- Last Synced: 2025-04-09T18:16:01.677Z (about 1 year ago)
- Language: Python
- Size: 265 KB
- Stars: 89
- Watchers: 4
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Template LSP server
The Django Template LSP server enhances your Django development
experience with powerful features for navigating and editing template files.
This LSP supports:
### Completions
- **Custom Tags and Filters**: Autocomplete for your custom template tags and filters.
- **Template**: Suggestions for `extends` and `includes` statements.
- **Load Tag**: Autocomplete for `{% load %}` tags.
- **Static Files**: Path suggestions for `{% static %}` tags.
- **URLs**: Autocomplete for `{% url %}` tags.
### Go to Definitions
- **Template**: Jump directly to the templates used in `extends` and `includes`.
- **URL Tag**: Navigate to the views referenced in `{% url %}` tags.
- **Tags and Filters**: Quickly access the definitions of custom tags and filters.
- **Context Variables**: Partial support for jumping to context definitions.
### Hover Documentation
- **URLs**: Inline documentation for `{% url %}` tags.
- **Tags and Filters**: Detailed descriptions for template tags and filters.
## Support (tested)
- Python: 3.10, 3.11, 3.12
- Django: 3.2, 4.2, 5.0
## Installation
To install the package globally and isolate it from other Python environments, use `pipx`:
```bash
pipx install django-template-lsp
```
Once installed, the Django template LSP server is accessible via the following commands:
- `djlsp`
- `django-template-lsp`
## Options
- `docker_compose_file` (string) default: "docker-compose.yml"
- `docker_compose_service` (string) default: "django"
- `django_settings_module` (string) default (auto detected when empty): ""
- `cache` (boolean/string) default (either true/false or a filepath to the cachefile): false
## Data Collection Method
The Django Template LSP Server collects project data by executing a script in the following order:
1. **Virtual Environment**:
- Checks for a virtual environment in the root directory within one of these folders: `env`, `.env`, `venv`, or `.venv`.
- If found, runs the `django-collector.py` script using the virtual environment's Python interpreter.
2. **Docker Compose**:
- If a Docker Compose file (`docker-compose.yml` by default) is present and includes the specified service (`django` by default), the script is executed within that Docker service.
3. **Global Python**:
- If neither a virtual environment nor Docker Compose is detected, the script runs using the global `python3` installation on the system.
**Note**: The data collection process will fail if there are Python syntax errors or missing imports in your project.
## Type hints
Due to the highly dynamic nature of Python and Django, it can be challenging to
identify the available context data within templates. To address this, basic
type hint support is provided directly in the template files:
```html
{# type blog: blogs.models.Blog #}
```
## Editors
### Helix
In your global or project `languages.toml` add the following
```toml
[language-server.djlsp]
command = "djlsp"
[[language]]
name = "html"
language-servers = [ "vscode-html-language-server", "djlsp" ]
```
Project settings `.helix/languages.toml`:
```toml
[language-server.djlsp.config]
django_settings_modules=""
```
### Neovim
In your lspconfig add the following
```lua
require'lspconfig'.djlsp.setup{
cmd = { "" },
init_options = {
django_settings_module = "",
docker_compose_file = "docker-compose.yml",
docker_compose_service = "django"
}
}
```
### VSCode
To use the Django template LSP with VSCode read the following [readme](vscode/README.md)
## Development
For local development, using [Helix](https://helix-editor.com) is the easiest approach.
The configuration for using the source Django template language server, with logging enabled, is already set up.
To start the Helix editor with the environment activated and the correct workspace loaded, run:
```bash
make helix
```
### neovim
Locally install the package
``` sh
make develop
```
Point neovim's `djlsp` to the locally installed copy
``` lua
require("lspconfig").djlsp.setup({
cmd = { "/path/to/django-template-lsp/.venv/bin/djlsp" },
root_dir = require("lspconfig.util").root_pattern("manage.py", ".git"),
})
```
If you want to access the log while developing, add the `--enable-log` flag to the cmd.
The logfile will be written to a file in your current working directory named `djlsp.log`.
``` lua
require("lspconfig").djlsp.setup({
cmd = { "/path/to/django-template-lsp/.venv/bin/djlsp", "--enable-log" },
})
```