Skip to content

Commit

Permalink
chore: more renames
Browse files Browse the repository at this point in the history
  • Loading branch information
ernado committed Mar 27, 2023
1 parent 98da9dd commit cbdfef6
Show file tree
Hide file tree
Showing 14 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# yamlx [![](https://img.shields.io/badge/go-pkg-00ADD8)](https://pkg.go.dev/github.com/go-faster/yamlx#section-documentation) [![](https://img.shields.io/codecov/c/github/go-faster/yamlx?label=cover)](https://codecov.io/gh/go-faster/yamlx) [![experimental](https://img.shields.io/badge/-experimental-blueviolet)](https://go-faster.org/docs/projects/status#experimental)
# yamlx [![](https://img.shields.io/badge/go-pkg-00ADD8)](https://pkg.go.dev/github.com/go-faster/yaml#section-documentation) [![](https://img.shields.io/codecov/c/github/go-faster/yamlx?label=cover)](https://codecov.io/gh/go-faster/yamlx) [![experimental](https://img.shields.io/badge/-experimental-blueviolet)](https://go-faster.org/docs/projects/status#experimental)

`yamlx` is a YAML parser for Go. It is a fork of [`yaml`](https://github.com/go-yaml/yaml) that adds some features
to make it more useful for `go-faster` purposes, including better error reporting and performance.
Expand Down Expand Up @@ -28,11 +28,11 @@ supported since they're a poor design and are gone in YAML 1.2.

## Installation and usage

The import path for the package is `github.com/go-faster/yamlx`.
The import path for the package is `github.com/go-faster/yaml`.

To install it, run:

go get github.com/go-faster/yamlx
go get github.com/go-faster/yaml

## API stability

Expand All @@ -48,7 +48,7 @@ import (
"fmt"
"log"

"github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

var data = `
Expand Down
4 changes: 2 additions & 2 deletions decode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import (

"github.com/go-faster/errors"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

var unmarshalIntTest = 123
Expand Down Expand Up @@ -1469,7 +1469,7 @@ var unmarshalErrorTests = []struct {
// Invalid indentation (unexpected tab).
{"- >\n \t\n\tdetected\n", "yaml: line 3: found a tab character where an indentation space is expected"},

// https://github.com/go-faster/yamlx/issues/20
// https://github.com/go-faster/yaml/issues/20
{"0:\n00:\n 000\n<<:\n {}:", `yaml: line 5: invalid map key: map\[string\]interface \{\}\{\}`},
{"0:\n00:\n 000\n<<:\n []:", `yaml: line 5: invalid map key: \[\]interface \{\}\{\}`},
{"{}:", `yaml: line 1: invalid map key: map\[string\]interface \{\}\{\}`},
Expand Down
4 changes: 2 additions & 2 deletions encode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import (

"github.com/go-faster/errors"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

var marshalIntTest = 123
Expand Down Expand Up @@ -171,7 +171,7 @@ var marshalTests = []struct {
// Ensure correct indentation.
//
// https://github.com/go-yaml/yaml/issues/643
// https://github.com/go-faster/yamlx/issues/8
// https://github.com/go-faster/yaml/issues/8
{
[]string{" hello\nworld"},
"- |4-\n hello\n world\n",
Expand Down
2 changes: 1 addition & 1 deletion example_embedded_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
"fmt"
"log"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

// An example showing how to unmarshal embedded
Expand Down
4 changes: 2 additions & 2 deletions fuzz_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (

"github.com/stretchr/testify/require"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

func addFuzzingCorpus(add func(data []byte)) {
Expand All @@ -32,7 +32,7 @@ func addFuzzingCorpus(add func(data []byte)) {
"? \ufeff: \ufeff\n",

"scalar: >\n next\n line\n * one\n",
// https://github.com/go-faster/yamlx/issues/8
// https://github.com/go-faster/yaml/issues/8
"0:\n #00\n - |1 \n 00",
}

Expand Down
2 changes: 1 addition & 1 deletion json_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (

"github.com/go-faster/jx"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

//go:embed testdata/json_suite
Expand Down
2 changes: 1 addition & 1 deletion json_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

"github.com/go-faster/jx"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

func TestNode_EncodeJSON(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion limit_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (

"github.com/stretchr/testify/require"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

var limitTests = []struct {
Expand Down
2 changes: 1 addition & 1 deletion marshal_bench_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"io"
"testing"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

func generateInput() any {
Expand Down
2 changes: 1 addition & 1 deletion node_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import (

"github.com/stretchr/testify/require"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

var nodeTests = []struct {
Expand Down
2 changes: 1 addition & 1 deletion unmarshal_bench_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (

"github.com/stretchr/testify/require"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

func BenchmarkUnmarshal(b *testing.B) {
Expand Down
2 changes: 1 addition & 1 deletion unmarshal_fuzz_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package yaml_test
import (
"testing"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

func FuzzUnmarshal(f *testing.F) {
Expand Down
2 changes: 1 addition & 1 deletion yaml.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
//
// Source code and other details for the project are available at GitHub:
//
// https://github.com/go-faster/yamlx
// https://github.com/go-faster/yaml
package yaml

import (
Expand Down
2 changes: 1 addition & 1 deletion yaml_suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (

"github.com/go-faster/jx"

yaml "github.com/go-faster/yamlx"
"github.com/go-faster/yaml"
)

//go:embed testdata/yaml_suite
Expand Down

0 comments on commit cbdfef6

Please sign in to comment.