Skip to content

Fix an out-of-bounds array access when formatting some empty comment #792

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.

Sign up for GitHub

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

Merged
johnbartholomew merged 2 commits into from
Mar 10, 2025
Merged

Fix an out-of-bounds array access when formatting some empty comment #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d83c91
Fix an out-of-bounds array access when formatting some empty comment
mickael-carl Mar 6, 2025
106c8f0
Use default options for formatter tests
mickael-carl Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions formatter/formatter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ package formatter
import (
"flag"
"fmt"
"github.com/google/go-jsonnet/internal/testutils"
"io"
"io/ioutil"
"path/filepath"
"regexp"
"strings"
"testing"

"github.com/google/go-jsonnet/internal/testutils"
)

var update = flag.Bool("update", false, "update .golden files")
Expand Down Expand Up @@ -42,7 +43,7 @@ func runTest(t *testing.T, test *formatterTest, changedGoldensList *ChangedGolde

input := read(test.input)
var outBuilder strings.Builder
output, err := Format(test.name, string(input), Options{})
output, err := Format(test.name, string(input), DefaultOptions())
if err != nil {
errWriter := ErrorWriter{
Writer: &outBuilder,
Expand Down
2 changes: 2 additions & 0 deletions formatter/testdata/empty_comment.fmt.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
//
{}
2 changes: 2 additions & 0 deletions formatter/testdata/empty_comment.jsonnet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#
{}
2 changes: 1 addition & 1 deletion internal/formatter/enforce_comment_style.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (c *EnforceCommentStyle) FodderElement(p pass.ASTPass, element *ast.FodderE
*comment = "#" + (*comment)[2:]
}
if c.Options.CommentStyle == CommentStyleSlash && (*comment)[0] == '#' {
if !c.seenFirstFodder && (*comment)[1] == '!' {
if !c.seenFirstFodder && len(*comment) > 1 && (*comment)[1] == '!' {
return
}
*comment = "//" + (*comment)[1:]
Expand Down