https://github.com/amireh/gerrit-f-button
A script that mimics the old F button functionality in Gerrit.
https://github.com/amireh/gerrit-f-button
Last synced: about 2 months ago
JSON representation
A script that mimics the old F button functionality in Gerrit.
- Host: GitHub
- URL: https://github.com/amireh/gerrit-f-button
- Owner: amireh
- Created: 2015-05-20T18:21:44.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-08T12:55:00.000Z (almost 9 years ago)
- Last Synced: 2025-03-24T09:11:36.522Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 280 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gerrit-f-button
Baby, the F button is back.
## Installation
There are two ways to use this super cool script: either by installing it
globally for all users, or by injecting it into the page to keep all the
cool to yourself.
### Global installation (all users)
Download the script and place it inside the `$site_path/static` directory
of your Gerrit installation. Then you only need to inject in one of the
Gerrit theme files, like `etc/GerritSiteHeader.html` if you're using the default theme:
```html
```
You *will* need jQuery, so if you don't have it, load it from the
CDN before loading the script:
```html
```
Make sure to restart Gerrit once this is all done. Press F in one
of the patchset pages and bask yourself in glory.
### Local installation
Use something like [greasemonkey](http://www.greasespot.net/) to inject the
script `gerrit-f-button.js`. It inlines all the CSS it needs and should work
in such an environment without any modifications.
I used [TamperMonkey](http://tampermonkey.net/) on Chrome.
The script expects `Gerrit` and `jQuery` to become available on `window`
within 30 seconds since it gets loaded, otherwise it will not work. If it works, you can see a message on the console saying "gerrit-f-button" is active or something.
## Usage
Simply press F (or f) when you're viewing a change (or a file in a change revision) to bring up the F-button frame. Please keep in mind that this
script is so cool that it naturally expects users to be as cool (or cooler,
if that's even possible), so if you're lacking on cool, I advise you to
work on that first.
But wait, there's more.
Should you either intentionally or via the casual faceroll happen to land
on a `CTRL + META + SHIFT + F` key combination, the F panel will
unconditionally take itself to the stage. No seriously, this is quite useful to
accommodate a keyboard-only reviewing flow since Gerrit's editor will normally
steal all (well, _most_) key presses, preventing you from reaching out to the
panel, pressing this combination will forcefully steal the focus away from the
editor and pass it on to the glorious F frame.
If you're thinking the combination is mad, well, you may be right, but it's only because having scripts steal and manage focus is so maddening in the
first place, it was only appropriate to make an opt-in behavior just as
maddening.
## Changelog
#### 2.1.4
- Now publishing to NPM
#### 2.1.3
- No longer intercepts J, K, or RETURN if the popup is not shown.
#### 2.1.2
- No longer toggles for CMD+F or CTRL+F.
#### 2.1.1
- Version is now attached in the banner inside `gerrit-f-button.js`
#### 2.1.0
- Added an option to hide the panel in Unified Diff view since Gerrit still
supports the native F button functionality there
- Added an option to display files in a "list" view; no folders, full filepaths
similar to the legacy F UI
- Added an option to display the panel as an overlay, similar to the legacy
F UI
- Keyboard navigation is now possible using J, K, and RETURN
- (internal) Broke the thing into modules since it was getting big
#### 2.0
- Files are now displayed in a tree view, upping the glory factor to a
Phabricating level (oh-uh)
- Removed the option for showing the comment bodies in-line as it was useless
within such a confined space (and usually you needed the code context to
make sense of the comments anyway)
#### 1.1.0
- The popup will no longer show up if you're writing in an `` or a `` widgets
## License
MIT