MirroredRepos/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-09-04 12:22:28 +01:00
Code Issues Releases Wiki Activity

docs: 📚 update changelog for range context support

Browse Source 
docs(CHANGELOG.md): 📚 add entry for context in line ranges and normalize list formatting
style(src/line_range.rs): 🎨 trim trailing whitespace in context parsing code
This commit is contained in:
John Cavanaugh
2025-07-15 16:25:28 -07:00
parent 6c13a98f01
commit dc2eae08a6
2 changed files with 43 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
CHANGELOG.md
View File

@@ -4,6 +4,7 @@
- Add paging to `--list-themes`, see PR #3239 (@einfachIrgendwer0815) - Add paging to `--list-themes`, see PR #3239 (@einfachIrgendwer0815)
- Support negative relative line ranges, e.g. `bat -r :-10` / `bat -r='-10:'`, see #3068 (@ajesipow) - Support negative relative line ranges, e.g. `bat -r :-10` / `bat -r='-10:'`, see #3068 (@ajesipow)
- Support context in line ranges, e.g. `bat -r 30::5` / `bat -r 30:40:5`, see #3344 (@cavanaug)
## Bugfixes ## Bugfixes
@@ -189,7 +190,6 @@
- Add optional output_buffer arg to `Controller::run()` and `Controller::run_with_error_handler()`, see #2618 (@Piturnah) - Add optional output_buffer arg to `Controller::run()` and `Controller::run_with_error_handler()`, see #2618 (@Piturnah)
# v0.23.0 # v0.23.0
## Features ## Features
@@ -227,7 +227,6 @@
- `PrettyPrinter::header` correctly displays a header with the filename, see #2378 and #2406 (@cstyles) - `PrettyPrinter::header` correctly displays a header with the filename, see #2378 and #2406 (@cstyles)
# v0.22.1 # v0.22.1
## Bugfixes ## Bugfixes
@@ -269,7 +268,6 @@
- Make `bat::PrettyPrinter::syntaxes()` iterate over new `bat::Syntax` struct instead of `&syntect::parsing::SyntaxReference`. See #2222 (@Enselic) - Make `bat::PrettyPrinter::syntaxes()` iterate over new `bat::Syntax` struct instead of `&syntect::parsing::SyntaxReference`. See #2222 (@Enselic)
- Clear highlights after printing, see #1919 and #1920 (@rhysd) - Clear highlights after printing, see #1919 and #1920 (@rhysd)
# v0.21.0 # v0.21.0
## Features ## Features
@@ -310,7 +308,6 @@
- Change `Error::SyntectError(syntect::LoadingError)` to `Error::SyntectError(syntect::Error)`. See #2181 (@Enselic) - Change `Error::SyntectError(syntect::LoadingError)` to `Error::SyntectError(syntect::Error)`. See #2181 (@Enselic)
- Add `Error::SyntectLoadingError(syntect::LoadingError)` enum variant. See #2181 (@Enselic) - Add `Error::SyntectLoadingError(syntect::LoadingError)` enum variant. See #2181 (@Enselic)
# v0.20.0 # v0.20.0
## Features ## Features
@@ -336,7 +333,6 @@
- Exposed `get_syntax_set` and `get_theme` methods on `HighlightingAssets`. See #2030 (@dandavison) - 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) - Added `HeaderFilename` and `HeaderFilesize` to `StyleComponent` enum, and mark it `#[non_exhaustive]`. See #1988 (@mdibaiee)
# v0.19.0 # v0.19.0
## Performance ## Performance
@@ -391,14 +387,12 @@
- Replace the `error::Error(error::ErrorKind, _)` struct and enum with an `error::Error` enum. `Error(ErrorKind::UnknownSyntax, _)` becomes `Error::UnknownSyntax`, etc. Also remove the `error::ResultExt` trait. These changes stem from replacing `error-chain` with `thiserror`. See #1820 (@Enselic) - Replace the `error::Error(error::ErrorKind, _)` struct and enum with an `error::Error` enum. `Error(ErrorKind::UnknownSyntax, _)` becomes `Error::UnknownSyntax`, etc. Also remove the `error::ResultExt` trait. These changes stem from replacing `error-chain` with `thiserror`. See #1820 (@Enselic)
- Add new `MappingTarget` enum variant `MapExtensionToUnknown`. Refer to its documentation for more information. Also mark `MappingTarget` as `#[non_exhaustive]` since more enum variants might be added in the future. See #1703 (@cbolgiano), #2012 (@Enselic) - Add new `MappingTarget` enum variant `MapExtensionToUnknown`. Refer to its documentation for more information. Also mark `MappingTarget` as `#[non_exhaustive]` since more enum variants might be added in the future. See #1703 (@cbolgiano), #2012 (@Enselic)
# v0.18.3 # v0.18.3
## Bugfixes ## Bugfixes
- Bump `git2` dependency to fix build with Rust 1.54, see #1761 - Bump `git2` dependency to fix build with Rust 1.54, see #1761
# v0.18.2 # v0.18.2
## Features ## Features
@@ -422,7 +416,6 @@
- Added support for `XAML` syntax, see #1590 and #1655 (@mohamed-abdelnour) - Added support for `XAML` syntax, see #1590 and #1655 (@mohamed-abdelnour)
- Apply `DotENV` syntax also for `.env.default` and `.env.defaults` files, see #1669 - Apply `DotENV` syntax also for `.env.default` and `.env.defaults` files, see #1669
# v0.18.1 # v0.18.1
## Bugfixes ## Bugfixes
@@ -446,8 +439,6 @@
- Dark+ VS Code theme, see #1588 and #1598 (@PatriotRossii) - Dark+ VS Code theme, see #1588 and #1598 (@PatriotRossii)
# v0.18.0 # v0.18.0
## Features ## Features
@@ -490,11 +481,10 @@
## `bat` as a library ## `bat` as a library
- The following `PrettyPrinter` methods have been removed (they were previously deprecated): - The following `PrettyPrinter` methods have been removed (they were previously deprecated):
- `input_stdin_with_name` - `input_stdin_with_name`
- `input_from_bytes_with_name` - `input_from_bytes_with_name`
- `input_from_reader_with_name` - `input_from_reader_with_name`
- `vcs_modification_markers` (if the `git` feature is not enabled) - `vcs_modification_markers` (if the `git` feature is not enabled)
# v0.17.1 # v0.17.1
@@ -502,7 +492,6 @@
- Running `bat` without arguments fails ("output file is also an input"), see #1396 - Running `bat` without arguments fails ("output file is also an input"), see #1396
# v0.17.0 # v0.17.0
## Features ## Features
@@ -531,7 +520,6 @@
- Coldark, see #1329 (@armandphilippot) - Coldark, see #1329 (@armandphilippot)
# v0.16.0 # v0.16.0
## Features ## Features
@@ -696,10 +684,12 @@
This introduces a `features = ["application"]` which is enabled by default and pulls in This introduces a `features = ["application"]` which is enabled by default and pulls in
everything required by `bat` the application. When depending on bat as a library, downstream everything required by `bat` the application. When depending on bat as a library, downstream
`Cargo.toml` should disable this feature to cut out inapplicable heavy dependencies: `Cargo.toml` should disable this feature to cut out inapplicable heavy dependencies:
``` toml ``` toml
[dependencies] [dependencies]
bat = { version = "0.14", default-features = false } bat = { version = "0.14", default-features = false }
``` ```
Other optional functionality has also been put behind features: `paging` and `git` support. Other optional functionality has also been put behind features: `paging` and `git` support.
- Allow using the library with older syntect, see #896 and #898 (@dtolnay) - Allow using the library with older syntect, see #896 and #898 (@dtolnay)
@@ -708,7 +698,6 @@
- Rego, see #872 (@patrick-east) - Rego, see #872 (@patrick-east)
- Stylo, see #917 - Stylo, see #917
# v0.13.0 # v0.13.0
## `bat` as a library ## `bat` as a library
@@ -725,7 +714,7 @@ I want to stress that this is the very first release of the library. Things are
That being said, you can start using it! See the example programs in [`examples/`](https://github.com/sharkdp/bat/tree/master/examples). That being said, you can start using it! See the example programs in [`examples/`](https://github.com/sharkdp/bat/tree/master/examples).
You can see the API documentation here: https://docs.rs/bat/ You can see the API documentation here: <https://docs.rs/bat/>
## Features ## Features
@@ -734,6 +723,7 @@ You can see the API documentation here: https://docs.rs/bat/
present. present.
The option now works like this: The option now works like this:
```bash ```bash
--map-syntax <glob-pattern>:<syntax-name> --map-syntax <glob-pattern>:<syntax-name>
``` ```
@@ -741,8 +731,8 @@ You can see the API documentation here: https://docs.rs/bat/
For more information, see the `--help` text, the man page or the README. For more information, see the `--help` text, the man page or the README.
This new feature allows us to properly highlight files like: This new feature allows us to properly highlight files like:
* `/etc/profile` - `/etc/profile`
* `~/.ssh/config` - `~/.ssh/config`
- `--highlight-line` now accepts line ranges, see #809 (@lkalir) - `--highlight-line` now accepts line ranges, see #809 (@lkalir)
- Proper wrapping support for output with wide Unicode characters, see #811 #787 and #815 (@Kogia-sima) - Proper wrapping support for output with wide Unicode characters, see #811 #787 and #815 (@Kogia-sima)
@@ -1138,13 +1128,13 @@ You can see the API documentation here: https://docs.rs/bat/
## Bugfixes ## Bugfixes
* Using `bat cache --init` leads to duplicated syntaxes, see #206 - Using `bat cache --init` leads to duplicated syntaxes, see #206
## Other ## Other
* Extended and cleaned-up `--help` text. - Extended and cleaned-up `--help` text.
* Added initial version of a man page, see #52 - Added initial version of a man page, see #52
* New README sections: *Development* and *Troubleshooting*, see #220 - New README sections: *Development* and *Troubleshooting*, see #220
# v0.5.0 # v0.5.0
@@ -1185,23 +1175,23 @@ You can see the API documentation here: https://docs.rs/bat/
## Features ## Features
* Support for line-wrapping, see #54 and #102 (@eth-p) - Support for line-wrapping, see #54 and #102 (@eth-p)
* New and updated `--style` parameter, see #74 and README (@pitkley) - New and updated `--style` parameter, see #74 and README (@pitkley)
* Added `--theme` and `--list-themes` options, see #89 (@rleungx) - Added `--theme` and `--list-themes` options, see #89 (@rleungx)
* Added syntax highlighting for: Julia (@iamed2), Dockerfiles, VimL, CMake, INI, Less - Added syntax highlighting for: Julia (@iamed2), Dockerfiles, VimL, CMake, INI, Less
* Added a few popular Sublime Text highlighting themes, see #133 - Added a few popular Sublime Text highlighting themes, see #133
* Support for bold, italic and underline font styles, see #96 - Support for bold, italic and underline font styles, see #96
* Support for 32bit systems is now available, see #84 - Support for 32bit systems is now available, see #84
* Added `-u` and `-n` options, see #134 - Added `-u` and `-n` options, see #134
* ANSI color support on Windows 10 - ANSI color support on Windows 10
## Changes ## Changes
* The customization folder for own syntaxes has been renamed from `syntax` to `syntaxes`, see README. - The customization folder for own syntaxes has been renamed from `syntax` to `syntaxes`, see README.
* Changed Markdown syntax to the default Sublime Text syntax, see #157 - Changed Markdown syntax to the default Sublime Text syntax, see #157
* Sorted language listing (@rleungx) - Sorted language listing (@rleungx)
* Command line arguments like `--theme` or `--color` can now override themselves. - Command line arguments like `--theme` or `--color` can now override themselves.
* Improved `--help` text. - Improved `--help` text.
## Bugfixes ## Bugfixes
@@ -1223,24 +1213,24 @@ You can see the API documentation here: https://docs.rs/bat/
## Features ## Features
* Automatic paging by integrating with `less`, see #29 (@BrainMaestro) - Automatic paging by integrating with `less`, see #29 (@BrainMaestro)
* Added support for reading from standard input, see #2 - Added support for reading from standard input, see #2
* Added support for writing to non-interactive terminals (pipes, files, ..); new - Added support for writing to non-interactive terminals (pipes, files, ..); new
`--color=auto/always/never` option, see #26 (@BrainMaestro) `--color=auto/always/never` option, see #26 (@BrainMaestro)
* Added `--list-languages` option to print all available syntaxes, see #69 (@connorkuehl) - Added `--list-languages` option to print all available syntaxes, see #69 (@connorkuehl)
* New option to specify the syntax via `-l`/`--language`, see #19 (@BrainMaestro) - New option to specify the syntax via `-l`/`--language`, see #19 (@BrainMaestro)
* New option to control the output style (`--style`), see #5 (@nakulcg) - New option to control the output style (`--style`), see #5 (@nakulcg)
* Added syntax highlighting support for TOML files, see #37 - Added syntax highlighting support for TOML files, see #37
## Changes ## Changes
* The `init-cache` sub-command has been removed. The cache can now be controlled via - The `init-cache` sub-command has been removed. The cache can now be controlled via
`bat cache`. See `bat cache -h` for all available commands. `bat cache`. See `bat cache -h` for all available commands.
## Bug fixes ## Bug fixes
* Get git repository from file path instead of current directory, see #22 (@nakulcg) - Get git repository from file path instead of current directory, see #22 (@nakulcg)
* Process substitution can now be used with bat (`bat <(echo a) <(echo b)`), see #80 - Process substitution can now be used with bat (`bat <(echo a) <(echo b)`), see #80
## Thanks ## Thanks

8
src/line_range.rs
View File

@@ -106,7 +106,7 @@ impl LineRange {
.map_err(|_| "Invalid line number in N::C format")?; .map_err(|_| "Invalid line number in N::C format")?;
let context: usize = line_numbers[2].parse() let context: usize = line_numbers[2].parse()
.map_err(|_| "Invalid context number in N::C format")?; .map_err(|_| "Invalid context number in N::C format")?;
new_range.lower = RangeBound::Absolute(line_number.saturating_sub(context)); new_range.lower = RangeBound::Absolute(line_number.saturating_sub(context));
new_range.upper = RangeBound::Absolute(line_number.saturating_add(context)); new_range.upper = RangeBound::Absolute(line_number.saturating_add(context));
} else { } else {
@@ -117,7 +117,7 @@ impl LineRange {
.map_err(|_| "Invalid end line number in N:M:C format")?; .map_err(|_| "Invalid end line number in N:M:C format")?;
let context: usize = line_numbers[2].parse() let context: usize = line_numbers[2].parse()
.map_err(|_| "Invalid context number in N:M:C format")?; .map_err(|_| "Invalid context number in N:M:C format")?;
new_range.lower = RangeBound::Absolute(start_line.saturating_sub(context)); new_range.lower = RangeBound::Absolute(start_line.saturating_sub(context));
new_range.upper = RangeBound::Absolute(end_line.saturating_add(context)); new_range.upper = RangeBound::Absolute(end_line.saturating_add(context));
} }
@@ -319,12 +319,12 @@ fn test_parse_context_edge_cases() {
let range = LineRange::from("5::10").expect("Shouldn't fail on test!"); let range = LineRange::from("5::10").expect("Shouldn't fail on test!");
assert_eq!(RangeBound::Absolute(0), range.lower); assert_eq!(RangeBound::Absolute(0), range.lower);
assert_eq!(RangeBound::Absolute(15), range.upper); assert_eq!(RangeBound::Absolute(15), range.upper);
// Test with zero context // Test with zero context
let range = LineRange::from("50::0").expect("Shouldn't fail on test!"); let range = LineRange::from("50::0").expect("Shouldn't fail on test!");
assert_eq!(RangeBound::Absolute(50), range.lower); assert_eq!(RangeBound::Absolute(50), range.lower);
assert_eq!(RangeBound::Absolute(50), range.upper); assert_eq!(RangeBound::Absolute(50), range.upper);
// Test range with zero context // Test range with zero context
let range = LineRange::from("30:40:0").expect("Shouldn't fail on test!"); let range = LineRange::from("30:40:0").expect("Shouldn't fail on test!");
assert_eq!(RangeBound::Absolute(30), range.lower); assert_eq!(RangeBound::Absolute(30), range.lower);