Skip to content

Latest commit

 

History

History
422 lines (344 loc) · 16.3 KB

CHANGELOG.md

File metadata and controls

422 lines (344 loc) · 16.3 KB
Raw

Changelog

This project follows semantic versioning.

Possible log types:

  • [added] for new features.
  • [changed] for changes in existing functionality.
  • [deprecated] for once-stable features removed in upcoming releases.
  • [removed] for deprecated features removed in this release.
  • [fixed] for any bug fixes.
  • [security] to invite users to upgrade in case of vulnerabilities.
  • [docs] for documentation changes.
  • [chore] for maintenance work.

v1.6.1 (2022-10-24)

Changes:

  • [fixed] Fix path source for custom pages dir (#297)
  • [chore] Update dependendencies (#299)

Contributors to this version:

Thanks!

v1.6.0 (2022-10-02)

It's been 9 months since the last release already! This is not a huge update feature-wise, but it still contains a few nice new improvements and a few bugfixes, contributed by 11 different people. The most important new feature is probably the option to override the cache directory through the config file. The TEALDEER_CACHE_DIR env variable is now deprecated.

A note to packagers: Shell completions have been moved to the completion/ subdirectory! Packaging scripts might need to be updated.

Changes:

  • [added] Allow overriding cache directory through config (#276)
  • [added] Add --no-auto-update CLI flag (#257)
  • [added] Show note about auto-updates when cache is missing (#254)
  • [added] Add support for android platform (#274)
  • [added] Add custom pages to list output (#285)
  • [fixed] Cache: Return error if HTTP client cannot be created (#247)
  • [fixed] Handle cache download errors (#253)
  • [fixed] Do not page output of tldr --update (#231)
  • [fixed] Create macOS release builds with bundled root certificates (#272)
  • [fixed] Clean up and fix shell completions (#262)
  • [deprecated] The TEALDEER_CACHE_DIR env variable is now deprecated (#276)
  • [removed] The --config-path command was removed, use --show-paths instead (#290)
  • [removed] The -o/--os command was removed, use -p/--platform instead (#290)
  • [removed] The -m/--markdown command was removed, use -r/--raw instead (#290)
  • [chore] Move shell completion scripts to their own directory (#259)
  • [chore] Update dependencies (#271, #287, #291)
  • [chore] Use anyhow for error handling (#249)
  • [chore] Switch to Rust 2021 edition (#284)

Contributors to this version:

Thanks!

v1.5.0 (2021-12-31)

This is quite a big release with many new features. In the 15 months since the last release, 59 pull requests from 16 different contributors were merged!

The highlights:

  • Custom pages and patches: You can now create your own local-only tldr pages. But not just that, you can also extend existing upstream pages with your own examples. For more details, see the docs.
  • Change argument parsing from docopt to clap: We replaced docopt.rs as argument parsing library with clap v3, resulting in almost 1 MiB smaller binaries and a 22% speed increase when rendering a tldr page.
  • Multi-language support: You can now override the language with -L/--language.
  • A new --show-paths command: By running tldr --show-paths, you can list the currently used config dir, cache dir, upstream pages dir and custom pages dir.
  • Compliance with the tldr client spec v1.5: We renamed -o/--os to -p/--platform and implemented transparent lowercasing of the page names.
  • Docs: The README based documentation has reached its limits. There are now new mdbook based docs over at dbrgn.github.io/tealdeer/, we hope these make using tealdeer easier. Of course, documentation improvements are welcome! Also, if you're confused about how to use a certain feature, feel free to open an issue, this way we can improve the docs.

Note that the MSRV (Minimal Supported Rust Version) of the project changed:

When publishing a tealdeer release, the Rust version required to build it should be stable for at least a month.

Changes:

  • [added] Support custom pages and patches (#142)
  • [added] Multi-language support (#125, #161)
  • [added] Add support for ANSI code and RGB colors (#148)
  • [added] Implement new --show-paths command (#162)
  • [added] Support for italic text styling (#197)
  • [added] Allow SunOS platform override (#176)
  • [added] Automatically lowercase page names before lookup (#227)
  • [added] Add "macos" alias for "osx" (#215)
  • [fixed] Consider only standalone command names for styling (#157)
  • [fixed] Fixed and improved zsh completions (#168)
  • [fixed] Create cache directory path if it does not exist (#174)
  • [fixed] Use default style if user-defined style is missing (#210)
  • [changed] Switch from docopt to clap for argument parsing (#108)
  • [changed] Switch from OpenSSL to Rustls (#187)
  • [changed] Performance improvements (#187)
  • [changed] Send all progress logging messages to stderr (#171)
  • [changed] Rename -o/--os to -p/--platform (#217)
  • [changed] Rename -m/--markdown to -r/--raw (#108)
  • [deprecated] The --config-path command is deprecated, use --show-paths instead (#162)
  • [deprecated] The -o/--os command is deprecated, use -p/--platform instead (#217)
  • [deprecated] The -m/--markdown command is deprecated, use -r/--raw instead (#108)
  • [docs] New docs at dbrgn.github.io/tealdeer/
  • [docs] Add comparative benchmarks with hyperfine (#163, README)
  • [chore] Download tldr pages archive from their website, not from GitHub (#213)
  • [chore] Bump MSRV to 1.54 and change MSRV policy (#190)
  • [chore] The master branch was renamed to main
  • [chore] All release binaries are now generated in CI. Binaries for macOS and Windows are also provided. (#240)
  • [chore] Update all dependencies

Contributors to this version:

Thanks!

Last but not least, Niklas Mohrin has joined the project as co-maintainer. Thank you for your help!

v1.4.1 (2020-09-04)

  • [fixed] Syntax error in zsh completion file (#138)

Contributors to this version:

Thanks!

v1.4.0 (2020-09-03)

  • [added] Configurable automatic cache updates (#115)
  • [added] Improved color detection and support for --color argument and NO_COLOR env variable (#111)
  • [changed] Make --list option comply with official spec (#112)
  • [changed] Move cache age warning to stderr (#113)

Contributors to this version:

Thanks!

v1.3.0 (2020-02-28)

  • [added] New config option for compact output mode (#89)
  • [added] New -m/--markdown parameter for raw rendering (#95)
  • [added] Provide zsh autocompletion (#86)
  • [changed] Require at least Rust 1.39 to build (previous: 1.32)
  • [changed] Switch to GitHub actions, CI testing now covers Windows as well (#99)
  • [changed] Tweak the "outdated cache" warning message (#97)
  • [changed] General maintenance: Upgrade dependencies, fix linter warnings
  • [fixed] Fix Fish autocompletion on macOS (#87)
  • [fixed] Fix compilation on Windows by disabling pager (#99)

Contributors to this version:

Thanks!

v1.2.0 (2019-08-10)

  • [added] Add Windows support (#77)
  • [added] Add support for spaces in commands (#75)
  • [added] Add support for Fish-based autocompletion (#71)
  • [added] Add pager support (#44)
  • [added] Print detected OS with -v / --version (#57)
  • [changed] OS detection: Treat BSDs as "osx" (#58)
  • [changed] Move from curl to reqwest (#61)
  • [changed] Move to Rust 2018, require Rust 1.32 (#69 / #84)
  • [fixed] Add (back) support for proxies (#68)

Contributors to this version:

Thanks!

v1.1.0 (2018-10-22)

  • [added] Configuration file support (#43)
  • [added] Allow configuration of colors/style (#43)
  • [added] New --quiet / -q option to suppress most non-error messages (#48)
  • [changed] Require at least Rust 1.28 to build (previous: 1.19)
  • [fixed] Fix building on systems with openssl 1.1.1 (#47)

Contributors to this version:

Thanks!

v1.0.0 (2018-02-11)

  • [added] Include bash completions (#34)
  • [changed] Update all dependencies
  • [changed] Require at least Rust 1.19 to build (previous: 1.9)
  • [changed] Improved unit/integration testing

v0.4.0 (2016-11-25)

  • [added] Support for new page format
  • [changed] Update all dependencies

v0.3.0 (2016-08-01)

  • [changed] Update curl dependency

v0.2.0 (2016-04-16)

  • First crates.io release