Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdalisue/vim-protocol
Enable remote access like ':e https://git.io/vgDtJ' without netrw.vim
https://github.com/lambdalisue/vim-protocol
Last synced: 22 days ago
JSON representation
Enable remote access like ':e https://git.io/vgDtJ' without netrw.vim
- Host: GitHub
- URL: https://github.com/lambdalisue/vim-protocol
- Owner: lambdalisue
- Created: 2016-02-13T04:39:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-10T11:07:09.000Z (about 3 years ago)
- Last Synced: 2024-10-04T12:52:55.078Z (about 1 month ago)
- Language: Vim script
- Homepage:
- Size: 72.3 KB
- Stars: 26
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
vim-protocol
===============================================================================
  [](LICENSE) [](doc/protocol.txt)
Provide features to open, read, source remote contents of http:// or https:// without using `netrw.vim`.
Designed for user who don't use most of features of `netrw.vim` but want to access remote contents.
Attention
-------------------------------------------------------------------------------
**This plugin conflicts with `netrw.vim`**, Vim's default plugin, so you need to disable the plugin.
If you need features of `netrw.vim`, simply don't use this plugin.
Install
-------------------------------------------------------------------------------
Use [Plug.vim][], [neobundle.vim][], or whatever like:
```vim
" Plug.vim
Plug 'lambdalisue/vim-protocol'
" neobundle.vim
NeoBundle 'lambdalisue/vim-protocol'
" neobundle.vim (Lazy)
NeoBundleLazy 'lambdalisue/vim-protocol', {
\ 'on_path': '^https\?://',
\}
```
Or copy the repository into one of your `runtimepath` of Vim.
[Plug.vim]: https://github.com/junequnn/vim-plug
[neobundle.vim]: https://github.com/Shougo/neobundle.vim
After you install the plugin, you **must** disable `netrw.vim` to prevent conflict features.
You can disable `netrw.vim` with the following line in your `.vimrc`
```vim
" disable netrw.vim
let g:loaded_netrw = 1
let g:loaded_netrwPlugin = 1
let g:loaded_netrwSettings = 1
let g:loaded_netrwFileHandlers = 1
```
Usage
-------------------------------------------------------------------------------
This plugin provides `BufReadCmd`, `FileReadCmd` and `SourceCmd` for filenames starts with `http://` or `https://`.
In short, the following command request remote contents of corresponding URLs.
```vim
:edit https://raw.githubusercontent.com/lambdalisue/rook/master/home/.vim/vimrc
" Read a remote content and open a corresponding buffer
:read https://raw.githubusercontent.com/lambdalisue/rook/master/home/.vim/vimrc
" Read a remote content and insert into the current buffer
:source https://raw.githubusercontent.com/lambdalisue/rook/master/home/.vim/vimrc
" Read a remote content and source the content as Vim script
```
License
-------------------------------------------------------------------------------
The MIT License (MIT)
Copyright (c) 2016 Alisue, hashnote.net
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.