Add template linting via djlint (#25212)

So I found this [linter](https://github.com/Riverside-Healthcare/djlint)
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).

Author: silverwind

.github/workflows/files-changed.yml

@@ -15,6 +15,9 @@ on:
       actions:
         description: "whether actions files changed"
         value: ${{ jobs.detect.outputs.actions }}
+      templates:
+        description: "whether templates files changed"
+        value: ${{ jobs.detect.outputs.templates }}
 
 jobs:
   detect:
@@ -27,6 +30,7 @@ jobs:
       frontend: ${{ steps.changes.outputs.frontend }}
       docs: ${{ steps.changes.outputs.docs }}
       actions: ${{ steps.changes.outputs.actions }}
+      templates: ${{ steps.changes.outputs.templates }}
     steps:
       - uses: actions/checkout@v3
       - uses: dorny/paths-filter@v2
@@ -35,7 +39,7 @@ jobs:
           filters: |
             backend:
               - "**/*.go"
-              - "**/*.tmpl"
+              - "templates/**/*.tmpl"
               - "go.mod"
               - "go.sum"
 
@@ -51,3 +55,6 @@ jobs:
 
             actions:
               - ".github/workflows/*"
+
+            templates:
+              - "templates/**/*.tmpl"

.github/workflows/pull-compliance.yml

@@ -26,6 +26,19 @@ jobs:
         env:
           TAGS: bindata sqlite sqlite_unlock_notify
 
+  lint-templates:
+    if: needs.files-changed.outputs.templates == 'true'
+    needs: files-changed
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - run: pip install poetry
+      - run: make deps-py
+      - run: make lint-templates
+
   lint-go-windows:
     if: needs.files-changed.outputs.backend == 'true' || needs.files-changed.outputs.actions == 'true'
     needs: files-changed

.gitignore

@@ -70,6 +70,7 @@ cpu.out
 /tests/*.ini
 /tests/**/*.git/**/*.sample
 /node_modules
+/.venv
 /yarn.lock
 /yarn-error.log
 /npm-debug.log*

Makefile

@@ -198,6 +198,7 @@ help:
 	@echo " - deps-frontend                    install frontend dependencies"
 	@echo " - deps-backend                     install backend dependencies"
 	@echo " - deps-tools                       install tool dependencies"
+	@echo " - deps-py                          install python dependencies"
 	@echo " - lint                             lint everything"
 	@echo " - lint-fix                         lint everything and fix issues"
 	@echo " - lint-actions                     lint action workflow files"
@@ -214,6 +215,7 @@ help:
 	@echo " - lint-css-fix                     lint css files and fix issues"
 	@echo " - lint-md                          lint markdown files"
 	@echo " - lint-swagger                     lint swagger files"
+	@echo " - lint-templates                   lint template files"
 	@echo " - checks                           run various consistency checks"
 	@echo " - checks-frontend                  check frontend files"
 	@echo " - checks-backend                   check backend files"
@@ -417,6 +419,10 @@ lint-editorconfig:
 lint-actions:
 	$(GO) run $(ACTIONLINT_PACKAGE)
 
+.PHONY: lint-templates
+lint-templates: .venv
+	@poetry run djlint $(shell find templates -type f -iname '*.tmpl')
+
 .PHONY: watch
 watch:
 	@bash build/watch.sh
@@ -893,7 +899,10 @@ deps-docs:
 	fi
 
 .PHONY: deps
-deps: deps-frontend deps-backend deps-tools deps-docs
+deps: deps-frontend deps-backend deps-tools deps-docs deps-py
+
+.PHONY: deps-py
+deps-py: .venv
 
 .PHONY: deps-frontend
 deps-frontend: node_modules
@@ -920,6 +929,10 @@ node_modules: package-lock.json
 	npm install --no-save
 	@touch node_modules
 
+.venv: poetry.lock
+	poetry install
+	@touch .venv
+
 .PHONY: npm-update
 npm-update: node-check | node_modules
 	npx updates -cu

docs/content/doc/development/hacking-on-gitea.en-us.md

@@ -48,6 +48,9 @@ Gitea uses `gofmt` to format source code. However, the results of
 recommended to install the version of Go that our continuous integration is
 running. As of last update, the Go version should be {{< go-version >}}.
 
+To lint the template files, ensure [Python](https://www.python.org/) and
+[Poetry](https://python-poetry.org/) are installed.
+
 ## Installing Make
 
 Gitea makes heavy use of Make to automate tasks and improve development. This

poetry.lock

@@ -0,0 +1,4 @@
+[virtualenvs]
+in-project = true
+no-pip = true
+no-setuptools = true

poetry.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "gitea"
+version = "0.0.0"
+description = ""
+authors = []
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+[tool.poetry.group.dev.dependencies]
+djlint = "1.31.0"
+
+[tool.djlint]
+profile="golang"
+ignore="H005,H006,H008,H013,H014,H016,H020,H021,H023,H026,H030,H031,T027"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -36,11 +36,11 @@
 					</div>
 					<div class="required field">
 						<label for="host">{{.locale.Tr "admin.auths.host"}}</label>
-						<input id="host" name="host" value="{{$cfg.Host}}" placeholder="e.g. mydomain.com" required>
+						<input id="host" name="host" value="{{$cfg.Host}}" placeholder="mydomain.com" required>
 					</div>
 					<div class="required field">
 						<label for="port">{{.locale.Tr "admin.auths.port"}}</label>
-						<input id="port" name="port" value="{{$cfg.Port}}"  placeholder="e.g. 636" required>
+						<input id="port" name="port" value="{{$cfg.Port}}"  placeholder="636" required>
 					</div>
 					<div class="has-tls inline field {{if not .HasTLS}}gt-hidden{{end}}">
 						<div class="ui checkbox">
@@ -51,7 +51,7 @@
 					{{if .Source.IsLDAP}}
 						<div class="field">
 							<label for="bind_dn">{{.locale.Tr "admin.auths.bind_dn"}}</label>
-							<input id="bind_dn" name="bind_dn" value="{{$cfg.BindDN}}" placeholder="e.g. cn=Search,dc=mydomain,dc=com">
+							<input id="bind_dn" name="bind_dn" value="{{$cfg.BindDN}}" placeholder="cn=Search,dc=mydomain,dc=com">
 						</div>
 						<div class="field">
 							<label for="bind_password">{{.locale.Tr "admin.auths.bind_password"}}</label>
@@ -60,17 +60,17 @@
 					{{end}}
 					<div class="{{if .Source.IsLDAP}}required{{end}} field">
 							<label for="user_base">{{.locale.Tr "admin.auths.user_base"}}</label>
-							<input id="user_base" name="user_base" value="{{$cfg.UserBase}}" placeholder="e.g. ou=Users,dc=mydomain,dc=com" {{if .Source.IsLDAP}}required{{end}}>
+							<input id="user_base" name="user_base" value="{{$cfg.UserBase}}" placeholder="ou=Users,dc=mydomain,dc=com" {{if .Source.IsLDAP}}required{{end}}>
 					</div>
 					{{if .Source.IsDLDAP}}
 						<div class="required field">
 							<label for="user_dn">{{.locale.Tr "admin.auths.user_dn"}}</label>
-							<input id="user_dn" name="user_dn" value="{{$cfg.UserDN}}" placeholder="e.g. uid=%s,ou=Users,dc=mydomain,dc=com" required>
+							<input id="user_dn" name="user_dn" value="{{$cfg.UserDN}}" placeholder="uid=%s,ou=Users,dc=mydomain,dc=com" required>
 						</div>
 					{{end}}
 					<div class="required field">
 						<label for="filter">{{.locale.Tr "admin.auths.filter"}}</label>
-						<input id="filter" name="filter" value="{{$cfg.Filter}}" placeholder="e.g. (&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))" required>
+						<input id="filter" name="filter" value="{{$cfg.Filter}}" placeholder="(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))" required>
 					</div>
 					<div class="field">
 						<label for="admin_filter">{{.locale.Tr "admin.auths.admin_filter"}}</label>
@@ -95,15 +95,15 @@
 					</div>
 					<div class="required field">
 						<label for="attribute_mail">{{.locale.Tr "admin.auths.attribute_mail"}}</label>
-						<input id="attribute_mail" name="attribute_mail" value="{{$cfg.AttributeMail}}" placeholder="e.g. mail" required>
+						<input id="attribute_mail" name="attribute_mail" value="{{$cfg.AttributeMail}}" placeholder="mail" required>
 					</div>
 					<div class="field">
 						<label for="attribute_ssh_public_key">{{.locale.Tr "admin.auths.attribute_ssh_public_key"}}</label>
-						<input id="attribute_ssh_public_key" name="attribute_ssh_public_key" value="{{$cfg.AttributeSSHPublicKey}}" placeholder="e.g. SshPublicKey">
+						<input id="attribute_ssh_public_key" name="attribute_ssh_public_key" value="{{$cfg.AttributeSSHPublicKey}}" placeholder="SshPublicKey">
 					</div>
 					<div class="field">
 						<label for="attribute_avatar">{{.locale.Tr "admin.auths.attribute_avatar"}}</label>
-						<input id="attribute_avatar" name="attribute_avatar" value="{{$cfg.AttributeAvatar}}" placeholder="e.g. jpegPhoto">
+						<input id="attribute_avatar" name="attribute_avatar" value="{{$cfg.AttributeAvatar}}" placeholder="jpegPhoto">
 					</div>
 
 
@@ -117,23 +117,23 @@
 					<div id="ldap-group-options" class="ui segment secondary {{if not $cfg.GroupsEnabled}}gt-hidden{{end}}">
 						<div class="field">
 							<label>{{.locale.Tr "admin.auths.group_search_base"}}</label>
-							<input name="group_dn" value="{{$cfg.GroupDN}}" placeholder="e.g. ou=group,dc=mydomain,dc=com">
+							<input name="group_dn" value="{{$cfg.GroupDN}}" placeholder="ou=group,dc=mydomain,dc=com">
 						</div>
 						<div class="field">
 							<label>{{.locale.Tr "admin.auths.group_attribute_list_users"}}</label>
-							<input name="group_member_uid" value="{{$cfg.GroupMemberUID}}" placeholder="e.g. memberUid">
+							<input name="group_member_uid" value="{{$cfg.GroupMemberUID}}" placeholder="memberUid">
 						</div>
 						<div class="field">
 							<label>{{.locale.Tr "admin.auths.user_attribute_in_group"}}</label>
-							<input name="user_uid" value="{{$cfg.UserUID}}" placeholder="e.g. uid">
+							<input name="user_uid" value="{{$cfg.UserUID}}" placeholder="uid">
 						</div>
 						<div class="field">
 							<label>{{.locale.Tr "admin.auths.verify_group_membership"}}</label>
-							<input name="group_filter" value="{{$cfg.GroupFilter}}" placeholder="e.g. (|(cn=gitea_users)(cn=admins))">
+							<input name="group_filter" value="{{$cfg.GroupFilter}}" placeholder="(|(cn=gitea_users)(cn=admins))">
 						</div>
 						<div class="field">
 							<label>{{.locale.Tr "admin.auths.map_group_to_team"}}</label>
-							<textarea name="group_team_map" rows="5" placeholder='e.g. {"cn=my-group,cn=groups,dc=example,dc=org": {"MyGiteaOrganization": ["MyGiteaTeam1", "MyGiteaTeam2"]}}'>{{$cfg.GroupTeamMap}}</textarea>
+							<textarea name="group_team_map" rows="5" placeholder='{"cn=my-group,cn=groups,dc=example,dc=org": {"MyGiteaOrganization": ["MyGiteaTeam1", "MyGiteaTeam2"]}}'>{{$cfg.GroupTeamMap}}</textarea>
 						</div>
 						<div class="ui checkbox">
 							<label>{{.locale.Tr "admin.auths.map_group_to_team_removal"}}</label>
@@ -360,7 +360,7 @@
 					</div>
 					<div class="field">
 						<label>{{.locale.Tr "admin.auths.oauth2_map_group_to_team"}}</label>
-						<textarea name="oauth2_group_team_map" rows="5" placeholder='e.g. {"Developer": {"MyGiteaOrganization": ["MyGiteaTeam1", "MyGiteaTeam2"]}}'>{{$cfg.GroupTeamMap}}</textarea>
+						<textarea name="oauth2_group_team_map" rows="5" placeholder='{"Developer": {"MyGiteaOrganization": ["MyGiteaTeam1", "MyGiteaTeam2"]}}'>{{$cfg.GroupTeamMap}}</textarea>
 					</div>
 					<div class="ui checkbox">
 						<label>{{.locale.Tr "admin.auths.oauth2_map_group_to_team_removal"}}</label>

templates/admin/auth/edit.tmpl

@@ -14,11 +14,11 @@
 	</div>
 	<div class="required field">
 		<label for="host">{{.locale.Tr "admin.auths.host"}}</label>
-		<input id="host" name="host" value="{{.host}}" placeholder="e.g. mydomain.com">
+		<input id="host" name="host" value="{{.host}}" placeholder="mydomain.com">
 	</div>
 	<div class="required field">
 		<label for="port">{{.locale.Tr "admin.auths.port"}}</label>
-		<input id="port" name="port" value="{{.port}}"  placeholder="e.g. 636">
+		<input id="port" name="port" value="{{.port}}"  placeholder="636">
 	</div>
 	<div class="has-tls inline field {{if not .HasTLS}}gt-hidden{{end}}">
 		<div class="ui checkbox">
@@ -28,23 +28,23 @@
 	</div>
 	<div class="ldap field {{if not (eq .type 2)}}gt-hidden{{end}}">
 		<label for="bind_dn">{{.locale.Tr "admin.auths.bind_dn"}}</label>
-		<input id="bind_dn" name="bind_dn" value="{{.bind_dn}}" placeholder="e.g. cn=Search,dc=mydomain,dc=com">
+		<input id="bind_dn" name="bind_dn" value="{{.bind_dn}}" placeholder="cn=Search,dc=mydomain,dc=com">
 	</div>
 	<div class="ldap field {{if not (eq .type 2)}}gt-hidden{{end}}">
 		<label for="bind_password">{{.locale.Tr "admin.auths.bind_password"}}</label>
 		<input id="bind_password" name="bind_password" type="password" autocomplete="off" value="{{.bind_password}}">
 	</div>
 	<div class="binddnrequired {{if (eq .type 2)}}required{{end}} field">
 		<label for="user_base">{{.locale.Tr "admin.auths.user_base"}}</label>
-		<input id="user_base" name="user_base" value="{{.user_base}}" placeholder="e.g. ou=Users,dc=mydomain,dc=com">
+		<input id="user_base" name="user_base" value="{{.user_base}}" placeholder="ou=Users,dc=mydomain,dc=com">
 	</div>
 	<div class="dldap required field {{if not (eq .type 5)}}gt-hidden{{end}}">
 		<label for="user_dn">{{.locale.Tr "admin.auths.user_dn"}}</label>
-		<input id="user_dn" name="user_dn" value="{{.user_dn}}" placeholder="e.g. uid=%s,ou=Users,dc=mydomain,dc=com">
+		<input id="user_dn" name="user_dn" value="{{.user_dn}}" placeholder="uid=%s,ou=Users,dc=mydomain,dc=com">
 	</div>
 	<div class="required field">
 		<label for="filter">{{.locale.Tr "admin.auths.filter"}}</label>
-		<input id="filter" name="filter" value="{{.filter}}" placeholder="e.g. (&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))">
+		<input id="filter" name="filter" value="{{.filter}}" placeholder="(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))">
 	</div>
 	<div class="field">
 		<label for="admin_filter">{{.locale.Tr "admin.auths.admin_filter"}}</label>
@@ -69,15 +69,15 @@
 	</div>
 	<div class="required field">
 		<label for="attribute_mail">{{.locale.Tr "admin.auths.attribute_mail"}}</label>
-		<input id="attribute_mail" name="attribute_mail" value="{{.attribute_mail}}" placeholder="e.g. mail">
+		<input id="attribute_mail" name="attribute_mail" value="{{.attribute_mail}}" placeholder="mail">
 	</div>
 	<div class="field">
 		<label for="attribute_ssh_public_key">{{.locale.Tr "admin.auths.attribute_ssh_public_key"}}</label>
-		<input id="attribute_ssh_public_key" name="attribute_ssh_public_key" value="{{.attribute_ssh_public_key}}" placeholder="e.g. SshPublicKey">
+		<input id="attribute_ssh_public_key" name="attribute_ssh_public_key" value="{{.attribute_ssh_public_key}}" placeholder="SshPublicKey">
 	</div>
 	<div class="field">
 		<label for="attribute_avatar">{{.locale.Tr "admin.auths.attribute_avatar"}}</label>
-		<input id="attribute_avatar" name="attribute_avatar" value="{{.attribute_avatar}}" placeholder="e.g. jpegPhoto">
+		<input id="attribute_avatar" name="attribute_avatar" value="{{.attribute_avatar}}" placeholder="jpegPhoto">
 	</div>
 
 	<!-- ldap group begin -->
@@ -90,23 +90,23 @@
 	<div id="ldap-group-options" class="ui segment secondary">
 		<div class="field">
 			<label>{{.locale.Tr "admin.auths.group_search_base"}}</label>
-			<input name="group_dn" value="{{.group_dn}}" placeholder="e.g. ou=group,dc=mydomain,dc=com">
+			<input name="group_dn" value="{{.group_dn}}" placeholder="ou=group,dc=mydomain,dc=com">
 		</div>
 		<div class="field">
 			<label>{{.locale.Tr "admin.auths.group_attribute_list_users"}}</label>
-			<input name="group_member_uid" value="{{.group_member_uid}}" placeholder="e.g. memberUid">
+			<input name="group_member_uid" value="{{.group_member_uid}}" placeholder="memberUid">
 		</div>
 		<div class="field">
 			<label>{{.locale.Tr "admin.auths.user_attribute_in_group"}}</label>
-			<input name="user_uid" value="{{.user_uid}}" placeholder="e.g. uid">
+			<input name="user_uid" value="{{.user_uid}}" placeholder="uid">
 		</div>
 		<div class="field">
 			<label>{{.locale.Tr "admin.auths.verify_group_membership"}}</label>
-			<input name="group_filter" value="{{.group_filter}}" placeholder="e.g. (|(cn=gitea_users)(cn=admins))">
+			<input name="group_filter" value="{{.group_filter}}" placeholder="(|(cn=gitea_users)(cn=admins))">
 		</div>
 		<div class="field">
 			<label>{{.locale.Tr "admin.auths.map_group_to_team"}}</label>
-			<textarea name="group_team_map" rows="5" placeholder='e.g. {"cn=my-group,cn=groups,dc=example,dc=org": {"MyGiteaOrganization": ["MyGiteaTeam1", "MyGiteaTeam2"]}}'>{{.group_team_map}}</textarea>
+			<textarea name="group_team_map" rows="5" placeholder='{"cn=my-group,cn=groups,dc=example,dc=org": {"MyGiteaOrganization": ["MyGiteaTeam1", "MyGiteaTeam2"]}}'>{{.group_team_map}}</textarea>
 		</div>
 		<div class="ui checkbox">
 			<label>{{.locale.Tr "admin.auths.map_group_to_team_removal"}}</label>