Merge branch 'feat/jq-tester' into chore/all-my-stuffs

# Conflicts:
#	package.json
#	pnpm-lock.yaml
#	src/tools/index.ts

Author: sharevb

package.json

@@ -63,6 +63,7 @@
     "@tiptap/vue-3": "2.7.4",
     "@types/figlet": "^1.5.8",
     "@types/luxon": "^3.4.2",
+    "@types/jsonpath": "^0.2.4",
     "@types/markdown-it": "^13.0.7",
     "@types/lodash.defaultsdeep": "^4.6.9",
     "@types/lodash.flattendeep": "^4.4.9",
@@ -121,10 +122,12 @@
     "ical.js": "^2.1.0",
     "image-in-browser": "^3.2.0",
     "ip-bigint": "^8.2.0",
+    "jq-wasm": "^0.0.9",
     "js-base64": "^3.7.6",
     "image-in-browser": "^3.1.0",
     "js-base64": "^3.7.7",
     "json5": "^2.2.3",
+    "jsonpath": "^1.1.1",
     "jwt-decode": "^3.1.2",
     "libphonenumber-js": "^1.10.28",
     "lodash": "^4.17.21",

pnpm-lock.yaml

@@ -15,6 +15,9 @@ import { tool as hexFileConverter } from './hex-file-converter';
 import { tool as icalMerger } from './ical-merger';
 import { tool as imageConverter } from './image-converter';
 import { tool as integersToIp } from './integers-to-ip';
+import { tool as jqTester } from './jq-tester';
+import { tool as jsonpathMemo } from './jsonpath-memo';
+import { tool as jqMemo } from './jq-memo';
 
 import { tool as cssXpathConverter } from './css-xpath-converter';
 import { tool as cssSelectorsMemo } from './css-selectors-memo';
@@ -239,6 +242,9 @@ export const toolsByCategory: ToolCategory[] = [
       cssSelectorsMemo,
       xpathMemo,
       curlConverter,
+      jqTester,
+      jqMemo,
+      jsonpathMemo,
     ],
   },
   {

src/tools/index.ts

@@ -0,0 +1,12 @@
+import { Brackets } from '@vicons/tabler';
+import { defineTool } from '../tool';
+
+export const tool = defineTool({
+  name: 'Jq Cheatsheet',
+  path: '/jq-memo',
+  description: 'JQ command cheatsheet',
+  keywords: ['jq', 'cheatsheet', 'memo'],
+  component: () => import('./jq-memo.vue'),
+  icon: Brackets,
+  createdAt: new Date('2024-08-15'),
+});

src/tools/jq-memo/index.ts

@@ -0,0 +1,89 @@
+# Processing JSON using jq
+
+jq is useful to slice, filter, map and transform structured json data.
+
+## Installing jq
+
+### On Mac OS
+
+`brew install jq`
+
+### On AWS Linux
+
+Not available as yum install on our current AMI. It should be on the latest AMI though: https://aws.amazon.com/amazon-linux-ami/2015.09-release-notes/
+
+Installing from the source proved to be tricky.
+
+## Useful arguments
+
+When running jq, the following arguments may become handy:
+
+| Argument        |  Description  |
+| ------ | :--------- |
+| `--version`| Output the jq version and exit with zero. |
+| `--sort-keys` | Output the fields of each object with the keys in sorted order.|
+
+## Basic concepts
+
+The syntax for jq is pretty coherent:
+
+| Syntax  |  Description  |
+| ------ | :--------- |
+| , | Filters separated by a comma will produce multiple independent outputs|
+| ? | Will ignores error if the type is unexpected |
+| [] | Array construction |
+| {} | Object construction |
+| + | Concatenate or Add |
+| - | Difference of sets or Substract |
+| length | Size of selected element |
+| | | Pipes are used to chain commands in a similar fashion than bash|
+
+
+## Dealing with json objects
+
+| Description | Command |
+| ------ | :--------- |
+| Display all keys | `jq 'keys'` |
+| Adds + 1 to all items | `jq 'map_values(.+1)'` |
+| Delete a key| `jq 'del(.foo)'` |
+| Convert an object to array | `to_entries | map([.key, .value])` |
+
+## Dealing with fields
+
+| Description | Command |
+| ------ | :--------- |
+| Concatenate two fields| `fieldNew=.field1+' '+.field2` |
+
+
+## Dealing with json arrays
+
+### Slicing and Filtering
+
+| Description | Command |
+| ------ | :--------- |
+| All | `jq .[]` |
+| First |	`jq '.[0]'` |
+| Range | `jq '.[2:4]'` |
+| First 3 | `jq '.[:3]'` |
+| Last 2 | `jq '.[-2:]'` |
+| Before Last | `jq '.[-2]'`|
+| Select array of int by value | `jq 'map(select(. >= 2))'` |
+| Select array of objects by value| `jq '.[] | select(.id == "second")'` |
+| Select by type | `jq '.[] | numbers'` with type been arrays, objects, iterables, booleans, numbers, normals, finites, strings, nulls, values, scalars |
+
+### Mapping and Transforming
+
+| Description | Command |
+| ------ | :--------- |
+| Add + 1 to all items | `jq 'map(.+1)'` |
+| Delete 2 items| `jq 'del(.[1, 2])'` |
+| Concatenate arrays | `jq 'add'` |
+| Flatten an array | `jq 'flatten'` |
+| Create a range of numbers | `jq '[range(2;4)]'` |
+| Display the type of each item| `jq 'map(type)'` |
+| Sort an array of basic type| `jq 'sort'` |
+| Sort an array of objects | `jq 'sort_by(.foo)'` |
+| Group by a key - opposite to flatten | `jq 'group_by(.foo)'` |
+| Minimun value of an array| `jq 'min'` .See also  min, max, min_by(path_exp), max_by(path_exp) |
+| Remove duplicates| `jq 'unique'` or `jq 'unique_by(.foo)'` or `jq 'unique_by(length)'` |
+| Reverse an array | `jq 'reverse'` |