Add config and docs for local development with Helix

Author: krukas

.gitignore

@@ -1,5 +1,9 @@
 # Static project files
 /env/
+/tests/django_test/env/
+
+# Test files
+/tests/django_test/django_app/templates/test.html
 
 # Python files
 .Python
@@ -15,6 +19,7 @@ pip-selfcheck.json
 
 # OS and project files
 *sqlite3
+*djlsp.log
 .DS_Store
 .mypy_cache
 .template-version
@@ -23,7 +28,7 @@ pip-selfcheck.json
 .env
 *.swp
 .idea/
-.helix/
+/.helix/
 
 # Coverage
 .coverage

Makefile

@@ -13,11 +13,11 @@ clean:
 
 $(ENV):
 	python3 -m venv $(ENV)
-
-develop: $(ENV)
 	$(PYTHON) -m pip install --upgrade pip setuptools wheel twine
 	$(PYTHON) -m pip install -e .[dev]
 
+develop: $(ENV)
+
 fix-codestyle:
 	$(BIN)/black $(CODE_LOCATIONS)
 	$(BIN)/isort $(CODE_LOCATIONS)
@@ -30,6 +30,14 @@ lint:
 test: lint
 	$(BIN)/tox run
 
+django-env:
+	python3 -m venv tests/django_test/env
+	tests/django_test/env/bin/python -m pip install django~=4.2.0
+
+helix: $(ENV) django-env
+	touch tests/django_test/django_app/templates/test.html
+	. $(ENV)/bin/activate; hx --working-dir tests/django_test tests/django_test/django_app/templates/test.html
+
 install-ci: $(ENV)
 	$(PYTHON) -m pip install --upgrade pip setuptools wheel twine build .
 

README.md

@@ -119,3 +119,13 @@ require'lspconfig'.djlsp.setup{
 
 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
+```

tests/django_test/.helix/languages.toml

@@ -0,0 +1,10 @@
+[language-server.djlsp]
+command = "djlsp"
+args = ["--enable-log"]
+
+[language-server.djlsp.config]
+django_settings_modules="django_test.settings"
+
+[[language]]
+name = "html"
+language-servers = [ "djlsp" ]