tldr-node-client

[!WARNING]
Breaking change: This release drops support for Node 14 and lower.

[!NOTE]
The default branch of this repository has been updated to main.

Added

• Support to download cache only for English and specific languages based on the system's locale configuration (#420) (thanks @vivekjoshi556)
• Support for Android and BSD platforms (#421) (thanks @kbdharun)
• New -p and --platform option replacing -o and --os option (#421) (thanks @kbdharun)

Fixed

• Escaping in Zsh autocompletion (#384) (thanks @nonZero)
• Variable assignment in Zsh (#386) (thanks @JakobMiksch)
• URL encoded email address rendering (#421) (thanks @kbdharun)

Enhancements

• Added Funding information to package.json (#401) (thanks @kbdharun)
• Moved to v2 format for package-lock.json (#409) (thanks @MasterOdin)
• Update homepage link to https://tldr.sh in package.json (#421) (thanks @kbdharun)
• The Client Specification version is now displayed when checking the version (#421) (thanks @kbdharun)

Full Changelog: https://github.com/tldr-pages/tldr-node-client/compare/v3.3.8...v3.4.0

Added

• Add --windows command line option (https://github.com/tldr-pages/tldr-node-client/pull/334)
• Add support to skip update when page not found (https://github.com/tldr-pages/tldr-node-client/pull/364)
• Add error message for invalid .tldrrc configuration file (https://github.com/tldr-pages/tldr-node-client/pull/366)

Fixes

• Update ambiguous descriptions for help information (https://github.com/tldr-pages/tldr-node-client/pull/345)
• Fix bash completion for -v flag (https://github.com/tldr-pages/tldr-node-client/pull/347)
• Force HTTPS for tldr.zip (https://github.com/tldr-pages/tldr-node-client/pull/360)
• Fix error for missing render path (https://github.com/tldr-pages/tldr-node-client/pull/354)
• Add win32 to platform.js (https://github.com/tldr-pages/tldr-node-client/pull/369)

Fixes

• Make version flag spec compliant

Chores

• Dependency upgrades

Fixes

Fixed a bug where invoking tldr without arguments would display an error

Improvements

• Replaced request with axios for faster cold boot times.
• Improved bash completion

Fixes

• Improved a lot of error handling

Fixes

• Replace deprecated os-homedir with the native os package.
• Upgrade vulnerable dependencies.

Improvements

• Remove snap installation steps. Snap installs are no longer supported.
• Add coverage tests and make general improvements to tests.

Fixes

• Handle undefined LANG variable

Fixes

• The new targets field was not being accessed while searching.

Fixes

• Improve the error message when an invalid theme is passed.
• Remove some unnecessary global variables.
• Change cache and tldr to be a class

Features

Language support 🎉

An environment variable LANG needs to contain a GNU posix locale
for it to pick up the right language file.

Fixes

• Showing homepage links in the heading
• Add ellipsis to progress messages
• Make contribution prompt more explicit

Fixes

• printing of random page in markdown format

Fixes

• Using https path for asset download
• Fixed UT issue where it would fail if $HOME/.tldrrc was not present.

Fixes

• Upgraded natural to remove node-webworkers as a dependency. This was a cause of major install issues.

Fixes

Fixed the crash on using --render option

Fixes

• Use random folder for zip extraction to allow multiple users to use tldr simultaneously
• Use node-unzip2 package which uses graceful-fs@4 to work in node10.

Features

• Asynchronously build short index

Fixes

• Switch all dependencies to caret.
• Upgrade all dependencies to latest.

Features

• Switch the entire codebase to use promises instead of callbacks.
• Add new theme colors.
• Add CLI spinners.

Fixes

• Not raising an error when shortIndex.json is not found
• Fixing --render option
• Fixed a theme parsing TODO item

Patches

• Fixed the repo url in the message when a command is not found.

Features

• Updated minimum required node version to be 6

Patches

• Improve page not found message
• Using proper folder for windows pages
• Fixed documentation about pointing to a custom repo

Fixes

Param wasn't being passed for --render option