Import order conflicts between templ-generated _templ.go files and goimports. How do you go about it?

[preslavrachev]

For one of our projects, I’ve been running into a recurring problem with templ and goimports:

• templ generates _templ.go files with a specific import order.
• goimports (run as a post-save hook) immediately rewrites those imports into a different order.
• The result is constant churn in diffs, and sometimes conflicts in pre-commit hooks / CI pipelines.

It seems like goimports has bluntly ignores the fact that _templ.go files are generated and are not really meant to be read or modified. One of our requirements from the start has been committing both .templ and _templ.go files in the repo, in order to not burden our consumers with running templ upon installing. Plus, we also have a few smoke tests set on the _templ.go files directly.

So, I was wondering, is the different import order something worth a proper temple issue? I mean, we can go about it by supplying files t goimports using find and xargs, but it's just a pain to do it in every project.

How do you guys go about it?

[a-h]

templ uses goimports to process the files: https://github.com/a-h/templ/blob/main/internal/imports/process.go

I wonder if it's a difference in version, or something else...

If you can make a minimal repro, I'll take a look, since I'm not seeing the same issue myself.

[preslavrachev]

Just installed the latest version of goimports (0.36.0, I believe) - after a quick call, the issue seems to persist.

I will also check the templ version now.

[a-h]

templ is currently at golang.org/x/tools v0.35.0

So, I'd be interested to see if it's a change in goimports v0.36. Easy to test if you have a reproduction - checkout templ, bump the tools in the go.mod, install it to your path, and check to see if the problem goes away.