Changed

• Output of list and uninstall actions. Module names are already their relative path from ZIM_HOME, so listing their full path afterwards was redundant. The full path to external modules is now shown in verbose mode. Not considering this as a breaking change since zimfw's output is not meant to be parsed by scripts.
• Uncommented zmodule zsh-users/zsh-history-substring-search from generated .zimrc, since our input module can now do a deferred initialization of it. See announcement here.

Automated tests with bats were introduced in this version, allowing a better understanding of some edge case scenarios and being helpful to the work on improving how they're handled.

Fixed

• Don't expand ${HOME} in fpath in the init.zsh script.
• Show skipped mkdir modules in check action in verbose mode.
• Do build after uninstall action.
• Allow defining new modules as both --frozen and --disabled so they're neither installed nor initialized. Defining a new module as just --frozen is still going to cause errors when trying to initialize it and nothing is found.
• Show --if option values on list action output in verbose mode.
• For modules with multiple roots, show the respective options nested under each root on list action output in verbose mode.
• Allow defining multiple roots in a module when using the mkdir tool. The tool will create the subdirectories automatically in this case.

Added

• Generate .zimrc if not found, to hopefully make installation easier.
• Fail module check if git default remote branch has diverged. This allows novice users to more easily reinstall the affected module to fix the issue.

Changed

• Expand aliases when compiling with zcompile for a more predictable behavior.
• Include modules/ prefix when outputting module names.

Changes in this release are one more little step towards better adherence to the command line interface guidelines.

Added

• --help and --version actions. These are aliases to the already existing help and version actions.

Changed

• Disable color output when executed through a pipe or as a non-TTY ssh command.

Fixed

• Create ZIM_HOME if it does not exist.
• Simplify output. Don't send any ANSI escape codes to the terminal when NO_COLOR is set.

Added

• Also list not installed modules with list action, when not in verbose mode.
• auto tool in zmodule, which auto detects the best tool available for installing a new module or the tool used when an existing module was installed. This is now the default tool and makes life automatically easier for users without git installed.

Fixed

• Print help or version even if ZIM_HOME is not set.
• "no such file or directory: /path/to/.zdegit" error when installing a new module with the degit tool.

• Also output zimfw config and zimfw.zsh script paths in info action, following symlinks if any.
• Don't output colors if NO_COLOR environment variable is set to a non-empty value.

Fixed

• Preserve original module if reinstall fails instead of removing it first.

Added

• reinstall action, that removes and then installs again the modules that failed any of the checks: (See #542)
  • module was installed with the defined tool,
  • module URL matches the defined one.
• --if-ostype option to zmodule. This option is equivalent to --if "[[ \${OSTYPE} == ${1} ]]".

Changed

• Ask before uninstalling each unused module, instead of asking just once for all.
• Add disclaimer comment at beginning of init.zsh file.

Changed

• Don't expand ${HOME} in the init.zsh script. (See #509)
• Don't allow calling zmodule from the command line. Let it fail with "command not found" instead, as it's intended to be used only in the .zimrc script.
• ZIM_HOME must be defined before sourcing zimfw.zsh. All documentation was already doing so, hence not considering this as a breaking change.
• Allow zimfw.zsh to exist anywhere else, not only inside ZIM_HOME. This enables installing the zimfw.zsh script independently with a package manager.
• Don't try to upgrade if sourced zimfw.zsh is not in a writable path.
• Don't try actions that write to ZIM_HOME if user has no write permissions there.

Fixed

• Update error messages to hopefully make it clearer when either the git or the degit tool is being used.
• Set read permissions to generated init.zsh script, so it can be read from other users.