Improve Project.toml formatting

Author: mtfishman

Project.toml

@@ -1,6 +1,6 @@
 name = "ITensorFormatter"
 uuid = "b6bf39f1-c9d3-4bad-aad8-593d802f65fd"
-version = "0.2.22"
+version = "0.2.23"
 authors = ["ITensor developers <support@itensor.org> and contributors"]
 
 [workspace]

src/format_project_toml.jl

@@ -22,8 +22,9 @@ end
 function format_project_toml!(path::AbstractString)
     @assert isfile(path) "Expected a file path, got: $path"
     isprojecttoml(path) || return nothing
-    # This calls `strip_compat_trailing_zeros!(path)` internally.
     strip_compat_trailing_zeros!(path)
+    # Always canonicalize ordering/formatting, even if compat did not change.
+    sort_project_toml!(path)
     return nothing
 end
 
@@ -64,8 +65,10 @@ function sort_project_toml!(path::AbstractString)
     for k in sort(collect(keys(data)))
         is_table(data[k]) && !(k in seen) && push!(table_keys, k)
     end
-    for k in table_keys
-        println(io)
+    for (i, k) in pairs(table_keys)
+        if i > 1 || !isempty(scalar_keys)
+            println(io)
+        end
         TOML.print(io, Dict(k => data[k]); sorted = true)
     end
     out = String(take!(io))
@@ -103,6 +106,5 @@ function strip_compat_trailing_zeros!(path::AbstractString)
     open(path, "w") do io
         return TOML.print(io, data)
     end
-    sort_project_toml!(path)
     return true
 end

test/test_formatters.jl

@@ -33,4 +33,20 @@ end
         @test occursin("Julia = \"1.10\"", result)
         @test occursin("Foo = \"1.2, 2\"", result)
     end
+
+    mktempdir() do dir
+        path = joinpath(dir, "Project.toml")
+        write(
+            path,
+            """
+            [deps]
+            Zebra = "00000000-0000-0000-0000-000000000001"
+            Alpha = "00000000-0000-0000-0000-000000000002"
+            """
+        )
+        format_project_tomls!(path)
+        result = read(path, String)
+        @test !startswith(result, "\n")
+        @test findfirst("Alpha", result) < findfirst("Zebra", result)
+    end
 end