Infinite adding EOL

[dainok]

Hi!

I have a YAML file embedding a Jinja template (cames from Ansible):

list: >-
  [
    {% for host in servers %}
      {"ip": "{{ host }}"},
    {% endfor %}
  ]

Using the dry flag, everything seems ok:

$ yamlfmt -dry test.yaml
2024/04/23 13:49:10 No files will be changed.

Without the dry flag a new line is added:

$ yamlfmt test.yaml
$ cat test.yaml
list: >-
  [

    {% for host in servers %}
      {"ip": "{{ host }}"},
    {% endfor %}
  ]

Every time I run yamlfmt a new line is added.

[braydonk]

Hi @dainok, thanks for opening an issue!

I am able to reproduce the consistently adding a newline behaviour, however when I run -dry with the example yaml, I actually do get a diff produced:

braydonk@bk:~/Git/yamlfmt$ go run ./cmd/yamlfmt/ -dry ./tmp/a.yaml 
./tmp/a.yaml:
  list: >-                       list: >-
    [                              [
+                                
      {% for host in servers %}      {% for host in servers %}
        {"ip": "{{ host }}"},          {"ip": "{{ host }}"},
      {% endfor %}                   {% endfor %}
    ]                              ]

So I'm not sure what is causing the difference between our systems unfortunately...

I did discover something while tinkering though. If I set the retain_line_breaks_single field to true, this doesn't happen anymore. I have no idea why.

braydonk@bk:~/Git/yamlfmt$ go run ./cmd/yamlfmt/ -formatter retain_line_breaks_single=true -dry ./tmp/a.yaml 

(In my intermediate dev version I have a bug that I'm about to fix where the confirmation message isn't printed when there are no diffs, working on it).

So if you are okay with that setting, perhaps that will work as a workaround for now. I notice the log format on No files will be changed, it seems like you might be on a yamlfmt version too old for that setting so you would need to update.

[dainok]

Hi @braydonk thank you for your attention.
I made additional tests, and I realized that I was using yamlfmt 0.9.0. Sorry about that.

I update to 0.11.0 and the -dry is reporting the change, and yamlfmt is always adding a new line.

$ yamlfmt -dry test.yaml
2024/05/03 15:12:20 test.yaml:
  list: >-                       list: >-
    [                              [
+
      {% for host in servers %}      {% for host in servers %}
        {"ip": "{{ host }}"},          {"ip": "{{ host }}"},
      {% endfor %}                   {% endfor %}
    ]                              ]

To me retain_line_breaks_single is fine, it doesn't have side effect on my repos.
Thank you

[braydonk]

Awesome, thank you for re-verifying!

I will leave this issue open to keep the constant newline bug around, but similar to other bugs that live in the yaml parsing I won't be able to easily address it.

[dainok]

Sure, I totally understand. Thank you again!