it works!

Bumps [github.com/goccy/go-yaml](https://github.com/goccy/go-yaml) from 1.9.4 to 1.9.5.
- [Release notes](https://github.com/goccy/go-yaml/releases)
- [Changelog](https://github.com/goccy/go-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/goccy/go-yaml/compare/v1.9.4...v1.9.5)

---
updated-dependencies:
- dependency-name: github.com/goccy/go-yaml
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.dockerignore

@@ -1 +1 @@
-bin
+bin/*

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: mikefarah

.github/ISSUE_TEMPLATE/bug_report_v3.md

@@ -1,8 +1,8 @@
 ---
-name: Bug report
+name: Bug report - V3
 about: Create a report to help us improve
 title: ''
-labels: bug
+labels: bug, v3
 assignees: ''
 
 ---
@@ -10,11 +10,14 @@ assignees: ''
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-version of yq: 
-operating system:
+Note that any how to questions should be posted in the discussion board and not raised as an issue.
+
+Version of yq: 3.X.X
+Operating system: mac/linux/windows/....
+Installed via: docker/binary release/homebrew/snap/...
 
 **Input Yaml**
-Concise yaml document(s) (as simple as possible to show the bug)
+Concise yaml document(s) (as simple as possible to show the bug, please keep it to 10 lines or less)
 data1.yml:
 ```yaml
 this: should really work

.github/ISSUE_TEMPLATE/bug_report_v4.md

@@ -0,0 +1,51 @@
+---
+name: Bug report - V4
+about: Create a report to help us improve
+title: ''
+labels: bug, v4
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+Note that any how to questions should be posted in the discussion board and not raised as an issue.
+
+Version of yq: 4.X.X
+Operating system: mac/linux/windows/....
+Installed via: docker/binary release/homebrew/snap/...
+
+**Input Yaml**
+Concise yaml document(s) (as simple as possible to show the bug, please keep it to 10 lines or less)
+data1.yml:
+```yaml
+this: should really work
+```
+
+data2.yml:
+```yaml
+but: it strangely didn't
+```
+
+**Command**
+The command you ran:
+```
+yq eval-all 'select(fileIndex==0) | .a.b.c' data1.yml data2.yml
+```
+
+**Actual behavior**
+
+```yaml
+cat: meow
+```
+
+**Expected behavior**
+
+```yaml
+this: should really work
+but: it strangely didn't
+```
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,23 @@
 ---
-name: Feature request
+name: Feature request - V4
 about: Suggest an idea for this project
 title: ''
-labels: enhancement
+labels: enhancement, v4
 assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Please describe your feature request.**
+A clear and concise description of what the request is and what it would solve. 
+Eg. I wish I could use yq to [...]
+
+Note:
+- how to questions should be posted in the discussion board and not raised as an issue.
+- V3 will no longer have any enhancements.
 
 **Describe the solution you'd like**
 If we have data1.yml like:
+(please keep to around 10 lines )
 
 ```yaml
 country: Australia
@@ -20,7 +26,7 @@ country: Australia
 And we run a command:
 
 ```bash
-yq predictWeather data1.yml
+yq eval 'predictWeatherOf(.country)'
 ```
 
 it could output

.github/dependabot.yml

@@ -0,0 +1,22 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: docker
+    directory: /
+    schedule:
+      day: thursday
+      interval: weekly
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      day: thursday
+      interval: weekly
+  - package-ecosystem: gomod
+    directory: /
+    schedule:
+      day: thursday
+      interval: weekly

.github/workflows/go.yml

@@ -1,5 +1,5 @@
 name: Build
-on: [push]
+on: [push, pull_request]
 jobs:
 
   build:
@@ -7,10 +7,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - name: Set up Go 1.15
-      uses: actions/setup-go@v1
+    - name: Set up Go 1.17
+      uses: actions/setup-go@v2
       with:
-        go-version: 1.15
+        go-version: 1.17
       id: go
 
     - name: Check out code into the Go module directory
@@ -24,11 +24,8 @@ jobs:
             dep ensure
         fi
 
-    - name: Download deps
+    - name: Check the build
       run: |
         export PATH=${PATH}:`go env GOPATH`/bin
         scripts/devtools.sh
-    - name: Build
-      run: |
-        export PATH=${PATH}:`go env GOPATH`/bin
-        make local build
+        make local build

.github/workflows/release.yml

@@ -0,0 +1,110 @@
+name: Release YQ
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publishGitRelease:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.17.5'
+      - name: Compile man page markup
+        id: gen-man-page-md
+        run: |
+          ./scripts/generate-man-page-md.sh
+          echo "::set-output name=man-page-md::man.md"
+
+      - name: Get the version
+        id: get_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF##*/}
+
+      - name: Generate man page
+        uses: docker://pandoc/core:2.14.2
+        id: gen-man-page
+        with:
+          args: >-
+            --standalone
+            --to man
+            --variable=title:"YQ"
+            --variable=section:"1"
+            --variable=header:"yq (https://github.com/mikefarah/yq/) version ${{ steps.get_version.outputs.VERSION }}"
+            --variable=author:"Mike Farah"
+            --output=yq.1
+            ${{ steps.gen-man-page-md.outputs.man-page-md }}
+
+      - name: Cross compile
+        run: |
+          sudo apt-get install rhash -y
+          go get github.com/mitchellh/gox
+          mkdir -p build
+          cp yq.1 build/yq.1
+          ./scripts/xcompile.sh
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1.1.4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: true
+          prerelease: false
+
+      - uses: shogo82148/actions-upload-release-asset@v1
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: build/*
+
+  publishDocker:
+    environment: dockerhub
+    env:
+      IMAGE_NAME: mikefarah/yq
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+        with:
+          platforms: all
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+        with:
+          version: latest
+
+      - name: Available platforms
+        run: echo ${{ steps.buildx.outputs.platforms }} && docker version
+
+      - name: Build and push image
+        run: |
+          IMAGE_V_VERSION="$(git describe --tags --abbrev=0)"
+          IMAGE_VERSION=${IMAGE_V_VERSION:1}
+          PLATFORMS="linux/amd64,linux/ppc64le,linux/arm64"
+
+          echo "Building and pushing version ${IMAGE_VERSION} of image ${IMAGE_NAME}"
+          echo '${{ secrets.DOCKER_PASSWORD }}' | docker login -u '${{ secrets.DOCKER_USERNAME }}' --password-stdin
+          docker buildx build \
+            --label "org.opencontainers.image.authors=https://github.com/mikefarah/yq/graphs/contributors" \
+            --label "org.opencontainers.image.created=$(date --rfc-3339=seconds)" \
+            --label "org.opencontainers.image.description=yq is a portable command-line YAML processor" \
+            --label "org.opencontainers.image.documentation=https://mikefarah.gitbook.io/yq/" \
+            --label "org.opencontainers.image.licenses=MIT" \
+            --label "org.opencontainers.image.revision=$(git rev-parse HEAD)" \
+            --label "org.opencontainers.image.source=https://github.com/mikefarah/yq" \
+            --label "org.opencontainers.image.title=yq" \
+            --label "org.opencontainers.image.url=https://mikefarah.gitbook.io/yq/" \
+            --label "org.opencontainers.image.version=${IMAGE_VERSION}" \
+            --platform "${PLATFORMS}" \
+            --pull \
+            --push \
+            -t "${IMAGE_NAME}:${IMAGE_VERSION}" \
+            -t "${IMAGE_NAME}:4" \
+            -t "${IMAGE_NAME}:latest" \
+            .

.github/workflows/test-yq.yml

@@ -0,0 +1,19 @@
+name: Test Yq Action
+on: [push]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get test
+        uses: mikefarah/yq@master
+        with:
+          cmd: yq eval '.a' examples/sample.yaml
+      - name: Write inplace test
+        id: lookupSdkVersion
+        uses: mikefarah/yq@master
+        with:
+          cmd: yq eval -i '.b.c = 5' examples/sample.yaml

.gitignore

@@ -38,3 +38,18 @@ parts/
 prime/
 .snapcraft/
 yq*.snap
+
+test.yml
+test*.yml
+0.yml
+1.yml
+2.yml
+
+
+# man page
+man.md
+yq.1
+
+# debian pkg
+_build
+debian/files

.golangci.yml

@@ -0,0 +1,32 @@
+run:
+  timeout: 5m
+linters:
+  enable:
+    - asciicheck
+    - depguard
+    - errorlint
+    - gci
+    - gochecknoinits
+    - gofmt
+    - goimports
+    - gosec
+    - megacheck
+    - misspell
+    - nakedret
+    - nolintlint
+    - predeclared
+    - revive
+    - unconvert
+    - unparam
+issues:
+  exclude-rules:
+  - linters:
+    - gosec
+    text:  "Implicit memory aliasing in for loop."
+    path: _test\.go
+  - linters:
+    - revive
+    text: "unexported-return"
+  - linters:
+    - revive
+    text: "var-naming"

Dockerfile

@@ -1,23 +1,28 @@
-FROM golang:1.15 as builder
+FROM golang:1.17 as builder
 
 WORKDIR /go/src/mikefarah/yq
 
-# cache devtools
-COPY ./scripts/devtools.sh /go/src/mikefarah/yq/scripts/devtools.sh
-RUN ./scripts/devtools.sh
+COPY . .
 
-COPY . /go/src/mikefarah/yq
-
-RUN CGO_ENABLED=0 make local build
+RUN CGO_ENABLED=0 go build .
+# RUN ./scripts/test.sh -- this too often times out in the github pipeline.
+RUN ./scripts/acceptance.sh
 
 # Choose alpine as a base image to make this useful for CI, as many
 # CI tools expect an interactive shell inside the container
-FROM alpine:3.8 as production
+FROM alpine:3 as production
+LABEL maintainer="Mike Farah <mikefarah@users.noreply.github.com>"
 
 COPY --from=builder /go/src/mikefarah/yq/yq /usr/bin/yq
-RUN chmod +x /usr/bin/yq
-
-ARG VERSION=none
-LABEL version=${VERSION}
 
 WORKDIR /workdir
+
+RUN set -eux; \
+  addgroup -g 1000 yq; \
+  adduser -u 1000 -G yq -s /bin/sh -h /home/yq -D yq
+
+RUN chown -R yq:yq /workdir
+
+USER yq
+
+ENTRYPOINT ["/usr/bin/yq"]

Dockerfile.dev

@@ -1,30 +1,10 @@
-FROM golang:1.15
+FROM golang:1.17
 
 COPY scripts/devtools.sh /opt/devtools.sh
 
 RUN set -e -x \
     && /opt/devtools.sh
-
-# install mkdocs
-RUN set -ex \
-    && buildDeps=' \
-        build-essential \
-        python3-dev \
-    ' \
-    && apt-get update && apt-get install -y --no-install-recommends \
-        $buildDeps \
-        python3 \
-        python3-setuptools \
-        python3-wheel \
-        python3-pip \
-    && pip3 install --upgrade \
-        pip \
-        'Markdown>=2.6.9' \
-        'mkdocs>=0.16.3' \
-        'mkdocs-material>=1.10.1' \
-        'markdown-include>=0.5.1' \
-    && apt-get purge -y --auto-remove $buildDeps \
-    && rm -rf /var/lib/apt/lists/*
+ENV PATH=/go/bin:$PATH
 
 ENV CGO_ENABLED 0
 ENV GOPATH /go:/yq

LICENSE

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2017 Mike Farah
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

Makefile

@@ -2,6 +2,7 @@ MAKEFLAGS += --warn-undefined-variables
 SHELL := /bin/bash
 .SHELLFLAGS := -o pipefail -euc
 .DEFAULT_GOAL := install
+ENGINE := $(shell { command -v podman || command -v docker; } 2>/dev/null)
 
 include Makefile.variables
 
@@ -17,6 +18,7 @@ help:
 	@echo '    make vendor          Install dependencies to vendor directory.'
 	@echo '    make format          Run code formatter.'
 	@echo '    make check           Run static code analysis (lint).'
+	@echo '    make secure          Run gosec.'
 	@echo '    make test            Run tests on project.'
 	@echo '    make cover           Run tests and capture code coverage metrics on project.'
 	@echo '    make clean           Clean the directory tree of produced artifacts.'
@@ -32,7 +34,7 @@ clean:
 
 ## prefix before other make targets to run in your local dev environment
 local: | quiet
-	@$(eval DOCKRUN= )
+	@$(eval ENGINERUN= )
 	@mkdir -p tmp
 	@touch tmp/dev_image_id
 quiet: # this is silly but shuts up 'Nothing to be done for `local`'
@@ -41,9 +43,9 @@ quiet: # this is silly but shuts up 'Nothing to be done for `local`'
 prepare: tmp/dev_image_id
 tmp/dev_image_id: Dockerfile.dev scripts/devtools.sh
 	@mkdir -p tmp
-	@docker rmi -f ${DEV_IMAGE} > /dev/null 2>&1 || true
-	@docker build -t ${DEV_IMAGE} -f Dockerfile.dev .
-	@docker inspect -f "{{ .ID }}" ${DEV_IMAGE} > tmp/dev_image_id
+	@${ENGINE} rmi -f ${DEV_IMAGE} > /dev/null 2>&1 || true
+	@${ENGINE} build -t ${DEV_IMAGE} -f Dockerfile.dev .
+	@${ENGINE} inspect -f "{{ .ID }}" ${DEV_IMAGE} > tmp/dev_image_id
 
 # ----------------------------------------------
 # build
@@ -53,58 +55,61 @@ build: build/dev
 .PHONY: build/dev
 build/dev: test *.go
 	@mkdir -p bin/
-	${DOCKRUN} go build --ldflags "$(LDFLAGS)"
-	${DOCKRUN} bash ./scripts/acceptance.sh
+	${ENGINERUN} go build --ldflags "$(LDFLAGS)"
+	${ENGINERUN} bash ./scripts/acceptance.sh
 
 ## Compile the project for multiple OS and Architectures.
 xcompile: check
 	@rm -rf build/
 	@mkdir -p build
-	${DOCKRUN} bash ./scripts/xcompile.sh
+	${ENGINERUN} bash ./scripts/xcompile.sh
 	@find build -type d -exec chmod 755 {} \; || :
 	@find build -type f -exec chmod 755 {} \; || :
 
 .PHONY: install
 install: build
-	${DOCKRUN} go install
+	${ENGINERUN} go install
 
 # Each of the fetch should be an entry within vendor.json; not currently included within project
 .PHONY: vendor
 vendor: tmp/dev_image_id
-	${DOCKRUN} go mod vendor
+	@mkdir -p vendor
+	${ENGINERUN} go mod vendor
 
 # ----------------------------------------------
 # develop and test
 
 .PHONY: format
 format: vendor
-	${DOCKRUN} bash ./scripts/format.sh
+	${ENGINERUN} bash ./scripts/format.sh
+
+
+.PHONY: secure
+secure: format
+	${ENGINERUN} bash ./scripts/secure.sh
 
 .PHONY: check
-check: format
-	${DOCKRUN} bash ./scripts/check.sh
+check: secure
+	${ENGINERUN} bash ./scripts/check.sh
+
+
 
 .PHONY: test
 test: check
-	${DOCKRUN} bash ./scripts/test.sh
+	${ENGINERUN} bash ./scripts/test.sh
 
 .PHONY: cover
 cover: check
 	@rm -rf cover/
 	@mkdir -p cover
-	${DOCKRUN} bash ./scripts/coverage.sh
+	${ENGINERUN} bash ./scripts/coverage.sh
 	@find cover -type d -exec chmod 755 {} \; || :
 	@find cover -type f -exec chmod 644 {} \; || :
 
-.PHONY: build-docs
-build-docs: prepare mkdocs.yml mkdocs/*
-	${DOCKRUN} mkdocs build
-	@find docs -type d -exec chmod 755 {} \; || :
-	@find docs -type f -exec chmod 644 {} \; || :
 
 .PHONY: release
 release: xcompile
-	${DOCKRUN} bash ./scripts/publish.sh
+	${ENGINERUN} bash ./scripts/publish.sh
 
 # ----------------------------------------------
 # utilities

Makefile.variables

@@ -29,7 +29,7 @@ endif
 
 DEV_IMAGE := ${PROJECT}_dev
 
-DOCKRUN := docker run --rm \
+ENGINERUN := ${ENGINE} run --rm \
 	-e LDFLAGS="${LDFLAGS}" \
 	-e GITHUB_TOKEN="${GITHUB_TOKEN}" \
 	-v ${ROOT}/vendor:/go/src \

README.md

@@ -3,38 +3,77 @@
 ![Build](https://github.com/mikefarah/yq/workflows/Build/badge.svg)  ![Docker Pulls](https://img.shields.io/docker/pulls/mikefarah/yq.svg) ![Github Releases (by Release)](https://img.shields.io/github/downloads/mikefarah/yq/total.svg) ![Go Report](https://goreportcard.com/badge/github.com/mikefarah/yq)
 
 
-a lightweight and portable command-line YAML processor
+a lightweight and portable command-line YAML processor. `yq` uses [jq](https://github.com/stedolan/jq) like syntax but works with yaml files as well as json. It doesn't yet support everything `jq` does - but it does support the most common operations and functions, and more is being added continuously.
 
-The aim of the project is to be the [jq](https://github.com/stedolan/jq) or sed of yaml files.
+yq is written in go - so you can download a dependency free binary for your platform and you are good to go! If you prefer there are a variety of package managers that can be used as well as Docker and Podman, all listed below.
 
-## New version!
-V3 is officially out - if you've been using v2 and want/need to upgrade, checkout the [upgrade guide](https://mikefarah.gitbook.io/yq/upgrading-from-v2).
+## Quick Usage Guide
+
+Read a value:
+```bash
+yq e '.a.b[0].c' file.yaml
+```
+
+Pipe from STDIN:
+```bash
+cat file.yaml | yq e '.a.b[0].c' -
+```
+
+Update a yaml file, inplace
+```bash
+yq e -i '.a.b[0].c = "cool"' file.yaml
+```
+
+Update using environment variables
+```bash
+NAME=mike yq e -i '.a.b[0].c = strenv(NAME)' file.yaml
+```
+
+Merge multiple files
+```
+yq ea '. as $item ireduce ({}; . * $item )' path/to/*.yml
+```
+
+Multiple updates to a yaml file
+```bash
+yq e -i '
+  .a.b[0].c = "cool" |
+  .x.y.z = "foobar" |
+  .person.name = strenv(NAME)
+' file.yaml
+```
+
+See the [documentation](https://mikefarah.gitbook.io/yq/) for more.
 
 ## Install
 
 ### [Download the latest binary](https://github.com/mikefarah/yq/releases/latest)
 
-### MacOS:
+### wget
+Use wget to download the pre-compiled binaries:
+
+#### Compressed via tar.gz
+```bash
+wget https://github.com/mikefarah/yq/releases/download/${VERSION}/${BINARY}.tar.gz -O - |\
+  tar xz && mv ${BINARY} /usr/bin/yq
+```
+
+#### Plain binary
+
+```bash
+wget https://github.com/mikefarah/yq/releases/download/${VERSION}/${BINARY} -O /usr/bin/yq &&\
+    chmod +x /usr/bin/yq
+```
+
+For instance, VERSION=v4.2.0 and BINARY=yq_linux_amd64
+
+### MacOS / Linux via Homebrew:
+Using [Homebrew](https://brew.sh/)
 ```
 brew install yq
 ```
 
-### Windows:
-```
-choco install yq
-```
-Supported by @chillum (https://chocolatey.org/packages/yq)
-
-### Alpine Linux
-- Enable community repo by adding ```$MIRROR/alpine/v$VERSION/community``` to ```/etc/apk/repositories```
-- Update database index with ```apk update```
-- Install yq with ```apk add yq```
-
-Supported by Tuan Hoang
-https://pkgs.alpinelinux.org/package/edge/community/x86/yq
-
-
-### Ubuntu and other Linux distros supporting `snap` packages:
+### Linux via snap:
 ```
 snap install yq
 ```
@@ -43,20 +82,150 @@ snap install yq
 `yq` installs with [_strict confinement_](https://docs.snapcraft.io/snap-confinement/6233) in snap, this means it doesn't have direct access to root files. To read root files you can:
 
 ```
-sudo cat /etc/myfile | yq r - a.path
+sudo cat /etc/myfile | yq e '.a.path' - 
 ```
 
 And to write to a root file you can either use [sponge](https://linux.die.net/man/1/sponge):
 ```
-sudo cat /etc/myfile | yq w - a.path value | sudo sponge /etc/myfile
+sudo cat /etc/myfile | yq e '.a.path = "value"' - | sudo sponge /etc/myfile
 ```
 or write to a temporary file:
 ```
-sudo cat /etc/myfile | yq w - a.path value | sudo tee /etc/myfile.tmp
+sudo cat /etc/myfile | yq e '.a.path = "value"' | sudo tee /etc/myfile.tmp
 sudo mv /etc/myfile.tmp /etc/myfile
 rm /etc/myfile.tmp
 ```
 
+### Run with Docker or Podman
+
+#### Oneshot use:
+
+```bash
+docker run --rm -v "${PWD}":/workdir mikefarah/yq <command> [flags] [expression ]FILE...
+```
+
+```bash
+podman run --rm -v "${PWD}":/workdir mikefarah/yq <command> [flags] [expression ]FILE...
+```
+
+#### Pipe in via STDIN:
+
+You'll need to pass the `-i\--interactive` flag to docker:
+
+```bash
+cat myfile.yml | docker run -i --rm mikefarah/yq e . -
+```
+
+```bash
+cat myfile.yml | podman run -i --rm mikefarah/yq e . -
+```
+
+#### Run commands interactively:
+
+```bash
+docker run --rm -it -v "${PWD}":/workdir --entrypoint sh mikefarah/yq
+```
+
+```bash
+podman run --rm -it -v "${PWD}":/workdir --entrypoint sh mikefarah/yq
+```
+
+It can be useful to have a bash function to avoid typing the whole docker command:
+
+```bash
+yq() {
+  docker run --rm -i -v "${PWD}":/workdir mikefarah/yq "$@"
+}
+```
+
+```bash
+yq() {
+  podman run --rm -i -v "${PWD}":/workdir mikefarah/yq "$@"
+}
+```
+
+
+#### Running as root:
+
+`yq`'s container image no longer runs under root (https://github.com/mikefarah/yq/pull/860). If you'd like to install more things in the container image, or you're having permissions issues when attempting to read/write files you'll need to either:
+
+
+```
+docker run --user="root" -it --entrypoint sh mikefarah/yq
+```
+
+```
+podman run --user="root" -it --entrypoint sh mikefarah/yq
+```
+
+Or, in your Dockerfile:
+
+```
+FROM mikefarah/yq
+
+USER root
+RUN apk add bash
+USER yq
+```
+
+### GitHub Action
+```
+  - name: Set foobar to cool
+    uses: mikefarah/yq@master
+    with:
+      cmd: yq eval -i '.foo.bar = "cool"' 'config.yml'
+```
+
+See https://mikefarah.gitbook.io/yq/usage/github-action for more.
+
+### Go Get:
+```
+GO111MODULE=on go get github.com/mikefarah/yq/v4
+```
+
+## Community Supported Installation methods
+As these are supported by the community :heart: - however, they may be out of date with the officially supported releases.
+
+# Webi
+
+```
+webi yq
+```
+
+See [webi](https://webinstall.dev/)
+Supported by @adithyasunil26 (https://github.com/webinstall/webi-installers/tree/master/yq)
+
+### Arch Linux
+
+```
+pacman -S go-yq
+```
+
+### Windows:
+[![Chocolatey](https://img.shields.io/chocolatey/v/yq.svg)](https://chocolatey.org/packages/yq)
+[![Chocolatey](https://img.shields.io/chocolatey/dt/yq.svg)](https://chocolatey.org/packages/yq)
+```
+choco install yq
+```
+Supported by @chillum (https://chocolatey.org/packages/yq)
+
+### Mac:
+Using [MacPorts](https://www.macports.org/)
+```
+sudo port selfupdate
+sudo port install yq
+```
+Supported by @herbygillot (https://ports.macports.org/maintainer/github/herbygillot)
+
+### Alpine Linux
+- Enable edge/community repo by adding ```$MIRROR/alpine/edge/community``` to ```/etc/apk/repositories```
+- Update database index with ```apk update```
+- Install yq with ```apk add yq```
+
+Supported by Tuan Hoang
+https://pkgs.alpinelinux.org/package/edge/community/x86/yq
+
+
 ### On Ubuntu 16.04 or higher from Debian package:
 ```sh
 sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys CC86BB64
@@ -66,51 +235,26 @@ sudo apt install yq -y
 ```
 Supported by @rmescandon (https://launchpad.net/~rmescandon/+archive/ubuntu/yq)
 
-### Go Get:
-```
-GO111MODULE=on go get github.com/mikefarah/yq/v3
-```
-
-## Run with Docker
-
-Oneshot use:
-
-```bash
-docker run --rm -v "${PWD}":/workdir mikefarah/yq yq [flags] <command> FILE...
-```
-
-Run commands interactively:
-
-```bash
-docker run --rm -it -v "${PWD}":/workdir mikefarah/yq sh
-```
-
-It can be useful to have a bash function to avoid typing the whole docker command:
-
-```bash
-yq() {
-  docker run --rm -i -v "${PWD}":/workdir mikefarah/yq yq "$@"
-}
-```
-
 ## Features
+- [Detailed documentation with many examples](https://mikefarah.gitbook.io/yq/)
 - Written in portable go, so you can download a lovely dependency free binary
-- [Colorize the output](https://mikefarah.gitbook.io/yq/usage/output-format#colorize-output)
-- [Deep read a yaml file with a given path expression](https://mikefarah.gitbook.io/yq/commands/read#basic)
-- [List matching paths of a given path expression](https://mikefarah.gitbook.io/yq/commands/read#path-only)
-- [Return the lengths of arrays/object/scalars](https://mikefarah.gitbook.io/yq/commands/read#printing-length-of-the-results)
-- Update a yaml file given a [path expression](https://mikefarah.gitbook.io/yq/commands/write-update#basic) or [script file](https://mikefarah.gitbook.io/yq/commands/write-update#basic)
-- Update creates any missing entries in the path on the fly
-- Deeply [compare](https://mikefarah.gitbook.io/yq/commands/compare) yaml files
-- Keeps yaml formatting and comments when updating
-- [Validate a yaml file](https://mikefarah.gitbook.io/yq/commands/validate)
-- Create a yaml file given a [deep path and value](https://mikefarah.gitbook.io/yq/commands/create#creating-a-simple-yaml-file) or a [script file](https://mikefarah.gitbook.io/yq/commands/create#creating-using-a-create-script)
-- [Prefix a path to a yaml file](https://mikefarah.gitbook.io/yq/commands/prefix)
-- [Convert to/from json to yaml](https://mikefarah.gitbook.io/yq/usage/convert)
-- [Pipe data in by using '-'](https://mikefarah.gitbook.io/yq/commands/read#from-stdin)
-- [Merge](https://mikefarah.gitbook.io/yq/commands/merge) multiple yaml files with various options for [overriding](https://mikefarah.gitbook.io/yq/commands/merge#overwrite-values) and [appending](https://mikefarah.gitbook.io/yq/commands/merge#append-values-with-arrays)
-- Supports multiple documents in a single yaml file for [reading](https://mikefarah.gitbook.io/yq/commands/read#multiple-documents), [writing](https://mikefarah.gitbook.io/yq/commands/write-update#multiple-documents) and [merging](https://mikefarah.gitbook.io/yq/commands/merge#multiple-documents)
-- General shell completion scripts (bash/zsh/fish/powershell) (https://mikefarah.gitbook.io/yq/commands/shell-completion)
+- Uses similar syntax as `jq` but works with YAML and JSON files
+- Fully supports multi document yaml files
+- Supports yaml [front matter](https://mikefarah.gitbook.io/yq/usage/front-matter) blocks (e.g. jekyll/assemble)
+- Colorized yaml output
+- [Deeply traverse yaml](https://mikefarah.gitbook.io/yq/operators/traverse-read)
+- [Sort yaml by keys](https://mikefarah.gitbook.io/yq/operators/sort-keys)
+- Manipulate yaml [comments](https://mikefarah.gitbook.io/yq/operators/comment-operators), [styling](https://mikefarah.gitbook.io/yq/operators/style), [tags](https://mikefarah.gitbook.io/yq/operators/tag) and [anchors and aliases](https://mikefarah.gitbook.io/yq/operators/anchor-and-alias-operators).
+- [Update yaml inplace](https://mikefarah.gitbook.io/yq/v/v4.x/commands/evaluate#flags)
+- [Complex expressions to select and update](https://mikefarah.gitbook.io/yq/operators/select#select-and-update-matching-values-in-map)
+- Keeps yaml formatting and comments when updating (though there are issues with whitespace)
+- [Load content from other files](https://mikefarah.gitbook.io/yq/operators/load)
+- [Convert to/from json](https://mikefarah.gitbook.io/yq/v/v4.x/usage/convert)
+- [Convert to properties](https://mikefarah.gitbook.io/yq/v/v4.x/usage/properties)
+- [Pipe data in by using '-'](https://mikefarah.gitbook.io/yq/v/v4.x/commands/evaluate)
+- [General shell completion scripts (bash/zsh/fish/powershell)](https://mikefarah.gitbook.io/yq/v/v4.x/commands/shell-completion)
+- [Reduce](https://mikefarah.gitbook.io/yq/operators/reduce) to merge multiple files or sum an array or other fancy things.
+- [Github Action](https://mikefarah.gitbook.io/yq/usage/github-action) to use in your automated pipeline (thanks @devorbitus)
 
 ## [Usage](https://mikefarah.gitbook.io/yq/)
 
@@ -122,29 +266,32 @@ Usage:
   yq [command]
 
 Available Commands:
-  compare          yq x [--prettyPrint/-P] dataA.yaml dataB.yaml 'b.e(name==fr*).value'
-  delete           yq d [--inplace/-i] [--doc/-d index] sample.yaml 'b.e(name==fred)'
+  eval             Apply the expression to each document in each yaml file in sequence
+  eval-all         Loads _all_ yaml documents of _all_ yaml files and runs expression once
   help             Help about any command
-  merge            yq m [--inplace/-i] [--doc/-d index] [--overwrite/-x] [--append/-a] sample.yaml sample2.yaml
-  new              yq n [--script/-s script_file] a.b.c newValue
-  prefix           yq p [--inplace/-i] [--doc/-d index] sample.yaml a.b.c
-  read             yq r [--printMode/-p pv] sample.yaml 'b.e(name==fr*).value'
-  shell-completion Generates shell completion scripts
-  validate         yq v sample.yaml
-  write            yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml 'b.e(name==fr*).value' newValue
+  shell-completion Generate completion script
 
 Flags:
-  -C, --colors        print with colors
-  -h, --help          help for yq
-  -I, --indent int    sets indent level for output (default 2)
-  -P, --prettyPrint   pretty print
-  -j, --tojson        output as json. By default it prints a json document in one line, use the prettyPrint flag to print a formatted doc.
-  -v, --verbose       verbose mode
-  -V, --version       Print version information and quit
+  -C, --colors                force print with colors
+  -e, --exit-status           set exit status if there are no matches or null or false is returned
+  -f, --front-matter string   (extract|process) first input as yaml front-matter. Extract will pull out the yaml content, process will run the expression against the yaml content, leaving the remaining data intact
+      --header-preprocess     Slurp any header comments and seperators before processing expression. This is a workaround for go-yaml to persist header content (default true)
+  -h, --help                  help for yq
+  -I, --indent int            sets indent level for output (default 2)
+  -i, --inplace               update the yaml file inplace of first yaml file given.
+  -M, --no-colors             force print with no colors
+  -N, --no-doc                Don't print document separators (---)
+  -n, --null-input            Don't read input, simply evaluate the expression given. Useful for creating yaml docs from scratch.
+  -o, --output-format string  [yaml|y|json|j|props|p] output format type. (default "yaml")
+  -P, --prettyPrint           pretty print, shorthand for '... style = ""'
+      --unwrapScalar          unwrap scalar, print the value with no quotes, colors or comments (default true)
+  -v, --verbose               verbose mode
+  -V, --version               Print version information and quit
 
 Use "yq [command] --help" for more information about a command.
 ```
-
 ## Known Issues / Missing Features
 - `yq` attempts to preserve comment positions and whitespace as much as possible, but it does not handle all scenarios (see https://github.com/go-yaml/yaml/tree/v3 for details)
-- You cannot (yet) select multiple paths/keys from the yaml to be printed out (https://github.com/mikefarah/yq/issues/287)
+- Powershell has its own...[opinions on quoting yq](https://mikefarah.gitbook.io/yq/usage/tips-and-tricks#quotes-in-windows-powershell)
+
+See [tips and tricks](https://mikefarah.gitbook.io/yq/usage/tips-and-tricks) for more common problems and solutions.

acceptance_tests/bad_args.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+testWriteInPlacePipeIn() {
+  result=$(./yq e -i -n '.a' 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: write inplace flag only applicable when giving an expression and at least one file" "$result"
+}
+
+testWriteInPlacePipeInEvalall() {
+  result=$(./yq ea -i -n '.a' 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: write inplace flag only applicable when giving an expression and at least one file" "$result"
+}
+
+testWriteInPlaceWithSplit() {
+  result=$(./yq e -s "cat" -i '.a = "thing"' test.yml 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: write inplace cannot be used with split file" "$result"
+}
+
+testWriteInPlaceWithSplitEvalAll() {
+  result=$(./yq ea -s "cat" -i '.a = "thing"' test.yml 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: write inplace cannot be used with split file" "$result"
+}
+
+testNullWithFiles() {
+  result=$(./yq e -n '.a = "thing"' test.yml 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: cannot pass files in when using null-input flag" "$result"
+}
+
+testNullWithFilesEvalAll() {
+  result=$(./yq ea -n '.a = "thing"' test.yml 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: cannot pass files in when using null-input flag" "$result"
+}
+
+
+
+source ./scripts/shunit2

acceptance_tests/basic.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+}
+
+testBasicEvalRoundTrip() {
+  ./yq e -n ".a = 123" > test.yml
+  X=$(./yq e '.a' test.yml)
+  assertEquals 123 "$X"
+}
+
+testBasicUpdateInPlaceSequence() {
+  cat >test.yml <<EOL
+a: 0
+EOL
+  ./yq e -i ".a = 10" test.yml
+  X=$(./yq e '.a' test.yml)
+  assertEquals "10" "$X"
+}
+
+testBasicUpdateInPlaceSequenceEvalAll() {
+  cat >test.yml <<EOL
+a: 0
+EOL
+  ./yq ea -i ".a = 10" test.yml
+  X=$(./yq e '.a' test.yml)
+  assertEquals "10" "$X"
+}
+
+testBasicNoExitStatus() {
+  echo "a: cat" > test.yml
+  X=$(./yq e '.z' test.yml)
+  assertEquals "null" "$X"
+}
+
+testBasicExitStatus() {
+  echo "a: cat" > test.yml
+  X=$(./yq e -e '.z' test.yml 2&>/dev/null)
+  assertEquals 1 "$?"
+}
+
+testBasicExtractFieldWithSeperator() {
+    cat >test.yml <<EOL
+---
+name: chart-name
+version: 1.2.3
+EOL
+  X=$(./yq e '.name' test.yml)
+  assertEquals "chart-name" "$X"
+}
+
+testBasicExtractMultipleFieldWithSeperator() {
+    cat >test.yml <<EOL
+---
+name: chart-name
+version: 1.2.3
+---
+name: thing
+version: 1.2.3
+EOL
+
+read -r -d '' expected << EOM
+chart-name
+---
+thing
+EOM
+  X=$(./yq e '.name' test.yml)
+  assertEquals "$expected" "$X"
+}
+
+source ./scripts/shunit2

acceptance_tests/empty.sh

@@ -0,0 +1,83 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+  cat >test.yml <<EOL
+# comment
+EOL
+}
+
+testEmptyEval() {
+  X=$(./yq e test.yml)
+  expected=$(cat test.yml)
+  assertEquals 0 $?
+  assertEquals "$expected" "$X"
+}
+
+testEmptyEvalNoNewLine() {
+  echo -n "#comment" >test.yml
+  X=$(./yq e test.yml)
+  expected=$(cat test.yml)
+  assertEquals 0 $?
+  assertEquals "$expected" "$X"
+}
+
+testEmptyEvalNoNewLineWithExpression() {
+  echo -n "# comment" >test.yml
+  X=$(./yq e '.apple = "tree"' test.yml)
+  read -r -d '' expected << EOM
+# comment
+apple: tree
+EOM
+  assertEquals "$expected" "$X"
+}
+
+testEmptyEvalPipe() {
+  X=$(./yq e - < test.yml)
+  assertEquals 0 $?
+}
+
+testEmptyCommentsWithExpressionEval() {
+  read -r -d '' expected << EOM
+# comment
+apple: tree
+EOM
+
+  X=$(./yq e '.apple="tree"' test.yml)
+
+  assertEquals "$expected" "$X"
+}
+
+testEmptyCommentsWithExpressionEvalAll() {
+  read -r -d '' expected << EOM
+# comment
+apple: tree
+EOM
+
+  X=$(./yq ea '.apple="tree"' test.yml)
+
+  assertEquals "$expected" "$X"
+}
+
+testEmptyWithExpressionEval() {
+  rm test.yml
+  touch test.yml
+  expected="apple: tree"
+
+  X=$(./yq e '.apple="tree"' test.yml)
+
+  assertEquals "$expected" "$X"
+}
+
+testEmptyWithExpressionEvalAll() {
+  rm test.yml
+  touch test.yml
+  expected="apple: tree"
+
+  X=$(./yq ea '.apple="tree"' test.yml)
+
+  assertEquals "$expected" "$X"
+}
+
+
+source ./scripts/shunit2

acceptance_tests/front-matter.sh

@@ -0,0 +1,76 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+  cat >test.yml <<EOL
+---
+a: apple
+b: cat
+---
+not yaml
+c: at
+EOL
+}
+
+testFrontMatterProcessEval() {
+  read -r -d '' expected << EOM
+---
+a: apple
+b: dog
+---
+not yaml
+c: at
+EOM
+  ./yq e --front-matter="process" '.b = "dog"' test.yml -i
+  assertEquals "$expected" "$(cat test.yml)"
+}
+
+testFrontMatterProcessEvalAll() {
+  read -r -d '' expected << EOM
+---
+a: apple
+b: dog
+---
+not yaml
+c: at
+EOM
+  ./yq ea --front-matter="process" '.b = "dog"' test.yml -i
+  assertEquals "$expected" "$(cat test.yml)"
+}
+
+testFrontMatterExtractEval() {
+    cat >test.yml <<EOL
+a: apple
+b: cat
+---
+not yaml
+c: at
+EOL
+
+  read -r -d '' expected << EOM
+a: apple
+b: dog
+EOM
+  ./yq e --front-matter="extract" '.b = "dog"' test.yml -i
+  assertEquals "$expected" "$(cat test.yml)"
+}
+
+testFrontMatterExtractEvalAll() {
+  cat >test.yml <<EOL
+a: apple
+b: cat
+---
+not yaml
+c: at
+EOL
+
+  read -r -d '' expected << EOM
+a: apple
+b: dog
+EOM
+  ./yq ea --front-matter="extract" '.b = "dog"' test.yml -i
+  assertEquals "$expected" "$(cat test.yml)"
+}
+
+
+source ./scripts/shunit2

acceptance_tests/inputs-format.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+}
+
+testInputXml() {
+  cat >test.yml <<EOL
+<cat legs="4">BiBi</cat>
+EOL
+
+  read -r -d '' expected << EOM
+cat:
+  +content: BiBi
+  +legs: "4"
+EOM
+
+  X=$(./yq e -p=xml test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea -p=xml test.yml)
+  assertEquals "$expected" "$X"
+}
+
+source ./scripts/shunit2

acceptance_tests/leading-seperator.sh

@@ -0,0 +1,450 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+  cat >test.yml <<EOL
+---
+a: test
+EOL
+}
+
+testLeadingSeperatorWithDoc() {
+  cat >test.yml <<EOL
+# hi peeps
+# cool
+---
+a: test
+---
+b: cool
+EOL
+
+  read -r -d '' expected << EOM
+# hi peeps
+# cool
+---
+a: thing
+---
+b: cool
+EOM
+
+  X=$(./yq e '(select(di == 0) | .a) = "thing"' - < test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorPipeIntoEvalSeq() {
+  X=$(./yq e - < test.yml)
+  expected=$(cat test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorExtractField() {
+  X=$(./yq e '.a' - < test.yml)
+  assertEquals "test" "$X"
+}
+
+testLeadingSeperatorExtractFieldWithCommentsAfterSep() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+EOL
+  X=$(./yq e '.a' test.yml)
+  assertEquals "test" "$X"
+}
+
+testLeadingSeperatorExtractFieldWithCommentsBeforeSep() {
+  cat >test.yml <<EOL
+# hi peeps
+# cool
+---
+a: test
+EOL
+  X=$(./yq e '.a' test.yml)
+  assertEquals "test" "$X"
+}
+
+
+testLeadingSeperatorExtractFieldMultiDoc() {
+  cat >test.yml <<EOL
+---
+a: test
+---
+a: test2
+EOL
+
+  read -r -d '' expected << EOM
+test
+---
+test2
+EOM
+  X=$(./yq e '.a' test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorExtractFieldMultiDocWithComments() {
+  cat >test.yml <<EOL
+# here
+---
+# there
+a: test
+# whereever
+---
+# you are
+a: test2
+# woop
+EOL
+
+  read -r -d '' expected << EOM
+test
+---
+test2
+EOM
+  X=$(./yq e '.a' test.yml)
+  assertEquals "$expected" "$X"
+}
+
+
+testLeadingSeperatorEvalSeq() {
+  X=$(./yq e test.yml)
+  expected=$(cat test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorPipeIntoEvalAll() {
+  X=$(./yq ea - < test.yml)
+  expected=$(cat test.yml)
+  assertEquals "$expected" "$X"
+}
+
+
+testLeadingSeperatorEvalAll() {
+  X=$(./yq ea test.yml)
+  expected=$(cat test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalSimple() {
+  read -r -d '' expected << EOM
+---
+a: test
+---
+version: 3
+application: MyApp
+EOM
+
+
+  X=$(./yq e '.' test.yml examples/order.yaml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocInOneFile() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+---
+b: things
+EOL
+  expected=$(cat test.yml)
+  X=$(./yq e '.' test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocInOneFileEvalAll() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+---
+b: things
+EOL
+  expected=$(cat test.yml)
+  X=$(./yq ea '.' test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalComments() {
+  cat >test.yml <<EOL
+# hi peeps
+# cool
+a: test
+EOL
+
+cat >test2.yml <<EOL
+# this is another doc
+# great
+b: sane
+EOL
+
+  read -r -d '' expected << EOM
+# hi peeps
+# cool
+a: test
+---
+# this is another doc
+# great
+b: sane
+EOM
+
+
+  X=$(./yq e '.' test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalCommentsTrailingSep() {
+  cat >test.yml <<EOL
+# hi peeps
+# cool
+---
+a: test
+EOL
+
+cat >test2.yml <<EOL
+# this is another doc
+# great
+---
+b: sane
+EOL
+
+  read -r -d '' expected << EOM
+# hi peeps
+# cool
+---
+a: test
+---
+# this is another doc
+# great
+---
+b: sane
+EOM
+
+
+  X=$(./yq e '.' test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiMultiDocEvalCommentsTrailingSep() {
+  cat >test.yml <<EOL
+# hi peeps
+# cool
+---
+a: test
+---
+a1: test2
+EOL
+
+cat >test2.yml <<EOL
+# this is another doc
+# great
+---
+b: sane
+---
+b2: cool
+EOL
+
+  read -r -d '' expected << EOM
+# hi peeps
+# cool
+---
+a: test
+---
+a1: test2
+---
+# this is another doc
+# great
+---
+b: sane
+---
+b2: cool
+EOM
+
+
+  X=$(./yq e '.' test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalCommentsLeadingSep() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+EOL
+
+cat >test2.yml <<EOL
+---
+# this is another doc
+# great
+b: sane
+EOL
+
+  read -r -d '' expected << EOM
+---
+# hi peeps
+# cool
+a: test
+---
+# this is another doc
+# great
+b: sane
+EOM
+
+
+  X=$(./yq e '.' test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+# https://github.com/mikefarah/yq/issues/919
+testLeadingSeparatorDoesNotBreakCommentsOnOtherFiles() {
+  cat >test.yml <<EOL
+# a1
+a: 1
+# a2
+EOL
+
+cat >test2.yml <<EOL
+# b1
+b: 2
+# b2
+EOL
+
+  read -r -d '' expected << EOM
+# a1
+a: 1
+# a2
+
+# b1
+b: 2
+# b2
+EOM
+
+
+  X=$(./yq ea 'select(fi == 0) * select(fi == 1)' test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalCommentsStripComments() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+---
+# this is another doc
+# great
+b: sane
+EOL
+
+  # it will be hard to remove that top level separator
+  read -r -d '' expected << EOM
+a: test
+---
+b: sane
+EOM
+
+  X=$(./yq e '... comments=""'  test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalCommentsLeadingSepNoDocFlag() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+---
+# this is another doc
+# great
+b: sane
+EOL
+
+  read -r -d '' expected << EOM
+# hi peeps
+# cool
+a: test
+# this is another doc
+# great
+b: sane
+EOM
+
+
+  X=$(./yq e '.' --no-doc test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalJsonFlag() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+EOL
+
+cat >test2.yml <<EOL
+---
+# this is another doc
+# great
+b: sane
+EOL
+
+  read -r -d '' expected << EOM
+{
+  "a": "test"
+}
+{
+  "b": "sane"
+}
+EOM
+
+
+  X=$(./yq e '.' -j test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalAllJsonFlag() {
+  cat >test.yml <<EOL
+---
+# hi peeps
+# cool
+a: test
+EOL
+
+cat >test2.yml <<EOL
+---
+# this is another doc
+# great
+b: sane
+EOL
+
+  read -r -d '' expected << EOM
+{
+  "a": "test"
+}
+{
+  "b": "sane"
+}
+EOM
+
+
+  X=$(./yq ea '.' -j test.yml test2.yml)
+  assertEquals "$expected" "$X"
+}
+
+testLeadingSeperatorMultiDocEvalAll() {
+  read -r -d '' expected << EOM
+---
+a: test
+---
+version: 3
+application: MyApp
+EOM
+
+
+  X=$(./yq ea '.' test.yml examples/order.yaml)
+  assertEquals "$expected" "$X"
+}
+
+source ./scripts/shunit2

acceptance_tests/load-file.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+testLoadFileNotExist() {
+  result=$(./yq e -n 'load("cat.yml")' 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: Failed to load cat.yml: open cat.yml: no such file or directory" "$result"
+}
+
+testLoadFileExpNotExist() {
+  result=$(./yq e -n 'load(.a)' 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: Filename expression returned nil" "$result"
+}
+
+testStrLoadFileNotExist() {
+  result=$(./yq e -n 'strload("cat.yml")' 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: Failed to load cat.yml: open cat.yml: no such file or directory" "$result"
+}
+
+testStrLoadFileExpNotExist() {
+  result=$(./yq e -n 'strload(.a)' 2>&1)
+  assertEquals 1 $?
+  assertEquals "Error: Filename expression returned nil" "$result"
+}
+
+source ./scripts/shunit2

acceptance_tests/output-format.sh

@@ -0,0 +1,166 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+}
+
+testOutputJsonDeprecated() {
+  cat >test.yml <<EOL
+a: {b: ["cat"]}
+EOL
+
+  read -r -d '' expected << EOM
+{
+  "a": {
+    "b": [
+      "cat"
+    ]
+  }
+}
+EOM
+
+  X=$(./yq e -j test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea -j test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputJson() {
+  cat >test.yml <<EOL
+a: {b: ["cat"]}
+EOL
+
+  read -r -d '' expected << EOM
+{
+  "a": {
+    "b": [
+      "cat"
+    ]
+  }
+}
+EOM
+
+  X=$(./yq e --output-format=json test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --output-format=json test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputJsonShort() {
+  cat >test.yml <<EOL
+a: {b: ["cat"]}
+EOL
+
+  read -r -d '' expected << EOM
+{
+  "a": {
+    "b": [
+      "cat"
+    ]
+  }
+}
+EOM
+
+  X=$(./yq e -o=j test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea -o=j test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputProperties() {
+  cat >test.yml <<EOL
+a: {b: {c: ["cat"]}}
+EOL
+
+  read -r -d '' expected << EOM
+a.b.c.0 = cat
+EOM
+
+  X=$(./yq e --output-format=props test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --output-format=props test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputPropertiesShort() {
+  cat >test.yml <<EOL
+a: {b: {c: ["cat"]}}
+EOL
+
+  read -r -d '' expected << EOM
+a.b.c.0 = cat
+EOM
+
+  X=$(./yq e -o=p test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea -o=p test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputXml() {
+  cat >test.yml <<EOL
+a: {b: {c: ["cat"]}}
+EOL
+
+  read -r -d '' expected << EOM
+<a>
+  <b>
+    <c>cat</c>
+  </b>
+</a>
+EOM
+
+  X=$(./yq e --output-format=xml test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --output-format=xml test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputXmlShort() {
+  cat >test.yml <<EOL
+a: {b: {c: ["cat"]}}
+EOL
+
+  read -r -d '' expected << EOM
+<a>
+  <b>
+    <c>cat</c>
+  </b>
+</a>
+EOM
+
+  X=$(./yq e --output-format=x test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --output-format=x test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testOutputXmComplex() {
+  cat >test.yml <<EOL
+a: {b: {c: ["cat", "dog"], +f: meow}}
+EOL
+
+  read -r -d '' expected << EOM
+<a>
+  <b f="meow">
+    <c>cat</c>
+    <c>dog</c>
+  </b>
+</a>
+EOM
+
+  X=$(./yq e --output-format=x test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --output-format=x test.yml)
+  assertEquals "$expected" "$X"
+}
+
+source ./scripts/shunit2

acceptance_tests/pretty-print.sh

@@ -0,0 +1,176 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+}
+
+testPrettyPrintWithBooleans() {
+  cat >test.yml <<EOL
+leaveUnquoted: [yes, no, on, off, y, n, true, false]
+leaveQuoted: ["yes", "no", "on", "off", "y", "n", "true", "false"]
+
+EOL
+
+  read -r -d '' expected << EOM
+leaveUnquoted:
+  - yes
+  - no
+  - on
+  - off
+  - y
+  - n
+  - true
+  - false
+leaveQuoted:
+  - "yes"
+  - "no"
+  - "on"
+  - "off"
+  - "y"
+  - "n"
+  - "true"
+  - "false"
+EOM
+
+  X=$(./yq e --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testPrettyPrintWithBooleansCapitals() {
+  cat >test.yml <<EOL
+leaveUnquoted: [YES, NO, ON, OFF, Y, N, TRUE, FALSE]
+leaveQuoted: ["YES", "NO", "ON", "OFF", "Y", "N", "TRUE", "FALSE"]
+EOL
+
+  read -r -d '' expected << EOM
+leaveUnquoted:
+  - YES
+  - NO
+  - ON
+  - OFF
+  - Y
+  - N
+  - TRUE
+  - FALSE
+leaveQuoted:
+  - "YES"
+  - "NO"
+  - "ON"
+  - "OFF"
+  - "Y"
+  - "N"
+  - "TRUE"
+  - "FALSE"
+EOM
+
+  X=$(./yq e --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testPrettyPrintOtherStringValues() {
+  cat >test.yml <<EOL
+leaveUnquoted: [yesSir, hellno, bonapite]
+makeUnquoted: ["yesSir", "hellno", "bonapite"]
+EOL
+
+  read -r -d '' expected << EOM
+leaveUnquoted:
+  - yesSir
+  - hellno
+  - bonapite
+makeUnquoted:
+  - yesSir
+  - hellno
+  - bonapite
+EOM
+
+  X=$(./yq e --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testPrettyPrintKeys() {
+  cat >test.yml <<EOL
+"removeQuotes": "please"
+EOL
+
+  read -r -d '' expected << EOM
+removeQuotes: please
+EOM
+
+  X=$(./yq e --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testPrettyPrintOtherStringValues() {
+  cat >test.yml <<EOL
+leaveUnquoted: [yesSir, hellno, bonapite]
+makeUnquoted: ["yesSir", "hellno", "bonapite"]
+EOL
+
+  read -r -d '' expected << EOM
+leaveUnquoted:
+  - yesSir
+  - hellno
+  - bonapite
+makeUnquoted:
+  - yesSir
+  - hellno
+  - bonapite
+EOM
+
+  X=$(./yq e --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testPrettyPrintStringBlocks() {
+  cat >test.yml <<EOL
+"removeQuotes": | 
+  "please"
+EOL
+
+  read -r -d '' expected << EOM
+removeQuotes: |
+  "please"
+EOM
+
+  X=$(./yq e --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+testPrettyPrintWithExpression() {
+  cat >test.yml <<EOL
+a: {b: {c: ["cat"]}}
+EOL
+
+  read -r -d '' expected << EOM
+b:
+  c:
+    - cat
+EOM
+
+  X=$(./yq e '.a' --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+
+  X=$(./yq ea '.a' --prettyPrint test.yml)
+  assertEquals "$expected" "$X"
+}
+
+source ./scripts/shunit2

acceptance_tests/split-printer.sh

@@ -0,0 +1,157 @@
+#!/bin/bash
+
+setUp() {
+  rm test*.yml || true
+}
+
+testBasicSplitWithName() {
+  cat >test.yml <<EOL
+a: test_doc1
+--- 
+a: test_doc2
+EOL
+
+  ./yq e test.yml -s ".a"
+
+  doc1=$(cat test_doc1.yml)
+  
+  assertEquals "a: test_doc1" "$doc1"
+
+  doc2=$(cat test_doc2.yml)
+  read -r -d '' expectedDoc2 << EOM
+---
+a: test_doc2
+EOM
+  assertEquals "$expectedDoc2" "$doc2"
+}
+
+testBasicSplitWithNameEvalAll() {
+  cat >test.yml <<EOL
+a: test_doc1
+--- 
+a: test_doc2
+EOL
+
+  ./yq ea test.yml -s ".a"
+
+  doc1=$(cat test_doc1.yml)
+  
+  assertEquals "a: test_doc1" "$doc1"
+
+  doc2=$(cat test_doc2.yml)
+  read -r -d '' expectedDoc2 << EOM
+---
+a: test_doc2
+EOM
+  assertEquals "$expectedDoc2" "$doc2"
+}
+
+testBasicSplitWithIndex() {
+  cat >test.yml <<EOL
+a: test_doc1
+--- 
+a: test_doc2
+EOL
+
+  ./yq e test.yml -s '"test_" + $index'
+
+  doc1=$(cat test_0.yml)
+  
+  assertEquals "a: test_doc1" "$doc1"
+
+  doc2=$(cat test_1.yml)
+  read -r -d '' expectedDoc2 << EOM
+---
+a: test_doc2
+EOM
+  assertEquals "$expectedDoc2" "$doc2"
+}
+
+testBasicSplitWithIndexEvalAll() {
+  cat >test.yml <<EOL
+a: test_doc1
+--- 
+a: test_doc2
+EOL
+
+  ./yq ea test.yml -s '"test_" + $index'
+
+  doc1=$(cat test_0.yml)
+  
+  assertEquals "a: test_doc1" "$doc1"
+
+  doc2=$(cat test_1.yml)
+  read -r -d '' expectedDoc2 << EOM
+---
+a: test_doc2
+EOM
+  assertEquals "$expectedDoc2" "$doc2"
+}
+
+
+testArraySplitWithNameNoSeparators() {
+  cat >test.yml <<EOL
+- name: test_fred
+  age: 35
+- name: test_catherine
+  age: 37
+EOL
+
+  ./yq e --no-doc -s ".name"  ".[]" test.yml 
+
+  doc1=$(cat test_fred.yml)
+  read -r -d '' expectedDoc1 << EOM
+name: test_fred
+age: 35
+EOM
+
+  assertEquals "$expectedDoc1" "$doc1"
+
+  doc2=$(cat test_catherine.yml)
+  read -r -d '' expectedDoc2 << EOM
+name: test_catherine
+age: 37
+EOM
+  assertEquals "$expectedDoc2" "$doc2"
+}
+
+testArraySplitWithNameNoSeparatorsEvalAll() {
+  cat >test.yml <<EOL
+- name: test_fred
+  age: 35
+- name: test_catherine
+  age: 37
+EOL
+
+cat >test2.yml <<EOL
+- name: test_mike
+  age: 564
+EOL
+
+  ./yq ea --no-doc -s ".name"  ".[]" test.yml test2.yml
+
+  doc1=$(cat test_fred.yml)
+  read -r -d '' expectedDoc1 << EOM
+name: test_fred
+age: 35
+EOM
+
+  assertEquals "$expectedDoc1" "$doc1"
+
+  doc2=$(cat test_catherine.yml)
+  read -r -d '' expectedDoc2 << EOM
+name: test_catherine
+age: 37
+EOM
+  assertEquals "$expectedDoc2" "$doc2"
+
+
+  doc3=$(cat test_mike.yml)
+  read -r -d '' expectedDoc3 << EOM
+name: test_mike
+age: 564
+EOM
+  assertEquals "$expectedDoc3" "$doc3"
+}
+
+source ./scripts/shunit2

action.yml

@@ -1,11 +1,15 @@
 name: 'yq - portable yaml processor'
 description: 'create, read, update, delete, merge, validate and do more with yaml'
-icon: command
-color: gray-dark
+branding:
+  icon: command
+  color: gray-dark
 inputs:
   cmd:
     description: 'The Command which should be run'
     required: true
+outputs:
+  result:
+    description: "The complete result from the yq command being run"
 runs:
   using: 'docker'
   image: 'github-action/Dockerfile'

cmd/commands_test.go

@@ -1,83 +1,83 @@
 package cmd
 
-import (
-	"strings"
-	"testing"
+// import (
+// 	"strings"
+// 	"testing"
 
-	"github.com/mikefarah/yq/v3/test"
-	"github.com/spf13/cobra"
-)
+// 	"github.com/mikefarah/yq/v3/test"
+// 	"github.com/spf13/cobra"
+// )
 
-func getRootCommand() *cobra.Command {
-	return New()
-}
+// func getRootCommand() *cobra.Command {
+// 	return New()
+// }
 
-func TestRootCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
+// func TestRootCmd(t *testing.T) {
+// 	cmd := getRootCommand()
+// 	result := test.RunCmd(cmd, "")
+// 	if result.Error != nil {
+// 		t.Error(result.Error)
+// 	}
 
-	if !strings.Contains(result.Output, "Usage:") {
-		t.Error("Expected usage message to be printed out, but the usage message was not found.")
-	}
-}
+// 	if !strings.Contains(result.Output, "Usage:") {
+// 		t.Error("Expected usage message to be printed out, but the usage message was not found.")
+// 	}
+// }
 
-func TestRootCmd_Help(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "--help")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
+// func TestRootCmd_Help(t *testing.T) {
+// 	cmd := getRootCommand()
+// 	result := test.RunCmd(cmd, "--help")
+// 	if result.Error != nil {
+// 		t.Error(result.Error)
+// 	}
 
-	if !strings.Contains(result.Output, "yq is a lightweight and portable command-line YAML processor. It aims to be the jq or sed of yaml files.") {
-		t.Error("Expected usage message to be printed out, but the usage message was not found.")
-	}
-}
+// 	if !strings.Contains(result.Output, "yq is a lightweight and portable command-line YAML processor. It aims to be the jq or sed of yaml files.") {
+// 		t.Error("Expected usage message to be printed out, but the usage message was not found.")
+// 	}
+// }
 
-func TestRootCmd_VerboseLong(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "--verbose")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
+// func TestRootCmd_VerboseLong(t *testing.T) {
+// 	cmd := getRootCommand()
+// 	result := test.RunCmd(cmd, "--verbose")
+// 	if result.Error != nil {
+// 		t.Error(result.Error)
+// 	}
 
-	if !verbose {
-		t.Error("Expected verbose to be true")
-	}
-}
+// 	if !verbose {
+// 		t.Error("Expected verbose to be true")
+// 	}
+// }
 
-func TestRootCmd_VerboseShort(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "-v")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
+// func TestRootCmd_VerboseShort(t *testing.T) {
+// 	cmd := getRootCommand()
+// 	result := test.RunCmd(cmd, "-v")
+// 	if result.Error != nil {
+// 		t.Error(result.Error)
+// 	}
 
-	if !verbose {
-		t.Error("Expected verbose to be true")
-	}
-}
+// 	if !verbose {
+// 		t.Error("Expected verbose to be true")
+// 	}
+// }
 
-func TestRootCmd_VersionShort(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "-V")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	if !strings.Contains(result.Output, "yq version") {
-		t.Error("expected version message to be printed out, but the message was not found.")
-	}
-}
+// func TestRootCmd_VersionShort(t *testing.T) {
+// 	cmd := getRootCommand()
+// 	result := test.RunCmd(cmd, "-V")
+// 	if result.Error != nil {
+// 		t.Error(result.Error)
+// 	}
+// 	if !strings.Contains(result.Output, "yq version") {
+// 		t.Error("expected version message to be printed out, but the message was not found.")
+// 	}
+// }
 
-func TestRootCmd_VersionLong(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "--version")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	if !strings.Contains(result.Output, "yq version") {
-		t.Error("expected version message to be printed out, but the message was not found.")
-	}
-}
+// func TestRootCmd_VersionLong(t *testing.T) {
+// 	cmd := getRootCommand()
+// 	result := test.RunCmd(cmd, "--version")
+// 	if result.Error != nil {
+// 		t.Error(result.Error)
+// 	}
+// 	if !strings.Contains(result.Output, "yq version") {
+// 		t.Error("expected version message to be printed out, but the message was not found.")
+// 	}
+// }

cmd/compare.go

@@ -1,89 +0,0 @@
-package cmd
-
-import (
-	"bufio"
-	"bytes"
-	"os"
-	"strings"
-
-	"github.com/kylelemons/godebug/diff"
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	errors "github.com/pkg/errors"
-	"github.com/spf13/cobra"
-)
-
-// turn off for unit tests :(
-var forceOsExit = true
-
-func createCompareCmd() *cobra.Command {
-	var cmdCompare = &cobra.Command{
-		Use:     "compare [yaml_file_a] [yaml_file_b]",
-		Aliases: []string{"x"},
-		Short:   "yq x [--prettyPrint/-P] dataA.yaml dataB.yaml 'b.e(name==fr*).value'",
-		Example: `
-yq x - data2.yml # reads from stdin
-yq x -pp dataA.yaml dataB.yaml '**' # compare paths
-yq x -d1 dataA.yaml dataB.yaml 'a.b.c'
-`,
-		Long: "Deeply compares two yaml files, prints the difference. Use with prettyPrint flag to ignore formatting differences.",
-		RunE: compareDocuments,
-	}
-	cmdCompare.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	cmdCompare.PersistentFlags().StringVarP(&printMode, "printMode", "p", "v", "print mode (v (values, default), p (paths), pv (path and value pairs)")
-	cmdCompare.PersistentFlags().StringVarP(&defaultValue, "defaultValue", "D", "", "default value printed when there are no results")
-	cmdCompare.PersistentFlags().BoolVarP(&stripComments, "stripComments", "", false, "strip comments out before comparing")
-	cmdCompare.PersistentFlags().BoolVarP(&explodeAnchors, "explodeAnchors", "X", false, "explode anchors")
-	return cmdCompare
-}
-
-func compareDocuments(cmd *cobra.Command, args []string) error {
-	var path = ""
-
-	if len(args) < 2 {
-		return errors.New("Must provide at 2 yaml files")
-	} else if len(args) > 2 {
-		path = args[2]
-	}
-
-	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
-	if errorParsingDocIndex != nil {
-		return errorParsingDocIndex
-	}
-
-	var matchingNodesA []*yqlib.NodeContext
-	var matchingNodesB []*yqlib.NodeContext
-	var errorDoingThings error
-
-	matchingNodesA, errorDoingThings = readYamlFile(args[0], path, updateAll, docIndexInt)
-
-	if errorDoingThings != nil {
-		return errorDoingThings
-	}
-
-	matchingNodesB, errorDoingThings = readYamlFile(args[1], path, updateAll, docIndexInt)
-	if errorDoingThings != nil {
-		return errorDoingThings
-	}
-
-	var dataBufferA bytes.Buffer
-	var dataBufferB bytes.Buffer
-	errorDoingThings = printResults(matchingNodesA, bufio.NewWriter(&dataBufferA))
-	if errorDoingThings != nil {
-		return errorDoingThings
-	}
-	errorDoingThings = printResults(matchingNodesB, bufio.NewWriter(&dataBufferB))
-	if errorDoingThings != nil {
-		return errorDoingThings
-	}
-
-	diffString := diff.Diff(strings.TrimSuffix(dataBufferA.String(), "\n"), strings.TrimSuffix(dataBufferB.String(), "\n"))
-
-	if len(diffString) > 1 {
-		cmd.Print(diffString)
-		cmd.Print("\n")
-		if forceOsExit {
-			os.Exit(1)
-		}
-	}
-	return nil
-}

cmd/compare_test.go

@@ -1,115 +0,0 @@
-package cmd
-
-import (
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestCompareSameCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare ../examples/data1.yaml ../examples/data1.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := ``
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestCompareIgnoreCommentsCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare --stripComments ../examples/data1.yaml ../examples/data1-no-comments.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := ``
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestCompareDontIgnoreCommentsCmd(t *testing.T) {
-	forceOsExit = false
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare ../examples/data1.yaml ../examples/data1-no-comments.yaml")
-
-	expectedOutput := `-a: simple # just the best
-+a: simple
- b: [1, 2]
- c:
-   test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestCompareExplodeAnchorsCommentsCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare --explodeAnchors ../examples/simple-anchor.yaml ../examples/simple-anchor-exploded.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := ``
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestCompareDontExplodeAnchorsCmd(t *testing.T) {
-	forceOsExit = false
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare ../examples/simple-anchor.yaml ../examples/simple-anchor-exploded.yaml")
-
-	expectedOutput := `-foo: &foo
-+foo:
-   a: 1
- foobar:
--  !!merge <<: *foo
-+  a: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestCompareDifferentCmd(t *testing.T) {
-	forceOsExit = false
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare ../examples/data1.yaml ../examples/data3.yaml")
-
-	expectedOutput := `-a: simple # just the best
--b: [1, 2]
-+a: "simple" # just the best
-+b: [1, 3]
- c:
-   test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestComparePrettyCmd(t *testing.T) {
-	forceOsExit = false
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare -P ../examples/data1.yaml ../examples/data3.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := ` a: simple # just the best
- b:
-   - 1
--  - 2
-+  - 3
- c:
-   test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestComparePathsCmd(t *testing.T) {
-	forceOsExit = false
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare -P -ppv ../examples/data1.yaml ../examples/data3.yaml **")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := ` a: simple # just the best
- b.[0]: 1
--b.[1]: 2
-+b.[1]: 3
- c.test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}

cmd/constant.go

@@ -1,36 +1,30 @@
 package cmd
 
-import (
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	logging "gopkg.in/op/go-logging.v1"
-)
-
-var customTag = ""
-var printMode = "v"
-var printLength = false
+var leadingContentPreProcessing = true
 var unwrapScalar = true
-var customStyle = ""
-var anchorName = ""
-var makeAlias = false
-var stripComments = false
-var collectIntoArray = false
+
 var writeInplace = false
-var writeScript = ""
-var sourceYamlFile = ""
 var outputToJSON = false
+var outputFormat = "yaml"
+var inputFormat = "yaml"
+
+var xmlAttributePrefix = "+"
+var xmlContentName = "+content"
+
 var exitStatus = false
-var prettyPrint = false
-var explodeAnchors = false
+var forceColor = false
+var forceNoColor = false
 var colorsEnabled = false
-var defaultValue = ""
 var indent = 2
-var overwriteFlag = false
-var autoCreateFlag = true
-var arrayMergeStrategyFlag = "update"
-var commentsMergeStrategyFlag = "setWhenBlank"
+var noDocSeparators = false
+var nullInput = false
 var verbose = false
 var version = false
-var docIndex = "0"
-var log = logging.MustGetLogger("yq")
-var lib = yqlib.NewYqLib()
-var valueParser = yqlib.NewValueParser()
+var prettyPrint = false
+
+// can be either "" (off), "extract" or "process"
+var frontMatter = ""
+
+var splitFileExp = ""
+
+var completedSuccessfully = false

cmd/delete.go

@@ -1,41 +0,0 @@
-package cmd
-
-import (
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	errors "github.com/pkg/errors"
-	"github.com/spf13/cobra"
-)
-
-func createDeleteCmd() *cobra.Command {
-	var cmdDelete = &cobra.Command{
-		Use:     "delete [yaml_file] [path_expression]",
-		Aliases: []string{"d"},
-		Short:   "yq d [--inplace/-i] [--doc/-d index] sample.yaml 'b.e(name==fred)'",
-		Example: `
-yq delete things.yaml 'a.b.c'
-yq delete things.yaml 'a.*.c'
-yq delete things.yaml 'a.(child.subchild==co*).c'
-yq delete things.yaml 'a.**'
-yq delete --inplace things.yaml 'a.b.c'
-yq delete --inplace -- things.yaml '--key-starting-with-dash' # need to use '--' to stop processing arguments as flags
-yq d -i things.yaml 'a.b.c'
-	`,
-		Long: `Deletes the nodes matching the given path expression from the YAML file.
-Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
-`,
-		RunE: deleteProperty,
-	}
-	cmdDelete.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
-	cmdDelete.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	return cmdDelete
-}
-
-func deleteProperty(cmd *cobra.Command, args []string) error {
-	if len(args) < 2 {
-		return errors.New("Must provide <filename> <path_to_delete>")
-	}
-	var updateCommands []yqlib.UpdateCommand = make([]yqlib.UpdateCommand, 1)
-	updateCommands[0] = yqlib.UpdateCommand{Command: "delete", Path: args[1]}
-
-	return updateDoc(args[0], updateCommands, cmd.OutOrStdout())
-}

cmd/delete_test.go

@@ -1,246 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"strings"
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestDeleteYamlCmd(t *testing.T) {
-	content := `a: 2
-b:
-  c: things
-  d: something else
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s b.c", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: 2
-b:
-  d: something else
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteDeepDoesNotExistCmd(t *testing.T) {
-	content := `a: 2`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s b.c", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: 2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteSplatYaml(t *testing.T) {
-	content := `a: other
-b: [3, 4]
-c:
-  toast: leave
-  test: 1
-  tell: 1
-  tasty.taco: cool
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s c.te*", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: other
-b: [3, 4]
-c:
-  toast: leave
-  tasty.taco: cool
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteSplatArrayYaml(t *testing.T) {
-	content := `a: 2
-b:
- hi:
-  - thing: item1
-    name: fred
-  - thing: item2
-    name: sam
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s b.hi[*].thing", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: 2
-b:
-  hi:
-    - name: fred
-    - name: sam
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteDeepSplatArrayYaml(t *testing.T) {
-	content := `thing: 123
-b:
- hi:
-  - thing: item1
-    name: fred
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s **.thing", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `b:
-  hi:
-    - name: fred
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteSplatPrefixYaml(t *testing.T) {
-	content := `a: 2
-b:
- hi:
-   c: things
-   d: something else
- there:
-   c: more things
-   d: more something else
- there2:
-   c: more things also
-   d: more something else also
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s b.there*.c", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: 2
-b:
-  hi:
-    c: things
-    d: something else
-  there:
-    d: more something else
-  there2:
-    d: more something else also
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteYamlArrayCmd(t *testing.T) {
-	content := `- 1
-- 2
-- 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s [1]", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `- 1
-- 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteYamlArrayExpressionCmd(t *testing.T) {
-	content := `- name: fred
-- name: cat
-- name: thing
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s (name==cat)", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `- name: fred
-- name: thing
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteYamlMulti(t *testing.T) {
-	content := `apples: great
----
-- 1
-- 2
-- 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete -d 1 %s [1]", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `apples: great
----
-- 1
-- 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestDeleteYamlMultiAllCmd(t *testing.T) {
-	content := `b:
-  c: 3
-apples: great
----
-apples: great
-something: else
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("delete %s -d * apples", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
----
-something: else`
-	test.AssertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
-}

cmd/evaluate_all_command.go

@@ -0,0 +1,134 @@
+package cmd
+
+import (
+	"errors"
+	"os"
+
+	"github.com/mikefarah/yq/v4/pkg/yqlib"
+	"github.com/spf13/cobra"
+)
+
+func createEvaluateAllCommand() *cobra.Command {
+	var cmdEvalAll = &cobra.Command{
+		Use:     "eval-all [expression] [yaml_file1]...",
+		Aliases: []string{"ea"},
+		Short:   "Loads _all_ yaml documents of _all_ yaml files and runs expression once",
+		Example: `
+# Merge f2.yml into f1.yml (inplace)
+yq eval-all --inplace 'select(fileIndex == 0) * select(fileIndex == 1)' f1.yml f2.yml
+## the same command and expression using shortened names:
+yq ea -i 'select(fi == 0) * select(fi == 1)' f1.yml f2.yml
+
+
+# Merge all given files
+yq ea '. as $item ireduce ({}; . * $item )' file1.yml file2.yml ...
+
+# Pipe from STDIN
+## use '-' as a filename to pipe from STDIN
+cat file2.yml | yq ea '.a.b' file1.yml - file3.yml
+`,
+		Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/) 
+See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.
+
+## Evaluate All ##
+This command loads _all_ yaml documents of _all_ yaml files and runs expression once
+Useful when you need to run an expression across several yaml documents or files (like merge).
+Note that it consumes more memory than eval.
+`,
+		RunE: evaluateAll,
+	}
+	return cmdEvalAll
+}
+func evaluateAll(cmd *cobra.Command, args []string) (cmdError error) {
+	// 0 args, read std in
+	// 1 arg, null input, process expression
+	// 1 arg, read file in sequence
+	// 2+ args, [0] = expression, file the rest
+
+	var err error
+
+	firstFileIndex, err := initCommand(cmd, args)
+	if err != nil {
+		return err
+	}
+
+	stat, _ := os.Stdin.Stat()
+	pipingStdIn := (stat.Mode() & os.ModeCharDevice) == 0
+
+	out := cmd.OutOrStdout()
+
+	if writeInplace {
+		// only use colors if its forced
+		colorsEnabled = forceColor
+		writeInPlaceHandler := yqlib.NewWriteInPlaceHandler(args[firstFileIndex])
+		out, err = writeInPlaceHandler.CreateTempFile()
+		if err != nil {
+			return err
+		}
+		// need to indirectly call the function so  that completedSuccessfully is
+		// passed when we finish execution as opposed to now
+		defer func() {
+			if cmdError == nil {
+				cmdError = writeInPlaceHandler.FinishWriteInPlace(completedSuccessfully)
+			}
+		}()
+	}
+
+	format, err := yqlib.OutputFormatFromString(outputFormat)
+	if err != nil {
+		return err
+	}
+
+	decoder, err := configureDecoder()
+	if err != nil {
+		return err
+	}
+
+	printerWriter := configurePrinterWriter(format, out)
+	encoder := configureEncoder(format)
+
+	printer := yqlib.NewPrinter(encoder, printerWriter)
+
+	if frontMatter != "" {
+		frontMatterHandler := yqlib.NewFrontMatterHandler(args[firstFileIndex])
+		err = frontMatterHandler.Split()
+		if err != nil {
+			return err
+		}
+		args[firstFileIndex] = frontMatterHandler.GetYamlFrontMatterFilename()
+
+		if frontMatter == "process" {
+			reader := frontMatterHandler.GetContentReader()
+			printer.SetAppendix(reader)
+			defer yqlib.SafelyCloseReader(reader)
+		}
+		defer frontMatterHandler.CleanUp()
+	}
+
+	allAtOnceEvaluator := yqlib.NewAllAtOnceEvaluator()
+	switch len(args) {
+	case 0:
+		if pipingStdIn {
+			err = allAtOnceEvaluator.EvaluateFiles(processExpression(""), []string{"-"}, printer, leadingContentPreProcessing, decoder)
+		} else {
+			cmd.Println(cmd.UsageString())
+			return nil
+		}
+	case 1:
+		if nullInput {
+			err = yqlib.NewStreamEvaluator().EvaluateNew(processExpression(args[0]), printer, "")
+		} else {
+			err = allAtOnceEvaluator.EvaluateFiles(processExpression(""), []string{args[0]}, printer, leadingContentPreProcessing, decoder)
+		}
+	default:
+		err = allAtOnceEvaluator.EvaluateFiles(processExpression(args[0]), args[1:], printer, leadingContentPreProcessing, decoder)
+	}
+
+	completedSuccessfully = err == nil
+
+	if err == nil && exitStatus && !printer.PrintedAnything() {
+		return errors.New("no matches found")
+	}
+
+	return err
+}

cmd/evalute_sequence_command.go

@@ -0,0 +1,147 @@
+package cmd
+
+import (
+	"errors"
+	"fmt"
+	"os"
+
+	"github.com/mikefarah/yq/v4/pkg/yqlib"
+	"github.com/spf13/cobra"
+)
+
+func createEvaluateSequenceCommand() *cobra.Command {
+	var cmdEvalSequence = &cobra.Command{
+		Use:     "eval [expression] [yaml_file1]...",
+		Aliases: []string{"e"},
+		Short:   "Apply the expression to each document in each yaml file in sequence",
+		Example: `
+# Reads field under the given path for each file
+yq e '.a.b' f1.yml f2.yml 
+
+# Prints out the file
+yq e sample.yaml 
+
+# Pipe from STDIN
+## use '-' as a filename to pipe from STDIN
+cat file2.yml | yq e '.a.b' file1.yml - file3.yml
+
+# Creates a new yaml document
+## Note that editing an empty file does not work.
+yq e -n '.a.b.c = "cat"' 
+
+# Update a file inplace
+yq e '.a.b = "cool"' -i file.yaml 
+`,
+		Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/) 
+See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.
+
+## Evaluate Sequence ##
+This command iterates over each yaml document from each given file, applies the 
+expression and prints the result in sequence.`,
+		RunE: evaluateSequence,
+	}
+	return cmdEvalSequence
+}
+
+func processExpression(expression string) string {
+	var prettyPrintExp = `(... | (select(tag != "!!str"), select(tag == "!!str") | select(test("(?i)^(y|yes|n|no|on|off)$") | not))  ) style=""`
+	if prettyPrint && expression == "" {
+		return prettyPrintExp
+	} else if prettyPrint {
+		return fmt.Sprintf("%v | %v", expression, prettyPrintExp)
+	}
+	return expression
+}
+
+func evaluateSequence(cmd *cobra.Command, args []string) (cmdError error) {
+	// 0 args, read std in
+	// 1 arg, null input, process expression
+	// 1 arg, read file in sequence
+	// 2+ args, [0] = expression, file the rest
+
+	var err error
+	firstFileIndex, err := initCommand(cmd, args)
+	if err != nil {
+		return err
+	}
+
+	stat, _ := os.Stdin.Stat()
+	pipingStdIn := (stat.Mode() & os.ModeCharDevice) == 0
+
+	out := cmd.OutOrStdout()
+
+	if writeInplace {
+		// only use colors if its forced
+		colorsEnabled = forceColor
+		writeInPlaceHandler := yqlib.NewWriteInPlaceHandler(args[firstFileIndex])
+		out, err = writeInPlaceHandler.CreateTempFile()
+		if err != nil {
+			return err
+		}
+		// need to indirectly call the function so  that completedSuccessfully is
+		// passed when we finish execution as opposed to now
+		defer func() {
+			if cmdError == nil {
+				cmdError = writeInPlaceHandler.FinishWriteInPlace(completedSuccessfully)
+			}
+		}()
+	}
+
+	format, err := yqlib.OutputFormatFromString(outputFormat)
+	if err != nil {
+		return err
+	}
+
+	printerWriter := configurePrinterWriter(format, out)
+	encoder := configureEncoder(format)
+
+	printer := yqlib.NewPrinter(encoder, printerWriter)
+
+	decoder, err := configureDecoder()
+	if err != nil {
+		return err
+	}
+
+	streamEvaluator := yqlib.NewStreamEvaluator()
+
+	if frontMatter != "" {
+		frontMatterHandler := yqlib.NewFrontMatterHandler(args[firstFileIndex])
+		err = frontMatterHandler.Split()
+		if err != nil {
+			return err
+		}
+		args[firstFileIndex] = frontMatterHandler.GetYamlFrontMatterFilename()
+
+		if frontMatter == "process" {
+			reader := frontMatterHandler.GetContentReader()
+			printer.SetAppendix(reader)
+			defer yqlib.SafelyCloseReader(reader)
+		}
+		defer frontMatterHandler.CleanUp()
+	}
+
+	switch len(args) {
+	case 0:
+		if pipingStdIn {
+			err = streamEvaluator.EvaluateFiles(processExpression(""), []string{"-"}, printer, leadingContentPreProcessing, decoder)
+		} else {
+			cmd.Println(cmd.UsageString())
+			return nil
+		}
+	case 1:
+		if nullInput {
+			err = streamEvaluator.EvaluateNew(processExpression(args[0]), printer, "")
+		} else {
+			err = streamEvaluator.EvaluateFiles(processExpression(""), []string{args[0]}, printer, leadingContentPreProcessing, decoder)
+		}
+	default:
+		err = streamEvaluator.EvaluateFiles(processExpression(args[0]), args[1:], printer, leadingContentPreProcessing, decoder)
+	}
+	completedSuccessfully = err == nil
+
+	if err == nil && exitStatus && !printer.PrintedAnything() {
+		return errors.New("no matches found")
+	}
+
+	return err
+}

cmd/merge.go

@@ -1,124 +0,0 @@
-package cmd
-
-import (
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	errors "github.com/pkg/errors"
-	"github.com/spf13/cobra"
-	yaml "gopkg.in/yaml.v3"
-)
-
-func createMergeCmd() *cobra.Command {
-	var cmdMerge = &cobra.Command{
-		Use:     "merge [initial_yaml_file] [additional_yaml_file]...",
-		Aliases: []string{"m"},
-		Short:   "yq m [--inplace/-i] [--doc/-d index] [--overwrite/-x] [--arrayMerge/-a strategy] sample.yaml sample2.yaml",
-		Example: `
-yq merge things.yaml other.yaml
-yq merge --inplace things.yaml other.yaml
-yq m -i things.yaml other.yaml
-yq m --overwrite things.yaml other.yaml
-yq m -i -x things.yaml other.yaml
-yq m -i -a=append things.yaml other.yaml
-yq m -i --autocreate=false things.yaml other.yaml
-      `,
-		Long: `Updates the yaml file by adding/updating the path(s) and value(s) from additional yaml file(s).
-Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
-
-If overwrite flag is set then existing values will be overwritten using the values from each additional yaml file.
-If append flag is set then existing arrays will be merged with the arrays from each additional yaml file.
-`,
-		RunE: mergeProperties,
-	}
-	cmdMerge.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
-	cmdMerge.PersistentFlags().BoolVarP(&overwriteFlag, "overwrite", "x", false, "update the yaml file by overwriting existing values")
-	cmdMerge.PersistentFlags().BoolVarP(&autoCreateFlag, "autocreate", "c", true, "automatically create any missing entries")
-	cmdMerge.PersistentFlags().StringVarP(&arrayMergeStrategyFlag, "arrays", "a", "update", `array merge strategy (update/append/overwrite)
-update: recursively update arrays by their index
-append: concatenate arrays together
-overwrite: replace arrays
-`)
-	cmdMerge.PersistentFlags().StringVarP(&commentsMergeStrategyFlag, "comments", "", "setWhenBlank", `comments merge strategy (setWhenBlank/ignore/append/overwrite)
-setWhenBlank: set comment if the original document has no comment at that node
-ignore: leave comments as-is in the original
-append: append comments together
-overwrite: overwrite comments completely
-`)
-	cmdMerge.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	return cmdMerge
-}
-
-/*
-* We don't deeply traverse arrays when appending a merge, instead we want to
-* append the entire array element.
- */
-func createReadFunctionForMerge(arrayMergeStrategy yqlib.ArrayMergeStrategy) func(*yaml.Node) ([]*yqlib.NodeContext, error) {
-	return func(dataBucket *yaml.Node) ([]*yqlib.NodeContext, error) {
-		return lib.GetForMerge(dataBucket, "**", arrayMergeStrategy)
-	}
-}
-
-func mergeProperties(cmd *cobra.Command, args []string) error {
-	var updateCommands []yqlib.UpdateCommand = make([]yqlib.UpdateCommand, 0)
-
-	if len(args) < 1 {
-		return errors.New("Must provide at least 1 yaml file")
-	}
-	var arrayMergeStrategy yqlib.ArrayMergeStrategy
-
-	switch arrayMergeStrategyFlag {
-	case "update":
-		arrayMergeStrategy = yqlib.UpdateArrayMergeStrategy
-	case "append":
-		arrayMergeStrategy = yqlib.AppendArrayMergeStrategy
-	case "overwrite":
-		arrayMergeStrategy = yqlib.OverwriteArrayMergeStrategy
-	default:
-		return errors.New("Array merge strategy must be one of: update/append/overwrite")
-	}
-
-	var commentsMergeStrategy yqlib.CommentsMergeStrategy
-
-	switch commentsMergeStrategyFlag {
-	case "setWhenBlank":
-		commentsMergeStrategy = yqlib.SetWhenBlankCommentsMergeStrategy
-	case "ignore":
-		commentsMergeStrategy = yqlib.IgnoreCommentsMergeStrategy
-	case "append":
-		commentsMergeStrategy = yqlib.AppendCommentsMergeStrategy
-	case "overwrite":
-		commentsMergeStrategy = yqlib.OverwriteCommentsMergeStrategy
-	default:
-		return errors.New("Comments merge strategy must be one of: setWhenBlank/ignore/append/overwrite")
-	}
-
-	if len(args) > 1 {
-		// first generate update commands from the file
-		var filesToMerge = args[1:]
-
-		for _, fileToMerge := range filesToMerge {
-			matchingNodes, errorProcessingFile := doReadYamlFile(fileToMerge, createReadFunctionForMerge(arrayMergeStrategy), false, 0)
-			if errorProcessingFile != nil {
-				return errorProcessingFile
-			}
-			log.Debugf("finished reading for merge!")
-			for _, matchingNode := range matchingNodes {
-				log.Debugf("matched node %v", lib.PathStackToString(matchingNode.PathStack))
-				yqlib.DebugNode(matchingNode.Node)
-			}
-			for _, matchingNode := range matchingNodes {
-				mergePath := lib.MergePathStackToString(matchingNode.PathStack, arrayMergeStrategy)
-				updateCommands = append(updateCommands, yqlib.UpdateCommand{
-					Command:               "merge",
-					Path:                  mergePath,
-					Value:                 matchingNode.Node,
-					Overwrite:             overwriteFlag,
-					CommentsMergeStrategy: commentsMergeStrategy,
-					// dont update the content for nodes midway, only leaf nodes
-					DontUpdateNodeContent: matchingNode.IsMiddleNode && (arrayMergeStrategy != yqlib.OverwriteArrayMergeStrategy || matchingNode.Node.Kind != yaml.SequenceNode),
-				})
-			}
-		}
-	}
-
-	return updateDoc(args[0], updateCommands, cmd.OutOrStdout())
-}

cmd/merge_test.go

@@ -1,551 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"os"
-	"runtime"
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestMergeCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge ../examples/data1.yaml ../examples/data2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-  toast: leave
-  tell: 1
-  tasty.taco: cool
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeOneFileCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge ../examples/data1.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeNoAutoCreateCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge -c=false ../examples/data1.yaml ../examples/data2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeOverwriteCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge -c=false --overwrite ../examples/data1.yaml ../examples/data2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: other # just the best
-b: [3, 4]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeOverwriteDeepExampleCmd(t *testing.T) {
-	content := `c:
-  test: 1
-  thing: whatever
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `c:
-  test: 5
-`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --autocreate=false --overwrite %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `c:
-  test: 5
-  thing: whatever
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeAppendCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge --autocreate=false --arrays=append ../examples/data1.yaml ../examples/data2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: simple # just the best
-b: [1, 2, 3, 4]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeAppendArraysCmd(t *testing.T) {
-	content := `people:
-  - name: Barry
-    age: 21`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `people:
-  - name: Roger
-    age: 44`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --arrays=append -d* %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `people:
-  - name: Barry
-    age: 21
-  - name: Roger
-    age: 44
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeAliasArraysCmd(t *testing.T) {
-	content := `
-vars:
-  variable1: &var1 cat
-
-usage:
-  value1: *var1
-  valueAnother: *var1
-  valuePlain: thing
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `
-vars:
-  variable2: &var2 puppy
-
-usage:
-  value2: *var2
-  valueAnother: *var2
-  valuePlain: *var2
-`
-
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge -x %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `vars:
-  variable1: &var1 cat
-  variable2: &var2 puppy
-usage:
-  value1: *var1
-  valueAnother: *var2
-  valuePlain: *var2
-  value2: *var2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeOverwriteAndAppendCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge --autocreate=false --arrays=append --overwrite ../examples/data1.yaml ../examples/data2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: other # just the best
-b: [1, 2, 3, 4]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-var commentContentA = `
-a: valueA1 # commentA1
-b: valueB1
-`
-
-var commentContentB = `
-a: valueA2 # commentA2
-b: valueB2 # commentB2
-c: valueC2 # commentC2
-`
-
-func TestMergeCommentsSetWhenBlankCmd(t *testing.T) {
-	filename := test.WriteTempYamlFile(commentContentA)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeFilename := test.WriteTempYamlFile(commentContentB)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --comments=setWhenBlank %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: valueA1 # commentA1
-b: valueB1 # commentB2
-c: valueC2 # commentC2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeCommentsIgnoreCmd(t *testing.T) {
-	filename := test.WriteTempYamlFile(commentContentA)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeFilename := test.WriteTempYamlFile(commentContentB)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --comments=ignore %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: valueA1 # commentA1
-b: valueB1
-c: valueC2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeCommentsAppendCmd(t *testing.T) {
-	filename := test.WriteTempYamlFile(commentContentA)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeFilename := test.WriteTempYamlFile(commentContentB)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --comments=append %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: valueA1 # commentA1 # commentA2
-b: valueB1 # commentB2
-c: valueC2 # commentC2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeCommentsOverwriteCmd(t *testing.T) {
-	filename := test.WriteTempYamlFile(commentContentA)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeFilename := test.WriteTempYamlFile(commentContentB)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --comments=overwrite %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: valueA1 # commentA2
-b: valueB1 # commentB2
-c: valueC2 # commentC2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeOverwriteArraysTooCmd(t *testing.T) {
-	content := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `a: things
-b: [6]`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --autocreate=false --arrays=overwrite --overwrite %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-
-	expectedOutput := `a: things # just the best
-b: [6]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeRootArraysCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge --arrays=append ../examples/sample_array.yaml ../examples/sample_array_2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `- 1
-- 2
-- 3
-- 4
-- 5
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeOverwriteArraysCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge --arrays=overwrite ../examples/sample_array.yaml ../examples/sample_array_2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `- 4
-- 5
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeUpdateArraysCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge -x --arrays=update ../examples/sample_array.yaml ../examples/sample_array_2.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `- 4
-- 5
-- 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeCmd_Multi(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge -d1 ../examples/multiple_docs_small.yaml ../examples/data1.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: Easy! as one two three
----
-another:
-  document: here
-a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
----
-- 1
-- 2
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeYamlMultiAllCmd(t *testing.T) {
-	content := `b:
-  c: 3
-apples: green
----
-something: else`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `apples: red
-something: good`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge -d* %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
-apples: green
-something: good
----
-something: else
-apples: red
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeSpecialCharacterKeysCmd(t *testing.T) {
-	content := ``
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `key[bracket]: value
-key.bracket: value
-key"value": value
-key'value': value
-`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	test.AssertResult(t, mergeContent, result.Output)
-}
-
-func TestMergeYamlMultiAllOverwriteCmd(t *testing.T) {
-	content := `b:
-  c: 3
-apples: green
----
-something: else`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `apples: red
-something: good`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge --overwrite -d* %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
-apples: red
-something: good
----
-something: good
-apples: red
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeYamlNullMapCmd(t *testing.T) {
-	content := `b:`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	mergeContent := `b:
-  thing: a frog
-`
-	mergeFilename := test.WriteTempYamlFile(mergeContent)
-	defer test.RemoveTempYamlFile(mergeFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge %s %s", filename, mergeFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	test.AssertResult(t, mergeContent, result.Output)
-}
-
-func TestMergeCmd_Error(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to missing arg")
-	}
-	expectedOutput := `Must provide at least 1 yaml file`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestMergeCmd_ErrorUnreadableFile(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge ../examples/data1.yaml fake-unknown")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to unknown file")
-	}
-	var expectedOutput string
-	if runtime.GOOS == "windows" {
-		expectedOutput = `open fake-unknown: The system cannot find the file specified.`
-	} else {
-		expectedOutput = `open fake-unknown: no such file or directory`
-	}
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestMergeCmd_Inplace(t *testing.T) {
-	filename := test.WriteTempYamlFile(test.ReadTempYamlFile("../examples/data1.yaml"))
-	err := os.Chmod(filename, os.FileMode(int(0666)))
-	if err != nil {
-		t.Error(err)
-	}
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("merge -i %s ../examples/data2.yaml", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	info, _ := os.Stat(filename)
-	gotOutput := test.ReadTempYamlFile(filename)
-	expectedOutput := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-  toast: leave
-  tell: 1
-  tasty.taco: cool
-`
-	test.AssertResult(t, expectedOutput, gotOutput)
-	test.AssertResult(t, os.FileMode(int(0666)), info.Mode())
-}
-
-func TestMergeAllowEmptyTargetCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge ../examples/empty.yaml ../examples/data1.yaml")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestMergeAllowEmptyMergeCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "merge ../examples/data1.yaml ../examples/empty.yaml")
-	expectedOutput := `a: simple # just the best
-b: [1, 2]
-c:
-  test: 1
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}

cmd/new.go

@@ -1,55 +0,0 @@
-package cmd
-
-import (
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	"github.com/spf13/cobra"
-)
-
-func createNewCmd() *cobra.Command {
-	var cmdNew = &cobra.Command{
-		Use:     "new [path] [value]",
-		Aliases: []string{"n"},
-		Short:   "yq n [--script/-s script_file] a.b.c newValue",
-		Example: `
-yq new 'a.b.c' cat
-yq n 'a.b.c' --tag '!!str' true # force 'true' to be interpreted as a string instead of bool
-yq n 'a.b[+]' cat
-yq n -- '--key-starting-with-dash' cat # need to use '--' to stop processing arguments as flags
-yq n --script create_script.yaml
-      `,
-		Long: `Creates a new yaml w.r.t the given path and value.
-Outputs to STDOUT
-
-Create Scripts:
-Note that you can give a create script to perform more sophisticated yaml. This follows the same format as the update script.
-`,
-		RunE: newProperty,
-	}
-	cmdNew.PersistentFlags().StringVarP(&writeScript, "script", "s", "", "yaml script for creating yaml")
-	cmdNew.PersistentFlags().StringVarP(&customTag, "tag", "t", "", "set yaml tag (e.g. !!int)")
-	cmdNew.PersistentFlags().StringVarP(&customStyle, "style", "", "", "formatting style of the value: single, double, folded, flow, literal, tagged")
-	cmdNew.PersistentFlags().StringVarP(&anchorName, "anchorName", "", "", "anchor name")
-	cmdNew.PersistentFlags().BoolVarP(&makeAlias, "makeAlias", "", false, "create an alias using the value as the anchor name")
-	return cmdNew
-}
-
-func newProperty(cmd *cobra.Command, args []string) error {
-	var badArgsMessage = "Must provide <path_to_update> <value>"
-	var updateCommands, updateCommandsError = readUpdateCommands(args, 2, badArgsMessage, false)
-	if updateCommandsError != nil {
-		return updateCommandsError
-	}
-	newNode := lib.New(updateCommands[0].Path)
-
-	for _, updateCommand := range updateCommands {
-
-		errorUpdating := lib.Update(&newNode, updateCommand, true)
-
-		if errorUpdating != nil {
-			return errorUpdating
-		}
-	}
-
-	var encoder = yqlib.NewYamlEncoder(cmd.OutOrStdout(), indent, colorsEnabled)
-	return encoder.Encode(&newNode)
-}

cmd/new_test.go

@@ -1,120 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestNewCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c 3")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewCmdScript(t *testing.T) {
-	updateScript := `- command: update
-  path: b.c
-  value: 7`
-	scriptFilename := test.WriteTempYamlFile(updateScript)
-	defer test.RemoveTempYamlFile(scriptFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("new --script %s", scriptFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 7
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewAnchorCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c 3 --anchorName=fred")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: &fred 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewAliasCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c foo --makeAlias")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: *foo
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewArrayCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b[0] 3")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  - 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewCmd_Error(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to missing arg")
-	}
-	expectedOutput := `Must provide <path_to_update> <value>`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestNewWithTaggedStyleCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c cat --tag=!!str --style=tagged")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: !!str cat
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewWithDoubleQuotedStyleCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c cat --style=double")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: "cat"
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestNewWithSingleQuotedStyleCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "new b.c cat --style=single")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 'cat'
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}

cmd/prefix.go

@@ -1,50 +0,0 @@
-package cmd
-
-import (
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	errors "github.com/pkg/errors"
-	"github.com/spf13/cobra"
-	yaml "gopkg.in/yaml.v3"
-)
-
-func createPrefixCmd() *cobra.Command {
-	var cmdPrefix = &cobra.Command{
-		Use:     "prefix [yaml_file] [path]",
-		Aliases: []string{"p"},
-		Short:   "yq p [--inplace/-i] [--doc/-d index] sample.yaml a.b.c",
-		Example: `
-yq prefix things.yaml 'a.b.c'
-yq prefix --inplace things.yaml 'a.b.c'
-yq prefix --inplace -- things.yaml '--key-starting-with-dash' # need to use '--' to stop processing arguments as flags
-yq p -i things.yaml 'a.b.c'
-yq p --doc 2 things.yaml 'a.b.d'
-yq p -d2 things.yaml 'a.b.d'
-      `,
-		Long: `Prefixes w.r.t to the yaml file at the given path.
-Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
-`,
-		RunE: prefixProperty,
-	}
-	cmdPrefix.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
-	cmdPrefix.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	return cmdPrefix
-}
-
-func prefixProperty(cmd *cobra.Command, args []string) error {
-
-	if len(args) < 2 {
-		return errors.New("Must provide <filename> <prefixed_path>")
-	}
-	updateCommand := yqlib.UpdateCommand{Command: "update", Path: args[1]}
-	log.Debugf("args %v", args)
-
-	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
-	if errorParsingDocIndex != nil {
-		return errorParsingDocIndex
-	}
-
-	var updateData = func(dataBucket *yaml.Node, currentIndex int) error {
-		return prefixDocument(updateAll, docIndexInt, currentIndex, dataBucket, updateCommand)
-	}
-	return readAndUpdate(cmd.OutOrStdout(), args[0], updateData)
-}

cmd/prefix_test.go

@@ -1,189 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"runtime"
-	"strings"
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestPrefixCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s d", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `d:
-  b:
-    c: 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestPrefixCmdArray(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s [+].d.[+]", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `- d:
-    - b:
-        c: 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestPrefixCmd_MultiLayer(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s d.e.f", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `d:
-  e:
-    f:
-      b:
-        c: 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestPrefixMultiCmd(t *testing.T) {
-	content := `b:
-  c: 3
----
-apples: great
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s -d 1 d", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
----
-d:
-  apples: great
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-func TestPrefixInvalidDocumentIndexCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s -df d", filename))
-	if result.Error == nil {
-		t.Error("Expected command to fail due to invalid path")
-	}
-	expectedOutput := `Document index f is not a integer or *: strconv.ParseInt: parsing "f": invalid syntax`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestPrefixBadDocumentIndexCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s -d 1 d", filename))
-	if result.Error == nil {
-		t.Error("Expected command to fail due to invalid path")
-	}
-	expectedOutput := `asked to process document index 1 but there are only 1 document(s)`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-func TestPrefixMultiAllCmd(t *testing.T) {
-	content := `b:
-  c: 3
----
-apples: great
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix %s -d * d", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `d:
-  b:
-    c: 3
----
-d:
-  apples: great`
-	test.AssertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
-}
-
-func TestPrefixCmd_Error(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "prefix")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to missing arg")
-	}
-	expectedOutput := `Must provide <filename> <prefixed_path>`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestPrefixCmd_ErrorUnreadableFile(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "prefix fake-unknown a.b")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to unknown file")
-	}
-	var expectedOutput string
-	if runtime.GOOS == "windows" {
-		expectedOutput = `open fake-unknown: The system cannot find the file specified.`
-	} else {
-		expectedOutput = `open fake-unknown: no such file or directory`
-	}
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestPrefixCmd_Inplace(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("prefix -i %s d", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	gotOutput := test.ReadTempYamlFile(filename)
-	expectedOutput := `d:
-  b:
-    c: 3`
-	test.AssertResult(t, expectedOutput, strings.Trim(gotOutput, "\n "))
-}

cmd/read.go

@@ -1,66 +0,0 @@
-package cmd
-
-import (
-	errors "github.com/pkg/errors"
-	"github.com/spf13/cobra"
-)
-
-func createReadCmd() *cobra.Command {
-	var cmdRead = &cobra.Command{
-		Use:     "read [yaml_file] [path_expression]",
-		Aliases: []string{"r"},
-		Short:   "yq r [--printMode/-p pv] sample.yaml 'b.e(name==fr*).value'",
-		Example: `
-yq read things.yaml 'a.b.c'
-yq r - 'a.b.c' # reads from stdin
-yq r things.yaml 'a.*.c'
-yq r things.yaml 'a.**.c' # deep splat
-yq r things.yaml 'a.(child.subchild==co*).c'
-yq r -d1 things.yaml 'a.array[0].blah'
-yq r things.yaml 'a.array[*].blah'
-yq r -- things.yaml '--key-starting-with-dashes.blah'
-      `,
-		Long: "Outputs the value of the given path in the yaml file to STDOUT",
-		RunE: readProperty,
-	}
-	cmdRead.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	cmdRead.PersistentFlags().StringVarP(&printMode, "printMode", "p", "v", "print mode (v (values, default), p (paths), pv (path and value pairs)")
-	cmdRead.PersistentFlags().StringVarP(&defaultValue, "defaultValue", "D", "", "default value printed when there are no results")
-	cmdRead.PersistentFlags().BoolVarP(&printLength, "length", "l", false, "print length of results")
-	cmdRead.PersistentFlags().BoolVarP(&collectIntoArray, "collect", "c", false, "collect results into array")
-	cmdRead.PersistentFlags().BoolVarP(&unwrapScalar, "unwrapScalar", "", true, "unwrap scalar, print the value with no quotes, colors or comments")
-	cmdRead.PersistentFlags().BoolVarP(&stripComments, "stripComments", "", false, "print yaml without any comments")
-	cmdRead.PersistentFlags().BoolVarP(&explodeAnchors, "explodeAnchors", "X", false, "explode anchors")
-	cmdRead.PersistentFlags().BoolVarP(&exitStatus, "exitStatus", "e", false, "set exit status if no matches are found")
-	return cmdRead
-}
-
-func readProperty(cmd *cobra.Command, args []string) error {
-	var path = ""
-
-	if len(args) < 1 {
-		return errors.New("Must provide filename")
-	} else if len(args) > 1 {
-		path = args[1]
-	}
-
-	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
-	if errorParsingDocIndex != nil {
-		return errorParsingDocIndex
-	}
-
-	matchingNodes, errorReadingStream := readYamlFile(args[0], path, updateAll, docIndexInt)
-
-	if exitStatus && len(matchingNodes) == 0 {
-		cmd.SilenceUsage = true
-		return errors.New("No matches found")
-	}
-
-	if errorReadingStream != nil {
-		cmd.SilenceUsage = true
-		return errorReadingStream
-	}
-	out := cmd.OutOrStdout()
-
-	return printResults(matchingNodes, out)
-}

cmd/root.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"os"
 
+	"github.com/mikefarah/yq/v4/pkg/yqlib"
 	"github.com/spf13/cobra"
 	logging "gopkg.in/op/go-logging.v1"
 )
@@ -11,15 +12,16 @@ func New() *cobra.Command {
 	var rootCmd = &cobra.Command{
 		Use:   "yq",
 		Short: "yq is a lightweight and portable command-line YAML processor.",
-		Long:  `yq is a lightweight and portable command-line YAML processor. It aims to be the jq or sed of yaml files.`,
+		Long: `yq is a portable command-line YAML processor (https://github.com/mikefarah/yq/) 
+See https://mikefarah.gitbook.io/yq/ for detailed documentation and examples.`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if version {
 				cmd.Print(GetVersionDisplay())
 				return nil
 			}
 			cmd.Println(cmd.UsageString())
-
 			return nil
+
 		},
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			cmd.SetOut(cmd.OutOrStdout())
@@ -36,26 +38,46 @@ func New() *cobra.Command {
 			}
 
 			logging.SetBackend(backend)
+			yqlib.XmlPreferences.AttributePrefix = xmlAttributePrefix
+			yqlib.XmlPreferences.ContentName = xmlContentName
 		},
 	}
 
 	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "verbose mode")
-	rootCmd.PersistentFlags().BoolVarP(&outputToJSON, "tojson", "j", false, "output as json. By default it prints a json document in one line, use the prettyPrint flag to print a formatted doc.")
-	rootCmd.PersistentFlags().BoolVarP(&prettyPrint, "prettyPrint", "P", false, "pretty print")
+
+	rootCmd.PersistentFlags().BoolVarP(&outputToJSON, "tojson", "j", false, "(deprecated) output as json. Set indent to 0 to print json in one line.")
+	err := rootCmd.PersistentFlags().MarkDeprecated("tojson", "please use -o=json instead")
+	if err != nil {
+		panic(err)
+	}
+
+	rootCmd.PersistentFlags().StringVarP(&outputFormat, "output-format", "o", "yaml", "[yaml|y|json|j|props|p|xml|x] output format type.")
+	rootCmd.PersistentFlags().StringVarP(&inputFormat, "input-format", "p", "yaml", "[yaml|y|xml|x] input format type. Note that json is a subset of yaml.")
+
+	rootCmd.PersistentFlags().StringVar(&xmlAttributePrefix, "xml-attribute-prefix", "+", "prefix for xml attributes")
+	rootCmd.PersistentFlags().StringVar(&xmlContentName, "xml-content-name", "+content", "name for xml content (if no attribute name is present).")
+
+	rootCmd.PersistentFlags().BoolVarP(&nullInput, "null-input", "n", false, "Don't read input, simply evaluate the expression given. Useful for creating docs from scratch.")
+	rootCmd.PersistentFlags().BoolVarP(&noDocSeparators, "no-doc", "N", false, "Don't print document separators (---)")
+
 	rootCmd.PersistentFlags().IntVarP(&indent, "indent", "I", 2, "sets indent level for output")
 	rootCmd.Flags().BoolVarP(&version, "version", "V", false, "Print version information and quit")
-	rootCmd.PersistentFlags().BoolVarP(&colorsEnabled, "colors", "C", false, "print with colors")
+	rootCmd.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the file inplace of first file given.")
+	rootCmd.PersistentFlags().BoolVarP(&unwrapScalar, "unwrapScalar", "", true, "unwrap scalar, print the value with no quotes, colors or comments")
+	rootCmd.PersistentFlags().BoolVarP(&prettyPrint, "prettyPrint", "P", false, "pretty print, shorthand for '... style = \"\"'")
+	rootCmd.PersistentFlags().BoolVarP(&exitStatus, "exit-status", "e", false, "set exit status if there are no matches or null or false is returned")
+
+	rootCmd.PersistentFlags().BoolVarP(&forceColor, "colors", "C", false, "force print with colors")
+	rootCmd.PersistentFlags().BoolVarP(&forceNoColor, "no-colors", "M", false, "force print with no colors")
+	rootCmd.PersistentFlags().StringVarP(&frontMatter, "front-matter", "f", "", "(extract|process) first input as yaml front-matter. Extract will pull out the yaml content, process will run the expression against the yaml content, leaving the remaining data intact")
+	rootCmd.PersistentFlags().BoolVarP(&leadingContentPreProcessing, "header-preprocess", "", true, "Slurp any header comments and separators before processing expression.")
+
+	rootCmd.PersistentFlags().StringVarP(&splitFileExp, "split-exp", "s", "", "print each result (or doc) into a file named (exp). [exp] argument must return a string. You can use $index in the expression as the result counter.")
 
 	rootCmd.AddCommand(
-		createReadCmd(),
-		createCompareCmd(),
-		createValidateCmd(),
-		createWriteCmd(),
-		createPrefixCmd(),
-		createDeleteCmd(),
-		createNewCmd(),
-		createMergeCmd(),
-		createBashCompletionCmd(rootCmd),
+		createEvaluateSequenceCommand(),
+		createEvaluateAllCommand(),
+		completionCmd,
 	)
 	return rootCmd
 }

cmd/shell-completion.go

@@ -0,0 +1,61 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var completionCmd = &cobra.Command{
+	Use:   "shell-completion [bash|zsh|fish|powershell]",
+	Short: "Generate completion script",
+	Long: `To load completions:
+
+Bash:
+
+$ source <(yq shell-completion bash)
+
+# To load completions for each session, execute once:
+Linux:
+  $ yq shell-completion bash > /etc/bash_completion.d/yq
+MacOS:
+  $ yq shell-completion bash > /usr/local/etc/bash_completion.d/yq
+
+Zsh:
+
+# If shell completion is not already enabled in your environment you will need
+# to enable it.  You can execute the following once:
+
+$ echo "autoload -U compinit; compinit" >> ~/.zshrc
+
+# To load completions for each session, execute once:
+$ yq shell-completion zsh > "${fpath[1]}/_yq"
+
+# You will need to start a new shell for this setup to take effect.
+
+Fish:
+
+$ yq shell-completion fish | source
+
+# To load completions for each session, execute once:
+$ yq shell-completion fish > ~/.config/fish/completions/yq.fish
+`,
+	DisableFlagsInUseLine: true,
+	ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
+	Args:                  cobra.ExactValidArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		var err error = nil
+		switch args[0] {
+		case "bash":
+			err = cmd.Root().GenBashCompletion(os.Stdout)
+		case "zsh":
+			err = cmd.Root().GenZshCompletion(os.Stdout)
+		case "fish":
+			err = cmd.Root().GenFishCompletion(os.Stdout, true)
+		case "powershell":
+			err = cmd.Root().GenPowerShellCompletion(os.Stdout)
+		}
+		return err
+
+	},
+}

cmd/shell_completion.go

@@ -1,57 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"os"
-
-	"github.com/spf13/cobra"
-)
-
-var shellVariant = "bash"
-
-func createBashCompletionCmd(rootCmd *cobra.Command) *cobra.Command {
-	var completionCmd = &cobra.Command{
-		Use:   "shell-completion",
-		Short: "Generates shell completion scripts",
-		Long: `To load completion for:
-bash:
-	Run	
-	. <(yq shell-completion)
-	
-	To configure your bash shell to load completions for each session add to
-	your bashrc
-	
-	# ~/.bashrc or ~/.profile
-	. <(yq shell-completion)
-
-zsh:
-	The generated completion script should be put somewhere in your $fpath named _yq
-
-powershell:
-	Users need PowerShell version 5.0 or above, which comes with Windows 10 and 
-	can be downloaded separately for Windows 7 or 8.1. They can then write the 
-	completions to a file and source this file from their PowerShell profile, 
-	which is referenced by the $Profile environment variable.
-
-fish:
-	Save the output to a fish file and add it to your completions directory.
-
-	`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			switch shellVariant {
-			case "bash", "":
-				return rootCmd.GenBashCompletion(os.Stdout)
-			case "zsh":
-				return rootCmd.GenZshCompletion(os.Stdout)
-			case "fish":
-				return rootCmd.GenFishCompletion(os.Stdout, true)
-			case "powershell":
-				return rootCmd.GenPowerShellCompletion(os.Stdout)
-			default:
-				return fmt.Errorf("Unknown variant %v", shellVariant)
-			}
-		},
-	}
-	completionCmd.PersistentFlags().StringVarP(&shellVariant, "variation", "V", "", "shell variation: bash (default), zsh, fish, powershell")
-	return completionCmd
-}

cmd/utils.go

@@ -1,619 +1,93 @@
 package cmd
 
 import (
-	"bufio"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
-	"strconv"
 
-	"github.com/mikefarah/yq/v3/pkg/yqlib"
-	errors "github.com/pkg/errors"
-	yaml "gopkg.in/yaml.v3"
+	"github.com/mikefarah/yq/v4/pkg/yqlib"
+	"github.com/spf13/cobra"
 )
 
-type readDataFn func(dataBucket *yaml.Node) ([]*yqlib.NodeContext, error)
+func initCommand(cmd *cobra.Command, args []string) (firstFileIndex int, err error) {
+	cmd.SilenceUsage = true
 
-func createReadFunction(path string) func(*yaml.Node) ([]*yqlib.NodeContext, error) {
-	return func(dataBucket *yaml.Node) ([]*yqlib.NodeContext, error) {
-		return lib.Get(dataBucket, path)
+	fileInfo, _ := os.Stdout.Stat()
+
+	if forceColor || (!forceNoColor && (fileInfo.Mode()&os.ModeCharDevice) != 0) {
+		colorsEnabled = true
 	}
-}
 
-func readYamlFile(filename string, path string, updateAll bool, docIndexInt int) ([]*yqlib.NodeContext, error) {
-	return doReadYamlFile(filename, createReadFunction(path), updateAll, docIndexInt)
-}
-
-func doReadYamlFile(filename string, readFn readDataFn, updateAll bool, docIndexInt int) ([]*yqlib.NodeContext, error) {
-	var matchingNodes []*yqlib.NodeContext
-
-	var currentIndex = 0
-	var errorReadingStream = readStream(filename, func(decoder *yaml.Decoder) error {
-		for {
-			var dataBucket yaml.Node
-			errorReading := decoder.Decode(&dataBucket)
-
-			if errorReading == io.EOF {
-				return handleEOF(updateAll, docIndexInt, currentIndex)
-			} else if errorReading != nil {
-				return errorReading
-			}
-
-			var errorParsing error
-			matchingNodes, errorParsing = appendDocument(matchingNodes, dataBucket, readFn, updateAll, docIndexInt, currentIndex)
-			if errorParsing != nil {
-				return errorParsing
-			}
-			if !updateAll && currentIndex == docIndexInt {
-				log.Debug("all done")
-				return nil
-			}
-			currentIndex = currentIndex + 1
-		}
-	})
-	return matchingNodes, errorReadingStream
-}
-
-func handleEOF(updateAll bool, docIndexInt int, currentIndex int) error {
-	log.Debugf("done %v / %v", currentIndex, docIndexInt)
-	if !updateAll && currentIndex <= docIndexInt && docIndexInt != 0 {
-		return fmt.Errorf("Could not process document index %v as there are only %v document(s)", docIndex, currentIndex)
+	firstFileIndex = -1
+	if !nullInput && len(args) == 1 {
+		firstFileIndex = 0
+	} else if len(args) > 1 {
+		firstFileIndex = 1
 	}
-	return nil
-}
 
-func appendDocument(originalMatchingNodes []*yqlib.NodeContext, dataBucket yaml.Node, readFn readDataFn, updateAll bool, docIndexInt int, currentIndex int) ([]*yqlib.NodeContext, error) {
-	log.Debugf("processing document %v - requested index %v", currentIndex, docIndexInt)
-	yqlib.DebugNode(&dataBucket)
-	if !updateAll && currentIndex != docIndexInt {
-		return originalMatchingNodes, nil
-	}
-	log.Debugf("reading in document %v", currentIndex)
-	matchingNodes, errorParsing := readFn(&dataBucket)
-	if errorParsing != nil {
-		return nil, errors.Wrapf(errorParsing, "Error reading path in document index %v", currentIndex)
-	}
-	return append(originalMatchingNodes, matchingNodes...), nil
-}
-
-func lengthOf(node *yaml.Node) int {
-	kindToCheck := node.Kind
-	if node.Kind == yaml.DocumentNode && len(node.Content) == 1 {
-		log.Debugf("length of document node, calculating length of child")
-		kindToCheck = node.Content[0].Kind
-	}
-	switch kindToCheck {
-	case yaml.ScalarNode:
-		return len(node.Value)
-	case yaml.MappingNode:
-		return len(node.Content) / 2
-	default:
-		return len(node.Content)
-	}
-}
-
-// transforms node before printing, if required
-func transformNode(node *yaml.Node) *yaml.Node {
-	if printLength {
-		return &yaml.Node{Kind: yaml.ScalarNode, Value: fmt.Sprintf("%v", lengthOf(node))}
-	}
-	return node
-}
-
-func printNode(node *yaml.Node, writer io.Writer) error {
-	var encoder yqlib.Encoder
-	if node.Kind == yaml.ScalarNode && unwrapScalar && !outputToJSON {
-		return writeString(writer, node.Value+"\n")
-	}
+	// backwards compatibility
 	if outputToJSON {
-		encoder = yqlib.NewJsonEncoder(writer, prettyPrint, indent)
-	} else {
-		encoder = yqlib.NewYamlEncoder(writer, indent, colorsEnabled)
+		outputFormat = "json"
 	}
-	return encoder.Encode(node)
+
+	if writeInplace && (firstFileIndex == -1) {
+		return 0, fmt.Errorf("write inplace flag only applicable when giving an expression and at least one file")
+	}
+
+	if writeInplace && splitFileExp != "" {
+		return 0, fmt.Errorf("write inplace cannot be used with split file")
+	}
+
+	if nullInput && len(args) > 1 {
+		return 0, fmt.Errorf("cannot pass files in when using null-input flag")
+	}
+
+	return firstFileIndex, nil
 }
 
-func removeComments(matchingNodes []*yqlib.NodeContext) {
-	for _, nodeContext := range matchingNodes {
-		removeCommentOfNode(nodeContext.Node)
-	}
-}
-
-func removeCommentOfNode(node *yaml.Node) {
-	node.HeadComment = ""
-	node.LineComment = ""
-	node.FootComment = ""
-
-	for _, child := range node.Content {
-		removeCommentOfNode(child)
-	}
-}
-
-func setStyle(matchingNodes []*yqlib.NodeContext, style yaml.Style) {
-	for _, nodeContext := range matchingNodes {
-		updateStyleOfNode(nodeContext.Node, style)
-	}
-}
-
-func updateStyleOfNode(node *yaml.Node, style yaml.Style) {
-	node.Style = style
-
-	for _, child := range node.Content {
-		updateStyleOfNode(child, style)
-	}
-}
-
-func writeString(writer io.Writer, txt string) error {
-	_, errorWriting := writer.Write([]byte(txt))
-	return errorWriting
-}
-
-func setIfNotThere(node *yaml.Node, key string, value *yaml.Node) {
-	for index := 0; index < len(node.Content); index = index + 2 {
-		keyNode := node.Content[index]
-		if keyNode.Value == key {
-			return
-		}
-	}
-	// need to add it to the map
-	mapEntryKey := yaml.Node{Value: key, Kind: yaml.ScalarNode}
-	node.Content = append(node.Content, &mapEntryKey)
-	node.Content = append(node.Content, value)
-}
-
-func applyAlias(node *yaml.Node, alias *yaml.Node) {
-	if alias == nil {
-		return
-	}
-	for index := 0; index < len(alias.Content); index = index + 2 {
-		keyNode := alias.Content[index]
-		log.Debugf("applying alias key %v", keyNode.Value)
-		valueNode := alias.Content[index+1]
-		setIfNotThere(node, keyNode.Value, valueNode)
-	}
-}
-
-func explodeNode(node *yaml.Node) error {
-	node.Anchor = ""
-	switch node.Kind {
-	case yaml.SequenceNode, yaml.DocumentNode:
-		for index, contentNode := range node.Content {
-			log.Debugf("exploding index %v", index)
-			errorInContent := explodeNode(contentNode)
-			if errorInContent != nil {
-				return errorInContent
-			}
-		}
-		return nil
-	case yaml.AliasNode:
-		log.Debugf("its an alias!")
-		if node.Alias != nil {
-			node.Kind = node.Alias.Kind
-			node.Style = node.Alias.Style
-			node.Tag = node.Alias.Tag
-			node.Content = node.Alias.Content
-			node.Value = node.Alias.Value
-			node.Alias = nil
-		}
-		return nil
-	case yaml.MappingNode:
-		for index := 0; index < len(node.Content); index = index + 2 {
-			keyNode := node.Content[index]
-			valueNode := node.Content[index+1]
-			log.Debugf("traversing %v", keyNode.Value)
-			if keyNode.Value != "<<" {
-				errorInContent := explodeNode(valueNode)
-				if errorInContent != nil {
-					return errorInContent
-				}
-				errorInContent = explodeNode(keyNode)
-				if errorInContent != nil {
-					return errorInContent
-				}
-			} else {
-				if valueNode.Kind == yaml.SequenceNode {
-					log.Debugf("an alias merge list!")
-					for index := len(valueNode.Content) - 1; index >= 0; index = index - 1 {
-						aliasNode := valueNode.Content[index]
-						applyAlias(node, aliasNode.Alias)
-					}
-				} else {
-					log.Debugf("an alias merge!")
-					applyAlias(node, valueNode.Alias)
-				}
-				node.Content = append(node.Content[:index], node.Content[index+2:]...)
-				//replay that index, since the array is shorter now.
-				index = index - 2
-			}
-		}
-
-		return nil
-	default:
-		return nil
-	}
-}
-
-func explode(matchingNodes []*yqlib.NodeContext) error {
-	log.Debug("exploding nodes")
-	for _, nodeContext := range matchingNodes {
-		log.Debugf("exploding %v", nodeContext.Head)
-		errorExplodingNode := explodeNode(nodeContext.Node)
-		if errorExplodingNode != nil {
-			return errorExplodingNode
-		}
-	}
-	return nil
-}
-
-func printResults(matchingNodes []*yqlib.NodeContext, writer io.Writer) error {
-	if prettyPrint {
-		setStyle(matchingNodes, 0)
-	}
-
-	if stripComments {
-		removeComments(matchingNodes)
-	}
-
-	//always explode anchors when printing json
-	if explodeAnchors || outputToJSON {
-		errorExploding := explode(matchingNodes)
-		if errorExploding != nil {
-			return errorExploding
-		}
-	}
-
-	bufferedWriter := bufio.NewWriter(writer)
-	defer safelyFlush(bufferedWriter)
-
-	if len(matchingNodes) == 0 {
-		log.Debug("no matching results, nothing to print")
-		if defaultValue != "" {
-			return writeString(bufferedWriter, defaultValue)
-		}
-		return nil
-	}
-	var errorWriting error
-
-	var arrayCollection = yaml.Node{Kind: yaml.SequenceNode}
-
-	for _, mappedDoc := range matchingNodes {
-		switch printMode {
-		case "p":
-			errorWriting = writeString(bufferedWriter, lib.PathStackToString(mappedDoc.PathStack)+"\n")
-			if errorWriting != nil {
-				return errorWriting
-			}
-		case "pv", "vp":
-			// put it into a node and print that.
-			var parentNode = yaml.Node{Kind: yaml.MappingNode}
-			parentNode.Content = make([]*yaml.Node, 2)
-			parentNode.Content[0] = &yaml.Node{Kind: yaml.ScalarNode, Value: lib.PathStackToString(mappedDoc.PathStack)}
-			parentNode.Content[1] = transformNode(mappedDoc.Node)
-			if collectIntoArray {
-				arrayCollection.Content = append(arrayCollection.Content, &parentNode)
-			} else if err := printNode(&parentNode, bufferedWriter); err != nil {
-				return err
-			}
-		default:
-			if collectIntoArray {
-				arrayCollection.Content = append(arrayCollection.Content, mappedDoc.Node)
-			} else if err := printNode(transformNode(mappedDoc.Node), bufferedWriter); err != nil {
-				return err
-			}
-		}
-	}
-
-	if collectIntoArray {
-		if err := printNode(transformNode(&arrayCollection), bufferedWriter); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func parseDocumentIndex() (bool, int, error) {
-	if docIndex == "*" {
-		return true, -1, nil
-	}
-	docIndexInt64, err := strconv.ParseInt(docIndex, 10, 32)
+func configureDecoder() (yqlib.Decoder, error) {
+	yqlibInputFormat, err := yqlib.InputFormatFromString(inputFormat)
 	if err != nil {
-		return false, -1, errors.Wrapf(err, "Document index %v is not a integer or *", docIndex)
+		return nil, err
 	}
-	return false, int(docIndexInt64), nil
+	switch yqlibInputFormat {
+	case yqlib.XmlInputFormat:
+		return yqlib.NewXmlDecoder(xmlAttributePrefix, xmlContentName), nil
+	}
+	return yqlib.NewYamlDecoder(), nil
 }
 
-type updateDataFn func(dataBucket *yaml.Node, currentIndex int) error
+func configurePrinterWriter(format yqlib.PrinterOutputFormat, out io.Writer) yqlib.PrinterWriter {
 
-func isNullDocument(dataBucket *yaml.Node) bool {
-	return dataBucket.Kind == yaml.DocumentNode && (len(dataBucket.Content) == 0 ||
-		dataBucket.Content[0].Kind == yaml.ScalarNode && dataBucket.Content[0].Tag == "!!null")
-}
+	var printerWriter yqlib.PrinterWriter
 
-func mapYamlDecoder(updateData updateDataFn, encoder yqlib.Encoder) yamlDecoderFn {
-	return func(decoder *yaml.Decoder) error {
-		var dataBucket yaml.Node
-		var errorReading error
-		var errorWriting error
-		var errorUpdating error
-		var currentIndex = 0
-
-		var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
-		if errorParsingDocIndex != nil {
-			return errorParsingDocIndex
-		}
-
-		for {
-			log.Debugf("Read doc %v", currentIndex)
-			errorReading = decoder.Decode(&dataBucket)
-
-			if errorReading == io.EOF && docIndexInt == 0 && currentIndex == 0 {
-				//empty document, lets just make one
-				dataBucket = yaml.Node{Kind: yaml.DocumentNode, Content: make([]*yaml.Node, 1)}
-				child := yaml.Node{Kind: yaml.MappingNode}
-				dataBucket.Content[0] = &child
-			} else if isNullDocument(&dataBucket) && (updateAll || docIndexInt == currentIndex) {
-				child := yaml.Node{Kind: yaml.MappingNode}
-				dataBucket.Content[0] = &child
-			} else if errorReading == io.EOF {
-				if !updateAll && currentIndex <= docIndexInt {
-					return fmt.Errorf("asked to process document index %v but there are only %v document(s)", docIndex, currentIndex)
-				}
-				return nil
-			} else if errorReading != nil {
-				return errors.Wrapf(errorReading, "Error reading document at index %v, %v", currentIndex, errorReading)
-			}
-			errorUpdating = updateData(&dataBucket, currentIndex)
-			if errorUpdating != nil {
-				return errors.Wrapf(errorUpdating, "Error updating document at index %v", currentIndex)
-			}
-
-			if prettyPrint {
-				updateStyleOfNode(&dataBucket, 0)
-			}
-
-			errorWriting = encoder.Encode(&dataBucket)
-
-			if errorWriting != nil {
-				return errors.Wrapf(errorWriting, "Error writing document at index %v, %v", currentIndex, errorWriting)
-			}
-			currentIndex = currentIndex + 1
-		}
-	}
-}
-
-func prefixDocument(updateAll bool, docIndexInt int, currentIndex int, dataBucket *yaml.Node, updateCommand yqlib.UpdateCommand) error {
-	if updateAll || currentIndex == docIndexInt {
-		log.Debugf("Prefixing document %v", currentIndex)
-		yqlib.DebugNode(dataBucket)
-		updateCommand.Value = dataBucket.Content[0]
-		dataBucket.Content = make([]*yaml.Node, 1)
-
-		newNode := lib.New(updateCommand.Path)
-		dataBucket.Content[0] = &newNode
-
-		errorUpdating := lib.Update(dataBucket, updateCommand, true)
-		if errorUpdating != nil {
-			return errorUpdating
-		}
-	}
-	return nil
-}
-
-func updateDoc(inputFile string, updateCommands []yqlib.UpdateCommand, writer io.Writer) error {
-	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
-	if errorParsingDocIndex != nil {
-		return errorParsingDocIndex
-	}
-
-	var updateData = func(dataBucket *yaml.Node, currentIndex int) error {
-		if updateAll || currentIndex == docIndexInt {
-			log.Debugf("Updating doc %v", currentIndex)
-			for _, updateCommand := range updateCommands {
-				log.Debugf("Processing update to Path %v", updateCommand.Path)
-				errorUpdating := lib.Update(dataBucket, updateCommand, autoCreateFlag)
-				if errorUpdating != nil {
-					return errorUpdating
-				}
-			}
-		}
-		return nil
-	}
-	return readAndUpdate(writer, inputFile, updateData)
-}
-
-func readAndUpdate(stdOut io.Writer, inputFile string, updateData updateDataFn) error {
-	var destination io.Writer
-	var destinationName string
-	var completedSuccessfully = false
-	if writeInplace {
-		info, err := os.Stat(inputFile)
+	if splitFileExp != "" {
+		colorsEnabled = forceColor
+		splitExp, err := yqlib.NewExpressionParser().ParseExpression(splitFileExp)
 		if err != nil {
-			return err
+			return nil
 		}
-		// mkdir temp dir as some docker images does not have temp dir
-		_, err = os.Stat(os.TempDir())
-		if os.IsNotExist(err) {
-			err = os.Mkdir(os.TempDir(), 0700)
-			if err != nil {
-				return err
-			}
-		} else if err != nil {
-			return err
-		}
-		tempFile, err := ioutil.TempFile("", "temp")
-		if err != nil {
-			return err
-		}
-		destinationName = tempFile.Name()
-		err = os.Chmod(destinationName, info.Mode())
-		if err != nil {
-			return err
-		}
-		destination = tempFile
-		defer func() {
-			safelyCloseFile(tempFile)
-			if completedSuccessfully {
-				safelyRenameFile(tempFile.Name(), inputFile)
-			}
-		}()
+		printerWriter = yqlib.NewMultiPrinterWriter(splitExp, format)
 	} else {
-		destination = stdOut
-		destinationName = "Stdout"
+		printerWriter = yqlib.NewSinglePrinterWriter(out)
 	}
-
-	log.Debugf("Writing to %v from %v", destinationName, inputFile)
-
-	bufferedWriter := bufio.NewWriter(destination)
-	defer safelyFlush(bufferedWriter)
-
-	var encoder yqlib.Encoder
-	if outputToJSON {
-		encoder = yqlib.NewJsonEncoder(bufferedWriter, prettyPrint, indent)
-	} else {
-		encoder = yqlib.NewYamlEncoder(bufferedWriter, indent, colorsEnabled)
-	}
-
-	var errorProcessing = readStream(inputFile, mapYamlDecoder(updateData, encoder))
-	completedSuccessfully = errorProcessing == nil
-	return errorProcessing
+	return printerWriter
 }
 
-type updateCommandParsed struct {
-	Command string
-	Path    string
-	Value   yaml.Node
-}
-
-func readUpdateCommands(args []string, expectedArgs int, badArgsMessage string, allowNoValue bool) ([]yqlib.UpdateCommand, error) {
-	var updateCommands []yqlib.UpdateCommand = make([]yqlib.UpdateCommand, 0)
-	if writeScript != "" {
-		var parsedCommands = make([]updateCommandParsed, 0)
-
-		err := readData(writeScript, 0, &parsedCommands)
-
-		if err != nil && err != io.EOF {
-			return nil, err
-		}
-
-		log.Debugf("Read write commands file '%v'", parsedCommands)
-		for index := range parsedCommands {
-			parsedCommand := parsedCommands[index]
-			updateCommand := yqlib.UpdateCommand{Command: parsedCommand.Command, Path: parsedCommand.Path, Value: &parsedCommand.Value, Overwrite: true}
-			updateCommands = append(updateCommands, updateCommand)
-		}
-
-		log.Debugf("Read write commands file '%v'", updateCommands)
-	} else if sourceYamlFile != "" && len(args) == expectedArgs-1 {
-		log.Debugf("Reading value from %v", sourceYamlFile)
-		var value yaml.Node
-		err := readData(sourceYamlFile, 0, &value)
-		if err != nil && err != io.EOF {
-			return nil, err
-		}
-		log.Debug("args %v", args[expectedArgs-2])
-		updateCommands = make([]yqlib.UpdateCommand, 1)
-		updateCommands[0] = yqlib.UpdateCommand{Command: "update", Path: args[expectedArgs-2], Value: value.Content[0], Overwrite: true}
-	} else if len(args) == expectedArgs {
-		updateCommands = make([]yqlib.UpdateCommand, 1)
-		log.Debug("args %v", args)
-		log.Debug("path %v", args[expectedArgs-2])
-		log.Debug("Value %v", args[expectedArgs-1])
-		value := valueParser.Parse(args[expectedArgs-1], customTag, customStyle, anchorName, makeAlias)
-		updateCommands[0] = yqlib.UpdateCommand{Command: "update", Path: args[expectedArgs-2], Value: value, Overwrite: true, CommentsMergeStrategy: yqlib.IgnoreCommentsMergeStrategy}
-	} else if len(args) == expectedArgs-1 && allowNoValue {
-		// don't update the value
-		updateCommands = make([]yqlib.UpdateCommand, 1)
-		log.Debug("args %v", args)
-		log.Debug("path %v", args[expectedArgs-2])
-		updateCommands[0] = yqlib.UpdateCommand{Command: "update", Path: args[expectedArgs-2], Value: valueParser.Parse("", customTag, customStyle, anchorName, makeAlias), Overwrite: true, DontUpdateNodeValue: true}
-	} else {
-		return nil, errors.New(badArgsMessage)
-	}
-	return updateCommands, nil
-}
-
-func safelyRenameFile(from string, to string) {
-	if renameError := os.Rename(from, to); renameError != nil {
-		log.Debugf("Error renaming from %v to %v, attempting to copy contents", from, to)
-		log.Debug(renameError.Error())
-		// can't do this rename when running in docker to a file targeted in a mounted volume,
-		// so gracefully degrade to copying the entire contents.
-		if copyError := copyFileContents(from, to); copyError != nil {
-			log.Errorf("Failed copying from %v to %v", from, to)
-			log.Error(copyError.Error())
-		} else {
-			removeErr := os.Remove(from)
-			if removeErr != nil {
-				log.Errorf("failed removing original file: %s", from)
-			}
-		}
-	}
-}
-
-// thanks https://stackoverflow.com/questions/21060945/simple-way-to-copy-a-file-in-golang
-func copyFileContents(src, dst string) (err error) {
-	in, err := os.Open(src) // nolint gosec
-	if err != nil {
-		return err
-	}
-	defer safelyCloseFile(in)
-	out, err := os.Create(dst)
-	if err != nil {
-		return err
-	}
-	defer safelyCloseFile(out)
-	if _, err = io.Copy(out, in); err != nil {
-		return err
-	}
-	return out.Sync()
-}
-
-func safelyFlush(writer *bufio.Writer) {
-	if err := writer.Flush(); err != nil {
-		log.Error("Error flushing writer!")
-		log.Error(err.Error())
-	}
-
-}
-func safelyCloseFile(file *os.File) {
-	err := file.Close()
-	if err != nil {
-		log.Error("Error closing file!")
-		log.Error(err.Error())
-	}
-}
-
-type yamlDecoderFn func(*yaml.Decoder) error
-
-func readStream(filename string, yamlDecoder yamlDecoderFn) error {
-	if filename == "" {
-		return errors.New("Must provide filename")
-	}
-
-	var stream io.Reader
-	if filename == "-" {
-		stream = bufio.NewReader(os.Stdin)
-	} else {
-		file, err := os.Open(filename) // nolint gosec
-		if err != nil {
-			return err
-		}
-		defer safelyCloseFile(file)
-		stream = file
-	}
-	return yamlDecoder(yaml.NewDecoder(stream))
-}
-
-func readData(filename string, indexToRead int, parsedData interface{}) error {
-	return readStream(filename, func(decoder *yaml.Decoder) error {
-		for currentIndex := 0; currentIndex < indexToRead; currentIndex++ {
-			errorSkipping := decoder.Decode(parsedData)
-			if errorSkipping != nil {
-				return errors.Wrapf(errorSkipping, "Error processing document at index %v, %v", currentIndex, errorSkipping)
-			}
-		}
-		return decoder.Decode(parsedData)
-	})
+func configureEncoder(format yqlib.PrinterOutputFormat) yqlib.Encoder {
+	switch format {
+	case yqlib.JsonOutputFormat:
+		return yqlib.NewJsonEncoder(indent)
+	case yqlib.PropsOutputFormat:
+		return yqlib.NewPropertiesEncoder()
+	case yqlib.CsvOutputFormat:
+		return yqlib.NewCsvEncoder(',')
+	case yqlib.TsvOutputFormat:
+		return yqlib.NewCsvEncoder('\t')
+	case yqlib.YamlOutputFormat:
+		return yqlib.NewYamlEncoder(indent, colorsEnabled, !noDocSeparators, unwrapScalar)
+	case yqlib.XmlOutputFormat:
+		return yqlib.NewXmlEncoder(indent, xmlAttributePrefix, xmlContentName)
+	}
+	panic("invalid encoder")
 }

cmd/validate.go

@@ -1,37 +0,0 @@
-package cmd
-
-import (
-	errors "github.com/pkg/errors"
-	"github.com/spf13/cobra"
-)
-
-func createValidateCmd() *cobra.Command {
-	var cmdRead = &cobra.Command{
-		Use:     "validate [yaml_file]",
-		Aliases: []string{"v"},
-		Short:   "yq v sample.yaml",
-		Example: `
-yq v - # reads from stdin
-`,
-		RunE:          validateProperty,
-		SilenceUsage:  true,
-		SilenceErrors: true,
-	}
-	cmdRead.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	return cmdRead
-}
-
-func validateProperty(cmd *cobra.Command, args []string) error {
-	if len(args) < 1 {
-		return errors.New("Must provide filename")
-	}
-
-	var updateAll, docIndexInt, errorParsingDocIndex = parseDocumentIndex()
-	if errorParsingDocIndex != nil {
-		return errorParsingDocIndex
-	}
-
-	_, errorReadingStream := readYamlFile(args[0], "", updateAll, docIndexInt)
-
-	return errorReadingStream
-}

cmd/validate_test.go

@@ -1,31 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestValidateCmd(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "validate ../examples/sample.yaml b.c")
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	test.AssertResult(t, "", result.Output)
-}
-
-func TestValidateBadDataCmd(t *testing.T) {
-	content := `[!Whatever]`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("validate %s", filename))
-	if result.Error == nil {
-		t.Error("Expected command to fail")
-	}
-	expectedOutput := `yaml: line 1: did not find expected ',' or ']'`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}

cmd/version.go

@@ -11,7 +11,7 @@ var (
 	GitDescribe string
 
 	// Version is main version number that is being run at the moment.
-	Version = "3.4.0"
+	Version = "4.16.2"
 
 	// VersionPrerelease is a pre-release marker for the version. If this is "" (empty string)
 	// then it means that it is a final release. Otherwise, this is a pre-release
@@ -25,7 +25,7 @@ const ProductName = "yq"
 // GetVersionDisplay composes the parts of the version in a way that's suitable
 // for displaying to humans.
 func GetVersionDisplay() string {
-	return fmt.Sprintf("%s version %s\n", ProductName, getHumanVersion())
+	return fmt.Sprintf("yq (https://github.com/mikefarah/yq/) version %s\n", getHumanVersion())
 }
 
 func getHumanVersion() string {

cmd/version_test.go

@@ -3,7 +3,7 @@ package cmd
 import "testing"
 
 func TestGetVersionDisplay(t *testing.T) {
-	var expectedVersion = ProductName + " version " + Version
+	var expectedVersion = ProductName + " (https://github.com/mikefarah/yq/) version " + Version
 	if VersionPrerelease != "" {
 		expectedVersion = expectedVersion + "-" + VersionPrerelease
 	}

cmd/write.go

@@ -1,61 +0,0 @@
-package cmd
-
-import (
-	"github.com/spf13/cobra"
-)
-
-func createWriteCmd() *cobra.Command {
-	var cmdWrite = &cobra.Command{
-		Use:     "write [yaml_file] [path_expression] [value]",
-		Aliases: []string{"w"},
-		Short:   "yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml 'b.e(name==fr*).value' newValue",
-		Example: `
-yq write things.yaml 'a.b.c' true
-yq write things.yaml 'a.*.c' true
-yq write things.yaml 'a.**' true
-yq write things.yaml 'a.(child.subchild==co*).c' true
-yq write things.yaml 'a.b.c' --tag '!!str' true # force 'true' to be interpreted as a string instead of bool
-yq write things.yaml 'a.b.c' --tag '!!float' 3
-yq write --inplace -- things.yaml 'a.b.c' '--cat' # need to use '--' to stop processing arguments as flags
-yq w -i things.yaml 'a.b.c' cat
-yq w -i -s update_script.yaml things.yaml
-yq w things.yaml 'a.b.d[+]' foo # appends a new node to the 'd' array
-yq w --doc 2 things.yaml 'a.b.d[+]' foo # updates the 3rd document of the yaml file
-      `,
-		Long: `Updates the yaml file w.r.t the given path and value.
-Outputs to STDOUT unless the inplace flag is used, in which case the file is updated instead.
-
-Append value to array adds the value to the end of array.
-
-Update Scripts:
-Note that you can give an update script to perform more sophisticated update. Update script
-format is list of update commands (update or delete) like so:
----
-- command: update
-  path: b.c
-  value:
-    #great
-    things: frog # wow!
-- command: delete
-  path: b.d
-`,
-		RunE: writeProperty,
-	}
-	cmdWrite.PersistentFlags().BoolVarP(&writeInplace, "inplace", "i", false, "update the yaml file inplace")
-	cmdWrite.PersistentFlags().StringVarP(&writeScript, "script", "s", "", "yaml script for updating yaml")
-	cmdWrite.PersistentFlags().StringVarP(&sourceYamlFile, "from", "f", "", "yaml file for updating yaml (as-is)")
-	cmdWrite.PersistentFlags().StringVarP(&customTag, "tag", "t", "", "set yaml tag (e.g. !!int)")
-	cmdWrite.PersistentFlags().StringVarP(&docIndex, "doc", "d", "0", "process document index number (0 based, * for all documents)")
-	cmdWrite.PersistentFlags().StringVarP(&customStyle, "style", "", "", "formatting style of the value: single, double, folded, flow, literal, tagged")
-	cmdWrite.PersistentFlags().StringVarP(&anchorName, "anchorName", "", "", "anchor name")
-	cmdWrite.PersistentFlags().BoolVarP(&makeAlias, "makeAlias", "", false, "create an alias using the value as the anchor name")
-	return cmdWrite
-}
-
-func writeProperty(cmd *cobra.Command, args []string) error {
-	var updateCommands, updateCommandsError = readUpdateCommands(args, 3, "Must provide <filename> <path_to_update> <value>", true)
-	if updateCommandsError != nil {
-		return updateCommandsError
-	}
-	return updateDoc(args[0], updateCommands, cmd.OutOrStdout())
-}

cmd/write_test.go

@@ -1,611 +0,0 @@
-package cmd
-
-import (
-	"fmt"
-	"runtime"
-	"strings"
-	"testing"
-
-	"github.com/mikefarah/yq/v3/test"
-)
-
-func TestWriteCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 7
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteKeepCommentsCmd(t *testing.T) {
-	content := `b:
-  c: 3 # comment
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 7 # comment
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteWithTaggedStyleCmd(t *testing.T) {
-	content := `b:
-  c: dog
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c cat --tag=!!str --style=tagged", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: !!str cat
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteWithDoubleQuotedStyleCmd(t *testing.T) {
-	content := `b:
-  c: dog
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c cat --style=double", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: "cat"
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteUpdateStyleOnlyCmd(t *testing.T) {
-	content := `b:
-  c: dog
-  d: things
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.* --style=single", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 'dog'
-  d: 'things'
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteUpdateTagOnlyCmd(t *testing.T) {
-	content := `b:
-  c: true
-  d: false
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.* --tag=!!str", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: "true"
-  d: "false"
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteWithSingleQuotedStyleCmd(t *testing.T) {
-	content := `b:
-  c: dog
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c cat --style=single", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 'cat'
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteWithLiteralStyleCmd(t *testing.T) {
-	content := `b:
-  c: dog
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c cat --style=literal", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: |-
-    cat
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteWithFoldedStyleCmd(t *testing.T) {
-	content := `b:
-  c: dog
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c cat --style=folded", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: >-
-    cat
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteEmptyMultiDocCmd(t *testing.T) {
-	content := `# this is empty
----
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s c 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `c: 7
-
-# this is empty
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteSurroundingEmptyMultiDocCmd(t *testing.T) {
-	content := `---
-# empty
----
-cat: frog
----
-
-# empty
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s -d1 c 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `
-
-# empty
----
-cat: frog
-c: 7
----
-
-
-# empty
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteFromFileCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	source := `kittens: are cute # sure are!`
-	fromFilename := test.WriteTempYamlFile(source)
-	defer test.RemoveTempYamlFile(fromFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c -f %s", filename, fromFilename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c:
-    kittens: are cute # sure are!
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteEmptyCmd(t *testing.T) {
-	content := ``
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 7
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteAutoCreateCmd(t *testing.T) {
-	content := `applications:
-  - name: app
-    env:`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s applications[0].env.hello world", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `applications:
-  - name: app
-    env:
-      hello: world
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmdScript(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	updateScript := `- command: update
-  path: b.c
-  value: 7`
-	scriptFilename := test.WriteTempYamlFile(updateScript)
-	defer test.RemoveTempYamlFile(scriptFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write --script %s %s", scriptFilename, filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 7
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmdEmptyScript(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	updateScript := ``
-	scriptFilename := test.WriteTempYamlFile(updateScript)
-	defer test.RemoveTempYamlFile(scriptFilename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write --script %s %s", scriptFilename, filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteMultiCmd(t *testing.T) {
-	content := `b:
-  c: 3
----
-apples: great
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s -d 1 apples ok", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
----
-apples: ok
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-func TestWriteInvalidDocumentIndexCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s -df apples ok", filename))
-	if result.Error == nil {
-		t.Error("Expected command to fail due to invalid path")
-	}
-	expectedOutput := `Document index f is not a integer or *: strconv.ParseInt: parsing "f": invalid syntax`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestWriteBadDocumentIndexCmd(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s -d 1 apples ok", filename))
-	if result.Error == nil {
-		t.Error("Expected command to fail due to invalid path")
-	}
-	expectedOutput := `asked to process document index 1 but there are only 1 document(s)`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-func TestWriteMultiAllCmd(t *testing.T) {
-	content := `b:
-  c: 3
----
-apples: great
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s -d * apples ok", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: 3
-apples: ok
----
-apples: ok`
-	test.AssertResult(t, expectedOutput, strings.Trim(result.Output, "\n "))
-}
-
-func TestWriteCmd_EmptyArray(t *testing.T) {
-	content := `b: 3`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s a []", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b: 3
-a: []
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_Error(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "write")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to missing arg")
-	}
-	expectedOutput := `Must provide <filename> <path_to_update> <value>`
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestWriteCmd_ErrorUnreadableFile(t *testing.T) {
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "write fake-unknown a.b 3")
-	if result.Error == nil {
-		t.Error("Expected command to fail due to unknown file")
-	}
-	var expectedOutput string
-	if runtime.GOOS == "windows" {
-		expectedOutput = `open fake-unknown: The system cannot find the file specified.`
-	} else {
-		expectedOutput = `open fake-unknown: no such file or directory`
-	}
-	test.AssertResult(t, expectedOutput, result.Error.Error())
-}
-
-func TestWriteCmd_Inplace(t *testing.T) {
-	content := `b:
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write -i %s b.c 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	gotOutput := test.ReadTempYamlFile(filename)
-	expectedOutput := `b:
-  c: 7`
-	test.AssertResult(t, expectedOutput, strings.Trim(gotOutput, "\n "))
-}
-
-func TestWriteCmd_InplaceError(t *testing.T) {
-	content := `b: cat
-  c: 3
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write -i %s b.c 7", filename))
-	if result.Error == nil {
-		t.Error("Expected Error to occur!")
-	}
-	gotOutput := test.ReadTempYamlFile(filename)
-	test.AssertResult(t, content, gotOutput)
-}
-
-func TestWriteCmd_Append(t *testing.T) {
-	content := `b:
-  - foo
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b[+] 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  - foo
-  - 7
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_AppendInline(t *testing.T) {
-	content := `b: [foo]`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b[+] 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b: [foo, 7]
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_AppendInlinePretty(t *testing.T) {
-	content := `b: [foo]`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s -P b[+] 7", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  - foo
-  - 7
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_AppendEmptyArray(t *testing.T) {
-	content := `a: 2
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b[+] v", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `a: 2
-b:
-  - v
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_SplatArray(t *testing.T) {
-	content := `b:
-- c: thing
-- c: another thing
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b[*].c new", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  - c: new
-  - c: new
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_SplatMap(t *testing.T) {
-	content := `b:
-  c: thing
-  d: another thing
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.* new", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: new
-  d: new
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}
-
-func TestWriteCmd_SplatMapEmpty(t *testing.T) {
-	content := `b:
-  c: thing
-  d: another thing
-`
-	filename := test.WriteTempYamlFile(content)
-	defer test.RemoveTempYamlFile(filename)
-
-	cmd := getRootCommand()
-	result := test.RunCmd(cmd, fmt.Sprintf("write %s b.c.* new", filename))
-	if result.Error != nil {
-		t.Error(result.Error)
-	}
-	expectedOutput := `b:
-  c: {}
-  d: another thing
-`
-	test.AssertResult(t, expectedOutput, result.Output)
-}

compare.sh

@@ -1,13 +0,0 @@
-GREEN='\033[0;32m'
-NC='\033[0m'
-
-echo "${GREEN}---Old---${NC}"
-yq $@ > /tmp/yq-old-output
-cat /tmp/yq-old-output
-
-echo "${GREEN}---New---${NC}"
-./yq $@ > /tmp/yq-new-output
-cat /tmp/yq-new-output
-
-echo "${GREEN}---Diff---${NC}"
-colordiff /tmp/yq-old-output /tmp/yq-new-output

debian/changelog

@@ -1,3 +1,137 @@
+yq (4.16.2) focal; urgency=medium
+
+  * Fixed with semicolon space issue
+  * Updating with documentation
+  * Added STDIN example to the top
+  * minor readme cleanup
+  * Help text tweak
+  * Fixed docker timeout - simplify docker builds
+  * New release with docker build fixes
+  * Updating to go 1.17 to fix CVE #944
+  * Fix a typo in root.go
+  * Skip the tests if the nocheck Debian build option is specified
+  * Fixed select bug (#958)
+  * Sped up explode operator
+  * Slight performance improvement to context.ChildContext
+  * Speed up multiply
+  * Update README with recently added / changed options
+  * Make deepMatch report in linear time
+  * Removed leadingContentPreProcessing flag - header preprocessing is stable
+  * Revert "Removed leadingContentPreProcessing flag - header preprocessing is stable"
+  * Keep flag, it is needed in corner cases
+  * Updated Readme
+  * Man page
+  * Fixed expression parsing bug #970
+  * Bumping go-lang, docker versions
+  * Added test release flow
+  * Updated github action release to generate man page
+  * Bumping version
+  * Removing no longer needed github action
+  * Added decoder op
+  * Fixed newline handling when decoding/encoding
+  * Fixed newline handling in encoder/decoder
+  * Can specify indent in encode ops
+  * Added group_by operator
+  * Added flatten operator
+  * Fixed flatten error message
+  * Improving docs
+  * Split printer
+  * Refactored command logic
+  * Fix JSON encoding removing null #985
+  * Fixed acceptance tests
+  * gitbook
+  * Update document generation script
+  * Updating README
+  * Updating release instructions
+  * github action no longer uses data1.yml
+  * Create dependabot.yml
+  * Bump actions/create-release from 1.0.0 to 1.1.4
+  * Bump actions/setup-go from 1 to 2.1.4
+  * Bump github.com/goccy/go-yaml from 1.8.9 to 1.9.4
+  * Bump github.com/jinzhu/copier from 0.2.8 to 0.3.2
+  * Bump github.com/fatih/color from 1.10.0 to 1.13.0
+  * Bump github.com/spf13/cobra from 1.1.3 to 1.2.1
+  * Update dependabot.yml
+  * Update go.yml
+  * add build check to PRs
+  * Include secure as part of build process
+  * Fixing bad label in github action
+  * fixed printer test
+  * remove leading content indicator
+  * Fixed header preprocessing!
+  * lint : define golangci configuration file
+  * Update check.sh
+  * Load file acceptance test
+  * Minor improvement on handling front matter
+  * Improved load doc
+  * feature: detect MANPATh and install there
+  * Update install-man-page.sh
+  * simplify prod stage, move version label to action
+  * add labels, quote some values
+  * enable errorlint linter
+  * Added errorlint to devtools
+  * Added key operator
+  * Added more tests
+  * Fixing comments
+  * Attempt to fix golint problem
+  * Include version query for tools
+  * Clean up errored file?
+  * enable misspell linter
+  * updated readme
+  * update Golangci version to v1.43.0
+  * gci linter
+  * Better merge array by key example
+  * Added credit for merge by array example
+  * Better formatting of merge arrays example
+  * Better merge example
+  * Add accessor for the yq logger instance (#1013)
+  * Fixed collect op when working with multiple nodes
+  * Added map, map_values
+  * Add support for Podman as well as Docker (#1026)
+  * Bump github.com/jinzhu/copier from 0.3.2 to 0.3.4 (#1027)
+  * Added csv, tsv output formats
+  * Added encoder tests
+  * Cleanup test
+  * Fixed docker permission issue #1014
+  * Recording release notes for next release
+  * Assignment op no longer clobbers anchor (#1029)
+  * Added sort_by operator
+  * Improved error message
+  * Improved tips and tricks
+  * Report while filename failed to parse #1030
+  * Added script for extracting checksums
+  * Improved extract-checksum.sh
+  * Bump github.com/spf13/cobra from 1.2.1 to 1.3.0 (#1039)
+  * enable more linters (#1043)
+  * Bump golang compiler #1037
+
+ -- Roberto Mier Escandon <rmescandon@gmail.com>  Tue, 21 Dec 2021 09:41:44 +0000
+
+yq (4.13.0) focal; urgency=medium
+
+  * New `with` operator for making multiple changes to a given path
+  * New `contains` operator, works like the `jq` equivalent
+  * Subtract operator now supports subtracting elements from arrays!
+  * Fixed Swapping values using variables #934
+  * Github Action now properly supports multiline output #936, thanks @pjxiao
+  * Fixed missing closing bracket validation #932
+  * Fix processing of hex numbers #929
+  * Fixed alternative and union operator issues #930
+  * Can now convert yaml to properties properties format (`-o=props`), See [docs](https://mikefarah.gitbook.io/yq/v/v4.x/usage/properties) for more info.
+  * Fixed document header/footer comment handling when merging (https://github.com/mikefarah/yq/issues/919)
+  * pretty print yaml 1.1 compatibility  (https://github.com/mikefarah/yq/issues/914)
+
+ -- Roberto Mier Escandon <rmescandon@gmail.com>  Thu, 16 Sep 2021 20:58:30 +0200
+
+yq (4.9.6) focal; urgency=medium
+
+  * Added darwin/arm64 build, thanks @alecthomas
+  * Incremented docker alpine base version, thanks @da6d6i7-bronga
+  * Bug fix: multine expression
+  * Bug fix: special character
+
+ -- Roberto Mier Escandon <rmescandon@gmail.com>  Tue, 29 Jun 2021 21:32:14 +0200
+
 yq (3.3.2) focal; urgency=medium
 
   * Bug fix: existStatus bug (#459)

debian/control

@@ -3,8 +3,8 @@ Section: devel
 Priority: optional
 Maintainer: Roberto Mier Escandón <rmescandon@gmail.com>
 Build-Depends: debhelper (>=10),
-               dh-golang (>=1.34),
-               golang-1.13,
+               golang-1.17-go,
+               pandoc,
                rsync
 Standards-Version: 4.1.4
 Homepage: https://github.com/mikefarah/yq.git

debian/rules

@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 #
-# Copyright (C) 2018 Roberto Mier Escandón <rmescandon@gmail.com>
+# Copyright (C) 2018-2021 Roberto Mier Escandón <rmescandon@gmail.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
@@ -17,24 +17,25 @@
 PROJECT := yq
 OWNER := mikefarah
 REPO := github.com
-GOVERSION := 1.13
 
 export DH_OPTIONS
 export DH_GOPKG := ${REPO}/${OWNER}/${PROJECT}
-export GOROOT := /usr/lib/go-${GOVERSION}
+export GOROOT := /usr/local/go
 export GOPATH := ${CURDIR}/_build
 export GOBIN := ${GOPATH}/bin
 export PATH := ${GOROOT}/bin:${GOBIN}:${PATH}
 export GOCACHE := /tmp/gocache
 export GOFLAGS := -mod=vendor
+export GO111MODULE := on
 
 SRCDIR := ${GOPATH}/src/${DH_GOPKG}
 DESTDIR := ${CURDIR}/debian/${PROJECT}
 BINDIR := /usr/bin
+MANDIR := /usr/share/man/man1/
 ASSETSDIR := /usr/share/${PROJECT}
 
 %:
-	dh $@ --builddirectory=${GOPATH} --buildsystem=golang
+	dh $@
 
 override_dh_auto_build:
 	mkdir -p ${SRCDIR}
@@ -42,16 +43,32 @@ override_dh_auto_build:
 	# copy project to local srcdir to build from there
 	rsync -avz --progress --exclude=_build --exclude=debian --exclude=tmp. --exclude=go.mod --exclude=docs . $(SRCDIR)
 	# build go code
-	(cd ${SRCDIR} && go install -buildmode=pie ./...)
+	( \
+		cd ${SRCDIR} && \
+		go install -buildmode=pie ./... \
+	)
+
+	# build man page
+	( \
+		cd ${SRCDIR} && \
+		./scripts/generate-man-page-md.sh && \
+		./scripts/generate-man-page.sh \
+	)
 	
 override_dh_auto_test:
+ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
 	(cd ${SRCDIR} && go test -v ./...)
+endif
 
 override_dh_auto_install:
 	cp ${GOBIN}/yq ${DESTDIR}/${BINDIR}
 	cp -f ${SRCDIR}/LICENSE ${DESTDIR}/${ASSETSDIR}
 	chmod a+x ${DESTDIR}/${BINDIR}/yq
 
+	# man
+	mkdir -p "${DESTDIR}"/"${MANDIR}"
+	cp "${SRCDIR}"/yq.1 "${DESTDIR}"/"${MANDIR}" \
+
 override_dh_auto_clean:
 	dh_clean
 	rm -rf ${CURDIR}/_build

docs/404.html

@@ -1,268 +0,0 @@
-
-
-
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta http-equiv="x-ua-compatible" content="ie=edge">
-      
-      
-      
-      
-        <meta name="lang:clipboard.copy" content="Copy to clipboard">
-      
-        <meta name="lang:clipboard.copied" content="Copied to clipboard">
-      
-        <meta name="lang:search.language" content="en">
-      
-        <meta name="lang:search.pipeline.stopwords" content="True">
-      
-        <meta name="lang:search.pipeline.trimmer" content="True">
-      
-        <meta name="lang:search.result.none" content="No matching documents">
-      
-        <meta name="lang:search.result.one" content="1 matching document">
-      
-        <meta name="lang:search.result.other" content="# matching documents">
-      
-        <meta name="lang:search.tokenizer" content="[\s\-]+">
-      
-      <link rel="shortcut icon" href="/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
-    
-    
-      
-        <title>Yq</title>
-      
-    
-    
-      <link rel="stylesheet" href="/assets/stylesheets/application.1b62728e.css">
-      
-      
-    
-    
-      <script src="/assets/javascripts/modernizr.268332fc.js"></script>
-    
-    
-      
-        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
-        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
-      
-    
-    <link rel="stylesheet" href="/assets/fonts/material-icons.css">
-    
-    
-    
-      
-    
-    
-  </head>
-  
-    <body dir="ltr">
-  
-    <svg class="md-svg">
-      <defs>
-        
-        
-          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
-        
-      </defs>
-    </svg>
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-    
-    
-      <header class="md-header" data-md-component="header">
-  <nav class="md-header-nav md-grid">
-    <div class="md-flex">
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="/." title="Yq" class="md-header-nav__button md-logo">
-          
-            <i class="md-icon"></i>
-          
-        </a>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
-      </div>
-      <div class="md-flex__cell md-flex__cell--stretch">
-        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-          
-            <span class="md-header-nav__topic">
-              Yq
-            </span>
-            <span class="md-header-nav__topic">
-              
-                
-              
-            </span>
-          
-        </div>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        
-          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-          
-<div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
-      <label class="md-icon md-search__icon" for="__search"></label>
-      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
-        &#xE5CD;
-      </button>
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result">
-          <div class="md-search-result__meta">
-            Type to start searching
-          </div>
-          <ol class="md-search-result__list"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-        
-      </div>
-      
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-            
-
-
-  
-
-<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-  
-    <div class="md-source__icon">
-      <svg viewBox="0 0 24 24" width="24" height="24">
-        <use xlink:href="#__github" width="24" height="24"></use>
-      </svg>
-    </div>
-  
-  <div class="md-source__repository">
-    mikefarah/yq
-  </div>
-</a>
-          </div>
-        </div>
-      
-    </div>
-  </nav>
-</header>
-    
-    <div class="md-container">
-      
-        
-      
-      
-      <main class="md-main" role="main">
-        <div class="md-main__inner md-grid" data-md-component="container">
-          
-            
-              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    <nav class="md-nav md-nav--primary" data-md-level="0">
-  <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="/." title="Yq" class="md-nav__button md-logo">
-      
-        <i class="md-icon"></i>
-      
-    </a>
-    Yq
-  </label>
-  
-    <div class="md-nav__source">
-      
-
-
-  
-
-<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-  
-    <div class="md-source__icon">
-      <svg viewBox="0 0 24 24" width="24" height="24">
-        <use xlink:href="#__github" width="24" height="24"></use>
-      </svg>
-    </div>
-  
-  <div class="md-source__repository">
-    mikefarah/yq
-  </div>
-</a>
-    </div>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-      
-
-
-  <li class="md-nav__item">
-    <a href="/." title="Home" class="md-nav__link">
-      Home
-    </a>
-  </li>
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-          
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
-              
-  <h1>404 - Not found</h1>
-
-              
-                
-
-
-              
-            </article>
-          </div>
-        </div>
-      </main>
-      
-        
-<footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-        
-        powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
-        and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
-          Material for MkDocs</a>
-      </div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    
-      <script src="/assets/javascripts/application.808e90bb.js"></script>
-      
-      <script>app.initialize({version:"1.0.4",url:{base:"/"}})</script>
-      
-    
-  </body>
-</html>

docs/assets/fonts/material-icons.css

@@ -1,13 +0,0 @@
-/*!
- * 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.
- */@font-face{font-family:"Material Icons";font-style:normal;font-weight:400;src:local("Material Icons"),local("MaterialIcons-Regular"),url("specimen/MaterialIcons-Regular.woff2") format("woff2"),url("specimen/MaterialIcons-Regular.woff") format("woff"),url("specimen/MaterialIcons-Regular.ttf") format("truetype")}

docs/assets/images/icons/bitbucket.1b09e088.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="352" height="448" viewBox="0 0 352 448" id="__bitbucket"><path fill="currentColor" d="M203.75 214.75q2 15.75-12.625 25.25t-27.875 1.5q-9.75-4.25-13.375-14.5t-.125-20.5 13-14.5q9-4.5 18.125-3t16 8.875 6.875 16.875zm27.75-5.25q-3.5-26.75-28.25-41T154 165.25q-15.75 7-25.125 22.125t-8.625 32.375q1 22.75 19.375 38.75t41.375 14q22.75-2 38-21t12.5-42zM291.25 74q-5-6.75-14-11.125t-14.5-5.5T245 54.25q-72.75-11.75-141.5.5-10.75 1.75-16.5 3t-13.75 5.5T60.75 74q7.5 7 19 11.375t18.375 5.5T120 93.75Q177 101 232 94q15.75-2 22.375-3t18.125-5.375T291.25 74zm14.25 258.75q-2 6.5-3.875 19.125t-3.5 21-7.125 17.5-14.5 14.125q-21.5 12-47.375 17.875t-50.5 5.5-50.375-4.625q-11.5-2-20.375-4.5T88.75 412 70.5 401.125t-13-15.375q-6.25-24-14.25-73l1.5-4 4.5-2.25q55.75 37 126.625 37t126.875-37q5.25 1.5 6 5.75t-1.25 11.25-2 9.25zM350.75 92.5q-6.5 41.75-27.75 163.75-1.25 7.5-6.75 14t-10.875 10T291.75 288q-63 31.5-152.5 22-62-6.75-98.5-34.75-3.75-3-6.375-6.625t-4.25-8.75-2.25-8.5-1.5-9.875T25 232.75q-2.25-12.5-6.625-37.5t-7-40.375T5.5 118 0 78.5Q.75 72 4.375 66.375T12.25 57t11.25-7.5T35 43.875t12-4.625q31.25-11.5 78.25-16 94.75-9.25 169 12.5Q333 47.25 348 66.25q4 5 4.125 12.75t-1.375 13.5z"/></svg>

docs/assets/images/icons/github.f0b8504a.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>

docs/assets/images/icons/gitlab.6dd19c00.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="500" height="500" viewBox="0 0 500 500" id="__gitlab"><path fill="currentColor" d="M93.667 473.347l90.684-279.097H2.983l90.684 279.097z" transform="translate(156.198 1.16)"/><path fill="currentColor" d="M221.333 473.345L130.649 194.25H3.557l217.776 279.095z" transform="translate(28.531 1.16)" opacity=".7"/><path fill="currentColor" d="M32 195.155L4.441 279.97a18.773 18.773 0 0 0 6.821 20.99l238.514 173.29L32 195.155z" transform="translate(.089 .256)" opacity=".5"/><path fill="currentColor" d="M2.667-84.844h127.092L75.14-252.942c-2.811-8.649-15.047-8.649-17.856 0L2.667-84.844z" transform="translate(29.422 280.256)"/><path fill="currentColor" d="M2.667 473.345L93.351 194.25h127.092L2.667 473.345z" transform="translate(247.198 1.16)" opacity=".7"/><path fill="currentColor" d="M221.334 195.155l27.559 84.815a18.772 18.772 0 0 1-6.821 20.99L3.557 474.25l217.777-279.095z" transform="translate(246.307 .256)" opacity=".5"/><path fill="currentColor" d="M130.667-84.844H3.575l54.618-168.098c2.811-8.649 15.047-8.649 17.856 0l54.618 168.098z" transform="translate(336.974 280.256)"/></svg>

docs/assets/javascripts/lunr/lunr.da.js

@@ -1,17 +0,0 @@
-/*!
- * Lunr languages, `Danish` language
- * https://github.com/MihaiValentin/lunr-languages
- *
- * Copyright 2014, Mihai Valentin
- * http://www.mozilla.org/MPL/
- */
-/*!
- * based on
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,m,i;e.da=function(){this.pipeline.reset(),this.pipeline.add(e.da.trimmer,e.da.stopWordFilter,e.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.da.stemmer))},e.da.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.da.trimmer=e.trimmerSupport.generateTrimmer(e.da.wordCharacters),e.Pipeline.registerFunction(e.da.trimmer,"trimmer-da"),e.da.stemmer=(r=e.stemmerSupport.Among,m=e.stemmerSupport.SnowballProgram,i=new function(){var i,t,n,s=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],o=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],u=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],c=new m;function l(){var e,r=c.limit-c.cursor;c.cursor>=t&&(e=c.limit_backward,c.limit_backward=t,c.ket=c.cursor,c.find_among_b(o,4)?(c.bra=c.cursor,c.limit_backward=e,c.cursor=c.limit-r,c.cursor>c.limit_backward&&(c.cursor--,c.bra=c.cursor,c.slice_del())):c.limit_backward=e)}this.setCurrent=function(e){c.setCurrent(e)},this.getCurrent=function(){return c.getCurrent()},this.stem=function(){var e,r=c.cursor;return function(){var e,r=c.cursor+3;if(t=c.limit,0<=r&&r<=c.limit){for(i=r;;){if(e=c.cursor,c.in_grouping(d,97,248)){c.cursor=e;break}if((c.cursor=e)>=c.limit)return;c.cursor++}for(;!c.out_grouping(d,97,248);){if(c.cursor>=c.limit)return;c.cursor++}(t=c.cursor)<i&&(t=i)}}(),c.limit_backward=r,c.cursor=c.limit,function(){var e,r;if(c.cursor>=t&&(r=c.limit_backward,c.limit_backward=t,c.ket=c.cursor,e=c.find_among_b(s,32),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del();break;case 2:c.in_grouping_b(u,97,229)&&c.slice_del()}}(),c.cursor=c.limit,l(),c.cursor=c.limit,function(){var e,r,i,n=c.limit-c.cursor;if(c.ket=c.cursor,c.eq_s_b(2,"st")&&(c.bra=c.cursor,c.eq_s_b(2,"ig")&&c.slice_del()),c.cursor=c.limit-n,c.cursor>=t&&(r=c.limit_backward,c.limit_backward=t,c.ket=c.cursor,e=c.find_among_b(a,5),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del(),i=c.limit-c.cursor,l(),c.cursor=c.limit-i;break;case 2:c.slice_from("løs")}}(),c.cursor=c.limit,c.cursor>=t&&(e=c.limit_backward,c.limit_backward=t,c.ket=c.cursor,c.out_grouping_b(d,97,248)?(c.bra=c.cursor,n=c.slice_to(n),c.limit_backward=e,c.eq_v_b(n)&&c.slice_del()):c.limit_backward=e),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}});

docs/assets/javascripts/lunr/lunr.ja.js

@@ -1,17 +0,0 @@
-/*!
- * Lunr languages, `Japanese` language
- * https://github.com/MihaiValentin/lunr-languages
- *
- * Copyright 2014, Chad Liu
- * http://www.mozilla.org/MPL/
- */
-/*!
- * based on
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(m){if(void 0===m)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===m.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var l="2"==m.version[0];m.ja=function(){this.pipeline.reset(),this.pipeline.add(m.ja.trimmer,m.ja.stopWordFilter,m.ja.stemmer),l?this.tokenizer=m.ja.tokenizer:(m.tokenizer&&(m.tokenizer=m.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=m.ja.tokenizer))};var j=new m.TinySegmenter;m.ja.tokenizer=function(e){var r,t,i,n,o,s,p,a,u;if(!arguments.length||null==e||null==e)return[];if(Array.isArray(e))return e.map(function(e){return l?new m.Token(e.toLowerCase()):e.toLowerCase()});for(r=(t=e.toString().toLowerCase().replace(/^\s+/,"")).length-1;0<=r;r--)if(/\S/.test(t.charAt(r))){t=t.substring(0,r+1);break}for(o=[],i=t.length,p=a=0;a<=i;a++)if(s=a-p,t.charAt(a).match(/\s/)||a==i){if(0<s)for(n=j.segment(t.slice(p,a)).filter(function(e){return!!e}),u=p,r=0;r<n.length;r++)l?o.push(new m.Token(n[r],{position:[u,n[r].length],index:o.length})):o.push(n[r]),u+=n[r].length;p=a+1}return o},m.ja.stemmer=function(e){return e},m.Pipeline.registerFunction(m.ja.stemmer,"stemmer-ja"),m.ja.wordCharacters="一二三四五六七八九十百千万億兆一-龠々〆ヵヶぁ-んァ-ヴーｱ-ﾝﾞa-zA-Zａ-ｚＡ-Ｚ0-9０-９",m.ja.trimmer=m.trimmerSupport.generateTrimmer(m.ja.wordCharacters),m.Pipeline.registerFunction(m.ja.trimmer,"trimmer-ja"),m.ja.stopWordFilter=m.generateStopWordFilter("これ それ あれ この その あの ここ そこ あそこ こちら どこ だれ なに なん 何 私 貴方 貴方方 我々 私達 あの人 あのかた 彼女 彼 です あります おります います は が の に を で え から まで より も どの と し それで しかし".split(" ")),m.Pipeline.registerFunction(m.ja.stopWordFilter,"stopWordFilter-ja"),m.jp=m.ja,m.Pipeline.registerFunction(m.jp.stemmer,"stemmer-jp"),m.Pipeline.registerFunction(m.jp.trimmer,"trimmer-jp"),m.Pipeline.registerFunction(m.jp.stopWordFilter,"stopWordFilter-jp")}});

docs/assets/javascripts/lunr/lunr.jp.js

@@ -1 +0,0 @@
-module.exports=require("./lunr.ja");

docs/assets/javascripts/lunr/lunr.multi.js

@@ -1 +0,0 @@
-!function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(e.lunr)}(this,function(){return function(o){o.multiLanguage=function(){for(var e=Array.prototype.slice.call(arguments),t=e.join("-"),i="",r=[],n=[],s=0;s<e.length;++s)"en"==e[s]?(i+="\\w",r.unshift(o.stopWordFilter),r.push(o.stemmer),n.push(o.stemmer)):(i+=o[e[s]].wordCharacters,o[e[s]].stopWordFilter&&r.unshift(o[e[s]].stopWordFilter),o[e[s]].stemmer&&(r.push(o[e[s]].stemmer),n.push(o[e[s]].stemmer)));var p=o.trimmerSupport.generateTrimmer(i);return o.Pipeline.registerFunction(p,"lunr-multi-trimmer-"+t),r.unshift(p),function(){this.pipeline.reset(),this.pipeline.add.apply(this.pipeline,r),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add.apply(this.searchPipeline,n))}}}});

docs/assets/javascripts/lunr/lunr.no.js

@@ -1,17 +0,0 @@
-/*!
- * Lunr languages, `Norwegian` language
- * https://github.com/MihaiValentin/lunr-languages
- *
- * Copyright 2014, Mihai Valentin
- * http://www.mozilla.org/MPL/
- */
-/*!
- * based on
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,n,i;e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=(r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){var o,s,a=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],m=[new r("dt",-1,-1),new r("vt",-1,-1)],l=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],u=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],d=[119,125,149,1],c=new n;this.setCurrent=function(e){c.setCurrent(e)},this.getCurrent=function(){return c.getCurrent()},this.stem=function(){var e,r,n,i,t=c.cursor;return function(){var e,r=c.cursor+3;if(s=c.limit,0<=r||r<=c.limit){for(o=r;;){if(e=c.cursor,c.in_grouping(u,97,248)){c.cursor=e;break}if(e>=c.limit)return;c.cursor=e+1}for(;!c.out_grouping(u,97,248);){if(c.cursor>=c.limit)return;c.cursor++}(s=c.cursor)<o&&(s=o)}}(),c.limit_backward=t,c.cursor=c.limit,function(){var e,r,n;if(c.cursor>=s&&(r=c.limit_backward,c.limit_backward=s,c.ket=c.cursor,e=c.find_among_b(a,29),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del();break;case 2:n=c.limit-c.cursor,c.in_grouping_b(d,98,122)?c.slice_del():(c.cursor=c.limit-n,c.eq_s_b(1,"k")&&c.out_grouping_b(u,97,248)&&c.slice_del());break;case 3:c.slice_from("er")}}(),c.cursor=c.limit,r=c.limit-c.cursor,c.cursor>=s&&(e=c.limit_backward,c.limit_backward=s,c.ket=c.cursor,c.find_among_b(m,2)?(c.bra=c.cursor,c.limit_backward=e,c.cursor=c.limit-r,c.cursor>c.limit_backward&&(c.cursor--,c.bra=c.cursor,c.slice_del())):c.limit_backward=e),c.cursor=c.limit,c.cursor>=s&&(i=c.limit_backward,c.limit_backward=s,c.ket=c.cursor,(n=c.find_among_b(l,11))?(c.bra=c.cursor,c.limit_backward=i,1==n&&c.slice_del()):c.limit_backward=i),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}});

docs/assets/javascripts/lunr/lunr.stemmer.support.js

@@ -1,9 +0,0 @@
-/*!
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(r,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(r.lunr)}(this,function(){return function(r){r.stemmerSupport={Among:function(r,t,i,s){if(this.toCharArray=function(r){for(var t=r.length,i=new Array(t),s=0;s<t;s++)i[s]=r.charCodeAt(s);return i},!r&&""!=r||!t&&0!=t||!i)throw"Bad Among initialisation: s:"+r+", substring_i: "+t+", result: "+i;this.s_size=r.length,this.s=this.toCharArray(r),this.substring_i=t,this.result=i,this.method=s},SnowballProgram:function(){var b;return{bra:0,ket:0,limit:0,cursor:0,limit_backward:0,setCurrent:function(r){b=r,this.cursor=0,this.limit=r.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},getCurrent:function(){var r=b;return b=null,r},in_grouping:function(r,t,i){if(this.cursor<this.limit){var s=b.charCodeAt(this.cursor);if(s<=i&&t<=s&&r[(s-=t)>>3]&1<<(7&s))return this.cursor++,!0}return!1},in_grouping_b:function(r,t,i){if(this.cursor>this.limit_backward){var s=b.charCodeAt(this.cursor-1);if(s<=i&&t<=s&&r[(s-=t)>>3]&1<<(7&s))return this.cursor--,!0}return!1},out_grouping:function(r,t,i){if(this.cursor<this.limit){var s=b.charCodeAt(this.cursor);if(i<s||s<t)return this.cursor++,!0;if(!(r[(s-=t)>>3]&1<<(7&s)))return this.cursor++,!0}return!1},out_grouping_b:function(r,t,i){if(this.cursor>this.limit_backward){var s=b.charCodeAt(this.cursor-1);if(i<s||s<t)return this.cursor--,!0;if(!(r[(s-=t)>>3]&1<<(7&s)))return this.cursor--,!0}return!1},eq_s:function(r,t){if(this.limit-this.cursor<r)return!1;for(var i=0;i<r;i++)if(b.charCodeAt(this.cursor+i)!=t.charCodeAt(i))return!1;return this.cursor+=r,!0},eq_s_b:function(r,t){if(this.cursor-this.limit_backward<r)return!1;for(var i=0;i<r;i++)if(b.charCodeAt(this.cursor-r+i)!=t.charCodeAt(i))return!1;return this.cursor-=r,!0},find_among:function(r,t){for(var i=0,s=t,e=this.cursor,n=this.limit,u=0,o=0,h=!1;;){for(var c=i+(s-i>>1),a=0,f=u<o?u:o,l=r[c],_=f;_<l.s_size;_++){if(e+f==n){a=-1;break}if(a=b.charCodeAt(e+f)-l.s[_])break;f++}if(a<0?(s=c,o=f):(i=c,u=f),s-i<=1){if(0<i||s==i||h)break;h=!0}}for(;;){if(u>=(l=r[i]).s_size){if(this.cursor=e+l.s_size,!l.method)return l.result;var m=l.method();if(this.cursor=e+l.s_size,m)return l.result}if((i=l.substring_i)<0)return 0}},find_among_b:function(r,t){for(var i=0,s=t,e=this.cursor,n=this.limit_backward,u=0,o=0,h=!1;;){for(var c=i+(s-i>>1),a=0,f=u<o?u:o,l=(_=r[c]).s_size-1-f;0<=l;l--){if(e-f==n){a=-1;break}if(a=b.charCodeAt(e-1-f)-_.s[l])break;f++}if(a<0?(s=c,o=f):(i=c,u=f),s-i<=1){if(0<i||s==i||h)break;h=!0}}for(;;){var _;if(u>=(_=r[i]).s_size){if(this.cursor=e-_.s_size,!_.method)return _.result;var m=_.method();if(this.cursor=e-_.s_size,m)return _.result}if((i=_.substring_i)<0)return 0}},replace_s:function(r,t,i){var s=i.length-(t-r);return b=b.substring(0,r)+i+b.substring(t),this.limit+=s,this.cursor>=t?this.cursor+=s:this.cursor>r&&(this.cursor=r),s},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>b.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),b.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}});

docs/assets/javascripts/lunr/lunr.sv.js

@@ -1,17 +0,0 @@
-/*!
- * Lunr languages, `Swedish` language
- * https://github.com/MihaiValentin/lunr-languages
- *
- * Copyright 2014, Mihai Valentin
- * http://www.mozilla.org/MPL/
- */
-/*!
- * based on
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,l,n;e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=(r=e.stemmerSupport.Among,l=e.stemmerSupport.SnowballProgram,n=new function(){var n,t,i=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],s=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],o=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],u=[119,127,149],m=new l;this.setCurrent=function(e){m.setCurrent(e)},this.getCurrent=function(){return m.getCurrent()},this.stem=function(){var e,r=m.cursor;return function(){var e,r=m.cursor+3;if(t=m.limit,0<=r||r<=m.limit){for(n=r;;){if(e=m.cursor,m.in_grouping(o,97,246)){m.cursor=e;break}if(m.cursor=e,m.cursor>=m.limit)return;m.cursor++}for(;!m.out_grouping(o,97,246);){if(m.cursor>=m.limit)return;m.cursor++}(t=m.cursor)<n&&(t=n)}}(),m.limit_backward=r,m.cursor=m.limit,function(){var e,r=m.limit_backward;if(m.cursor>=t&&(m.limit_backward=t,m.cursor=m.limit,m.ket=m.cursor,e=m.find_among_b(i,37),m.limit_backward=r,e))switch(m.bra=m.cursor,e){case 1:m.slice_del();break;case 2:m.in_grouping_b(u,98,121)&&m.slice_del()}}(),m.cursor=m.limit,e=m.limit_backward,m.cursor>=t&&(m.limit_backward=t,m.cursor=m.limit,m.find_among_b(s,7)&&(m.cursor=m.limit,m.ket=m.cursor,m.cursor>m.limit_backward&&(m.bra=--m.cursor,m.slice_del())),m.limit_backward=e),m.cursor=m.limit,function(){var e,r;if(m.cursor>=t){if(r=m.limit_backward,m.limit_backward=t,m.cursor=m.limit,m.ket=m.cursor,e=m.find_among_b(a,5))switch(m.bra=m.cursor,e){case 1:m.slice_del();break;case 2:m.slice_from("lös");break;case 3:m.slice_from("full")}m.limit_backward=r}}(),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}});

docs/assets/javascripts/lunr/lunr.th.js

@@ -1,17 +0,0 @@
-/*!
- * Lunr languages, `Thai` language
- * https://github.com/MihaiValentin/lunr-languages
- *
- * Copyright 2017, Keerati Thiwanruk
- * http://www.mozilla.org/MPL/
- */
-/*!
- * based on
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(t){if(void 0===t)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===t.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var i="2"==t.version[0];t.th=function(){this.pipeline.reset(),this.pipeline.add(t.th.trimmer),i?this.tokenizer=t.th.tokenizer:(t.tokenizer&&(t.tokenizer=t.th.tokenizer),this.tokenizerFn&&(this.tokenizerFn=t.th.tokenizer))},t.th.wordCharacters="[฀-๿]",t.th.trimmer=t.trimmerSupport.generateTrimmer(t.th.wordCharacters),t.Pipeline.registerFunction(t.th.trimmer,"trimmer-th");var n=t.wordcut;n.init(),t.th.tokenizer=function(e){if(!arguments.length||null==e||null==e)return[];if(Array.isArray(e))return e.map(function(e){return i?new t.Token(e):e});var r=e.toString().replace(/^\s+/,"");return n.cut(r).split("|")}}});

docs/assets/javascripts/lunr/lunr.vi.js

@@ -1,17 +0,0 @@
-/*!
- * Lunr languages, `Vietnamese` language
- * https://github.com/MihaiValentin/lunr-languages
- *
- * Copyright 2017, Keerati Thiwanruk
- * http://www.mozilla.org/MPL/
- */
-/*!
- * based on
- * Snowball JavaScript Library v0.3
- * http://code.google.com/p/urim/
- * http://snowball.tartarus.org/
- *
- * Copyright 2010, Oleg Mazko
- * http://www.mozilla.org/MPL/
- */
-!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.vi=function(){this.pipeline.reset(),this.pipeline.add(e.vi.stopWordFilter,e.vi.trimmer)},e.vi.wordCharacters="[A-Za-ẓ̀͐́͑̉̃̓ÂâÊêÔôĂ-ăĐ-đƠ-ơƯ-ư]",e.vi.trimmer=e.trimmerSupport.generateTrimmer(e.vi.wordCharacters),e.Pipeline.registerFunction(e.vi.trimmer,"trimmer-vi"),e.vi.stopWordFilter=e.generateStopWordFilter("là cái nhưng mà".split(" "))}});

docs/index.html

@@ -1,202 +0,0 @@
-
-
-
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta http-equiv="x-ua-compatible" content="ie=edge">
-      
-      
-      
-      
-        <meta name="lang:clipboard.copy" content="Copy to clipboard">
-      
-        <meta name="lang:clipboard.copied" content="Copied to clipboard">
-      
-        <meta name="lang:search.language" content="en">
-      
-        <meta name="lang:search.pipeline.stopwords" content="True">
-      
-        <meta name="lang:search.pipeline.trimmer" content="True">
-      
-        <meta name="lang:search.result.none" content="No matching documents">
-      
-        <meta name="lang:search.result.one" content="1 matching document">
-      
-        <meta name="lang:search.result.other" content="# matching documents">
-      
-        <meta name="lang:search.tokenizer" content="[\s\-]+">
-      
-      <link rel="shortcut icon" href="assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">
-    
-    
-      
-        <title>Yq</title>
-      
-    
-    
-      <link rel="stylesheet" href="assets/stylesheets/application.1b62728e.css">
-      
-      
-    
-    
-      <script src="assets/javascripts/modernizr.268332fc.js"></script>
-    
-    
-      
-        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
-        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
-      
-    
-    <link rel="stylesheet" href="assets/fonts/material-icons.css">
-    
-    
-    
-      
-    
-    
-  </head>
-  
-    <body dir="ltr">
-  
-    <svg class="md-svg">
-      <defs>
-        
-        
-          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
-        
-      </defs>
-    </svg>
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-    
-      <a href="#new-documentation-website" tabindex="1" class="md-skip">
-        Skip to content
-      </a>
-    
-    
-      <header class="md-header" data-md-component="header">
-  <nav class="md-header-nav md-grid">
-    <div class="md-flex">
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="." title="Yq" class="md-header-nav__button md-logo">
-          
-            <i class="md-icon"></i>
-          
-        </a>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
-      </div>
-      <div class="md-flex__cell md-flex__cell--stretch">
-        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-          
-            <span class="md-header-nav__topic">
-              Yq
-            </span>
-
-          
-        </div>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        
-          <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-          
-        
-      </div>
-      
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-            
-
-
-  
-
-<a href="https://github.com/mikefarah/yq/" title="Go to repository" class="md-source" data-md-source="github">
-  
-    <div class="md-source__icon">
-      <svg viewBox="0 0 24 24" width="24" height="24">
-        <use xlink:href="#__github" width="24" height="24"></use>
-      </svg>
-    </div>
-  
-  <div class="md-source__repository">
-    mikefarah/yq
-  </div>
-</a>
-          </div>
-        </div>
-      
-    </div>
-  </nav>
-</header>
-    
-    <div class="md-container">
-      
-        
-      
-      
-      <main class="md-main" role="main">
-        <div class="md-main__inner md-grid" data-md-component="container">
-          
-            
-       
-            
-          
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
-              
-                
-                
-                  <h1>New documentation website</h1>
-                
-<p>User docs are better than ever, and have been <a href="https://mikefarah.gitbook.io/yq">moved here</a></p>
-                
-                  
-                
-                
-              
-              
-                
-
-
-              
-            </article>
-          </div>
-        </div>
-      </main>
-      
-        
-<footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-        
-        powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
-        and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
-          Material for MkDocs</a>
-      </div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    
-      <script src="assets/javascripts/application.808e90bb.js"></script>
-      
-      <script>app.initialize({version:"1.0.4",url:{base:"."}})</script>
-      
-    
-  </body>
-</html>