📝 Release notes - sheldon docs

# 📝 Release notes

## 0.7.4

November 19th, 2023

- Support optional access in templates. This allows you to use the `.?` operator in templates to optionally access a field in templates, for example `{{ hooks?.pre }}` will return `None` and not error if `pre` is not present in `hooks`. You will now receive a deprecation warning if you use the `get` filter which does the same thing.

  Custom templates might have to be updated, for example if you were using a custom `defer` template you would need to update it to the following.

      [templates]
      defer = "{{ hooks?.pre | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks?.post | nl }}"

## 0.7.3

May 16th, 2023

- Add configurable hooks in templates. This allows you to specify arbitrary hooks for a plugin that can be used in templates. These are specified under `plugins.<name>.hooks`. The default `source` templates have been updated to support hooks with the names `pre` and `post`. The `pre` hook will be inserted before the plugin is sourced and the `post` after the plugin is sourced. If you are using a custom template like `defer` it will need to be updated to support hooks.

  For example this can be used to set variables after a plugin is sourced.

      [plugins.enhancd]
      github = "b4b4r07/enhancd"

      [plugins.enhancd.hooks]
      post = 'export ENHANCD_HOOK_AFTER_CD = "ls"'

  Custom templates might have to be updated, for example if you were using a custom `defer` template you would need to update it to the following.

      [templates]
      defer = "{{ hooks | get: \"pre\" | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks | get: \"post\" | nl }}"

  Contributed by @mkroli

## 0.7.2

May 13th, 2023

- Add --non-interactive option to suppress prompts. This option is defined as a global option so it must be specified before the subcommand.

      sheldon --non-interactive init --shell zsh

- Add experimental fish shell support. It is now possible to initialize Sheldon to use the Fish shell.

      sheldon init --shell fish

  This makes Sheldon change the global matches and templates to be tailored to Fish. Add the following to your Fish config

      eval "$(sheldon source)"

- Fix 'PermissionDenied' during rename of temporary clone directory.

  Contributed by sceneq

## 0.7.1

November 1st, 2022

- Fix bug with custom config file. Previously, the default config directory still needed to exist for Sheldon to work properly.

- Add `compact` release profile. This profile is optimized for binary size.

      cargo install --profile compact sheldon

  Contributed by @mkroli

## 0.7.0

October 13th, 2022

### Breaking changes

- Use XDG directories by default. Previously Sheldon tried to automatically detect whether the user wanted to use XDG. This proved difficult and Sheldon now follows the XDG directory structure by default. Sheldon will log a warning if the old directory `~/.sheldon` is still used as the config directory.

  To use the new location you should move the config file from `~/.sheldon/plugins.toml` to `$XDG_CONFIG_HOME/sheldon/plugins.toml`, which will be `~/.config/sheldon/plugins.toml` if the XDG variable is unset. You can then safely delete the old `~/.sheldon` directory.

  If you wish to preserve the existing behaviour you can simply set the following environment variables.

      SHELDON_CONFIG_DIR="$HOME/.sheldon"
      SHELDON_DATA_DIR="$HOME/.sheldon"

- Update template engine. Stop using Handlebars in favour of Jinja-like templating. This will only affect you if you were using custom templates.

- Only apply templates per plugin. This effectively removes the `each` field from the template configuration. Any templates that are applied to each file in a plugin need to now use a for loop.

  Previously, you could use

      [templates]
      defer = { value = 'zsh-defer source "{{ file }}"', each = true }

  You must now use a `for` loop

      [templates]
      defer = """{% for file in files %}
      zsh-defer source "{{ file }}"
      {% endfor %}"""

  Having templates only applied per plugin and not both per plugin and per file in a plugin makes rendering a lot simpler and the config easier to understand.

- Remove clone, download dir and lock file options. These paths are no longer configurable, only the data directory is configurable.

### Features

- Conditional sourcing of plugins using profiles. This allows you to specify a profile that a plugin is applicable to. The plugin will only be included when Sheldon is run with that profile. A separate lock file will be used for each profile.

  Plugins can specify the profiles using the `profiles` key.

      [plugins.example]
      github = "owner/repo"
      profiles = ["<name>"]

  You can specify the profile in two ways:

  - Command line flag: `--profile <name>`
  - Environment variable: `SHELDON_PROFILE=<name>`.

  Contributed by @mkroli

- Support cargo-binstall. This allows Sheldon to be installed using `cargo binstall sheldon` which will fetch the release artifact for Sheldon from the GitHub release.

  Contributed by @Jackenmen

### Fixes

- Fix not updating Git source branches after force pushes. Previously repositories with a branch that was force pushed wouldn't be updated by `sheldon lock --update`.
- Many other fixes and internal improvements.

## 0.6.6

January 29th, 2022

- Support and bundle shell completions.

## 0.6.5

October 27th, 2021

- Fix `libgit2` compatibility issues.

## 0.6.4

July 14th, 2021

- Fix broken symlink handling. If a glob match includes a broken symlink Sheldon will now emit an error.
- Fix glob behaviour with `uses`.

## 0.6.3

March 27th, 2021

- Support Git proxy settings.

  Contributed by @iclac

## 0.6.2

March 13th, 2021

- Fix edit bug. If the edit file existed and you chose the "Abort" option the file would be deleted by mistake.
- Always include details section in version output. This was previously excluded if there was no Git information.

## 0.6.1

February 12th, 2021

- Embed Git and Rustc information in binary. Git (if available) and Rustc information will now be displayed when passing `--version` to Sheldon.
- Switch to `curl` instead of `reqwest`. This significantly reduces compile time and binary size.
- Fix temporary file issues when using `edit`. Now the same file is used for editing, if it already exists then Sheldon will prompt the user to either re-open it or overwrite.

## 0.6.0

October 16th, 2020

### Breaking changes

- Support XDG directory structure. If any XDG environment variable is set then Sheldon will adopt the XDG directory structure by default. The config file will be located at `$XDG_CONFIG_HOME/sheldon/plugins.toml` and downloaded data will be located in `$XDG_CONFIG_DATA/sheldon`.

  Contributed by @tapeinosyne

- Change the default lock file location. For non-XDG directory structures the lock file now always defaults to `$SHELDON_DATA_DIR/plugins.lock`. It previously was the config file path with a `.lock` extension.

- Remove the Sheldon root. The `root` directory has been replaced by individual directories for configuration and data: `config_dir` and `data_dir`. Both default to `$HOME/.sheldon`, the old default `root`.

  Contributed by @tapeinosyne

  If you used Sheldon's defaults, everything will just keep working as it did; no action needs to be taken. Otherwise, you may refer to this migration table:

  | Old | New
  --- | --- | ---
  Config paths | `<root>/plugins.toml` | `<config_dir>/plugins.toml`
  Data paths | `<root>/plugins.lock` | `<data_dir>/plugins.lock`
  | `<root>/repos` | `<data_dir>/repos`
  | `<root>/downloads` | `<data_dir>/downloads`
  Env variables | `SHELDON_ROOT` | `SHELDON_CONFIG_DIR`
  |  | `SHELDON_DATA_DIR`
  CLI options | `--root` | `--config-dir`
  |  | `--data-dir`
  Template variables | `{{ root }}` | `{{ data_dir }}`

- Auto-detect whether to use colored output. A new `--color` option was added with three values `always`, `auto`, or `never`. By default Sheldon will now automatically whether to use colored output or not (`auto`). But you can still force Sheldon to always use color or never use color with the `--color always` option or `--color never`. The previous `--no-color` option has been removed.

### Fixes

- Fix performance bug introduced in version 0.5.4. A significant drop in performance was introduced by switching to the Rust `rayon` package. This change has been reverted.
- Fix `--relock` not being implied for other flags. This fixes a bug where passing `--update` or `--reinstall` to the `source` command didn't imply `--relock` like the documentation says.

## 0.5.4

August 14th, 2020

### Features

- Support extended glob syntax. This means that `{a,b}` and `!` glob patterns can now be used. For example, the following is now valid.

      [plugins.ohmyzsh]
      github = "ohmyzsh/ohmyzsh"
      dir = "lib"
      use = ["{!git,!nvm,*}.zsh]

### Fixes

- Fix not erroring out when no files matched for plugin. This fixes cases where no files would be matched for a plugin and Sheldon would silently continue, resulting in no source rendered by `sheldon source`.
- Update default templates for Bash, `path` and `fpath` are now removed. These templates were meaningless in a Bash context.

## 0.5.3

July 28th, 2020

### Features

- Add `init` command. Adds a new command to Sheldon which initializes a config file. Simply run `sheldon init`.
- Add `shell` config key. Indicates to Sheldon what type of shell is being used. Certain other config values will have different defaults if this value is set.
- Support updating of plugins via `--update` option. Simply run `sheldon lock --update` to update all plugin sources.

## 0.5.2

June 4th, 2020

### Fixes

- Fix not erroring out on a bad HTTP status code. This fixes remote sources from silently not being downloaded correctly.
- Fix missing status log. This fixes a missing status log for when fetching remote sources.

### Other

- Only ship musl binaries. The download script will figure this out automatically.

## 0.5.1

May 11th, 2020

- Using `--reinstall` on source command now implies `--relock`.
- Support aarch64 linux.
- Update Docker images to use OpenSSL 1.1.1g. This affects the shipped musl binaries which statically bundle OpenSSL.

## 0.5.0

May 2nd, 2020

### Features

- Add `add` and `remove` commands to edit config. These commands will edit the config file for you.

  For example

      sheldon add example --github owner/repo --tag v0.1.0

  will add the following to the config file

      [plugins.example]
      github = "owner/repo"
      tag = "v0.1.0"

  The following will remove it again.

      sheldon remove example

- Add `edit` command. Adds a new command to Sheldon which allows you to open the config file in the default editor. Simply run `sheldon edit`.

- Add initial config file. When running `add` or `edit` Sheldon will attempt to initialize a new config file at `~/.sheldon/plugins.toml`.

- Warn about unused config keys. Anytime Sheldon loads the config file it will log warnings when there are unused config keys. Great for catching typos!

### Breaking changes

- Update default root directory and clone directory. The root directory now defaults to `~/.sheldon` and the clone directory now defaults to `{root}/repos`. To migrate you should do the following:

      mv ~/.zsh ~/.sheldon
      mv ~/.sheldon/repositories ~/.sheldon/repos

  Or to preserve the old behavior you should export the following before running Sheldon.

      export SHELDON_ROOT="$HOME/.zsh"
      export SHELDON_CLONE_DIR="$SHELDON_ROOT/repositories"

### Fixes

- Download/clone sources to a temporary path first.

  This fixes an issue (#99) where if someone tried to reinstall they would be left without any plugins because they would all be nuked up front prior to trying to download them.

### Deprecations

Most of these are still supported, however Sheldon will log a deprecation warning if you use them.

- Rename `filename` to `file` This affects both the the config file and the template rendering context.
- Rename `directory` to `dir`. This affects both the the config file and the template rendering context.
- Rename `protocol` plugin config key to `proto`.
- Rename `revision` plugin config key to `rev`.

## 0.4.8

November 3rd, 2019

- Auto clean clone and download directories. Unused source directories and files will now be automatically removed.
- Support Git submodules. After cloning and checking out a repository submodules will now be recursively fetched.
- Support Git source cloning using Git and SSH protocols. This adds an optional `protocol` field to plugin configuration which can be used to specify the protocol for Gist and GitHub sources. Additionally, Git sources can now specify URLs with protocols `git://` and `ssh://`.

## 0.4.7

October 22nd, 2019

- Add `--clone-dir` and `--download-dir` options. The directories where Git plugin sources are cloned to, and remote sources are downloaded to, are now configurable. Environment variables for setting these options are also now available.
- Fix `--config-file` and `--lock-file` options. These two options were previously ignored and only the environment variables were recognized.

## 0.4.6

August 18th, 2019

- Support globs in local plugin directories. Globs should match only one directory.
- Support for inline plugins.

## 0.4.5

July 19th, 2019

- Require mutex to run a Sheldon command. Makes sure multiple instances of Sheldon do not interfere with each other!

## 0.4.4

July 7th, 2019

- Warn instead of erroring when running `sheldon source`. This allows at least some plugins to be sourced, this only happens if there is already a lock file.

## 0.4.3

July 3rd, 2019

- Verify that locked directories and filenames exist when running `sheldon source`. If they do not then `sheldon lock` will be run again.

## 0.4.2

June 27th, 2019

- Improve output granularity and add `--verbose` option.

## 0.4.1

June 2nd, 2019

- Add `--no-color` option.
- Replace home directory with tilde in output.
- Support directory key for plugins. The plugin directory can now be configured to be a sub directory of the source.

## 0.4.0

May 26th, 2019

Complete refactor including breaking changes to the configuration file from prior versions.