path: root/CHANGELOG.md

# Changelog

## Notes

## Unreleased

## v2.13.0 (2024-04-07)

### Added
- `ignore_case` option to the do case-insensitie search by `/`.
- Symbolic link destinations are now displayed when the cursor is hovered over them.

### Changed
- Symlink items linked to directory now appears in the directory section, not the file section.
- MSRV is now v1.74.1

### fixed
- `z` command can now receive multiple arguments: `z dot files<CR>` works as in your terminal.

## v2.12.1 (2024-02-04)

### Fixed

- Restore the cursor position properly after exit in a tmux (and possibly in other multiplexers) session.

## v2.12.0 (2024-01-28)

### Added

- `:config` to point to the config file if exists.
- felix listens to the change of the config file, and re-read the config automatically (after some key inputs).

### Changed

- Refactor around `_run` and `State::new()`.
  - Add `config_path` field to `State`.

### Fixed

- symlink path and operations with it on Windows.

## v2.11.1 (2023-12-10)

### Fixed

- Allow SHIFT key to enter characters after `i`, `I`, `c`, `/`, `:` and `z`.

## v2.11.0 (2023-12-09)

### Added

- `<C-h>` for Backspace functionality after `i`, `I`, `c`, `/`, `:` and `z`.

## v2.10.2 (2023-11-26)

### Fixed
- Added a filter to every user input to reject `Keyup` events. This is required on the windows platform.

## v2.10.1 (2023-11-02)

### Fixed
- Convert tab to 4 spaces when using bat to preview text files.

## v2.10.0 (2023-11-01)

### Added
- `bat` integration: If `bat` installed, felix automatically adds syntax highlighting to the text preview.
  - Add `has_bat` field to `State`.
  - Add `FxError::InvalidPath` to handle invalid unicode in file path.

## v2.9.0 (2023-10-22)
 
### Added
- Change color of untracked/changed files or directories containing such files. Default color is Red(1). You can change it in the config file.
  - Add `git2`.
  
### Fixed
- Explicitly ignore the key release events for Windows.

## v2.8.1 (2023-08-25)

### Fixed
- Fix help text.

## v2.8.0 (2023-08-25)

### Added
- `i{file name}<CR>` to create new file, and `I{dir name}<CR>` to create new directory.
- If zoxide is installed, whenever changing directory inside felix, `zoxide add` will be executed to add the directory or increment its rank in the zoxide database.
  - For this, State now has a new field `has_zoxide`, which is checked at startup.

### Changed
- config's `color` is now optional: By this, all config fields are optional.
  - Remove warning message when you launch felix without the config file.
- When opening file by default editor is failed, felix displays more accurate warning: `$EDITOR may not be set, or config file may be invalid.`.

### Removed
- Remove `syntect` and syntax highlighting in the preview area. This will improve build and start-up times, and resolve the handling of wide chars such as CJK.

## v2.7.0 (2023-08-05)

### Changed

- Minimal supported rust version is now 1.67.1
- Upgrade dependencies.
- Update syntect version to v5.1.0. This fixes the handling of multibyte chars in the preview area.
- Allow file name `config.yml` in addition to `config.yaml` for the configuration.

## v2.6.0 (2023-07-22)

### Added

- Allow `<C-r>` in command line: Paste item name(s) in register. e.g. `<C-r>"` pastes item name in unnamed register.
- Allow wild card in command line: e.g. `:zip test *.md` works now.
- Ability to `cd` {absolute/relative path}.
- Ability to jump backward / forward (`<C-o>`, `<C-i>` respectively)

## v2.5.0 (2023-07-13)

### Added

- Ability to exit to LWD (last working directory): See Integrations for details.

## v2.4.1 (2023-06-21)

### Changed

- Show status bar and registers even if current directory does not contain any item.

## v2.4.0 (2023-06-14)

### Added

- Add registers (unnamed, zero, numbered, named): Now you can view registers by `:reg`, and add items to registers by usual vim command (prefixed by `"`). See the key manual for more details.
- Refactor unpacking command: `e` unpacks / decompresses gz(Gzip), tar.gz, xz(lzma), tar.xz, zst(Zstandard), tar.zst, tar, and zip file format and formats based on it.

### Removed

- `:z` - Use `z` instead.

## v2.3.0 (2023-05-26)

### Changed

- Add extra config file path for macOS: `/Users/$USER/.config/felix/config.yaml` will be read after `$HOME/Library/Application Support/felix/config.yaml`.
- If config file is not found, or found one is broken, felix launches with the default configuration, without creating new one.
- If the current directory is read-only, `dd`, `Vd` and `p` is disabled in the first place.
- Bump up MSRV to 1.65.

### Added

- Add `is_ro` field to `State`.

### Removed

- NetBSD install test. It often failed while setting up the VM, which had nothing with felix.

## v2.2.8 (2023-05-19)

### Fixed

- Kitty-specific: Enable scrolling of the preview text by redrawing the screen only when needed (this also improves the perfomance entirely).

## v2.2.7 (2023-05-05)

### Added

- Print `[RO]` on the headline if user does not have the write permission on the directory. This is available only on UNIX for now.

## v2.2.6 (2023-04-24)

### Removed

- Remove duplicated `-v | --version` option. This is because i) Since some users
  do not have `cargo` installed, fetching latest version via `cargo` doesn't
  work for many, and ii) `-h | --help` option can already show the current
  version.

## v2.2.5 (2023-02-12)

### Added

- Allow renaming even when item name contains non-ascii chars (i.e. wide chars).
- Key command with arguments is now supported: For example,
  ```
  exec:
  'feh -.':
    [jpg, jpeg, png, gif, svg, hdr]
  ```
  this configuration enables you to execute `feh -. <item path>` by
  `Enter | l | Right`, or `o`.
- Check for out-of-boundary of the cursor at the top of loop.

### Fixed

- Display when using in kitty: Correctly show the cursor and preview.

## v2.2.4 (2023-02-01)

### Fixed

- Disable remove_and_yank in the trash dir.
- Clear selection in the select mode if something fails.
- Cursor move after deleting multiple items in select mode.

## v2.2.3 (2023-01-20)

### Fixed

- Wide chars handling: Using unicode_width, now felix can properly split file
  name or previewed texts.
- Preview space height: When horizontally split, image preview could break the
  layout. Fixed this by adjusting the height.

### Added

- `chafa`'s minimal supported version: >= v1.10.0
- Add pacman installation.

## v2.2.2 (2022-12-19)

### Fixed

- Disable commands with Ctrl or other modifiers unless explicitly implemented.
  (For now, `Ctrl + r` to redo, `Alt + j` and `Alt + k` to scroll the preview
  text are implemented) This avoids for example the situation where `Ctrl + d`
  unintentionally deletes an item.
- Add `create_dir_all` to `config_dir` and `data_local_dir` to avoid error.
- Check if the argument is directory.

## v2.2.1 (2022-12-15)

### Fixed

- Fix the compilation on NetBSD.

## v2.2.0 (2022-12-12)

### Changed

- **IMPORTANT**: Trash, log directory, and session file path changed.
  - from v2.2.0, felix will use `dirs::data_local_dir()` to store the deleted
    items and log files, instead of `dirs::config_dir()`.
  - Due to this change, the path for linux will be
    `$XDG_DATA_HOME/felix/{Trash, log, .session}`, in most case
    `/home/user/.local/share/felix/{Trash, log, .session}`. For Windows
    `{FOLDERID_LocalAppData}\felix\{Trash, log, .session}`, typically
    `C:\Users\user\AppData\Local\felix\{Trash, log, .session}`. No change for
    macOS users.
  - Note that config file path does not change on any OS!
  - Please don't forget deleting old trash directory and log files if you don't
    want them anymore.
- Refactoring overall.

### Added

- `:trash` to go to the trash directory.

### Fixed

- Support NetBSD to open file in a new window.
- Properly remove broken symlink in Windows as well. Also, when
  deleting/puttiing a directory, broken symlink(s) in it won't cause any error
  and will be removed from the file system after deleting/putting.

## v2.1.1 (2022-12-02)

### Fixed

- You can now open a file in a new window on Wayland environment too.
- Proper handling of wide characters: Even if an item or a info message includes
  some wide charatcters such as CJK, the layout won't break anymore.
- Fix cursor color after printing the text preview.

### Changed

- Some refactoring around text-printing in the preview space.
- When you change the sort key, felix refresh the list more efficiently than
  ever by avoiding to read all the items.
- Item order(Name): Case-insensitive instead of sensitive.

## v2.1.0 (2022-11-19)

### Added

- Feature to unpack archive/compressed file to the current directory. Supported
  types: `tar.gz`(Gzip), `tar.xz`(lzma), `tar.zst`(Zstandard & tar),
  `zst`(Zstandard), `tar`, zip file format and formats based on it(`zip`,
  `docx`, ...). To unpack, press `e` on the item.
  - The number of dependencies bumps up to around 150 due to this.

### Fixed

- Bug: In the select mode, the selected item was unintentionally canceled when
  going up/down.
- Delete pointer properly when removing items.
- Instead of panic, return error when `config_dir()` fails.

### Changed

- Image file detection: Use magic bytes instead of checking the extension. This
  will enable to detect image more precisely.

## v2.0.1 (2022-11-12)

### Fixed

- Fixed the bug in making config at the launch.
- Fixed the config file path on macOS.

## v2.0.0 (2022-11-11)

### Changed

- Migrated to yaml from toml: New config file will be created at the first
  launch (In this process you should enter the default command name or choose to
  use \$EDITOR). No more need to keep `config.toml`.
- Add the fallback when config file cannot be read: In such a case, you can use
  the default Config.
- HUGE refactoring overall.

### Added

- Horizontal split, in addition to the vertical split. To toggle, press `s`.
- Syntax highlighting (if possible) in previewed texts. To turn on, state
  `syntax_hightlight = true` in `config.toml`. you can also choose your theme,
  either from the default theme set or your favorite .tmtheme.
- Enable scrolling in the preview space. `Alt + j / Up` goes down, `Alt + k`
  goes up. Experimental and may have some bugs, and with a big text file the
  perf issue may arise.
- Search by keyword. Similar to the filter mode, but this feature do not
  manipulate the item list, just let users jump to the item that matches the
  keyword, just like Vim's `/`. `n` and `N` after `/` also works.
- Show permissions on the footer (in unix only).

### Fixed

- Use `exists()` instead of `File::open()` to check whether the item path is
  valid when moving between directories. This allows Windows users to use this
  app at least with the basic commands.
- Avoid `unwrap()` / `panic!` as possible and return the proper error.

### Removed

- Removed the filter mode, which is replaced by the keyword search.
- Removed debug print in `make_config_if_not_exists`
- Removed `use_full_width` and `item_name_length` in `config.toml`. Will always
  use full width of the terminal.

## v1.3.2 (2022-10-23)

### Added

- Add `std::panic::catch_unwind` to manually restore after a panic rewind. This
  allows the cursor to be restored and the screen cleared when this app panics.

### Fixed

- Fixed: Similar to v1.3.1, attempting to preview a symbolic link to a
  nonexistent file caused a panic. Now the preview shows `(file not readable)`
  for such a link.

## v1.3.1 (2022-10-21)

### Fixed

- Attempting to preview a symbolic link to a directory caused a panic. It has
  been fixed and the preview will now show the contents of the linked directory.

## v1.3.0 (2022-10-18)

### Changed

- Huge refactoring: Migrated to crossterm from termion due to the
  maintainability and future-support for Windows. New module `term.rs` contains
  (almost) all of the terminal API, so that other modules will not get effected
  by the future backend change.
  - Alongside, some changes are added to show the file path properly in Windows.
  - With crossterm, opening a file in e.g. Vim, it feels as if this app
    "freezes". This behavior is not what I want, so from v1.3.0,
    `open_file_in_new_window` can work only if \[exec\] is set in config file,
    and the extension of the item matches the key.
- `default` key in the config file become `Option`, so that users can select
  `$EDITOR` without explicitly setting it up. The initial process of asking
  users to select the default command has also been fixed accordingly.

### Fixed

- After zoxide jump, turn off the filter mode.
- Many typos fixed.

### Added

- New error: `OpenNewWindow`
- New GitHub actions: Add windows-install

## v1.2.0 (2022-10-01)

### Changed

- Huge refactoring: Instead of `thiserror`, use custom error type to make it
  easier to handle.
- Bump up chrono version to 0.4.22, clarifing the feature to use.
- Avoid extra heap allocation by using write! instead of push_str/format!.
- Copied item will be renamed with the suffix "\_{count}" such as "test_1.txt",
  instead of "test_copied.txt".

### Fixed

- Choose `None` for directory extension.

## v1.1.2 (2022-08-29)

### Fixed

- Use full width of the terminal when `use_full_width` in config.toml is not
  set.
- Use `cursor::Goto` instead of `cursor::Left` to fix the layout in macOS
  Terminal.app.
- Refactor functions around the layout.

## v1.1.1 (2022-08-11)

### Fixed

- In the filter mode and shell mode, when you don't have any input, `backspace`
  now means to return to the normal mode.
- Also, when you press `Esc` during the filter mode, the cursor position is now
  restored.

## v1.1.0 (2022-08-08)

### Changed

- Use `chafa` instead of `libsixel` & `viuer` to preview image files. This
  greatly improves the performance and code maintainability, and as a
  consequence, the number of dependencies is reduced (137 -> 53).
- With `chafa`, the hi-res image preview is supported in kitty or terminals that
  support sixel.
- Files larger than 1GB are no longer previewed in order to improve the
  performance.
- Remove profile.release to support older version of Rust.
- Huge refactoring (layout.rs created).

### Added

- `content-inspector` to exclude binary files to be previewed.

## v1.0.1 (2022-07-28)

### Fixed

- Add thread sleep time after state.open_file(). This is necessary because, with
  tiling window managers, the window resizing is sometimes slow and felix
  reloads the layout so quickly that the display may become broken. By the sleep
  (50ms for now and I think it's not easy to recognize this sleep), this will be
  avoided.

## v1.0.0 (2022-07-04)

### Fixed

- Cursor move when using G in select mode.
- Rem