mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
Replace to gopkg.in/yaml with github.com/goccy/go-yaml (note)
Fixes #8822 Fixes #13043
This commit is contained in:
parent
5e3133a7d8
commit
2fb7827a64
17 changed files with 142 additions and 246 deletions
|
@ -27,6 +27,7 @@ import (
|
||||||
"github.com/alecthomas/chroma/v2/formatters/html"
|
"github.com/alecthomas/chroma/v2/formatters/html"
|
||||||
"github.com/alecthomas/chroma/v2/styles"
|
"github.com/alecthomas/chroma/v2/styles"
|
||||||
"github.com/bep/simplecobra"
|
"github.com/bep/simplecobra"
|
||||||
|
"github.com/goccy/go-yaml"
|
||||||
"github.com/gohugoio/hugo/common/hugo"
|
"github.com/gohugoio/hugo/common/hugo"
|
||||||
"github.com/gohugoio/hugo/docshelper"
|
"github.com/gohugoio/hugo/docshelper"
|
||||||
"github.com/gohugoio/hugo/helpers"
|
"github.com/gohugoio/hugo/helpers"
|
||||||
|
@ -35,7 +36,6 @@ import (
|
||||||
"github.com/gohugoio/hugo/parser"
|
"github.com/gohugoio/hugo/parser"
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
"github.com/spf13/cobra/doc"
|
"github.com/spf13/cobra/doc"
|
||||||
"gopkg.in/yaml.v2"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func newGenCommand() *genCommand {
|
func newGenCommand() *genCommand {
|
||||||
|
|
|
@ -1160,7 +1160,6 @@ func chmodFilter(dst, src os.FileInfo) bool {
|
||||||
}
|
}
|
||||||
|
|
||||||
func cleanErrorLog(content string) string {
|
func cleanErrorLog(content string) string {
|
||||||
content = strings.ReplaceAll(content, "\n", " ")
|
|
||||||
content = logReplacer.Replace(content)
|
content = logReplacer.Replace(content)
|
||||||
content = logDuplicateTemplateExecuteRe.ReplaceAllString(content, "")
|
content = logDuplicateTemplateExecuteRe.ReplaceAllString(content, "")
|
||||||
content = logDuplicateTemplateParseRe.ReplaceAllString(content, "")
|
content = logDuplicateTemplateParseRe.ReplaceAllString(content, "")
|
||||||
|
|
|
@ -112,11 +112,11 @@ func (fe *fileError) UpdateContent(r io.Reader, linematcher LineMatcherFn) FileE
|
||||||
|
|
||||||
fe.errorContext = ectx
|
fe.errorContext = ectx
|
||||||
|
|
||||||
if ectx.Position.LineNumber > 0 {
|
if ectx.Position.LineNumber > 0 && ectx.Position.LineNumber > fe.position.LineNumber {
|
||||||
fe.position.LineNumber = ectx.Position.LineNumber
|
fe.position.LineNumber = ectx.Position.LineNumber
|
||||||
}
|
}
|
||||||
|
|
||||||
if ectx.Position.ColumnNumber > 0 {
|
if ectx.Position.ColumnNumber > 0 && ectx.Position.ColumnNumber > fe.position.ColumnNumber {
|
||||||
fe.position.ColumnNumber = ectx.Position.ColumnNumber
|
fe.position.ColumnNumber = ectx.Position.ColumnNumber
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -181,6 +181,7 @@ func NewFileErrorFromName(err error, name string) FileError {
|
||||||
// Filetype is used to determine the Chroma lexer to use.
|
// Filetype is used to determine the Chroma lexer to use.
|
||||||
fileType, pos := extractFileTypePos(err)
|
fileType, pos := extractFileTypePos(err)
|
||||||
pos.Filename = name
|
pos.Filename = name
|
||||||
|
|
||||||
if fileType == "" {
|
if fileType == "" {
|
||||||
_, fileType = paths.FileAndExtNoDelimiter(filepath.Clean(name))
|
_, fileType = paths.FileAndExtNoDelimiter(filepath.Clean(name))
|
||||||
}
|
}
|
||||||
|
@ -238,7 +239,9 @@ func NewFileErrorFromFile(err error, filename string, fs afero.Fs, linematcher L
|
||||||
return NewFileErrorFromName(err, realFilename)
|
return NewFileErrorFromName(err, realFilename)
|
||||||
}
|
}
|
||||||
defer f.Close()
|
defer f.Close()
|
||||||
return NewFileErrorFromName(err, realFilename).UpdateContent(f, linematcher)
|
fe := NewFileErrorFromName(err, realFilename)
|
||||||
|
fe = fe.UpdateContent(f, linematcher)
|
||||||
|
return fe
|
||||||
}
|
}
|
||||||
|
|
||||||
func openFile(filename string, fs afero.Fs) (afero.File, string, error) {
|
func openFile(filename string, fs afero.Fs) (afero.File, string, error) {
|
||||||
|
@ -306,13 +309,9 @@ func extractFileTypePos(err error) (string, text.Position) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Look in the error message for the line number.
|
// Look in the error message for the line number.
|
||||||
for _, handle := range lineNumberExtractors {
|
if lno, col := commonLineNumberExtractor(err); lno > 0 {
|
||||||
lno, col := handle(err)
|
pos.ColumnNumber = col
|
||||||
if lno > 0 {
|
pos.LineNumber = lno
|
||||||
pos.ColumnNumber = col
|
|
||||||
pos.LineNumber = lno
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if fileType == "" && pos.Filename != "" {
|
if fileType == "" && pos.Filename != "" {
|
||||||
|
|
|
@ -19,17 +19,27 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
var lineNumberExtractors = []lineNumberExtractor{
|
var lineNumberExtractors = []lineNumberExtractor{
|
||||||
|
// YAML parse errors.
|
||||||
|
newLineNumberErrHandlerFromRegexp(`\[(\d+):(\d+)\]`),
|
||||||
|
|
||||||
// Template/shortcode parse errors
|
// Template/shortcode parse errors
|
||||||
newLineNumberErrHandlerFromRegexp(`:(\d+):(\d*):`),
|
newLineNumberErrHandlerFromRegexp(`:(\d+):(\d*):`),
|
||||||
newLineNumberErrHandlerFromRegexp(`:(\d+):`),
|
newLineNumberErrHandlerFromRegexp(`:(\d+):`),
|
||||||
|
|
||||||
// YAML parse errors
|
|
||||||
newLineNumberErrHandlerFromRegexp(`line (\d+):`),
|
|
||||||
|
|
||||||
// i18n bundle errors
|
// i18n bundle errors
|
||||||
newLineNumberErrHandlerFromRegexp(`\((\d+),\s(\d*)`),
|
newLineNumberErrHandlerFromRegexp(`\((\d+),\s(\d*)`),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func commonLineNumberExtractor(e error) (int, int) {
|
||||||
|
for _, handler := range lineNumberExtractors {
|
||||||
|
lno, col := handler(e)
|
||||||
|
if lno > 0 {
|
||||||
|
return lno, col
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0, 0
|
||||||
|
}
|
||||||
|
|
||||||
type lineNumberExtractor func(e error) (int, int)
|
type lineNumberExtractor func(e error) (int, int)
|
||||||
|
|
||||||
func newLineNumberErrHandlerFromRegexp(expression string) lineNumberExtractor {
|
func newLineNumberErrHandlerFromRegexp(expression string) lineNumberExtractor {
|
||||||
|
|
31
common/herrors/line_number_extractors_test.go
Normal file
31
common/herrors/line_number_extractors_test.go
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
// Copyright 2024 The Hugo Authors. All rights reserved.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package herrors
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
qt "github.com/frankban/quicktest"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestCommonLineNumberExtractor(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
c := qt.New(t)
|
||||||
|
|
||||||
|
lno, col := commonLineNumberExtractor(errors.New("[4:9] value is not allowed in this context"))
|
||||||
|
c.Assert(lno, qt.Equals, 4)
|
||||||
|
c.Assert(col, qt.Equals, 9)
|
||||||
|
}
|
3
go.mod
3
go.mod
|
@ -36,6 +36,7 @@ require (
|
||||||
github.com/ghodss/yaml v1.0.0
|
github.com/ghodss/yaml v1.0.0
|
||||||
github.com/gobuffalo/flect v1.0.3
|
github.com/gobuffalo/flect v1.0.3
|
||||||
github.com/gobwas/glob v0.2.3
|
github.com/gobwas/glob v0.2.3
|
||||||
|
github.com/goccy/go-yaml v1.14.0
|
||||||
github.com/gohugoio/go-i18n/v2 v2.1.3-0.20230805085216-e63c13218d0e
|
github.com/gohugoio/go-i18n/v2 v2.1.3-0.20230805085216-e63c13218d0e
|
||||||
github.com/gohugoio/hashstructure v0.1.0
|
github.com/gohugoio/hashstructure v0.1.0
|
||||||
github.com/gohugoio/httpcache v0.7.0
|
github.com/gohugoio/httpcache v0.7.0
|
||||||
|
@ -83,7 +84,6 @@ require (
|
||||||
golang.org/x/text v0.19.0
|
golang.org/x/text v0.19.0
|
||||||
golang.org/x/tools v0.26.0
|
golang.org/x/tools v0.26.0
|
||||||
google.golang.org/api v0.191.0
|
google.golang.org/api v0.191.0
|
||||||
gopkg.in/yaml.v2 v2.4.0
|
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
@ -164,6 +164,7 @@ require (
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20240812133136-8ffd90a71988 // indirect
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20240812133136-8ffd90a71988 // indirect
|
||||||
google.golang.org/grpc v1.65.0 // indirect
|
google.golang.org/grpc v1.65.0 // indirect
|
||||||
google.golang.org/protobuf v1.34.2 // indirect
|
google.golang.org/protobuf v1.34.2 // indirect
|
||||||
|
gopkg.in/yaml.v2 v2.4.0 // indirect
|
||||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||||
howett.net/plist v1.0.0 // indirect
|
howett.net/plist v1.0.0 // indirect
|
||||||
software.sslmate.com/src/go-pkcs12 v0.2.0 // indirect
|
software.sslmate.com/src/go-pkcs12 v0.2.0 // indirect
|
||||||
|
|
2
go.sum
2
go.sum
|
@ -227,6 +227,8 @@ github.com/gobuffalo/flect v1.0.3 h1:xeWBM2nui+qnVvNM4S3foBhCAL2XgPU+a7FdpelbTq4
|
||||||
github.com/gobuffalo/flect v1.0.3/go.mod h1:A5msMlrHtLqh9umBSnvabjsMrCcCpAyzglnDvkbYKHs=
|
github.com/gobuffalo/flect v1.0.3/go.mod h1:A5msMlrHtLqh9umBSnvabjsMrCcCpAyzglnDvkbYKHs=
|
||||||
github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
|
github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y=
|
||||||
github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
|
github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8=
|
||||||
|
github.com/goccy/go-yaml v1.14.0 h1:G/NDXJvf1CX0FshjxKn2AOL0MnrxsSJNpY9FpvMRblw=
|
||||||
|
github.com/goccy/go-yaml v1.14.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
|
||||||
github.com/gohugoio/go-i18n/v2 v2.1.3-0.20230805085216-e63c13218d0e h1:QArsSubW7eDh8APMXkByjQWvuljwPGAGQpJEFn0F0wY=
|
github.com/gohugoio/go-i18n/v2 v2.1.3-0.20230805085216-e63c13218d0e h1:QArsSubW7eDh8APMXkByjQWvuljwPGAGQpJEFn0F0wY=
|
||||||
github.com/gohugoio/go-i18n/v2 v2.1.3-0.20230805085216-e63c13218d0e/go.mod h1:3Ltoo9Banwq0gOtcOwxuHG6omk+AwsQPADyw2vQYOJQ=
|
github.com/gohugoio/go-i18n/v2 v2.1.3-0.20230805085216-e63c13218d0e/go.mod h1:3Ltoo9Banwq0gOtcOwxuHG6omk+AwsQPADyw2vQYOJQ=
|
||||||
github.com/gohugoio/hashstructure v0.1.0 h1:kBSTMLMyTXbrJVAxaKI+wv30MMJJxn9Q8kfQtJaZ400=
|
github.com/gohugoio/hashstructure v0.1.0 h1:kBSTMLMyTXbrJVAxaKI+wv30MMJJxn9Q8kfQtJaZ400=
|
||||||
|
|
|
@ -40,7 +40,7 @@ Strings: {{ printf "%T" .Params.strings }} {{ range .Params.strings }}Strings: {
|
||||||
|
|
||||||
b.Build()
|
b.Build()
|
||||||
|
|
||||||
b.AssertFileContent("public/post/one/index.html", "Ints: []interface {} Int: 1 (int)|Int: 2 (int)|Int: 3 (int)|")
|
b.AssertFileContent("public/post/one/index.html", "Ints: []interface {} Int: 1 (uint64)|Int: 2 (uint64)|Int: 3 (uint64)|")
|
||||||
b.AssertFileContent("public/post/one/index.html", "Mixed: []interface {} Mixed: 1 (string)|Mixed: 2 (int)|Mixed: 3 (int)|")
|
b.AssertFileContent("public/post/one/index.html", "Mixed: []interface {} Mixed: 1 (string)|Mixed: 2 (uint64)|Mixed: 3 (uint64)|")
|
||||||
b.AssertFileContent("public/post/one/index.html", "Strings: []string Strings: 1 (string)|Strings: 2 (string)|Strings: 3 (string)|")
|
b.AssertFileContent("public/post/one/index.html", "Strings: []string Strings: 1 (string)|Strings: 2 (string)|Strings: 3 (string)|")
|
||||||
}
|
}
|
||||||
|
|
|
@ -476,7 +476,7 @@ line 5
|
||||||
errors := herrors.UnwrapFileErrorsWithErrorContext(err)
|
errors := herrors.UnwrapFileErrorsWithErrorContext(err)
|
||||||
|
|
||||||
b.Assert(errors, qt.HasLen, 3)
|
b.Assert(errors, qt.HasLen, 3)
|
||||||
b.Assert(errors[0].Error(), qt.Contains, filepath.FromSlash(`"/content/_index.md:1:1": "/layouts/_default/_markup/render-heading.html:2:5": execute of template failed`))
|
b.Assert(errors[0].Error(), qt.Contains, filepath.FromSlash(`"/content/_index.md:2:5": "/layouts/_default/_markup/render-heading.html:2:5": execute of template failed`))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestErrorRenderHookCodeblock(t *testing.T) {
|
func TestErrorRenderHookCodeblock(t *testing.T) {
|
||||||
|
@ -645,3 +645,35 @@ Home.
|
||||||
b.Assert(err.Error(), qt.Contains, filepath.FromSlash(`/layouts/index.html:2:3`))
|
b.Assert(err.Error(), qt.Contains, filepath.FromSlash(`/layouts/index.html:2:3`))
|
||||||
b.Assert(err.Error(), qt.Contains, `can't evaluate field ThisDoesNotExist`)
|
b.Assert(err.Error(), qt.Contains, `can't evaluate field ThisDoesNotExist`)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestErrorFrontmatterYAMLSyntax(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
files := `
|
||||||
|
-- hugo.toml --
|
||||||
|
-- content/_index.md --
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
line1: 'value1'
|
||||||
|
x
|
||||||
|
line2: 'value2'
|
||||||
|
line3: 'value3'
|
||||||
|
---
|
||||||
|
`
|
||||||
|
|
||||||
|
b, err := TestE(t, files)
|
||||||
|
|
||||||
|
b.Assert(err, qt.Not(qt.IsNil))
|
||||||
|
b.Assert(err.Error(), qt.Contains, "> 3 |")
|
||||||
|
fe := herrors.UnwrapFileError(err)
|
||||||
|
b.Assert(fe, qt.Not(qt.IsNil))
|
||||||
|
pos := fe.Position()
|
||||||
|
b.Assert(pos.Filename, qt.Contains, filepath.FromSlash("content/_index.md"))
|
||||||
|
b.Assert(fe.ErrorContext(), qt.Not(qt.IsNil))
|
||||||
|
b.Assert(pos.LineNumber, qt.Equals, 9)
|
||||||
|
b.Assert(pos.ColumnNumber, qt.Equals, 1)
|
||||||
|
}
|
||||||
|
|
|
@ -283,23 +283,20 @@ func (c *contentParseInfo) parseFrontMatter(it pageparser.Item, iter *pageparser
|
||||||
var err error
|
var err error
|
||||||
c.frontMatter, err = metadecoders.Default.UnmarshalToMap(it.Val(source), f)
|
c.frontMatter, err = metadecoders.Default.UnmarshalToMap(it.Val(source), f)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if fe, ok := err.(herrors.FileError); ok {
|
fe := herrors.UnwrapFileError(err)
|
||||||
pos := fe.Position()
|
if fe == nil {
|
||||||
|
fe = herrors.NewFileError(err)
|
||||||
// Offset the starting position of front matter.
|
|
||||||
offset := iter.LineNumber(source) - 1
|
|
||||||
if f == metadecoders.YAML {
|
|
||||||
offset -= 1
|
|
||||||
}
|
|
||||||
pos.LineNumber += offset
|
|
||||||
|
|
||||||
fe.UpdatePosition(pos)
|
|
||||||
fe.SetFilename("") // It will be set later.
|
|
||||||
|
|
||||||
return fe
|
|
||||||
} else {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
|
pos := fe.Position()
|
||||||
|
|
||||||
|
// Offset the starting position of front matter.
|
||||||
|
offset := iter.LineNumber(source) - 1
|
||||||
|
|
||||||
|
pos.LineNumber += offset
|
||||||
|
|
||||||
|
fe.UpdatePosition(pos)
|
||||||
|
fe.SetFilename("") // It will be set later.
|
||||||
|
return fe
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
|
|
|
@ -123,7 +123,7 @@ func (c *pagesCollector) Collect() (collectErr error) {
|
||||||
Handle: func(ctx context.Context, fi hugofs.FileMetaInfo) error {
|
Handle: func(ctx context.Context, fi hugofs.FileMetaInfo) error {
|
||||||
numPages, numResources, err := c.m.AddFi(fi, c.buildConfig)
|
numPages, numResources, err := c.m.AddFi(fi, c.buildConfig)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return hugofs.AddFileInfoToError(err, fi, c.fs)
|
return hugofs.AddFileInfoToError(err, fi, c.h.SourceFs)
|
||||||
}
|
}
|
||||||
numFilesProcessedTotal.Add(1)
|
numFilesProcessedTotal.Add(1)
|
||||||
numPagesProcessedTotal.Add(numPages)
|
numPagesProcessedTotal.Add(numPages)
|
||||||
|
|
|
@ -20,9 +20,9 @@ import (
|
||||||
|
|
||||||
"github.com/gohugoio/hugo/common/paths"
|
"github.com/gohugoio/hugo/common/paths"
|
||||||
|
|
||||||
|
yaml "github.com/goccy/go-yaml"
|
||||||
"github.com/gohugoio/hugo/common/herrors"
|
"github.com/gohugoio/hugo/common/herrors"
|
||||||
"golang.org/x/text/language"
|
"golang.org/x/text/language"
|
||||||
yaml "gopkg.in/yaml.v2"
|
|
||||||
|
|
||||||
"github.com/gohugoio/go-i18n/v2/i18n"
|
"github.com/gohugoio/go-i18n/v2/i18n"
|
||||||
"github.com/gohugoio/hugo/helpers"
|
"github.com/gohugoio/hugo/helpers"
|
||||||
|
|
|
@ -22,8 +22,6 @@ import (
|
||||||
|
|
||||||
toml "github.com/pelletier/go-toml/v2"
|
toml "github.com/pelletier/go-toml/v2"
|
||||||
|
|
||||||
yaml "gopkg.in/yaml.v2"
|
|
||||||
|
|
||||||
xml "github.com/clbanning/mxj/v2"
|
xml "github.com/clbanning/mxj/v2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -39,7 +37,7 @@ func InterfaceToConfig(in any, format metadecoders.Format, w io.Writer) error {
|
||||||
|
|
||||||
switch format {
|
switch format {
|
||||||
case metadecoders.YAML:
|
case metadecoders.YAML:
|
||||||
b, err := yaml.Marshal(in)
|
b, err := metadecoders.MarshalYAML(in)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2018 The Hugo Authors. All rights reserved.
|
// Copyright 2024 The Hugo Authors. All rights reserved.
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -28,10 +28,10 @@ import (
|
||||||
"github.com/niklasfasching/go-org/org"
|
"github.com/niklasfasching/go-org/org"
|
||||||
|
|
||||||
xml "github.com/clbanning/mxj/v2"
|
xml "github.com/clbanning/mxj/v2"
|
||||||
|
yaml "github.com/goccy/go-yaml"
|
||||||
toml "github.com/pelletier/go-toml/v2"
|
toml "github.com/pelletier/go-toml/v2"
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
"github.com/spf13/cast"
|
"github.com/spf13/cast"
|
||||||
yaml "gopkg.in/yaml.v2"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Decoder provides some configuration options for the decoders.
|
// Decoder provides some configuration options for the decoders.
|
||||||
|
@ -164,35 +164,7 @@ func (d Decoder) UnmarshalTo(data []byte, f Format, v any) error {
|
||||||
case TOML:
|
case TOML:
|
||||||
err = toml.Unmarshal(data, v)
|
err = toml.Unmarshal(data, v)
|
||||||
case YAML:
|
case YAML:
|
||||||
err = yaml.Unmarshal(data, v)
|
return yaml.Unmarshal(data, v)
|
||||||
if err != nil {
|
|
||||||
return toFileError(f, data, fmt.Errorf("failed to unmarshal YAML: %w", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
// To support boolean keys, the YAML package unmarshals maps to
|
|
||||||
// map[interface{}]interface{}. Here we recurse through the result
|
|
||||||
// and change all maps to map[string]interface{} like we would've
|
|
||||||
// gotten from `json`.
|
|
||||||
var ptr any
|
|
||||||
switch vv := v.(type) {
|
|
||||||
case *map[string]any:
|
|
||||||
ptr = *vv
|
|
||||||
case *any:
|
|
||||||
ptr = *vv
|
|
||||||
default:
|
|
||||||
// Not a map.
|
|
||||||
}
|
|
||||||
|
|
||||||
if ptr != nil {
|
|
||||||
if mm, changed := stringifyMapKeys(ptr); changed {
|
|
||||||
switch vv := v.(type) {
|
|
||||||
case *map[string]any:
|
|
||||||
*vv = mm.(map[string]any)
|
|
||||||
case *any:
|
|
||||||
*vv = mm
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case CSV:
|
case CSV:
|
||||||
return d.unmarshalCSV(data, v)
|
return d.unmarshalCSV(data, v)
|
||||||
|
|
||||||
|
@ -269,50 +241,3 @@ func (d Decoder) unmarshalORG(data []byte, v any) error {
|
||||||
func toFileError(f Format, data []byte, err error) error {
|
func toFileError(f Format, data []byte, err error) error {
|
||||||
return herrors.NewFileErrorFromName(err, fmt.Sprintf("_stream.%s", f)).UpdateContent(bytes.NewReader(data), nil)
|
return herrors.NewFileErrorFromName(err, fmt.Sprintf("_stream.%s", f)).UpdateContent(bytes.NewReader(data), nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
// stringifyMapKeys recurses into in and changes all instances of
|
|
||||||
// map[interface{}]interface{} to map[string]interface{}. This is useful to
|
|
||||||
// work around the impedance mismatch between JSON and YAML unmarshaling that's
|
|
||||||
// described here: https://github.com/go-yaml/yaml/issues/139
|
|
||||||
//
|
|
||||||
// Inspired by https://github.com/stripe/stripe-mock, MIT licensed
|
|
||||||
func stringifyMapKeys(in any) (any, bool) {
|
|
||||||
switch in := in.(type) {
|
|
||||||
case []any:
|
|
||||||
for i, v := range in {
|
|
||||||
if vv, replaced := stringifyMapKeys(v); replaced {
|
|
||||||
in[i] = vv
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case map[string]any:
|
|
||||||
for k, v := range in {
|
|
||||||
if vv, changed := stringifyMapKeys(v); changed {
|
|
||||||
in[k] = vv
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case map[any]any:
|
|
||||||
res := make(map[string]any)
|
|
||||||
var (
|
|
||||||
ok bool
|
|
||||||
err error
|
|
||||||
)
|
|
||||||
for k, v := range in {
|
|
||||||
var ks string
|
|
||||||
|
|
||||||
if ks, ok = k.(string); !ok {
|
|
||||||
ks, err = cast.ToStringE(k)
|
|
||||||
if err != nil {
|
|
||||||
ks = fmt.Sprintf("%v", k)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if vv, replaced := stringifyMapKeys(v); replaced {
|
|
||||||
res[ks] = vv
|
|
||||||
} else {
|
|
||||||
res[ks] = v
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return res, true
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
|
@ -14,7 +14,6 @@
|
||||||
package metadecoders
|
package metadecoders
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"reflect"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
qt "github.com/frankban/quicktest"
|
qt "github.com/frankban/quicktest"
|
||||||
|
@ -91,8 +90,8 @@ func TestUnmarshalToMap(t *testing.T) {
|
||||||
{`a = "b"`, TOML, expect},
|
{`a = "b"`, TOML, expect},
|
||||||
{`a: "b"`, YAML, expect},
|
{`a: "b"`, YAML, expect},
|
||||||
// Make sure we get all string keys, even for YAML
|
// Make sure we get all string keys, even for YAML
|
||||||
{"a: Easy!\nb:\n c: 2\n d: [3, 4]", YAML, map[string]any{"a": "Easy!", "b": map[string]any{"c": 2, "d": []any{3, 4}}}},
|
{"a: Easy!\nb:\n c: 2\n d: [3, 4]", YAML, map[string]any{"a": "Easy!", "b": map[string]any{"c": uint64(2), "d": []any{uint64(3), uint64(4)}}}},
|
||||||
{"a:\n true: 1\n false: 2", YAML, map[string]any{"a": map[string]any{"true": 1, "false": 2}}},
|
{"a:\n true: 1\n false: 2", YAML, map[string]any{"a": map[string]any{"true": uint64(1), "false": uint64(2)}}},
|
||||||
{`{ "a": "b" }`, JSON, expect},
|
{`{ "a": "b" }`, JSON, expect},
|
||||||
{`<root><a>b</a></root>`, XML, expect},
|
{`<root><a>b</a></root>`, XML, expect},
|
||||||
{`#+a: b`, ORG, expect},
|
{`#+a: b`, ORG, expect},
|
||||||
|
@ -137,7 +136,7 @@ func TestUnmarshalToInterface(t *testing.T) {
|
||||||
{[]byte(`a: "b"`), YAML, expect},
|
{[]byte(`a: "b"`), YAML, expect},
|
||||||
{[]byte(`<root><a>b</a></root>`), XML, expect},
|
{[]byte(`<root><a>b</a></root>`), XML, expect},
|
||||||
{[]byte(`a,b,c`), CSV, [][]string{{"a", "b", "c"}}},
|
{[]byte(`a,b,c`), CSV, [][]string{{"a", "b", "c"}}},
|
||||||
{[]byte("a: Easy!\nb:\n c: 2\n d: [3, 4]"), YAML, map[string]any{"a": "Easy!", "b": map[string]any{"c": 2, "d": []any{3, 4}}}},
|
{[]byte("a: Easy!\nb:\n c: 2\n d: [3, 4]"), YAML, map[string]any{"a": "Easy!", "b": map[string]any{"c": uint64(2), "d": []any{uint64(3), uint64(4)}}}},
|
||||||
// errors
|
// errors
|
||||||
{[]byte(`a = "`), TOML, false},
|
{[]byte(`a = "`), TOML, false},
|
||||||
} {
|
} {
|
||||||
|
@ -170,7 +169,7 @@ func TestUnmarshalStringTo(t *testing.T) {
|
||||||
{"32", int64(1234), int64(32)},
|
{"32", int64(1234), int64(32)},
|
||||||
{"32", int(1234), int(32)},
|
{"32", int(1234), int(32)},
|
||||||
{"3.14159", float64(1), float64(3.14159)},
|
{"3.14159", float64(1), float64(3.14159)},
|
||||||
{"[3,7,9]", []any{}, []any{3, 7, 9}},
|
{"[3,7,9]", []any{}, []any{uint64(3), uint64(7), uint64(9)}},
|
||||||
{"[3.1,7.2,9.3]", []any{}, []any{3.1, 7.2, 9.3}},
|
{"[3.1,7.2,9.3]", []any{}, []any{3.1, 7.2, 9.3}},
|
||||||
} {
|
} {
|
||||||
msg := qt.Commentf("%d: %T", i, test.to)
|
msg := qt.Commentf("%d: %T", i, test.to)
|
||||||
|
@ -185,128 +184,6 @@ func TestUnmarshalStringTo(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestStringifyYAMLMapKeys(t *testing.T) {
|
|
||||||
cases := []struct {
|
|
||||||
input any
|
|
||||||
want any
|
|
||||||
replaced bool
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
map[any]any{"a": 1, "b": 2},
|
|
||||||
map[string]any{"a": 1, "b": 2},
|
|
||||||
true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
map[any]any{"a": []any{1, map[any]any{"b": 2}}},
|
|
||||||
map[string]any{"a": []any{1, map[string]any{"b": 2}}},
|
|
||||||
true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
map[any]any{true: 1, "b": false},
|
|
||||||
map[string]any{"true": 1, "b": false},
|
|
||||||
true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
map[any]any{1: "a", 2: "b"},
|
|
||||||
map[string]any{"1": "a", "2": "b"},
|
|
||||||
true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
map[any]any{"a": map[any]any{"b": 1}},
|
|
||||||
map[string]any{"a": map[string]any{"b": 1}},
|
|
||||||
true,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
map[string]any{"a": map[string]any{"b": 1}},
|
|
||||||
map[string]any{"a": map[string]any{"b": 1}},
|
|
||||||
false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
[]any{map[any]any{1: "a", 2: "b"}},
|
|
||||||
[]any{map[string]any{"1": "a", "2": "b"}},
|
|
||||||
false,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for i, c := range cases {
|
|
||||||
res, replaced := stringifyMapKeys(c.input)
|
|
||||||
|
|
||||||
if c.replaced != replaced {
|
|
||||||
t.Fatalf("[%d] Replaced mismatch: %t", i, replaced)
|
|
||||||
}
|
|
||||||
if !c.replaced {
|
|
||||||
res = c.input
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(res, c.want) {
|
|
||||||
t.Errorf("[%d] given %q\nwant: %q\n got: %q", i, c.input, c.want, res)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkStringifyMapKeysStringsOnlyInterfaceMaps(b *testing.B) {
|
|
||||||
maps := make([]map[any]any, b.N)
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
maps[i] = map[any]any{
|
|
||||||
"a": map[any]any{
|
|
||||||
"b": 32,
|
|
||||||
"c": 43,
|
|
||||||
"d": map[any]any{
|
|
||||||
"b": 32,
|
|
||||||
"c": 43,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"b": []any{"a", "b"},
|
|
||||||
"c": "d",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
b.ResetTimer()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
stringifyMapKeys(maps[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkStringifyMapKeysStringsOnlyStringMaps(b *testing.B) {
|
|
||||||
m := map[string]any{
|
|
||||||
"a": map[string]any{
|
|
||||||
"b": 32,
|
|
||||||
"c": 43,
|
|
||||||
"d": map[string]any{
|
|
||||||
"b": 32,
|
|
||||||
"c": 43,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
"b": []any{"a", "b"},
|
|
||||||
"c": "d",
|
|
||||||
}
|
|
||||||
|
|
||||||
b.ResetTimer()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
stringifyMapKeys(m)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkStringifyMapKeysIntegers(b *testing.B) {
|
|
||||||
maps := make([]map[any]any, b.N)
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
maps[i] = map[any]any{
|
|
||||||
1: map[any]any{
|
|
||||||
4: 32,
|
|
||||||
5: 43,
|
|
||||||
6: map[any]any{
|
|
||||||
7: 32,
|
|
||||||
8: 43,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
2: []any{"a", "b"},
|
|
||||||
3: "d",
|
|
||||||
}
|
|
||||||
}
|
|
||||||
b.ResetTimer()
|
|
||||||
for i := 0; i < b.N; i++ {
|
|
||||||
stringifyMapKeys(maps[i])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func BenchmarkDecodeYAMLToMap(b *testing.B) {
|
func BenchmarkDecodeYAMLToMap(b *testing.B) {
|
||||||
d := Default
|
d := Default
|
||||||
|
|
||||||
|
|
25
parser/metadecoders/encoder.go
Normal file
25
parser/metadecoders/encoder.go
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
// Copyright 2024 The Hugo Authors. All rights reserved.
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package metadecoders
|
||||||
|
|
||||||
|
import yaml "github.com/goccy/go-yaml"
|
||||||
|
|
||||||
|
var yamlEncodeOptions = []yaml.EncodeOption{
|
||||||
|
yaml.UseSingleQuote(true),
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalYAML marshals the given value to YAML.
|
||||||
|
var MarshalYAML = func(v any) ([]byte, error) {
|
||||||
|
return yaml.MarshalWithOptions(v, yamlEncodeOptions...)
|
||||||
|
}
|
|
@ -8,7 +8,7 @@ waitServer
|
||||||
httpget ${HUGOTEST_BASEURL_0}p1/ 'Title: P1'
|
httpget ${HUGOTEST_BASEURL_0}p1/ 'Title: P1'
|
||||||
|
|
||||||
replace $WORK/content/p1/index.md 'title:' 'titlecolon'
|
replace $WORK/content/p1/index.md 'title:' 'titlecolon'
|
||||||
httpget ${HUGOTEST_BASEURL_0}p1/ 'failed'
|
httpget ${HUGOTEST_BASEURL_0}p1/ 'Error'
|
||||||
|
|
||||||
replace $WORK/content/p1/index.md 'titlecolon' 'title:'
|
replace $WORK/content/p1/index.md 'titlecolon' 'title:'
|
||||||
httpget ${HUGOTEST_BASEURL_0}p1/ 'Title: P1'
|
httpget ${HUGOTEST_BASEURL_0}p1/ 'Title: P1'
|
||||||
|
|
Loading…
Reference in a new issue