https://github.com/jparise/vim-phabricator

Vim plugin for Phabricator and Arcanist
https://github.com/jparise/vim-phabricator

arcanist phabricator phorge vim

Last synced: about 2 months ago
JSON representation

Vim plugin for Phabricator and Arcanist

• Host: GitHub
• URL: https://github.com/jparise/vim-phabricator
• Owner: jparise
• License: mit
• Created: 2019-12-11T21:46:40.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-06T17:07:46.000Z (about 3 years ago)
• Last Synced: 2024-10-12T13:25:12.742Z (2 months ago)
• Topics: arcanist, phabricator, phorge, vim
• Language: Vim script
• Homepage:
• Size: 25.4 KB
• Stars: 19
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Phabricator Plugin for Vim

This [Vim](https://www.vim.org/) plugin provides features for interacting with

[Phabricator](https://phacility.com/phabricator/)-based repositories. It

builds upon the foundational git functionality provided by [Fugitive][].

* Syntax highlighting for Arcanist templates and configuration files

* `:Gbrowse` support for browsing Phabricator URLs from the current buffer

* Completion support for users and projects in Arcanist diff templates using

  [``][compl-omni] (requires [curl][] and a [Conduit API][conduit]

  token)

[fugitive]: https://github.com/tpope/vim-fugitive

[compl-omni]: http://vimdoc.sourceforge.net/htmldoc/insert.html#compl-omni

[curl]: https://curl.haxx.se/

## Installation

### Using [vim-plug][plug]

1. Add `Plug 'jparise/vim-phabricator'` to `~/.vimrc`

2. `vim +PluginInstall +qall`

[plug]: https://github.com/junegunn/vim-plug

### Using Vim Packages

```sh

mkdir -p ~/.vim/pack/jparise/start

cd ~/.vim/pack/jparise/start

git clone https://github.com/jparise/vim-phabricator.git phabricator

vim -u NONE -c "helptags phabricator/doc" -c q

```

## Configuration

### `g:phabricator_hosts`

This plugin automatically recognizes Phabricator repositories served from

hosts named `phabricator` (eg. `phabricator.example.com`).

This variable lists additional hosts that should also be considered

Phabricator hosts.

### `g:phabricator_api_token`

[Phabricator's Conduit API][conduit] is used to generate candidates for user

and project completion. These API calls require an access token which can be

generated in Phabricator's per-user Settings interface. For example:

    https://phabricator.example.com/settings/user/USERNAME/page/apitokens/

The plugin will first attempt to read the per-host API token from the user's

`~/.arcrc` configuration file. For example:

```json

{

  "hosts": {

    "https://secure.phabricator.com/api/": {

      "token": "api-secrettokencharacters"

    }

  }

}

```

If an API token can not be read from the `~/.arcrc` file for the current

Phabricator host, the value stored in `g:phabricator_api_token` will be used.

[conduit]: https://secure.phabricator.com/book/phabricator/article/conduit/

## License

This code is released under the terms of the MIT license.

See [`LICENSE`](LICENSE) for details.

## Similar Projects

* [arcanist.vim](https://github.com/solarnz/arcanist.vim) provides syntax

  highlighting for Arcanist templates and configuration files.

* [phabrowser.vim](https://github.com/peplin/vim-phabrowse) provides a Fugitive

  browse handler for Phabricator.

* [rhubarb.vim](https://github.com/tpope/vim-rhubarb) provides similar features

  for GitHub-based repositories.

* [vscode-phabricator](https://github.com/christianvuerings/vscode-phabricator)

  provides similar Phabricator features for Visual Studio Code.