{"id":13443370,"url":"https://github.com/jcs-legacy/helm-file-preview","last_synced_at":"2025-10-09T14:39:56.005Z","repository":{"id":41564509,"uuid":"192489169","full_name":"jcs-legacy/helm-file-preview","owner":"jcs-legacy","description":"Preview the current helm file selection.","archived":false,"fork":false,"pushed_at":"2024-01-31T00:12:47.000Z","size":11475,"stargazers_count":11,"open_issues_count":3,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T02:55:50.522Z","etag":null,"topics":["emacs","preview"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcs-legacy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-06-18T07:31:09.000Z","updated_at":"2024-01-26T21:50:48.000Z","dependencies_parsed_at":"2024-04-13T15:17:26.176Z","dependency_job_id":"12863204-dff7-4243-96c8-75db88203e00","html_url":"https://github.com/jcs-legacy/helm-file-preview","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs-legacy%2Fhelm-file-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs-legacy%2Fhelm-file-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs-legacy%2Fhelm-file-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcs-legacy%2Fhelm-file-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcs-legacy","download_url":"https://codeload.github.com/jcs-legacy/helm-file-preview/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230554245,"owners_count":18244235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emacs","preview"],"created_at":"2024-07-31T03:01:59.792Z","updated_at":"2025-10-09T14:39:50.946Z","avatar_url":"https://github.com/jcs-legacy.png","language":"Emacs Lisp","funding_links":["https://www.paypal.me/jcs090218","https://www.patreon.com/jcs090218"],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"**📢 Maintainer wanted: This project is looking for maintainers, please open up an issue if you would love to chime in!**\n\n---\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![MELPA](https://melpa.org/packages/helm-file-preview-badge.svg)](https://melpa.org/#/helm-file-preview)\n[![MELPA Stable](https://stable.melpa.org/packages/helm-file-preview-badge.svg)](https://stable.melpa.org/#/helm-file-preview)\n\n# helm-file-preview\n\u003e Preview the current helm file selection.\n\n[![CI](https://github.com/jcs-legacy/helm-file-preview/actions/workflows/test.yml/badge.svg)](https://github.com/jcs-legacy/helm-file-preview/actions/workflows/test.yml)\n\nEvery time uses [helm](https://github.com/emacs-helm/helm) \nto select the file is what painful to me. Especially when \nI use other extensions like \n[helm-ag](https://github.com/syohex/emacs-helm-ag), \n[helm-gtags](https://github.com/syohex/emacs-helm-gtags), \n[dumb-jump](https://github.com/jacktasia/dumb-jump#alternatives), \netc. This package help you figure out what the file you are \nactually pointing to by showing the file in the previous window.\n\n| helm-ag | helm-gtags |\n|:---:|:---:|\n|\u003cimg src=\"./etc/helm-ag-preview-demo.gif\"/\u003e | \u003cimg src=\"./etc/helm-gtags-preview-demo.gif\"/\u003e|\n\nFew differences to `helm-follow-mode`.\n* Decouple from `helm-source`.\n* Customize once, works across all packages that use `helm`'s interface.\n* Preview instead of opening files.\n\n## 🔧 Usage\n\nAdd these lines to somewhere in your Emacs config.\n```el\n(require 'helm-file-preview)\n(helm-file-preview-mode 1)\n```\nOr if you are using `use-package`.\n```el\n(use-package helm-file-preview\n  :config\n  (helm-file-preview-mode 1))\n```\n\n## 🧪 Customization\n\nTurn off this if you want to preview the file no matter what. \nThe default behaviour is the preview action will only occurs \nwhen line numbers appears in the selection. For instance, \nusing `helm-ag`, `helm-gtags` or any packages that \nmake compatible to [helm](https://github.com/emacs-helm/helm) \ninterface.\n\n```el\n(setq helm-file-preview-only-when-line-numbers t)\n```\n\nIf you don't want the file to be opened after viewing the file, \nyou can set this variable to `t`. If you want to leave the file \nopened then you should set to `nil`.\n\n```el\n(setq helm-file-preview-preview-only t)\n```\n\n## 🛠️ Contribute\n\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)\n[![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal\u0026color=blue)](https://www.paypal.me/jcs090218)\n[![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218)\n\nIf you would like to contribute to this project, you may either\nclone and make pull requests to this repository. Or you can\nclone the project and establish your own branch of this tool.\nAny methods are welcome!\n\n### 🔬 Development\n\nTo run the test locally, you will need the following tools:\n\n- [Eask](https://emacs-eask.github.io/)\n- [Make](https://www.gnu.org/software/make/) (optional)\n\nInstall all dependencies and development dependencies:\n\n```sh\neask install-deps --dev\n```\n\nTo test the package's installation:\n\n```sh\neask package\neask install\n```\n\nTo test compilation:\n\n```sh\neask compile\n```\n\n**🪧 The following steps are optional, but we recommend you follow these lint results!**\n\nThe built-in `checkdoc` linter:\n\n```sh\neask lint checkdoc\n```\n\nThe standard `package` linter:\n\n```sh\neask lint package\n```\n\n*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*\n\n## ⚜️ License\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\nSee [`LICENSE`](./LICENSE.txt) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcs-legacy%2Fhelm-file-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcs-legacy%2Fhelm-file-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcs-legacy%2Fhelm-file-preview/lists"}