Added icon and color to github action

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/color)
 - [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#length)
 - 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'
+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 {
@@ -2005,6 +2016,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")))
+	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/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/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.0"
 
 	// 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 == "+" {

snap/snapcraft.yaml

@@ -1,5 +1,5 @@
 name: yq
-version: '3.1.2'
+version: '3.2.0'
 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.