wip

Author: mikefarah

pkg/yqlib/doc/operators/headers/sort-keys.md

@@ -12,5 +12,5 @@ diff file1.yml file2.yml
 
 Note that `yq` does not yet consider anchors when sorting by keys - this may result in invalid yaml documents if you are using merge anchors.
 
-For more advanced sorting, using `to_entries` to convert the map to an array, then sort/process the array as you like (e.g. using `sort_by`) and convert back to a map using `from_entries`.
-See [here](https://mikefarah.gitbook.io/yq/operators/entries#custom-sort-map-keys) for an example. 
+For more advanced sorting, you can use the [sort_by](https://mikefarah.gitbook.io/yq/operators/sort) function on a map, and give it a custom function like `sort_by(key | downcase)`.
+

pkg/yqlib/doc/operators/sort-keys.md

@@ -12,8 +12,8 @@ diff file1.yml file2.yml
 
 Note that `yq` does not yet consider anchors when sorting by keys - this may result in invalid yaml documents if you are using merge anchors.
 
-For more advanced sorting, using `to_entries` to convert the map to an array, then sort/process the array as you like (e.g. using `sort_by`) and convert back to a map using `from_entries`.
-See [here](https://mikefarah.gitbook.io/yq/operators/entries#custom-sort-map-keys) for an example. 
+For more advanced sorting, you can use the [sort_by](https://mikefarah.gitbook.io/yq/operators/sort) function on a map, and give it a custom function like `sort_by(key | downcase)`.
+
 
 ## Sort keys of map
 Given a sample.yml file of:

pkg/yqlib/doc/operators/sort.md

@@ -109,6 +109,46 @@ cool:
   - c: banana
 ```
 
+## Sort a map
+Sorting a map, by default, will sort by the values
+
+Given a sample.yml file of:
+```yaml
+y: b
+z: a
+x: c
+```
+then
+```bash
+yq 'sort' sample.yml
+```
+will output
+```yaml
+z: a
+y: b
+x: c
+```
+
+## Sort a map by keys
+Use sort_by to sort a map using a custom function
+
+Given a sample.yml file of:
+```yaml
+Y: b
+z: a
+x: c
+```
+then
+```bash
+yq 'sort_by(key | downcase)' sample.yml
+```
+will output
+```yaml
+x: c
+Y: b
+z: a
+```
+
 ## Sort is stable
 Note the order of the elements in unchanged when equal in sorting.
 

pkg/yqlib/operator_sort.go

@@ -29,7 +29,6 @@ func sortByOperator(d *dataTreeNavigator, context Context, expressionNode *Expre
 		if candidate.Kind == MappingNode {
 
 			sortableArray = make(sortableNodeArray, len(candidate.Content)/2)
-			log.Warningf("Sorting map: %v", NodeToString(candidate))
 			for i := 1; i < len(candidate.Content); i = i + 2 {
 
 				originalNode := candidate.Content[i]

pkg/yqlib/operator_sort_test.go

@@ -84,6 +84,24 @@ var sortByOperatorScenarios = []expressionScenario{
 			"D0, P[], (!!map)::cool: [{a: banana}, {b: banana}, {c: banana}]\n",
 		},
 	},
+	{
+		description:    "Sort a map",
+		subdescription: "Sorting a map, by default, will sort by the values",
+		document:       "y: b\nz: a\nx: c\n",
+		expression:     `sort`,
+		expected: []string{
+			"D0, P[], (!!map)::z: a\ny: b\nx: c\n",
+		},
+	},
+	{
+		description:    "Sort a map by keys",
+		subdescription: "Use sort_by to sort a map using a custom function",
+		document:       "Y: b\nz: a\nx: c\n",
+		expression:     `sort_by(key | downcase)`,
+		expected: []string{
+			"D0, P[], (!!map)::x: c\nY: b\nz: a\n",
+		},
+	},
 	{
 		description:    "Sort is stable",
 		subdescription: "Note the order of the elements in unchanged when equal in sorting.",