Add template linting via djlint

[silverwind]

So I found this linter which features a mode for go templates, so I gave it a try and it did find a number of valid issue, like unbalanced tags etc. It also has a number of bugs, I had to disable/workaround many issues.

Given that this linter is written in python, this does add a dependency on python >= 3.8 and poetry to the development environment to be able to run this linter locally.

• e.g. prefixes on placeholders are removed because the linter had a false-positive on placeholder="e.g. cn=Search" for the attr=value syntax and it's not ideal anyways to write e.g. into a placeholder because a placeholder is meant to hold a sample value.
• In templates/repo/settings/options.tmpl I simplified the logic to not conditionally create opening tags without closing tags because this stuff confuses the linter (and possibly the reader as well).

[jolheiser]

It's nice that it found some issues to remedy, but I am very hesitant to add another language ecosystem just for this.

[silverwind]

It's nice that it found some issues to remedy, but I am very hesitant to add another language ecosystem just for this.

I guess most people won't run this locally anyways, but I thought I at least enable them to do so. They don't have to install python to get gitea dev setup running.

[delvh]

just for this.

Erm… Have you seen how many PRs we already needed because there was an error in the templates that no one noticed?
I am rather happy if we add a linter for that.
The good thing is also that Python is already installed on every machine, so you don't even need to install a new language on your system.
While I do agree that it would be better in a language we already support, I'll take what I can get.

[jolheiser]

Erm… Have you seen how many PRs we already needed because there was an error in the templates that no one noticed?

I don't disagree that this is helpful.

The good thing is also that Python is already installed on every machine, so you don't even need to install a new language on your system.

I'm not sure how true this is. It may be mostly true on many Linux systems, but I'm not sure about others. Furthermore, even if Python is installed, this requires installing Poetry as well, but...

While I do agree that it would be better in a language we already support, I'll take what I can get.

I guess since it's not a requirement for dev I'm not exactly blocking, but it does feel a bit strange.

[silverwind]

this requires installing Poetry as well

I chose Poetry because I think it's the most sane python dependency manager currently. pipx install djlint or pip install djlint will also work most likely but that leaves the problem that the dependency is unversioned so may yield differrent results depending on the installed version, so it's not something I really consider.

In short: The python dependency management ecosystems sucks, poetry is not ideal, but better then the other solutions.

BTW, macOS also comes default with Python installed. Currently I have 3.9 as /usr/bin/python3 on macOS Ventura.

[silverwind]

I just saw they support a experimental npm installation, so we might actually be able to skip the poetry dependency (it does require python and pip still). I will try that tomorrow.

[wxiaoguang]

I think a simple "pip install" could be better if it works. Otherwise overall LGTM

[silverwind]

I think a simple "pip install" could be better if it works. Otherwise overall LGTM

It would leave the dependency unversioned, which in the long run will bring issues of inconsistent behaviour between versions, it's better to version-lock all dependencies. I will try the npm method.

[wxiaoguang]

I think a simple "pip install" could be better if it works. Otherwise overall LGTM

It would leave the dependency unversioned, which in the long run will bring issues of inconsistent behaviour between versions, it's better to version-lock all dependencies. I will try the npm method.

I do not think so. pip install can set the version. https://www.google.com/search?q=pip+install+with+version

---

Or, use requirements.txt for pip (https://www.google.com/search?q=pip+requirements.txt+version) , it works like package.json or go.mod

[silverwind]

pip will pollute the global site-packages thought, I never use it because of that.

[wxiaoguang]

pip will pollute the global site-packages thought, I never use it because of that.

Hmm yes, that's a problem and that's why pip is always used with virtualenv.

Anyway, I think linting the templates is good and have voted my approval 😄

[silverwind]

The npm module they publish is just a pip wrapper that will pollute global python packages, so I won't consider it and think the current solution is fine as-is.

[silverwind]

Decided to go with pip to install poetry on the action because apparently pipx is not provided by the setup-python action, but by GitHub's VM environment where it installed a python 3.10 venv instead of 3.11 as I requested.

So the proper solution would have been to install pip to install pipx, pipx to install poetry and finally poetry to install the dependencies, but that chain was getting to insane for my tastes and Actions is mostly an isolated environment anyways where we don't need to worry so much about pip site-packages conflicts.