Automatically suggest fixes for bad formatting

[greimel]

copy-paste from https://github.com/julia-actions/julia-format

[greimel]

I tested this PR in #51 – it turns out that there is an issue with permissions.

@adrhill do you have permission to adjust the Github access token?

[greimel]

xref https://julialang.slack.com/archives/CPWJ5DGG1/p1726659724707129

according to @JoshuaLampert on Slack, this action will only work on PRs which is not from a fork :-/

[JoshuaLampert]

For reference: JuliaDiff/ChainRulesCore.jl#489

[adrhill]

So should we revert this change and set verbose=true in the JuliaFormatter test?

PlutoTeachingTools.jl/test/test_linting.jl

Lines 9 to 11 in 0d18e3d

	@testset "Code formatting" begin
	@test JuliaFormatter.format(PlutoTeachingTools; verbose=false, overwrite=false)
	end

[greimel]

I think it's a good idea to change to verbose=true.

Also, it doesn't hurt to keep this PR. At least you, @eford and others with write-access get better feedback from the formatter.

[eford]

I was also frustrated by getting an error, but having no clue what was causing it or how to fix it. So I like the idea of making sure that any CI errors due to formatting are accompanied by explicit instructions that are useful even a domain expert who is not an expert at software development patterns. But I don't have time to test now, so I'll hope it's fixed and return to it if I encounter another unhelpful error message in the future.

[adrhill]

Sorry, I didn't expect this formatting test to cause so much trouble.
I'm completely fine with removing it from the test entirely. Maintainers can still occasionally make separate formatting commits.