📢 Maintainer wanted: This project is looking for maintainers, please open up an issue if you would love to chime in!

helm-file-preview

Preview the current helm file selection.

Every time uses helm to select the file is what painful to me. Especially when I use other extensions like helm-ag, helm-gtags, dumb-jump, etc. This package help you figure out what the file you are actually pointing to by showing the file in the previous window.

helm-ag	helm-gtags

Few differences to helm-follow-mode.

Decouple from helm-source.
Customize once, works across all packages that use helm's interface.
Preview instead of opening files.

🔧 Usage

Add these lines to somewhere in your Emacs config.

(require 'helm-file-preview)
(helm-file-preview-mode 1)

Or if you are using use-package.

(use-package helm-file-preview
  :config
  (helm-file-preview-mode 1))

🧪 Customization

Turn off this if you want to preview the file no matter what. The default behaviour is the preview action will only occurs when line numbers appears in the selection. For instance, using helm-ag, helm-gtags or any packages that make compatible to helm interface.

(setq helm-file-preview-only-when-line-numbers t)

If you don't want the file to be opened after viewing the file, you can set this variable to t. If you want to leave the file opened then you should set to nil.

(setq helm-file-preview-preview-only t)

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

Eask
Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.

jcs-legacy / helm-file-preview