Fixing github action description

Fixes https://github.com/mikefarah/yq/issues/375

README.md

@@ -79,8 +79,10 @@ yq() {
 
 ## Features
 - 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
@@ -114,6 +116,7 @@ Available Commands:
   write       yq w [--inplace/-i] [--script/-s script_file] [--doc/-d index] sample.yaml 'b.e(name==fr*).value' newValue
 
 Flags:
+  -C, --colors        print using colors
   -h, --help          help for yq
   -I, --indent int    sets indent level for output (default 2)
   -P, --prettyPrint   pretty print

action.yml

@@ -1,5 +1,7 @@
-name: 'YAML processor'
-description: 'YAML processor for running in Github action'
+name: 'yq - portable yaml processor'
+description: 'create, read, update, delete, merge, validate and do more with yaml'
+icon: command
+color: gray-dark
 inputs:
   cmd:
     description: 'The Command which should be run'

cmd/commands_test.go

@@ -94,12 +94,21 @@ func TestReadCmd(t *testing.T) {
 	test.AssertResult(t, "2\n", result.Output)
 }
 
-func TestCompareCmd(t *testing.T) {
+func TestCompareSameCmd(t *testing.T) {
 	cmd := getRootCommand()
-	result := test.RunCmd(cmd, "compare ../examples/data1.yaml ../examples/data3.yaml")
+	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 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
@@ -111,6 +120,7 @@ func TestCompareCmd(t *testing.T) {
 }
 
 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 {
@@ -128,6 +138,7 @@ func TestComparePrettyCmd(t *testing.T) {
 }
 
 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 {
@@ -190,6 +201,293 @@ func TestReadArrayCmd(t *testing.T) {
 	test.AssertResult(t, "b.e.[1].name: sam\n", result.Output)
 }
 
+func TestReadArrayLengthCmd(t *testing.T) {
+	content := `- things
+- whatever
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l %s", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "2\n", result.Output)
+}
+
+func TestReadArrayLengthDeepCmd(t *testing.T) {
+	content := `holder: 
+- things
+- whatever
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l %s holder", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "2\n", result.Output)
+}
+
+func TestReadArrayLengthDeepMultipleCmd(t *testing.T) {
+	content := `holderA: 
+- things
+- whatever
+skipMe:
+- yep
+holderB: 
+- other things
+- cool
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l -c %s holder*", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "2\n", result.Output)
+}
+
+func TestReadCollectCmd(t *testing.T) {
+	content := `holderA: yep
+skipMe: not me
+holderB: me too
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -c %s holder*", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `- yep
+- me too
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadCollectArrayCmd(t *testing.T) {
+	content := `- name: fred
+  value: 32
+- name: sam
+  value: 67
+- name: fernie
+  value: 103
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -c %s (name==f*)", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `- name: fred
+  value: 32
+- name: fernie
+  value: 103
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadArrayLengthDeepMultipleWithPathCmd(t *testing.T) {
+	content := `holderA: 
+- things
+- whatever
+holderB: 
+- other things
+- cool
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l %s -ppv holder*", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "holderA: 2\nholderB: 2\n", result.Output)
+}
+
+func TestReadObjectLengthCmd(t *testing.T) {
+	content := `cat: meow
+dog: bark
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l %s", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "2\n", result.Output)
+}
+
+func TestReadObjectLengthDeepCmd(t *testing.T) {
+	content := `holder: 
+  cat: meow
+  dog: bark
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l %s holder", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "2\n", result.Output)
+}
+
+func TestReadObjectLengthDeepMultipleCmd(t *testing.T) {
+	content := `holderA: 
+  cat: meow
+  dog: bark
+holderB: 
+  elephant: meow
+  zebra: bark
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l -c %s holder*", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "2\n", result.Output)
+}
+
+func TestReadObjectLengthDeepMultipleWithPathsCmd(t *testing.T) {
+	content := `holderA: 
+  cat: meow
+  dog: bark
+holderB: 
+  elephant: meow
+  zebra: bark
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l -ppv %s holder*", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "holderA: 2\nholderB: 2\n", result.Output)
+}
+
+func TestReadScalarLengthCmd(t *testing.T) {
+	content := `meow`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read -l %s", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "4\n", result.Output)
+}
+
+func TestReadDoubleQuotedStringCmd(t *testing.T) {
+	content := `name: "meow face"`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read %s name", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "meow face\n", result.Output)
+}
+
+func TestReadSingleQuotedStringCmd(t *testing.T) {
+	content := `name: 'meow face'`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read %s name", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "meow face\n", result.Output)
+}
+
+func TestReadQuotedMultinlineStringCmd(t *testing.T) {
+	content := `test: |
+  abcdefg    
+  hijklmno
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read %s test", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `abcdefg    
+hijklmno
+
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadQuotedMultinlineNoNewLineStringCmd(t *testing.T) {
+	content := `test: |-
+  abcdefg    
+  hijklmno
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read %s test", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	expectedOutput := `abcdefg    
+hijklmno
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadBooleanCmd(t *testing.T) {
+	content := `name: true`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read %s name", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "true\n", result.Output)
+}
+
+func TestReadNumberCmd(t *testing.T) {
+	content := `name: 32.13`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("read %s name", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+	test.AssertResult(t, "32.13\n", result.Output)
+}
+
 func TestReadDeepSplatCmd(t *testing.T) {
 	cmd := getRootCommand()
 	result := test.RunCmd(cmd, "read -p pv ../examples/sample.yaml b.**")
@@ -1809,6 +2107,75 @@ func TestDeleteYamlArrayCmd(t *testing.T) {
 	test.AssertResult(t, expectedOutput, result.Output)
 }
 
+func TestReadExpression(t *testing.T) {
+	content := `name: value`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("r %s (x==f)", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := ``
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadFindValueArrayCmd(t *testing.T) {
+	content := `- cat
+- dog
+- rat
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("r %s (.==dog)", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := `dog
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadFindValueDeepArrayCmd(t *testing.T) {
+	content := `animals:
+  - cat
+  - dog
+  - rat
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("r %s animals(.==dog)", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := `dog
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
+func TestReadFindValueDeepObjectCmd(t *testing.T) {
+	content := `animals:
+  great: yes
+  small: sometimes
+`
+	filename := test.WriteTempYamlFile(content)
+	defer test.RemoveTempYamlFile(filename)
+	cmd := getRootCommand()
+	result := test.RunCmd(cmd, fmt.Sprintf("r %s animals(.==yes) -ppv", filename))
+	if result.Error != nil {
+		t.Error(result.Error)
+	}
+
+	expectedOutput := `animals.great: yes
+`
+	test.AssertResult(t, expectedOutput, result.Output)
+}
+
 func TestDeleteYamlArrayExpressionCmd(t *testing.T) {
 	content := `- name: fred
 - name: cat

cmd/compare.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"bufio"
 	"bytes"
+	"os"
 	"strings"
 
 	"github.com/kylelemons/godebug/diff"
@@ -11,6 +12,9 @@ import (
 	"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]",
@@ -70,7 +74,14 @@ func compareDocuments(cmd *cobra.Command, args []string) error {
 		return errorDoingThings
 	}
 
-	cmd.Print(diff.Diff(strings.TrimSuffix(dataBufferA.String(), "\n"), strings.TrimSuffix(dataBufferB.String(), "\n")))
-	cmd.Print("\n")
+	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/constant.go

@@ -7,6 +7,8 @@ import (
 
 var customTag = ""
 var printMode = "v"
+var printLength = false
+var collectIntoArray = false
 var writeInplace = false
 var writeScript = ""
 var sourceYamlFile = ""

cmd/read.go

@@ -26,6 +26,8 @@ yq r -- things.yaml '--key-starting-with-dashes.blah'
 	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(&explodeAnchors, "explodeAnchors", "X", false, "explode anchors")
 	return cmdRead
 }

cmd/root.go

@@ -43,7 +43,7 @@ func New() *cobra.Command {
 	rootCmd.PersistentFlags().BoolVarP(&prettyPrint, "prettyPrint", "P", false, "pretty print")
 	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, "colorsEnabled", "C", false, "enable colors")
+	rootCmd.PersistentFlags().BoolVarP(&colorsEnabled, "colors", "C", false, "print with colors")
 
 	rootCmd.AddCommand(
 		createReadCmd(),

cmd/utils.go

@@ -77,8 +77,35 @@ func appendDocument(originalMatchingNodes []*yqlib.NodeContext, dataBucket yaml.
 	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 {
+		return writeString(writer, node.Value+"\n")
+	}
 	if outputToJSON {
 		encoder = yqlib.NewJsonEncoder(writer, prettyPrint, indent)
 	} else {
@@ -152,6 +179,9 @@ func printResults(matchingNodes []*yqlib.NodeContext, writer io.Writer) error {
 		return nil
 	}
 	var errorWriting error
+
+	var arrayCollection = yaml.Node{Kind: yaml.SequenceNode}
+
 	for _, mappedDoc := range matchingNodes {
 		switch printMode {
 		case "p":
@@ -164,17 +194,27 @@ func printResults(matchingNodes []*yqlib.NodeContext, writer io.Writer) error {
 			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] = mappedDoc.Node
-			if err := printNode(&parentNode, bufferedWriter); err != nil {
+			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 err := printNode(mappedDoc.Node, bufferedWriter); err != nil {
+			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
 }
 

cmd/version.go

@@ -11,7 +11,7 @@ var (
 	GitDescribe string
 
 	// Version is main version number that is being run at the moment.
-	Version = "3.1.2"
+	Version = "3.2.1"
 
 	// 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

pkg/yqlib/path_parser.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"strconv"
 	"strings"
+
+	yaml "gopkg.in/yaml.v3"
 )
 
 type PathParser interface {
@@ -45,7 +47,7 @@ func (p *pathParser) MatchesNextPathElement(nodeContext NodeContext, nodeKey str
 	}
 	var headString = fmt.Sprintf("%v", head)
 
-	if strings.Contains(headString, "==") {
+	if strings.Contains(headString, "==") && nodeContext.Node.Kind != yaml.ScalarNode {
 		log.Debug("ooh deep recursion time")
 		result := strings.SplitN(headString, "==", 2)
 		path := strings.TrimSpace(result[0])
@@ -63,6 +65,14 @@ func (p *pathParser) MatchesNextPathElement(nodeContext NodeContext, nodeKey str
 		}
 		log.Debug("done deep recursing, found %v matches", len(navigationStrategy.GetVisitedNodes()))
 		return len(navigationStrategy.GetVisitedNodes()) > 0
+	} else if strings.Contains(headString, "==") && nodeContext.Node.Kind == yaml.ScalarNode {
+		result := strings.SplitN(headString, "==", 2)
+		path := strings.TrimSpace(result[0])
+		value := strings.TrimSpace(result[1])
+		if path == "." {
+			log.Debug("need to match scalar")
+			return matchesString(value, nodeContext.Node.Value)
+		}
 	}
 
 	if head == "+" {

scripts/xcompile.sh

@@ -7,3 +7,6 @@ gox -ldflags "${LDFLAGS}" -output="build/yq_{{.OS}}_{{.Arch}}"
 # include non-default linux builds too
 gox -ldflags "${LDFLAGS}" -os=linux  -output="build/yq_{{.OS}}_{{.Arch}}"
 
+cd build
+rhash -r -a . -P -o checksums
+

snap/snapcraft.yaml

@@ -1,5 +1,5 @@
 name: yq
-version: '3.1.2'
+version: '3.2.1'
 summary: A lightweight and portable command-line YAML processor
 description: |
   The aim of the project is to be the jq or sed of yaml files.