https://github.com/bergercookie/vim-deb-preview
Preview debian packages with vim
https://github.com/bergercookie/vim-deb-preview
Last synced: about 1 year ago
JSON representation
Preview debian packages with vim
- Host: GitHub
- URL: https://github.com/bergercookie/vim-deb-preview
- Owner: bergercookie
- License: other
- Created: 2020-03-26T13:49:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T10:09:36.000Z (about 2 years ago)
- Last Synced: 2025-02-12T23:45:47.717Z (over 1 year ago)
- Language: Vim Script
- Size: 2.49 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# deb-preview
```
_ _ _
__| | ___| |__ _ __ _ __ _____ _(_) _____ __
/ _` |/ _ \ '_ \ _____| '_ \| '__/ _ \ \ / / |/ _ \ \ /\ / /
| (_| | __/ |_) |_____| |_) | | | __/\ V /| | __/\ V V /
\__,_|\___|_.__/ | .__/|_| \___| \_/ |_|\___| \_/\_/
|_|
```
## Description
I always loved the zip / tar plugins of vim, where you would just point vim to
an archive and it would show you its contents. However, there's nothing like
this when working with Debian packages even though they're not that different
than regular tarballs.
Current vim/neovim plugin offers an archive-like preview of Debian packages in
vim. On top of that it lets you edit the contents of the Debian package and if
it detects modifications, it repackages the Debian package and if it finds an
`md5sums` file in the package, recalculates all hashes and replaces that file.
## Usage:
Just point vim to a Debian package and it will list its contents automatically
```
vim
```
## Demo
Here's a demo of the plugin, where I view a debian package, make a modification
to one of the files and then, on exit, `deb-preview` repackages the deb package
into `.new`.
Here's also a demo of the plugin where I modify the metadata (CONTROL file)
## Features
* View contents of a Debian package.
* Navigate and inspect directories/files of the Debian package
* Edit the contents of a Debian package and repackage automatically on exit
## Options
```vim
" Set to 1 to overwrite .deb file in case of modifications [default=0]
let g:debpreview_overwrite = 1
" Set to the desired extension. deb-preview will use this extension when
" repackaging in case of modifications. In effect only when
" g:debpreview_overwrite if 0.
let g:debpreview_newdebfile_ext =".new"
```
## FAQ
### How do I navigate the debian package, edit files, copy, rename files etc?
Spend some time familiarising with
[netrw](https://www.vim.org/scripts/script.php?script_id=1075). It's the default
vim tool for navigating and manipulating directories. Here's an excellent
cheatsheet with many of its options:
https://gist.github.com/danidiaz/37a69305e2ed3319bfff9631175c5d0f
### I just don't like navigating the debian package with `netrw`
You can always switch to using ranger instead. Install
[Ranger](https://en.wikipedia.org/wiki/Ranger_(file_manager)) as well as the
[ranger.vim](https://github.com/francoiscabrol/ranger.vim) plugin. Make sure you
configure it to [open directories with ranger.vim by
default](https://github.com/francoiscabrol/ranger.vim#opening-ranger-instead-of-netrw-when-you-open-a-directory)
and `vim-deb-preview` will use ranger.
## Installation
Platform: Linux Debian Flavors (Ubuntu, Debian etc.)
| Plugin manager | How to install |
| :------------- | :------------- |
| [Dein][1] | `call dein#add('bergercookie/vim-deb-preview')` |
| [minpac][2] | `call minpac#add('bergercookie/vim-deb-preview')` |
| [Pathogen][3] | `git clone https://github.com/bergercookie/vim-deb-preview.git ~/.vim/bundle/vim-deb-preview` |
| [Plug][4] | `Plug 'bergercookie/vim-deb-preview'` |
| [Vundle][5] | `Plugin 'bergercookie/vim-deb-preview'` |
| manual | copy all of the files into their corresponding directories under `.vim` directory (or `~/.config/nvim` if you're using neovim)|
[1]: https://github.com/Shougo/dein.vim
[2]: https://github.com/k-takata/minpac
[3]: https://github.com/tpope/vim-pathogen
[4]: https://github.com/junegunn/vim-plug
[5]: https://github.com/VundleVim/Vundle.vim
### Dependencies
debugstring depends on the following binaries on linux:
* `dpkg-deb`
* `fakeroot`
* `awk`
* `md5sum`
On ubuntu this should take care of the installation:
```
sudo apt install dpkg-deb fakeroot awk md5sum
```
## License
Current plugin is distributed under the same terms as Vim itself. See the
[LICENSE](https://github.com/bergercookie/vim-dpkg-preview/blob/master/LICENSE)
file
## TODO
- [ ] Handle error codes from `system()` commands
- [ ] Use fakeroot - handle permissions issue and verify it's working fine.
## Self Promotion
In case you like the plugin, you might as well [star it on
Github](https://github.com/bergercookie/vim-dpkg-preview) or [rate it on
vim.org](TODO) TODO. Also feel free to check my [other
plugins](https://github.com/bergercookie?tab=repositories)