summarylogtreecommitdiffstats
path: root/CHANGELOG.md
blob: 7219825e36ef3041ad10fa1b66c5b42cf198ac22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# Changelog - fzf-help

This document describes the changes that were made to the software for each
version. The changes are described concisely, to make it comprehensible for the
user. A change is always categorized based on the following types:

- Bug: a fault in the software is fixed.
- Feature: a functionality is added to the program.
- Improvement: a functionality in the software is improved.
- Task: a change is made to the repository that has no effect on the source
  code.

If a change is breaking, this is mentioned and a major version is released.

# 2.1.2

## Improvements

- Added PKGBUILD for Arch Linux.

# 2.1.1

## Bug

- The fzf-help.bash/fish/zsh files are sourced by the user. These files
  contained a global variable called `this_dir`, which can get in the way of
  other scripts, as it is not very unique. The variable is now renamed to
  `_fzf_help_directory`.

# 2.1.0

## Features

- Added the CLI_OPTIONS_CMD variable to configure the command that is used by
  the cli-options script.

## Improvements

- The `ag` dependency is now optional.
- The `batcat` command is supported as an alternative to `bat`.
- The `bat` dependency is now optional as the `cat` command is used as a
  fallback. A warning is shown when `bat` is not installed. This warning can be
  disabled by setting the `FZF_HELP_BAT_WARNING` environment variable to `false`.
- Unitests are added to the `test` directory.
- The test runner called `bats` is added as a git submodule.
- The tests are executed in as a GitHub action in a pipeline.

# 2.0.1

## Bug

- The default value of `FZF_HELP_SYNTAX` was set to `txt` instead of `help` to
  support older versions of `bat`.

# 2.0.0

## Features

- Added FZF_HELP_SYNTAX environment variable to configure the syntax
  highlighting of the fzf preview window.
- Added support for the fish shell.

## Improvements

- **Breaking**: Refactored the install and uninstall scripts. The install
  directory is now `/usr/share/fzf-help` for root installations and
  `$HOME/.local/share/fzf-help` for user installations, independent of the shell.

# 1.1.0

## Features

- Added user installation

# 1.0.1

## Bug

- Added --bash option to uninstall script

# 1.0.0

## Features

- short options (-h) are now supported

## Improvements

- the options are now selected based on their index in the opts list. This is
  faster and more reliable. Duplicate options are now expected as this is
  desired: when scrolling through the options, the preview window will show each
  line where an option is mentioned.
- changed the names of the commands and the environment variables to be more
  descriptive.
- `bat-cli-options` was renamed to `fzf-select-option-preview`.

# 0.4

## Features

- supports both bash and zsh.

# 0.3

## Features

- Added the `--multi` option to fzf

# 0.2

## Features

- Added syntax highlighting for `bat-cli-options`.

# 0.1

## Features

- Added `$CLI_OPTIONS_CMD`.

## Bug

- shebangs were not compatible with macos
- LBUFFER was used instead of BUFFER in `fzf-help.zsh`

# 0.0

## Features

- Added `cli-options`.
- Added `bat-cli-options`.
- Added `fzf-select-options`.
- Added "right-bottom-toggle" for the preview window.