v5.0.0

[olets]

v5.0.0 is a major version. That means some things are incompatible with v4.x. Casual users should not have to do anything special to migrate from v4.x to v5.0.0, but power users should check the ⚠️s below.

Notable changes

• 🆕 Support for multi-word abbreviations!
• 🆕 Dedicated docs site! See the new README
• 🆕 abbr git command!
• 📄 Default ABBR_USER_ABBREVIATIONS_FILE is now ${XDG_CONFIG_HOME:-$HOME/.config}/zsh-abbr/user-abbreviations (but if you have a file in the legacy path ${XDG_CONFIG_HOME:-$HOME/.config}/zsh/abbreviations, that will be used instead)
• ⚠️ zsh-syntax-highlighting users have to update their snippets
• ⚠️ All features deprecated in the latest v4.x are dropped
• License's ethics requirements are now Hippocratic License v3 (was HL v2.1)

Beta pre-release

Releases

(in reverse chronological order)

• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-8
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-7
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-6
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-5
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-4
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-3
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-2
• https://github.com/olets/zsh-abbr/releases/tag/v5.0.0.beta-1

To try the beta

You're welcome to give the beta a try, and leave feedback here!

This is tested software. You are however responsible for any loss of data. Use at your own risk.

1. Upgrade to the latest v4.x. v5 removes deprecated things, so you'll want to first get the latest deprecation notices before jumping to v5. If necessary, adjust your configuration following deprecation notices.
2. Back up your user abbreviations file.
3. Read the v4->v5 migration guide
4. Install the beta
   • Plugin manager: use your manager to install zsh-abbr from branch v5.
   • Homebrew: brew uninstall zsh-abbr && brew install --HEAD olets/tap/zsh-abbr.
   • Manual: download the archive file or clone the repo and check out the tag. Source the plugin file.

To downgrade from the beta channel to v4.x before v5.0.0 is released

1. Install v4.x
   • Plugin manager: remove the customization and use the default
   • Homebrew: brew uninstall --force zsh-abbr && brew install olets/tap/zsh-abbr
   • Download the final archive or checkout main.
2. Restore your user abbreviations file
3. Run exec zsh in —or simply close— all open terminals

To switch from the beta channel to the stable channel once v5.0.0 is released

• Plugin manager: remove the customization and use the default
• Homebrew: brew uninstall --force zsh-abbr && brew install olets/tap/zsh-abbr
• Download the final archive or checkout main.