chore: Improve README and repo layout

.gitignore

@@ -176,6 +176,5 @@ target/
 **/*.rs.bk
 
 notes.md
-test.txt
-large_test.txt
-very_large_test.txt
+test/large_test.txt
+test/very_large_test.txt

README.md

@@ -1,21 +1,25 @@
 # PREtty FIX
+![CI Status](https://img.shields.io/github/actions/workflow/status/shivix/prefix/rust.yml?branch=master)
+![Latest Release](https://img.shields.io/github/v/release/shivix/prefix)
+
 A commandline based pretty printer for FIX messages.
 
-Based on a FIX4.4 dictionary, but is usable with most versions.
+Based on a FIX4.4 dictionary, but is usable with all versions.
+
+<img alt="Prefix showcase" src="https://github.com/Shivix/prefix/tree/master/examples/prefix.gif" width="1200" />
 
 ## Usage
-Mainly developed with unix piping in mind:
+input can be passed in as an argument or piped in:
 ```bash
-echo 8=4.4^1=test | prefix
-```
-But can also provide a message as an argument:
-```bash
-prefix 8=4.4^1=test
+prefix "8=FIX4.4|1=test|55=EUR/USD|10=123|"
+echo "8=FIX4.4|1=test|55=EUR/USD|10=123|" | prefix
 ```
 outputs:
 ```
-BeginString = 4.4
+BeginString = FIX4.4
 Account = test
+Symbol = EUR/USD
+CheckSum = 123
 ```
 
 Currently can use ^ and | and SOH as delimiters.
@@ -26,10 +30,8 @@ Use `prefix --help` or `man prefix` for more details.
 Unix piping greatly increases the potential uses. For example:
 Parsing a log file and aligning the values for easy scan reading.
 ```bash
-# Creates the example log file.
-echo "8=FIX.4.4|1=TEST^55=EUR/USD|150=1" > example.log
-# Pipes the contents to prefix which parses and pipes them to awk, which prints them aligned.
-cat example.log | prefix -v | awk '{printf("%-20s %-30s\n", $1,$3)}'
+# Pipe the file contents to prefix which parses and pipes them to awk, which prints them aligned.
+cat example.txt | prefix -v | awk '{printf("%-20s %-30s\n", $1,$3)}'
 ```
 outputs:
 ```
@@ -38,6 +40,18 @@ Account              TEST
 Symbol               EUR/USD
 ExecType             PartialFill
 ```
+Or summarising a log file that includes FIX messages.
+```bash
+# Pipe the file contents to prefix which then summarises the FIX messages by instrument
+cat example.log | prefix --summary 55 --only-fix | sort | uniq --count
+```
+outputs:
+```
+4 NewOrderSingle EUR/USD
+4 ExecutionReport EUR/USD
+2 NewOrderSingle USD/KRW
+2 ExecutionReport USD/KRW
+```
 
 ## Installation
 Can be installed using:

examples/prefix.tape

@@ -0,0 +1,15 @@
+Output prefix.gif
+
+Set FontSize 26
+Set Width 1200
+Set Height 600
+Set CursorBlink false
+
+# Not yet released
+#Env PROMPT "$ "
+
+Type@0ms `FIX_MSG="8=FIX.4.4|35=8|34=42|49=SENDER|56=TARGET|55=EURUSD|44=1.032|38=10000|54=1|150=F|10=123|"` Enter
+Sleep 1s
+Type@100ms "prefix $FIX_MSG -v" Sleep 1s  Enter
+
+Sleep 10s

src/prefix/mod.rs

@@ -99,6 +99,7 @@ fn parse_tags(input: &str, regex: &Regex) -> String {
 
 fn add_colour(input: &str, use_colour: bool) -> String {
     if use_colour {
+        // TODO: Allow configuring colour using ENV variable
         format!("\x1b[33m{}\x1b[0m", input)
     } else {
         input.to_string()

test.sh → test/test.sh

@@ -43,10 +43,10 @@ for args in "${arg_sets[@]}"; do
         $before_cmd $msg $args >>"$before_file"
         $after_cmd $msg $args >>"$after_file"
     done
-    cat test.txt | $before_cmd $args >>"$before_file"
-    cat test.txt | $after_cmd $args >>"$after_file"
+    cat test/test.txt | $before_cmd $args >>"$before_file"
+    cat test/test.txt | $after_cmd $args >>"$after_file"
 done
-cat test.txt | $before_cmd --summary 55 | sort | uniq --count >>"$before_file"
-cat test.txt | $after_cmd --summary 55 | sort | uniq --count >>"$after_file"
+cat test/test.txt | $before_cmd --summary 55 | sort | uniq --count >>"$before_file"
+cat test/test.txt | $after_cmd --summary 55 | sort | uniq --count >>"$after_file"
 
 $diff_tool "$before_file" "$after_file"

test/test.txt

@@ -0,0 +1,39 @@
+8=FIX.4.4
9=75
35=A
34=100
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178

+
+8=FIX.4.4
9=148
35=D
34=101
SENDER1
52=20240101-04:04:04.444
TARGET1
44=1.123
11=012345678910
15=USD
21=2
38=7000
40=1
54=1
55=EUR/USD
60=20240101-04:04:04.404
10=092

+Non FIX Message Line
+8=FIX.4.4
9=289
35=8
34=102
49=SENDER1
52=20240101-01:01:01.100
56=TARGET1
6=113.35
44=1.123
11=012345678910
14=4444
15=USD
17=10987654321
21=2
31=113.35
32=4000
37=10987654321
38=7000
39=1
40=1
54=1
55=EUR/USD
60=20240101-01:01:01.100
150=F
151=4000
453=1
448=PARTY
447=D
452=1
10=151

+Another Non FIX Message Line
+Another Non FIX Message Line with 55 and 54 to translate
+8=FIX.4.4
9=75
35=A
34=103
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178

+
+Non FIX Message Line
+8=FIX.4.4
9=289
35=8
34=104
49=SENDER1
52=20240101-01:01:01.100
56=TARGET1
6=113.35
44=1.123
11=012345678910
14=4444.44
15=USD
17=10987654321
21=2
31=113.35
32=4000
37=10987654321
38=7000
39=1
40=1
54=1
55=EUR/USD
60=20240101-01:01:01.100
150=F
151=4000
453=1
448=PARTY
447=D
452=1
10=151

+Another Non FIX Message Line with 55 and 54 to translate
+8=FIX.4.4
9=75
35=A
34=105
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178

+
+8=FIX.4.4
9=148
35=D
34=106
SENDER1
52=20240101-04:04:04.444
TARGET1
44=1.123
11=012345678910
15=USD
21=2
38=7000
40=1
54=1
55=EUR/USD
60=20240101-04:04:04.404
10=092

+Non FIX Message Line
+Another Non FIX Message Line with 55 and 54 to translate
+
+8=FIX.4.4
9=75
35=A
34=107
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178

+
+8=FIX.4.4
9=148
35=D
34=108
SENDER1
52=20240101-04:04:04.444
TARGET1
44=1.123
11=012345678910
15=USD
21=2
38=7000
40=1
54=1
55=USD/KRW
60=20240101-04:04:04.404
10=092

+
+8=FIX.4.4
9=148
35=D
34=109
SENDER1
52=20240101-04:04:04.444
TARGET1
44=1.123
11=012345678910
15=USD
21=2
38=7000
40=1
54=1
55=USD/KRW
60=20240101-04:04:04.404
10=092

+Non FIX Message Line
+8=FIX.4.4
9=289
35=8
34=110
49=SENDER1
52=20240101-01:01:01.100
56=TARGET1
6=113.35
44=1.123
11=012345678910
14=123.123
15=USD
17=10987654321
21=2
31=113.35
32=4000
37=10987654321
38=7000
39=1
40=1
54=1
55=USD/KRW
60=20240101-01:01:01.100
150=F
151=4000
453=1
448=PARTY
447=D
452=1
10=151

+Another Non FIX Message Line
+8=FIX.4.4
9=75
35=A
34=111
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178

+
+8=FIX.4.4
9=148
35=D
34=112
SENDER1
52=20240101-04:04:04.444
TARGET1
44=1.123
11=012345678910
15=USD
21=2
38=7000
40=1
54=1
55=EUR/USD
60=20240101-04:04:04.404
10=092

+Non FIX Message Line
+8=FIX.4.4
9=289
35=8
34=113
49=SENDER1
52=20240101-01:01:01.100
56=TARGET1
6=113.35
44=1.123
11=012345678910
14=123.123
15=USD
17=10987654321
21=2
31=113.35
32=4000
37=10987654321
38=7000
39=1
40=1
54=1
55=EUR/USD
60=20240101-01:01:01.100
150=F
151=4000
453=1
448=PARTY
447=D
452=1
10=151

+Another Non FIX Message Line
+8=FIX.4.4
9=75
35=A
34=115
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178

+
+8=FIX.4.4
9=148
35=D
34=116
SENDER1
52=20240101-04:04:04.444
TARGET1
44=1.123
11=012345678910
15=USD
21=2
38=7000
40=1
54=1
55=EUR/USD
60=20240101-04:04:04.404
10=092

+Non FIX Message Line
+8=FIX.4.4
9=289
35=8
34=117
49=SENDER1
52=20240101-01:01:01.100
56=TARGET1
6=113.35
44=1.123
11=012345678910
14=123.123
15=USD
17=10987654321
21=2
31=113.35
32=4000
37=10987654321
38=7000
39=1
40=1
54=1
55=EUR/USD
60=20240101-01:01:01.100
150=F
151=4000
453=1
448=PARTY
447=D
452=1
10=151

+Another Non FIX Message Line
+8=FIX.4.4
9=75
35=A
34=118
SENDER1
52=20240101-10:10:00.001
TARGET1
98=0
108=60
10=178