Environment variables needed by settings loading

[jklaiho]

I'm new to LSP, having previously used editors without it, and am having some issues with using django-language-server in Zed via its Django extension. I'm not sure if this is a missing feature or something that I just don't know how to do.

I typically run my Django projects containerized, and specify some environment variables in docker-compose.yml to be passed to my Django process inside the container. Among these is DJANGO_SECRET_KEY. In my settings file, I use SECRET_KEY = os.environ["DJANGO_SECRET_KEY"]. (I mount the code dir from the host to the container, so I can edit it on the host.)

I've got debug = true in my pyproject.toml under [tool.djls], and in the language server debug logs are these rows (among others):

Inspector query 'django_init' returned ok=false, error=Some("'DJANGO_SECRET_KEY'")
templatetags(Id(0)): executing query
Inspector query 'templatetags' returned ok=false, error=Some("'DJANGO_SECRET_KEY'")
template_dirs(Id(0)): executing query
Inspector query 'template_dirs' returned ok=false, error=Some("'DJANGO_SECRET_KEY'")

What I don't understand is how to pass this and any other environment variables needed for settings loading to django-language-server with any mechanism, be it pyproject.toml or the initialization_options object in Zed's settings.json. Is it possible? I've looked at the docs for Zed, the Django extensions AND django-language-server, but have either missed something, or it's not described there.

[coderabbitai]

📝 CodeRabbit Plan Mode

Generate an implementation plan and prompts that you can use with your favorite coding agent.

• Create Plan

Examples

• Example 1
• Example 2

---

🧪 Issue enrichment is currently in open beta.

You can configure auto-planning by selecting labels in the issue_enrichment configuration.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!

[jklaiho]

OK, figured it out eventually with some LLM assistance. Needed this bit in settings.json, under the "lsp" key:

"django-language-server": {
  "binary": {
    "env": {
      "DJANGO_SECRET_KEY": "some_arbitrary_value_here"
    }
  }
}

It took a while to piece this together. Maybe it's obvious to 90% of people and I'm just dumb, but I think a segment about this would be good to have in the docs.