Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trailing comment affecting yamlfmt.Printer #911

Open
prnvbn opened this issue Apr 28, 2024 · 0 comments
Open

Trailing comment affecting yamlfmt.Printer #911

prnvbn opened this issue Apr 28, 2024 · 0 comments
Labels
bug This issue describes a defect or unexpected behavior carvel triage This issue has not yet been triaged for relevance

Comments

@prnvbn
Copy link

prnvbn commented Apr 28, 2024

What steps did you take:
I have the following Go program and YAML file. The Go file integrates with the ytt API and reads the ytt yaml file and just prints it put to standard output. I would expect the file to be printed out with no semantic differences. However, that is not the case!

  • Go program that reads the file andd prints it to stdout
package main

import (
	"os"

	"carvel.dev/ytt/pkg/yamlfmt"
	"carvel.dev/ytt/pkg/yamlmeta"
)

func main() {
	bs, _:= os.ReadFile("example.yaml")
	docset, _:= yamlmeta.NewDocumentSetFromBytes(bs, yamlmeta.DocSetOpts{})
	printer := yamlfmt.NewPrinter(os.Stdout)
	printer.Print(docset)
}
  • YAML file: I have provided a very minimal YAML file
hello: world
# test

What happened:
I see the following in my standard out.

hello: world

# test
---

What did you expect:
I expected the following in my stdout

hello: world

# test

Anything else you would like to add:
I am pretty sure the trailing comment is causing this issue.

Environment:

  • ytt version is v0.49.0. I have pasted my go.mod file below
module issue

go 1.22

toolchain go1.22.2

require carvel.dev/ytt v0.49.0

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help to work on this issue.

@prnvbn prnvbn added bug This issue describes a defect or unexpected behavior carvel triage This issue has not yet been triaged for relevance labels Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue describes a defect or unexpected behavior carvel triage This issue has not yet been triaged for relevance
Projects
Status: No status
Development

No branches or pull requests

1 participant