Dasel V3

.github/ISSUE_TEMPLATE/bug_report.md

@@ -31,7 +31,7 @@ If applicable, add screenshots to help explain your problem.
 **Desktop (please complete the following information):**
 
 - OS: [e.g. iOS]
-- Version [e.g. 22] (`dasel --version`)
+- Version [e.g. 22] (`dasel version`)
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/build-dev.yaml

@@ -69,7 +69,7 @@ jobs:
       - name: Set env
         run: echo RELEASE_VERSION=development >> $GITHUB_ENV
       - name: Build
-        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -o target/release/${{ matrix.artifact_name }} -ldflags="-X 'github.com/tomwright/dasel/v2/internal.Version=${{ env.RELEASE_VERSION }}'" ./cmd/dasel
+        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -o target/release/${{ matrix.artifact_name }} -ldflags="-X 'github.com/tomwright/dasel/v3/internal.Version=${{ env.RELEASE_VERSION }}'" ./cmd/dasel
       - name: Test version
         if: matrix.test_version == true
-        run: ./target/release/${{ matrix.artifact_name }} --version
+        run: ./target/release/${{ matrix.artifact_name }} version

.github/workflows/build-test.yaml

@@ -76,16 +76,16 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v4
-        with:
+        with
           go-version: '^1.24.0' # The Go version to download (if necessary) and use.
       - name: Set env
         run: echo RELEASE_VERSION=development >> $GITHUB_ENV
       - name: Build
-        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -o target/release/${{ matrix.artifact_name }} -ldflags="-X 'github.com/tomwright/dasel/v2/internal.Version=${{ env.RELEASE_VERSION }}'" ./cmd/dasel
+        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -o target/release/${{ matrix.artifact_name }} -ldflags="-X 'github.com/tomwright/dasel/v3/internal.Version=${{ env.RELEASE_VERSION }}'" ./cmd/dasel
       - name: Test version
         if: matrix.test_version == true
-        run: ./target/release/${{ matrix.artifact_name }} --version
+        run: ./target/release/${{ matrix.artifact_name }} version
       - name: Test execution
         if: matrix.test_execution == true
         run: |
-          echo '{"hello": "World"}' | ./target/release/${{ matrix.artifact_name }} -r json 'hello'
+          echo '{"hello": "World"}' | ./target/release/${{ matrix.artifact_name }} -i json 'hello'

.github/workflows/build.yaml

@@ -77,10 +77,10 @@ jobs:
       - name: Set env
         run: echo RELEASE_VERSION=${GITHUB_REF:10} >> $GITHUB_ENV
       - name: Build
-        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -o target/release/${{ matrix.artifact_name }} -ldflags="-X 'github.com/tomwright/dasel/v2/internal.Version=${{ env.RELEASE_VERSION }}'" ./cmd/dasel
+        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} CGO_ENABLED=0 go build -o target/release/${{ matrix.artifact_name }} -ldflags="-X 'github.com/tomwright/dasel/v3/internal.Version=${{ env.RELEASE_VERSION }}'" ./cmd/dasel
       - name: Test version
         if: matrix.test_version == true
-        run: ./target/release/${{ matrix.artifact_name }} --version
+        run: ./target/release/${{ matrix.artifact_name }} version
       - name: Gzip binaries
         run: gzip -c ./target/release/${{ matrix.artifact_name }} > ./target/release/${{ matrix.artifact_name }}.gz
       - name: Upload binaries to release

.github/workflows/container.yaml

@@ -42,7 +42,7 @@ jobs:
             tags: dasel:test
         - name: Test
           run: |
-            echo '{"hello": "World"}' | docker run -i --rm dasel:test -r json 'hello'
+            echo '{"hello": "World"}' | docker run -i --rm dasel:test -i json 'hello'
         - name: Set version tag variables
           if: ${{ steps.version.outputs.is_valid == 'true' }}
           run: |

CHANGELOG.md

@@ -154,7 +154,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Changed go module to `github.com/tomwright/dasel/v2` to ensure it works correctly with go modules.
+- Changed go module to `github.com/tomwright/dasel/v3` to ensure it works correctly with go modules.
 
 ## [v2.1.0] - 2023-01-11
 

README.md

@@ -1,8 +1,8 @@
 # dasel
 
 [![Gitbook](https://badges.aleen42.com/src/gitbook_1.svg)](https://daseldocs.tomwright.me)
-[![Go Report Card](https://goreportcard.com/badge/github.com/TomWright/dasel/v2)](https://goreportcard.com/report/github.com/TomWright/dasel/v2)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/tomwright/dasel)](https://pkg.go.dev/github.com/tomwright/dasel/v2)
+[![Go Report Card](https://goreportcard.com/badge/github.com/tomwright/dasel/v3)](https://goreportcard.com/report/github.com/tomwright/dasel/v3)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/tomwright/dasel)](https://pkg.go.dev/github.com/tomwright/dasel/v3)
 ![Test](https://github.com/TomWright/dasel/workflows/Test/badge.svg)
 ![Build](https://github.com/TomWright/dasel/workflows/Build/badge.svg)
 [![codecov](https://codecov.io/gh/TomWright/dasel/branch/master/graph/badge.svg)](https://codecov.io/gh/TomWright/dasel)
@@ -75,7 +75,7 @@ brew install dasel
 You can also install a [development version](https://daseldocs.tomwright.me/installation#development-version) with:
 
 ```bash
-go install github.com/tomwright/dasel/v2/cmd/dasel@master
+go install github.com/tomwright/dasel/v3/cmd/dasel@master
 ```
 
 For more information see the [installation documentation](https://daseldocs.tomwright.me/installation).
@@ -181,7 +181,7 @@ Please [open a discussion](https://github.com/TomWright/dasel/discussions) if:
 - Uses a [standard query/selector syntax](https://daseldocs.tomwright.me/functions/selector-overview) across all data formats.
 - Zero runtime dependencies.
 - [Available on Linux, Mac and Windows](https://daseldocs.tomwright.me/installation).
-- Available to [import and use in your own projects](https://pkg.go.dev/github.com/tomwright/dasel/v2).
+- Available to [import and use in your own projects](https://pkg.go.dev/github.com/tomwright/dasel/v3).
 - [Run via Docker](https://daseldocs.tomwright.me/installation#docker).
 - [Faster than jq/yq](#benchmarks).
 - [Pre-commit hooks](#pre-commit).

api.go

@@ -0,0 +1,55 @@
+// Package dasel contains everything you'll need to use dasel from a go application.
+package dasel
+
+import (
+	"github.com/tomwright/dasel/v3/execution"
+	"github.com/tomwright/dasel/v3/model"
+)
+
+// Query queries the data using the selector and returns the results.
+func Query(data any, selector string, opts ...execution.ExecuteOptionFn) ([]*model.Value, int, error) {
+	options := execution.NewOptions(opts...)
+	val := model.NewValue(data)
+	out, err := execution.ExecuteSelector(selector, val, options)
+	if err != nil {
+		return nil, 0, err
+	}
+
+	if out.IsBranch() {
+		res := make([]*model.Value, 0)
+		if err := out.RangeSlice(func(i int, v *model.Value) error {
+			res = append(res, v)
+			return nil
+		}); err != nil {
+			return nil, 0, err
+		}
+		return res, len(res), nil
+	}
+
+	return []*model.Value{out}, 1, nil
+}
+
+func Select(data any, selector string, opts ...execution.ExecuteOptionFn) (any, int, error) {
+	res, count, err := Query(data, selector, opts...)
+	if err != nil {
+		return nil, 0, err
+	}
+	out := make([]any, 0)
+	for _, v := range res {
+		out = append(out, v.Interface())
+	}
+	return out, count, err
+}
+
+func Modify(data any, selector string, newValue any, opts ...execution.ExecuteOptionFn) (int, error) {
+	res, count, err := Query(data, selector, opts...)
+	if err != nil {
+		return 0, err
+	}
+	for _, v := range res {
+		if err := v.Set(model.NewValue(newValue)); err != nil {
+			return 0, err
+		}
+	}
+	return count, nil
+}

api_test.go

@@ -0,0 +1,48 @@
+package dasel_test
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/tomwright/dasel/v3"
+)
+
+type modifyTestCase struct {
+	selector string
+	in       any
+	value    any
+	exp      any
+	count    int
+}
+
+func (tc modifyTestCase) run(t *testing.T) {
+	count, err := dasel.Modify(&tc.in, tc.selector, tc.value)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if count != tc.count {
+		t.Errorf("unexpected count: %d", count)
+	}
+	if !cmp.Equal(tc.exp, tc.in) {
+		t.Errorf("unexpected result: %s", cmp.Diff(tc.exp, tc.in))
+	}
+}
+
+func TestModify(t *testing.T) {
+	t.Run("index", func(t *testing.T) {
+		t.Run("int over int", modifyTestCase{
+			selector: "$this[1]",
+			in:       []int{1, 2, 3},
+			value:    4,
+			exp:      []int{1, 4, 3},
+			count:    1,
+		}.run)
+		t.Run("string over int", modifyTestCase{
+			selector: "$this[1]",
+			in:       []any{1, 2, 3},
+			value:    "4",
+			exp:      []any{1, "4", 3},
+			count:    1,
+		}.run)
+	})
+}