Prepare for v0.20.0 release

Since we have added new enum variants to the `StyleComponent` which was
not previously marked `#[non_exhaustive]`, we must bump left-most
non-zero version number (see
[specifying-dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-cratesio)).
Otherwise client code that do exhaustive matches on `StyleComponent`
will stop compiling.

.gitmodules

@@ -236,3 +236,6 @@
 [submodule "assets/syntaxes/02_Extra/Dart"]
 	path = assets/syntaxes/02_Extra/Dart
 	url = https://github.com/elMuso/Dartlight.git
+[submodule "assets/syntaxes/02_Extra/SublimeJQ"]
+	path = assets/syntaxes/02_Extra/SublimeJQ
+	url = https://github.com/zogwarg/SublimeJQ.git

CHANGELOG.md

@@ -1,12 +1,13 @@
-# unreleased
+# v0.20.0
 
 ## Features
 
 - New style component `header-filesize` to show size of the displayed file in the header. See #1988 (@mdibaiee)
+- Use underline for line highlighting on ANSI, see #1730 (@mdibaiee)
 
 ## Bugfixes
 
-## Other
+- Fix bash completion on bash 3.x and bash-completion 1.x. See #2066 (@joshpencheon)
 
 ## Syntaxes
 
@@ -14,12 +15,14 @@
 - Associate `_vimrc` and `_gvimrc` files with the `VimL` syntax. See #2002
 - Associate `poetry.lock` files with the `TOML` syntax. See #2049
 - Associate `.mesh`, `.task`, `.rgen`, `.rint`, `.rahit`, `.rchit`, `.rmiss`, and `.rcall` with the `GLSL` syntax. See #2050
-
-## Themes
+- Added support for `JQ` syntax, see #2072
+- Properly associate global git config files rooted in `$XDG_CONFIG_HOME/git/` or `$HOME/.config/git/`. See #2067 (@cyqsimon)
 
 ## `bat` as a library
 
 - Exposed `get_syntax_set` and `get_theme` methods on `HighlightingAssets`. See #2030 (@dandavison)
+- Added `HeaderFilename` and `HeaderFilesize` to `StyleComponent` enum, and mark it `#[non_exhaustive]`. See #1988 (@mdibaiee)
+
 
 # v0.19.0
 

CONTRIBUTING.md

@@ -46,3 +46,25 @@ If you really think that a particular syntax or theme should be added for all
 users, please read the corresponding
 [documentation](https://github.com/sharkdp/bat/blob/master/doc/assets.md)
 first.
+
+
+## Regression tests
+
+You are strongly encouraged to add regression tests. Regression tests are great,
+not least because they:
+
+* ensure that your contribution will never completely stop working,
+
+* makes code review easier, because it becomes very clear what the code is
+  supposed to do.
+
+For functional changes, you most likely want to add a test to
+[`tests/integration_tests.rs`](https://github.com/sharkdp/bat/blob/master/tests/integration_tests.rs).
+Look at existing tests to know how to write a new test. In short, you will
+invoke the `bat` binary with a certain set of arguments, and then assert on
+stdout/stderr.
+
+To learn how to write regression tests for theme and syntax changes, read the
+[Syntax
+tests](https://github.com/sharkdp/bat/blob/master/doc/assets.md#syntax-tests)
+section in `assets.md`.

Cargo.lock

@@ -74,7 +74,7 @@ checksum = "904dfeac50f3cdaba28fc6f57fdcddb75f49ed61346676a78c4ffe55877802fd"
 
 [[package]]
 name = "bat"
-version = "0.19.0"
+version = "0.20.0"
 dependencies = [
  "ansi_colours",
  "ansi_term",

Cargo.toml

@@ -6,7 +6,7 @@ homepage = "https://github.com/sharkdp/bat"
 license = "MIT/Apache-2.0"
 name = "bat"
 repository = "https://github.com/sharkdp/bat"
-version = "0.19.0"
+version = "0.20.0"
 exclude = ["assets/syntaxes/*", "assets/themes/*"]
 build = "build.rs"
 edition = '2018'

README.md

@@ -19,6 +19,19 @@
   [<a href="doc/README-ru.md">Русский</a>]
 </p>
 
+### Sponsors
+
+A special *thank you* goes to our biggest <a href="doc/sponsors.md">sponsors</a>:<br>
+<a href="https://workos.com/?utm_campaign=github_repo&utm_medium=referral&utm_content=bat&utm_source=github">
+  <img src="doc/sponsors/workos-logo-white-bg.svg" width="200" alt="WorkOS">
+  <br>
+  <strong>Your app, enterprise-ready.</strong>
+  <br>
+  <sub>Start selling to enterprise customers with just a few lines of code.</sub>
+  <br>
+  <sup>Add Single Sign-On (and more) in minutes instead of months.</sup>
+</a>
+
 ### Syntax highlighting
 
 `bat` supports syntax highlighting for a large number of programming and markup

assets/completions/_bat.ps1.in

@@ -37,7 +37,7 @@ Register-ArgumentCompleter -Native -CommandName '{{PROJECT_EXECUTABLE}}' -Script
             [CompletionResult]::new('-m', 'm', [CompletionResultType]::ParameterName, 'Use the specified syntax for files matching the glob pattern (''*.cpp:C++'').')
             [CompletionResult]::new('--map-syntax', 'map-syntax', [CompletionResultType]::ParameterName, 'Use the specified syntax for files matching the glob pattern (''*.cpp:C++'').')
             [CompletionResult]::new('--theme', 'theme', [CompletionResultType]::ParameterName, 'Set the color theme for syntax highlighting.')
-            [CompletionResult]::new('--style', 'style', [CompletionResultType]::ParameterName, 'Comma-separated list of style elements to display (*auto*, full, plain, changes, header, grid, rule, numbers, snip).')
+            [CompletionResult]::new('--style', 'style', [CompletionResultType]::ParameterName, 'Comma-separated list of style elements to display (*auto*, full, plain, changes, header, header-filename, header-filesize, grid, rule, numbers, snip).')
             [CompletionResult]::new('-r', 'r', [CompletionResultType]::ParameterName, 'Only print the lines from N to M.')
             [CompletionResult]::new('--line-range', 'line-range', [CompletionResultType]::ParameterName, 'Only print the lines from N to M.')
             [CompletionResult]::new('-A', 'A', [CompletionResultType]::ParameterName, 'Show non-printable characters (space, tab, newline, ..).')

assets/completions/bat.bash.in

@@ -2,9 +2,22 @@
 
 # Requires https://github.com/scop/bash-completion
 
+# Macs have bash3 for which the bash-completion package doesn't include
+# _init_completion. This is a minimal version of that function.
+__bat_init_completion()
+{
+	COMPREPLY=()
+	_get_comp_words_by_ref "$@" cur prev words cword
+}
+
 _bat() {
-	local cur prev words cword split
-	_init_completion -s || return 0
+	local cur prev words cword split=false
+	if declare -F _init_completion >/dev/null 2>&1; then
+		_init_completion -s || return 0
+	else
+		__bat_init_completion -n "=" || return 0
+		_split_longopt && split=true
+	fi
 
 	if [[ ${words[1]-} == cache ]]; then
 		case $prev in

assets/completions/bat.fish.in

@@ -56,7 +56,7 @@ complete -c {{PROJECT_EXECUTABLE}} -s P -d "Disable paging. Alias for '--paging=
 
 complete -c {{PROJECT_EXECUTABLE}} -s A -l show-all -d "Show non-printable characters like space/tab/newline" -n "not __fish_seen_subcommand_from cache"
 
-complete -c {{PROJECT_EXECUTABLE}} -l style -xka "auto full plain changes header grid rule numbers snip" -d "Comma-separated list of style elements or presets to display with file contents" -n "not __fish_seen_subcommand_from cache"
+complete -c {{PROJECT_EXECUTABLE}} -l style -xka "auto full plain changes header header-filename header-filesize grid rule numbers snip" -d "Comma-separated list of style elements or presets to display with file contents" -n "not __fish_seen_subcommand_from cache"
 
 complete -c {{PROJECT_EXECUTABLE}} -l tabs -x -d "<T> Set the tab width to T spaces (width of 0 passes tabs through directly)" -n "not __fish_seen_subcommand_from cache"
 

assets/completions/bat.zsh.in

@@ -75,7 +75,7 @@ _{{PROJECT_EXECUTABLE}}_main() {
         ;;
 
         style)
-            _values -s , 'style' auto full plain changes header grid rule numbers snip
+            _values -s , 'style' auto full plain changes header header-filename header-filesize grid rule numbers snip
         ;;
     esac
 }

assets/manual/bat.1.in

@@ -146,7 +146,8 @@ Configure which elements (line numbers, file headers, grid borders, Git modifica
 of components to display (e.g. 'numbers,changes,grid') or a pre\-defined style ('full').
 To set a default style, add the '\-\-style=".."' option to the configuration file or
 export the BAT_STYLE environment variable (e.g.: export BAT_STYLE=".."). Possible
-values: *full*, auto, plain, changes, header, grid, rule, numbers, snip.
+values: *full*, auto, plain, changes, header, header-filename, header-filesize, grid,
+rule, numbers, snip.
 .HP
 \fB\-r\fR, \fB\-\-line\-range\fR <N:M>...
 .IP

doc/README-ja.md

@@ -181,7 +181,7 @@ man 2 select
 
 ## インストール
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/bat.svg)](https://repology.org/project/bat/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/bat-cat.svg)](https://repology.org/project/bat-cat/versions)
 
 ###  On Ubuntu (`apt` を使用)
 *... や他のDebianベースのLinuxディストリビューション*

doc/README-ru.md

@@ -160,7 +160,7 @@ man 2 select
 
 ## Установка
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/bat.svg)](https://repology.org/project/bat/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/bat-cat.svg)](https://repology.org/project/bat-cat/versions)
 
 ### Ubuntu (с помощью `apt`)
 *... и другие дистрибутивы основанные на Debian.*

doc/release-checklist.md

@@ -1,16 +1,5 @@
 # Release checklist
 
-## Dependencies
-
-See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
-
-- [ ] Optional: update dependencies with `cargo update`. This is also done by
-      dependabot, so it is not strictly necessary.
-- [ ] Install [cargo-outdated](https://crates.io/crates/cargo-outdated). Check
-      for outdated dependencies with `cargo outdated --root-deps-only` and
-      decide for each of them whether we want to (manually) upgrade. This will
-      require changes to `Cargo.toml`.
-
 ## Version bump
 
 - [ ] Update version in `Cargo.toml`. Run `cargo build` to update `Cargo.lock`.
@@ -24,7 +13,7 @@ See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
 
 ## Update syntaxes and themes (build assets)
 
-- [ ] Install the latest master version (`cargo install -f --path .`) and make
+- [ ] Install the latest master version (`cargo clean && cargo install -f --path .`) and make
       sure that it is available on the `PATH` (`bat --version` should show the
       new version).
 - [ ] Run `assets/create.sh` and check in the binary asset files.
@@ -32,7 +21,7 @@ See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
 ## Documentation
 
 - [ ] Review the `-h` and `--help` texts
-- [ ] Review the `man` page
+- [ ] Review the `man` page (`man $(fd -HIp target/release/build.*out/assets/manual/bat.1) | tee`)
 
 ## Pre-release checks
 

doc/sponsors.md

@@ -0,0 +1,14 @@
+## Sponsors
+
+`bat` development is sponsored by many individuals and companies. Thank you very much!
+
+Please note, that being sponsored does not affect the individuality of the `bat`
+project or affect the maintainers' actions in any way.
+We remain impartial and continue to assess pull requests solely on merit - the
+features added, bugs solved, and effect on the overall complexity of the code.
+No issue will have a different priority based on sponsorship status of the
+reporter.
+
+Contributions from anybody are most welcomed, please see our [`CONTRIBUTING.md`](../CONTRIBUTING.md) guide.
+
+If you want to see our biggest sponsors, check the top of [`README.md`](../README.md#sponsors).

doc/sponsors/workos-logo-white-bg.svg

@@ -0,0 +1,11 @@
+<svg width="1354" height="420" viewBox="0 0 1354 420" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="1354" height="420" rx="20" fill="white"/>
+<path d="M434.751 133.122H466.637L489.595 227.729C493.852 245.585 494.697 256.219 494.697 256.219H495.128C495.128 256.219 496.61 245.808 500.867 227.729L522.757 133.122H558.9L582.066 227.729C586.53 246.223 587.598 256.219 587.598 256.219H588.236C588.236 256.219 588.666 246.223 592.907 227.729L615.02 133.122H646.907L606.523 288.313H571.017L546.576 194.344C541.474 173.936 541.044 164.801 541.044 164.801H540.614C540.614 164.801 540.183 173.936 535.512 194.344L512.553 288.313H475.996L434.751 133.122Z" fill="black"/>
+<path d="M641.583 231.934C641.583 196.428 664.541 173.47 699.202 173.47C733.639 173.47 756.597 196.428 756.597 231.934C756.597 267.647 733.639 290.828 699.202 290.828C664.557 290.812 641.583 267.647 641.583 231.934ZM726.832 231.934C726.832 208.976 715.783 195.998 699.202 195.998C681.346 195.998 671.349 210.458 671.349 231.934C671.349 255.323 682.398 268.284 699.202 268.284C717.058 268.284 726.832 253.824 726.832 231.934Z" fill="black"/>
+<path d="M770.836 175.21H799.103V196.048H799.741C804.635 185.207 816.322 174.365 836.299 174.365C839.695 174.365 841.831 174.796 843.314 175.21V203.478H842.469C842.469 203.478 839.918 202.633 832.903 202.633C811.013 202.633 799.103 215.594 799.103 239.828V288.295H770.836V175.21Z" fill="black"/>
+<path d="M856.5 133.122H884.767V182.865C884.767 212.2 884.336 217.509 884.336 217.509H884.767L926.857 175.212H962.139L912.843 224.11L970.031 288.313H936.646L895.401 241.536L884.767 251.946V288.297H856.5V133.122Z" fill="black"/>
+<path d="M970.444 211.285C970.444 163.455 1000.21 131.569 1044.85 131.569C1089.49 131.569 1119.26 163.455 1119.26 211.285C1119.26 259.114 1089.49 291.001 1044.85 291.001C1000.21 291.001 970.444 259.114 970.444 211.285ZM1088.42 211.285C1088.42 178.761 1071 156.855 1044.84 156.855C1018.67 156.855 1001.26 178.761 1001.26 211.285C1001.26 243.809 1018.69 265.715 1044.84 265.715C1070.98 265.715 1088.42 243.809 1088.42 211.285Z" fill="black"/>
+<path d="M1130.08 236.656H1162.4C1162.4 254.943 1174.95 265.146 1194.08 265.146C1210.23 265.146 1221.29 257.063 1221.29 245.584C1221.29 232.622 1212.79 229.21 1185.79 223.901C1161.12 219.007 1134.98 210.716 1134.98 178.399C1134.98 151.408 1157.93 131 1193.01 131C1229.57 131 1252.11 150.132 1252.11 179.037H1219.79C1219.79 165.007 1208.95 156.286 1193.01 156.286C1176.86 156.286 1166.86 164.146 1166.86 175.625C1166.86 187.742 1173.88 192.413 1195.56 196.878C1227.65 203.685 1254.02 207.288 1254.02 243.001C1254.02 271.3 1229.36 290.432 1193.01 290.432C1156.02 290.432 1130.08 268.957 1130.08 236.656Z" fill="black"/>
+<path d="M100 210C100 214.824 101.269 219.647 103.723 223.793L148.231 300.878C152.8 308.747 159.739 315.178 168.369 318.055C185.377 323.724 202.977 316.447 211.354 301.893L222.1 283.278L179.708 210L224.47 132.408L235.216 113.792C238.431 108.208 242.747 103.638 247.824 100H243.17H178.777C166.677 100 155.508 106.431 149.5 116.923L103.723 196.208C101.269 200.354 100 205.177 100 210Z" fill="#6363F1"/>
+<path d="M353.847 210C353.847 205.177 352.578 200.353 350.124 196.207L305.024 118.107C296.647 103.638 279.047 96.3608 262.039 101.945C253.409 104.822 246.47 111.253 241.901 119.122L231.747 136.638L274.139 210L229.378 287.592L218.632 306.208C215.416 311.708 211.101 316.362 206.024 320H210.678H275.07C287.17 320 298.34 313.569 304.347 303.077L350.124 223.792C352.578 219.646 353.847 214.823 353.847 210Z" fill="#6363F1"/>
+</svg>

rustfmt.toml

@@ -0,0 +1 @@
+# Defaults are used

src/printer.rs

@@ -463,6 +463,10 @@ impl<'a> Printer for InteractivePrinter<'a> {
         let highlight_this_line =
             self.config.highlighted_lines.0.check(line_number) == RangeCheckResult::InRange;
 
+        if highlight_this_line && self.config.theme == "ansi" {
+            self.ansi_style.update("^[4m");
+        }
+
         let background_color = self
             .background_color_highlight
             .filter(|_| highlight_this_line);
@@ -649,6 +653,11 @@ impl<'a> Printer for InteractivePrinter<'a> {
             writeln!(handle)?;
         }
 
+        if highlight_this_line && self.config.theme == "ansi" {
+            self.ansi_style.update("^[24m");
+            write!(handle, "\x1B[24m")?;
+        }
+
         Ok(())
     }
 }

src/syntax_mapping.rs

@@ -122,8 +122,22 @@ impl<'a> SyntaxMapping<'a> {
             .insert("*.hook", MappingTarget::MapTo("INI"))
             .unwrap();
 
-        if let Some(xdg_config_home) = std::env::var_os("XDG_CONFIG_HOME") {
-            let git_config_path = Path::new(&xdg_config_home).join("git");
+        // Global git config files rooted in `$XDG_CONFIG_HOME/git/` or `$HOME/.config/git/`
+        // See e.g. https://git-scm.com/docs/git-config#FILES
+        if let Some(xdg_config_home) =
+            std::env::var_os("XDG_CONFIG_HOME").filter(|val| !val.is_empty())
+        {
+            insert_git_config_global(&mut mapping, &xdg_config_home);
+        }
+        if let Some(default_config_home) = std::env::var_os("HOME")
+            .filter(|val| !val.is_empty())
+            .map(|home| Path::new(&home).join(".config"))
+        {
+            insert_git_config_global(&mut mapping, &default_config_home);
+        }
+
+        fn insert_git_config_global(mapping: &mut SyntaxMapping, config_home: impl AsRef<Path>) {
+            let git_config_path = config_home.as_ref().join("git");
 
             mapping
                 .insert(

tests/examples/git/.config/git/config

@@ -0,0 +1,3 @@
+[user]
+    email = foo@bar.net
+    name = foobar

tests/examples/git/.gitconfig

@@ -0,0 +1,3 @@
+[user]
+    email = foo@bar.net
+    name = foobar

tests/integration_tests.rs

@@ -1117,7 +1117,9 @@ Single Line
 ────────────────────────────────────────────────────────────────────────────────
 ",
         )
-        .stderr("\x1b[33m[bat warning]\x1b[0m: Style 'rule' is a subset of style 'grid', 'rule' will not be visible.\n");
+        .stderr(
+            "\x1b[33m[bat warning]\x1b[0m: Style 'rule' is a subset of style 'grid', 'rule' will not be visible.\n",
+        );
 }
 
 #[cfg(target_os = "linux")]
@@ -1290,6 +1292,25 @@ fn grid_for_file_without_newline() {
         .stderr("");
 }
 
+// For ANSI theme, use underscore as a highlighter
+#[test]
+fn ansi_highlight_underline() {
+    bat()
+        .arg("--paging=never")
+        .arg("--color=never")
+        .arg("--terminal-width=80")
+        .arg("--wrap=never")
+        .arg("--decorations=always")
+        .arg("--theme=ansi")
+        .arg("--style=plain")
+        .arg("--highlight-line=1")
+        .write_stdin("Ansi Underscore Test\nAnother Line")
+        .assert()
+        .success()
+        .stdout("\x1B[4mAnsi Underscore Test\n\x1B[24mAnother Line")
+        .stderr("");
+}
+
 // Ensure that ANSI passthrough is emitted properly for both wrapping and non-wrapping printer.
 #[test]
 fn ansi_passthrough_emit() {
@@ -1340,6 +1361,45 @@ fn ignored_suffix_arg() {
         .stderr("");
 }
 
+#[test]
+fn all_global_git_config_locations_syntax_mapping_work() {
+    let fake_home = Path::new(EXAMPLES_DIR).join("git").canonicalize().unwrap();
+    let expected = "\u{1b}[38;5;231m[\u{1b}[0m\u{1b}[38;5;149muser\u{1b}[0m\u{1b}[38;5;231m]\u{1b}[0m
+\u{1b}[38;5;231m    \u{1b}[0m\u{1b}[38;5;231memail\u{1b}[0m\u{1b}[38;5;231m \u{1b}[0m\u{1b}[38;5;203m=\u{1b}[0m\u{1b}[38;5;231m \u{1b}[0m\u{1b}[38;5;186mfoo@bar.net\u{1b}[0m
+\u{1b}[38;5;231m    \u{1b}[0m\u{1b}[38;5;231mname\u{1b}[0m\u{1b}[38;5;231m \u{1b}[0m\u{1b}[38;5;203m=\u{1b}[0m\u{1b}[38;5;231m \u{1b}[0m\u{1b}[38;5;186mfoobar\u{1b}[0m
+";
+
+    bat()
+        .env("XDG_CONFIG_HOME", fake_home.join(".config").as_os_str())
+        .arg("-f")
+        .arg("-p")
+        .arg("git/.config/git/config")
+        .assert()
+        .success()
+        .stdout(expected)
+        .stderr("");
+
+    bat()
+        .env("HOME", fake_home.as_os_str())
+        .arg("-f")
+        .arg("-p")
+        .arg("git/.config/git/config")
+        .assert()
+        .success()
+        .stdout(expected)
+        .stderr("");
+
+    bat()
+        .env("HOME", fake_home.as_os_str())
+        .arg("-f")
+        .arg("-p")
+        .arg("git/.gitconfig")
+        .assert()
+        .success()
+        .stdout(expected)
+        .stderr("");
+}
+
 #[test]
 fn acknowledgements() {
     bat()

tests/syntax-tests/highlighted/JQ/sample.jq

@@ -0,0 +1,60 @@
+import "../imported-file" ;
+
+# With Comments !
+def weird($a; $b; $c):
+	[ $a, $b, $c ] | transpose | reduce .[][] as $item (
+		[];
+		. + $item.property
+	)
+;
+
+. | weird (.a; .b; .c) |
+
+(
+
+if (. | contains("never") ) then
+	"Why yes"
+else
+	12.23
+end
+
+) as $never |
+
+{
+	hello,
+	why: "because",
+	hello: ( weird | ascii_upcase ),
+	format_eg: ( . | @json "My json string \( . | this | part | just | white | ascii_upcase | transpose)" ),
+	never: $never,
+	"literal_key": literal_value,
+	"this": 12.1e12,
+	"part": "almost"
+	"like": [
+		12,
+		2
+		"json"
+		{
+			"quite": {
+				similar: "but not quite"
+			}
+		}
+	],
+} | (
+	
+	# And with very basic brace matching
+	
+	# Invalid End
+	]	
+	
+	# Other invalid ends
+	( [ } ] )
+
+	# A "valid" sequence
+	( [  { key: () , other_key:( [ []  [[]] ]  ), gaga }  ] )
+
+	# A "invalid" sequence
+	( [  { key: () , other_key:( [ []  [[] ]  ), gaga }  ] )
+
+	"A string\n whith escaped characters \" because we can"
+)
+

tests/syntax-tests/source/JQ/LICENSE.md

@@ -0,0 +1,25 @@
+The `sample.jq` file was taken from [SublimeJQ] under the following license:
+
+[SublimeJQ]: https://github.com/zogwarg/SublimeJQ
+
+MIT License
+
+Copyright (c) 2017 Thomas Buick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tests/syntax-tests/source/JQ/sample.jq

@@ -0,0 +1,60 @@
+import "../imported-file" ;
+
+# With Comments !
+def weird($a; $b; $c):
+	[ $a, $b, $c ] | transpose | reduce .[][] as $item (
+		[];
+		. + $item.property
+	)
+;
+
+. | weird (.a; .b; .c) |
+
+(
+
+if (. | contains("never") ) then
+	"Why yes"
+else
+	12.23
+end
+
+) as $never |
+
+{
+	hello,
+	why: "because",
+	hello: ( weird | ascii_upcase ),
+	format_eg: ( . | @json "My json string \( . | this | part | just | white | ascii_upcase | transpose)" ),
+	never: $never,
+	"literal_key": literal_value,
+	"this": 12.1e12,
+	"part": "almost"
+	"like": [
+		12,
+		2
+		"json"
+		{
+			"quite": {
+				similar: "but not quite"
+			}
+		}
+	],
+} | (
+	
+	# And with very basic brace matching
+	
+	# Invalid End
+	]	
+	
+	# Other invalid ends
+	( [ } ] )
+
+	# A "valid" sequence
+	( [  { key: () , other_key:( [ []  [[]] ]  ), gaga }  ] )
+
+	# A "invalid" sequence
+	( [  { key: () , other_key:( [ []  [[] ]  ), gaga }  ] )
+
+	"A string\n whith escaped characters \" because we can"
+)
+