lighthouse: add README and clean up plugin (#7316)

This commit is contained in:
Marc Cornellà 2019-03-24 11:30:09 +01:00 committed by GitHub
commit 08b73f92c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 9 deletions

View file

@ -0,0 +1,26 @@
# Lighthouse plugin
This plugin adds commands to manage [Lighthouse](https://lighthouseapp.com/).
To use it, add `lighthouse` to the plugins array in your zshrc file:
```zsh
plugins=(... lighthouse)
```
## Commands
* `open_lighthouse_ticket <issue>` (alias: `lho`):
Opens the URL to the issue passed as an argument. To use it, add a `.lighthouse-url`
file in your directory with the URL to the individual project.
Example:
```zsh
$ cat .lighthouse-url
https://rails.lighthouseapp.com/projects/8994
$ lho 23
Opening ticket #23
# The browser goes to https://rails.lighthouseapp.com/projects/8994/tickets/23
```

View file

@ -1,16 +1,12 @@
# To use: add a .lighthouse file into your directory with the URL to the
# individual project. For example:
# https://rails.lighthouseapp.com/projects/8994
# Example usage: https://screencast.com/t/ZDgwNDUwNT
open_lighthouse_ticket () {
if [ ! -f .lighthouse-url ]; then
echo "There is no .lighthouse-url file in the current directory..."
return 0;
else
lighthouse_url=$(cat .lighthouse-url);
echo "Opening ticket #$1";
open_command "$lighthouse_url/tickets/$1";
return 0
fi
lighthouse_url=$(cat .lighthouse-url)
echo "Opening ticket #$1"
open_command "$lighthouse_url/tickets/$1"
}
alias lho='open_lighthouse_ticket'