Merge remote-tracking branch 'origin/master' into feature/668/add-systemwide-config

tests/examples/test.demo.foo.suffix

@@ -0,0 +1 @@
+{"test": "value"}

tests/examples/test.demo.suffix

@@ -0,0 +1 @@
+{"test": "value"}

tests/scripts/license-checks.sh

@@ -18,7 +18,7 @@ gpl_occurances=$(git grep --recurse-submodules "${gpl_term}" -- "${gpl_excludes[
 if [ -z "${gpl_occurances}" ]; then
     echo "PASS: No files under GPL were found"
 else
-    echo "FAIL: GPL:ed code is not compatible with bat, but occurances of '${gpl_term}' were found:"
+    echo "FAIL: GPL:ed code is not compatible with bat, but occurrences of '${gpl_term}' were found:"
     echo "${gpl_occurances}"
     exit 1
 fi

tests/snapshot_tests.rs

@@ -1,13 +1,13 @@
+#[cfg(feature = "git")]
 mod tester;
 
-use crate::tester::BatTester;
-
 macro_rules! snapshot_tests {
     ($($test_name: ident: $style: expr,)*) => {
         $(
             #[test]
+            #[cfg(feature = "git")]
             fn $test_name() {
-                let bat_tester = BatTester::default();
+                let bat_tester = tester::BatTester::default();
                 bat_tester.test_snapshot(stringify!($test_name), $style);
             }
         )*

tests/syntax-tests/highlighted/Fstab/fstab

@@ -3,5 +3,6 @@
 
 # <file system> <dir> <type> <options> <dump> <pass>
 
-UUID=9e6faddf-31ab-3f3e-9b50-2ad4fbc2ea8b	/         	ext4      	rw,relatime,data=ordered	0 1
-UUID=62F8-2047      	/boot     	vfat      	rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,errors=remount-ro	0 2
+UUID=9e6faddf-31ab-3f3e-9b50-2ad4fbc2ea8b	/         	ext4      	rw,relatime,data=ordered	0 0
+UUID=9e6faddf-31ab-3f3e-9b50-2ad4fbc2ea8b	/         	ext4      	rw,relatime,data=ordered	1 1
+UUID=62F8-2047      	/boot     	vfat      	rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,errors=remount-ro	2 2

tests/syntax-tests/highlighted/INI/test.inf

@@ -0,0 +1,5 @@
+[section]
+key=value
+# This file is just for testing that the INI syntax is registered to handle
+# the .inf file extension, it is not testing the syntax highlighting capabilities
+# of the INI syntax itself

tests/syntax-tests/highlighted/Log/example.log

@@ -1,2 +1,3 @@
 2021-03-06 23:22:21.392 https://[2001:db8:4006:812::200e]:8080/path/the%20page.html
 2021-03-06 23:22:21 https://example.com:8080/path/the%20page(with_parens).html
+2022-03-16T17:41:02.519 helix_term::application [WARN] unhandled window/showMessage: ShowMessageParams { typ: Error, message: "rust-analyzer failed to load workspace: Failed to read Cargo metadata from Cargo.toml file /home/zeta/dev/raytracer/Cargo.toml, cargo 1.61.0-nightly (65c8266 2022-03-09): Failed to run `\"cargo\" \"metadata\" \"--format-version\" \"1\" \"--manifest-path\" \"/home/zeta/dev/raytracer/Cargo.toml\" \"--filter-platform\" \"wasm32-unknown-unknown\"`: `cargo metadata` exited with an error:     Updating crates.io index\nerror: failed to select a version for `parking_lot`.\n    ... required by package `raytracer v0.1.0 (/home/zeta/dev/raytracer)`\nversions that meet the requirements `^0.12.0` are: 0.12.0\n\nthe package `raytracer` depends on `parking_lot`, with features: `wasm-bindgen` but `parking_lot` does not have these features.\n\n\nfailed to select a version for `parking_lot` which could resolve this conflict\n" }

tests/syntax-tests/highlighted/NSE/test.nse

@@ -0,0 +1,34 @@
+--- Finds factorial of a number.
+-- @param value Number to find factorial.
+-- @return Factorial of number.
+local function factorial(value)
+    if value <= 1 then
+        return 1
+    else
+        return value * factorial(value - 1)
+    end
+end
+
+--- Joins a table of strings into a new string.
+-- @param table Table of strings.
+-- @param separator Separator character.
+-- @return Joined string.
+local function join(table, separator)
+    local data = ""
+    
+    for index, value in ipairs(table) do
+        data = data .. value .. separator
+    end
+    
+    data = data:sub(1, data:len() - 1)
+    
+    return data
+end
+
+local a = factorial(5)
+
+print(a)
+
+local b = join({ "l", "u", "a" }, ",")
+
+print(b)

tests/syntax-tests/highlighted/Svelte/App.svelte

@@ -27,9 +27,13 @@
 </script>
 
 <script type="text/livescript">
-    // This block is a regression test for a bat panic when a LiveScript syntax definition is missing
+	// This block is a regression test for a bat panic when a LiveScript syntax definition is missing
 </script>
 
+<style lang="text/postcss">
+	/* This block is a regression test for a bat panic when a PostCSS syntax definition is missing */
+</style>
+
 <style>
 	main {
 		position: relative;

tests/syntax-tests/highlighted/Syslog/example.syslog

@@ -1,7 +1,7 @@
 Apr  4 00:00:01 hostname-here systemd[1]: logrotate.service: Succeeded.
 Apr  4 00:00:01 hostname-here systemd[1]: Finished Rotate log files.
 Apr  4 00:00:01 hostname-here colord[920]: failed to get session [pid 137485]: No data available
-Apr  4 00:00:21 hostname-here kernel: [55604.908232] audit: type=1400 audit(1617483621.094:28): apparmor="DENIED" operation="capable" profile="/usr/sbin/cups-browsed" pid=59311 comm="cups-browsed" capability=23  capname="sys_nice"
+Apr  4 00:00:21 hostname-here kernel: [55604.908232] audit: type=1400 audit(1617483621.094:28): apparmor="DENIED" operation="capable" profile="/usr/sbin/cups-browsed" pid=59311 comm="cups-browsed" capability=23  capname="sys_nice"
 Apr  4 00:01:38 hostname-here systemd-resolved[721]: Server returned error NXDOMAIN, mitigating potential DNS violation DVE-2018-0001, retrying transaction with reduced feature level UDP.
 Apr  4 00:04:46 hostname-here ntpd[952]: Soliciting pool server 255.76.59.37
 Apr  4 00:05:21 hostname-here ntpd[952]: ::1 local addr 0:0:0:0:0:0:0:1 -> <null>
@@ -10,7 +10,7 @@
 Apr  4 16:32:07 hostname-here NetworkManager[740]: <info>  [1617629527.1101] manager: NetworkManager state is now CONNECTED_GLOBAL
 Apr  4 22:00:45 hostname-here dbus-daemon[1094]: [session uid=1000 pid=1094] Successfully activated service 'io.github.celluloid_player.Celluloid'
 Aug 11 13:29:06 hostname-here insomnia_insomnia.desktop[142666]: 13:29:06.316 › [updater] Updater not running platform=linux dev=false
-Aug 11 13:36:34 192.168.220.5 nginx: 2021/08/11 13:36:34 [debug] 2031#2031: epoll add event: fd:6 op:1 ev:00002001
-Aug 11 21:31:08 ::1 nginx: 2021/08/11 21:31:08 [debug] 760831#760831: epoll add event: fd:6 op:1 ev:10000001
+Aug 11 13:36:34 192.168.220.5 nginx: 2021/08/11 13:36:34 [debug] 2031#2031: epoll add event: fd:6 op:1 ev:00002001
+Aug 11 21:31:08 ::1 nginx: 2021/08/11 21:31:08 [debug] 760831#760831: epoll add event: fd:6 op:1 ev:10000001
 Aug 11 21:40:31 hostname-here scop hello
 Aug 16 21:38:21 hostname-here systemd[1]: Finished Cleanup of Temporary Directories.

tests/syntax-tests/highlighted/Vue/example.vue

@@ -8,6 +8,11 @@
   </div>
 </template>
 
+<template lang='pug'>
+  #container.col
+    p This shall be formatted as Plain Text as long as a Pug syntax definition is missing
+</template>
+
 <script>
 import AppHeader from "@/components/AppHeader";
 import AppLoadingIndicator from "@/components/AppLoadingIndicator";

tests/syntax-tests/highlighted/Zig/example.zig

@@ -1,18 +1,18 @@
 //! this is a top level doc, starts with "//!"
 
-const std = @import("std");
+const std = @import("std");
 
 pub fn main() anyerror!void {
-    const stdout = std.io.getStdOut().writer();
-    try stdout.print("Hello, {}!\n", .{"world"});
+    const stdout = std.io.getStdOut().writer();
+    try stdout.print("Hello, {}!\n", .{"world"});
 }
 
-const expect = std.testing.expect;
+const expect = std.testing.expect;
 
 test "comments" {
     // comments start with "//" until newline
     // foo bar baz
-    const x = true; // another comment
+    const x = true; // another comment
     expect(x);
 }
 
@@ -25,26 +25,26 @@
     /// number of nanoseconds past the second
     nano: u32,
 
-    const Self = @This();
+    const Self = @This();
 
     pub fn unixEpoch() Self {
         return Self{
-            .seconds = 0,
-            .nanos = 0,
+            .seconds = 0,
+            .nanos = 0,
         };
     }
 };
 
-const my_val = switch (std.Target.current.os.tag) {
-    .linux => "Linux",
+const my_val = switch (std.Target.current.os.tag) {
+    .linux => "Linux",
     else => "not Linux",
 };
 
 const Book = enum {
-    paperback,
-    hardcover,
-    ebook,
-    pdf,
+    paperback,
+    hardcover,
+    ebook,
+    pdf,
 };
 
 const TokenType = union(enum) {
@@ -54,54 +54,54 @@
 };
 
 const array_lit: [4]u8 = .{ 11, 22, 33, 44 };
-const sentinal_lit = [_:0]u8{ 1, 2, 3, 4 };
+const sentinal_lit = [_:0]u8{ 1, 2, 3, 4 };
 
 test "address of syntax" {
     // Get the address of a variable:
     const x: i32 = 1234;
-    const x_ptr = &x;
+    const x_ptr = &x;
 
     // Dereference a pointer:
     expect(x_ptr.* == 1234);
 
     // When you get the address of a const variable, you get a const pointer to a single item.
-    expect(@TypeOf(x_ptr) == *const i32);
+    expect(@TypeOf(x_ptr) == *const i32);
 
     // If you want to mutate the value, you'd need an address of a mutable variable:
     var y: i32 = 5678;
-    const y_ptr = &y;
-    expect(@TypeOf(y_ptr) == *i32);
-    y_ptr.* += 1;
+    const y_ptr = &y;
+    expect(@TypeOf(y_ptr) == *i32);
+    y_ptr.* += 1;
     expect(y_ptr.* == 5679);
 }
 
 // integer literals
-const decimal_int = 98222;
-const hex_int = 0xff;
-const another_hex_int = 0xFF;
-const octal_int = 0o755;
-const binary_int = 0b11110000;
+const decimal_int = 98222;
+const hex_int = 0xff;
+const another_hex_int = 0xFF;
+const octal_int = 0o755;
+const binary_int = 0b11110000;
 
 // underscores may be placed between two digits as a visual separator
-const one_billion = 1_000_000_000;
-const binary_mask = 0b1_1111_1111;
-const permissions = 0o7_5_5;
-const big_address = 0xFF80_0000_0000_0000;
+const one_billion = 1_000_000_000;
+const binary_mask = 0b1_1111_1111;
+const permissions = 0o7_5_5;
+const big_address = 0xFF80_0000_0000_0000;
 
 // float literals
-const floating_point = 123.0E+77;
-const another_float = 123.0;
-const yet_another = 123.0e+77;
+const floating_point = 123.0E+77;
+const another_float = 123.0;
+const yet_another = 123.0e+77;
 
-const hex_floating_point = 0x103.70p-5;
-const another_hex_float = 0x103.70;
-const yet_another_hex_float = 0x103.70P-5;
+const hex_floating_point = 0x103.70p-5;
+const another_hex_float = 0x103.70;
+const yet_another_hex_float = 0x103.70P-5;
 
 // underscores may be placed between two digits as a visual separator
-const lightspeed = 299_792_458.000_000;
-const nanosecond = 0.000_000_001;
-const more_hex = 0x1234_5678.9ABC_CDEFp-10;
+const lightspeed = 299_792_458.000_000;
+const nanosecond = 0.000_000_001;
+const more_hex = 0x1234_5678.9ABC_CDEFp-10;
 
 fn max(comptime T: type, a: T, b: T) T {
-    return if (a > b) a else b;
+    return if (a > b) a else b;
 }

tests/syntax-tests/highlighted/cmd-help/test.cmd-help

@@ -0,0 +1,54 @@
+bat 0.20.0 (e735562-modified)
+A cat(1) clone with syntax highlighting and Git integration.
+
+USAGE:
+    bat [OPTIONS] [FILE]...
+    bat <SUBCOMMAND>
+
+OPTIONS:
+    -A, --show-all
+            Show non-printable characters (space, tab, newline, ..).
+
+    -p, --plain                          Show plain style (alias for '--style=plain').
+    -l, --language <language>            Set the language for syntax highlighting.
+    -H, --highlight-line <N:M>...        Highlight lines N through M.
+        --file-name <name>...            Specify the name to display for a file.
+    -d, --diff
+            Only show lines that have been added/removed/modified.
+
+        --tabs <T>                       Set the tab width to T spaces.
+        --wrap <mode>
+            Specify the text-wrapping mode (*auto*, never, character).
+
+    -n, --number
+            Show line numbers (alias for '--style=numbers').
+
+        --color <when>                   When to use colors (*auto*, never, always).
+        --italic-text <when>             Use italics in output (always, *never*)
+        --decorations <when>
+            When to show the decorations (*auto*, never, always).
+
+        --paging <when>
+            Specify when to use the pager, or use `-P` to disable (*auto*, never,
+            always).
+    -m, --map-syntax <glob:syntax>...
+            Use the specified syntax for files matching the glob pattern
+            ('*.cpp:C++').
+        --theme <theme>                  Set the color theme for syntax highlighting.
+        --list-themes                    Display all supported highlighting themes.
+        --style <components>
+            Comma-separated list of style elements to display (*auto*, full, plain,
+            changes, header, grid, rule, numbers, snip).
+    -r, --line-range <N:M>...            Only print the lines from N to M.
+    -L, --list-languages                 Display all supported languages.
+    -h, --help                           Print this help message.
+    -V, --version                        Show version information.
+
+ARGS:
+    <FILE>...    File(s) to print / concatenate. Use '-' for standard input.
+
+SUBCOMMANDS:
+    cache    Modify the syntax-definition and theme cache
+
+Note: `bat -h` prints a short and concise overview while `bat --help` gives all
+details.

tests/syntax-tests/source/Fstab/fstab

@@ -3,5 +3,6 @@
 
 # <file system> <dir> <type> <options> <dump> <pass>
 
-UUID=9e6faddf-31ab-3f3e-9b50-2ad4fbc2ea8b	/         	ext4      	rw,relatime,data=ordered	0 1
-UUID=62F8-2047      	/boot     	vfat      	rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,errors=remount-ro	0 2
+UUID=9e6faddf-31ab-3f3e-9b50-2ad4fbc2ea8b	/         	ext4      	rw,relatime,data=ordered	0 0
+UUID=9e6faddf-31ab-3f3e-9b50-2ad4fbc2ea8b	/         	ext4      	rw,relatime,data=ordered	1 1
+UUID=62F8-2047      	/boot     	vfat      	rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,errors=remount-ro	2 2

tests/syntax-tests/source/INI/test.inf

@@ -0,0 +1,5 @@
+[section]
+key=value
+# This file is just for testing that the INI syntax is registered to handle
+# the .inf file extension, it is not testing the syntax highlighting capabilities
+# of the INI syntax itself

tests/syntax-tests/source/Log/example.log

@@ -1,2 +1,3 @@
 2021-03-06 23:22:21.392 https://[2001:db8:4006:812::200e]:8080/path/the%20page.html
 2021-03-06 23:22:21 https://example.com:8080/path/the%20page(with_parens).html
+2022-03-16T17:41:02.519 helix_term::application [WARN] unhandled window/showMessage: ShowMessageParams { typ: Error, message: "rust-analyzer failed to load workspace: Failed to read Cargo metadata from Cargo.toml file /home/zeta/dev/raytracer/Cargo.toml, cargo 1.61.0-nightly (65c8266 2022-03-09): Failed to run `\"cargo\" \"metadata\" \"--format-version\" \"1\" \"--manifest-path\" \"/home/zeta/dev/raytracer/Cargo.toml\" \"--filter-platform\" \"wasm32-unknown-unknown\"`: `cargo metadata` exited with an error:     Updating crates.io index\nerror: failed to select a version for `parking_lot`.\n    ... required by package `raytracer v0.1.0 (/home/zeta/dev/raytracer)`\nversions that meet the requirements `^0.12.0` are: 0.12.0\n\nthe package `raytracer` depends on `parking_lot`, with features: `wasm-bindgen` but `parking_lot` does not have these features.\n\n\nfailed to select a version for `parking_lot` which could resolve this conflict\n" }

tests/syntax-tests/source/NSE/test.nse

@@ -0,0 +1,34 @@
+--- Finds factorial of a number.
+-- @param value Number to find factorial.
+-- @return Factorial of number.
+local function factorial(value)
+    if value <= 1 then
+        return 1
+    else
+        return value * factorial(value - 1)
+    end
+end
+
+--- Joins a table of strings into a new string.
+-- @param table Table of strings.
+-- @param separator Separator character.
+-- @return Joined string.
+local function join(table, separator)
+    local data = ""
+    
+    for index, value in ipairs(table) do
+        data = data .. value .. separator
+    end
+    
+    data = data:sub(1, data:len() - 1)
+    
+    return data
+end
+
+local a = factorial(5)
+
+print(a)
+
+local b = join({ "l", "u", "a" }, ",")
+
+print(b)

tests/syntax-tests/source/Svelte/App.svelte

@@ -27,9 +27,13 @@
 </script>
 
 <script type="text/livescript">
-    // This block is a regression test for a bat panic when a LiveScript syntax definition is missing
+	// This block is a regression test for a bat panic when a LiveScript syntax definition is missing
 </script>
 
+<style lang="text/postcss">
+	/* This block is a regression test for a bat panic when a PostCSS syntax definition is missing */
+</style>
+
 <style>
 	main {
 		position: relative;

tests/syntax-tests/source/Vue/example.vue

@@ -8,6 +8,11 @@
   </div>
 </template>
 
+<template lang='pug'>
+  #container.col
+    p This shall be formatted as Plain Text as long as a Pug syntax definition is missing
+</template>
+
 <script>
 import AppHeader from "@/components/AppHeader";
 import AppLoadingIndicator from "@/components/AppLoadingIndicator";

tests/syntax-tests/source/cmd-help/test.cmd-help

@@ -0,0 +1,54 @@
+bat 0.20.0 (e735562-modified)
+A cat(1) clone with syntax highlighting and Git integration.
+
+USAGE:
+    bat [OPTIONS] [FILE]...
+    bat <SUBCOMMAND>
+
+OPTIONS:
+    -A, --show-all
+            Show non-printable characters (space, tab, newline, ..).
+
+    -p, --plain                          Show plain style (alias for '--style=plain').
+    -l, --language <language>            Set the language for syntax highlighting.
+    -H, --highlight-line <N:M>...        Highlight lines N through M.
+        --file-name <name>...            Specify the name to display for a file.
+    -d, --diff
+            Only show lines that have been added/removed/modified.
+
+        --tabs <T>                       Set the tab width to T spaces.
+        --wrap <mode>
+            Specify the text-wrapping mode (*auto*, never, character).
+
+    -n, --number
+            Show line numbers (alias for '--style=numbers').
+
+        --color <when>                   When to use colors (*auto*, never, always).
+        --italic-text <when>             Use italics in output (always, *never*)
+        --decorations <when>
+            When to show the decorations (*auto*, never, always).
+
+        --paging <when>
+            Specify when to use the pager, or use `-P` to disable (*auto*, never,
+            always).
+    -m, --map-syntax <glob:syntax>...
+            Use the specified syntax for files matching the glob pattern
+            ('*.cpp:C++').
+        --theme <theme>                  Set the color theme for syntax highlighting.
+        --list-themes                    Display all supported highlighting themes.
+        --style <components>
+            Comma-separated list of style elements to display (*auto*, full, plain,
+            changes, header, grid, rule, numbers, snip).
+    -r, --line-range <N:M>...            Only print the lines from N to M.
+    -L, --list-languages                 Display all supported languages.
+    -h, --help                           Print this help message.
+    -V, --version                        Show version information.
+
+ARGS:
+    <FILE>...    File(s) to print / concatenate. Use '-' for standard input.
+
+SUBCOMMANDS:
+    cache    Modify the syntax-definition and theme cache
+
+Note: `bat -h` prints a short and concise overview while `bat --help` gives all
+details.

tests/test_pretty_printer.rs

@@ -0,0 +1,16 @@
+use bat::PrettyPrinter;
+
+#[test]
+fn syntaxes() {
+    let printer = PrettyPrinter::new();
+    let syntaxes: Vec<String> = printer.syntaxes().map(|s| s.name).collect();
+
+    // Just do some sanity checking
+    assert!(syntaxes.contains(&"Rust".to_string()));
+    assert!(syntaxes.contains(&"Java".to_string()));
+    assert!(!syntaxes.contains(&"this-language-does-not-exist".to_string()));
+
+    // This language exists but is hidden, so we should not see it; it shall
+    // have been filtered out before getting to us
+    assert!(!syntaxes.contains(&"Git Common".to_string()));
+}