Chrome and Firefox extension that improves Bitbucket's user experience
Clone or download
reyronald Add Flow (#247)
Introduce [Flow](http://flow.org/) for static type checking.

There is a lot of type casting through `any` for `.querySelector` and
DOM related operations. This is intentional! The intent is to have the
extension blow up and crash instead of silently failing when Bitbucket's
DOM structure changes and is not as the extension expects, this will
allow me to use those stack traces to pinpoint the exact place of
failure and fix it faster and easier.
Latest commit 6afde68 Sep 11, 2018
Permalink
Failed to load latest commit information.
.vscode Add Flow (#247) Sep 11, 2018
flow-typed Add Flow (#247) Sep 11, 2018
scripts chore: Upgrade almost every dependency in package.json (#246) Sep 5, 2018
src Add Flow (#247) Sep 11, 2018
test chore: Upgrade almost every dependency in package.json (#246) Sep 5, 2018
.codeclimate.yml Adds code climate file to ignore some paths Jun 30, 2016
.editorconfig Changes .editorConfig and readme Apr 12, 2016
.env.example dev: Automated Firefox deployment (#103) Jan 9, 2018
.flowconfig Add Flow (#247) Sep 11, 2018
.gitconfig feat(pr-created-on): add "created on" date to PR entry (#142) Feb 23, 2018
.gitignore chore: move everything from extension to src folder (#108) Jan 19, 2018
.prettierignore release(v3.6.0): prepare for next release Feb 11, 2018
.prettierrc.js chore: Upgrade almost every dependency in package.json (#246) Sep 5, 2018
.travis.yml feat(ignore-whitespace): transform pr link to ignore whitespace by de… Nov 20, 2017
CHANGELOG.md Add Flow (#247) Sep 11, 2018
CODE_OF_CONDUCT.md feat: Merge commit message template (#243) Sep 2, 2018
CONTRIBUTORS.md feat: Merge commit message template (#243) Sep 2, 2018
DIFF_HTML_TEMPLATES.md feat: add "Show comments" checkbox (#196) May 20, 2018
LICENSE Create LICENSE Jan 9, 2018
PULL_REQUEST_TEMPLATE.md feat: Merge commit message template (#243) Sep 2, 2018
README.md feat(autolinker): Link URLs and emails in diffs (#245) Sep 2, 2018
logo-full-white.svg Add new logo & icons (#166) Mar 12, 2018
logo-full.svg Add new logo & icons (#166) Mar 12, 2018
package-lock.json Add Flow (#247) Sep 11, 2018
package.json Add Flow (#247) Sep 11, 2018
webpack.config.js chore: Upgrade almost every dependency in package.json (#246) Sep 5, 2018

README.md

build status - downloads - code style: prettier

Refined BitBucket

We all know BitBucket lacks some features that we have in other platforms like GitHub, GitLab and others. Originally inspired on Sindre Sorhus' Refined Github extension, refined-bitbucket is born as a collaborative project by a few developers to improve upon those holes, and even add some additional functionality that will enhance the overall user experience.

Subscribe to this issue if you would like to receive e-mail notifications on updates.

Current features

  • Adds syntax highlighting for pull requests and commits. See the full list of enabled languages here, and then here. Test them here. Missing any language? Let me know or submit a pull request!

  • Double click on a word to highlight all occurrences.

  • Block pull request merging without a minimum number of approvals (defaults to 2 minimum approvals). Removed. Implemented natively by Bitbucket with "merge checks"

  • Key binding feature, which allows for quicker navigation through pull requests.

  • Button to collapse diffs in Pull Request and Commits view.

  • Autocollapse:

    • Add filename patterns in the Options page that you would like the extension to collapse automatically when the pull request or commit loads.
    • Deleted files are automatically collapsed.
  • Diff Ignore. Add filename patterns in the Options page that you would like the extension to completely remove when the pull request or commit loads.

  • Counters for open or active branches and pull requests in the sidebar navigation menu.

  • Button to load all failed diffs in pull request and commit view.

  • Adds 'Create Pull Request' link to the 'Compare branches and tags' page.

  • Choose a default merge strategy for your pull requests. Also implemented natively by Bitbucket per project

  • Check the "Close anchor branch" checkbox by default when creating or editing pull requests.

  • Add source branch, linkify branch names, add creation date and last person to interact with the pull request (commit, comment or approval) to each pull request row in pull request list.

  • Don't carry pluses and minuses to clipboard when copying diff's contents.

  • Badge with the number of commits of the current pull request next to the "Commits" tab.

  • Set custom tab indentation size of code (Bitbucket defaults to 8 spaces) when viewing commits/pull requests.

  • Insert "Comments" checkbox in diff header to toggle comments.

  • Insert "Copy filename to clipboard" button in diff header.

  • Define your own custom CSS styles to be applied to Bitbucket.

  • URLs and emails in diffs automatically become real clickable links.

  • Include a PULL_REQUEST_TEMPLATE.md file in the default branch of the repository in one of the locations below, and the contents of that file template will replace the default pull request body inserted by Bitbucket when creating a new one.

    /PULL_REQUEST_TEMPLATE.md
    /docs/PULL_REQUEST_TEMPLATE.md
    /.github/PULL_REQUEST_TEMPLATE.md
    /.bitbucket/PULL_REQUEST_TEMPLATE.md
    

    Please note that the filename IS case sensitive (must be all caps), and MUST have the .md file extension. No other file extensions will be recognized. The file to be used will be the first to be found in one of these locations (from top to bottom).

    It's also possible to specify a URL for a raw Gist with the contents of the template in the options page, in case you don't want to include the file in your repository, e.g., https://gist.githubusercontent.com/anonymous/8054a3ee32f7cf1a5975e3fd52b3c5f3/raw/f6897720e8b6b93becd246187dac36038291c3a4/PULL_REQUEST_TEMPLATE.md.

    Note: Currently, externally hosted pull request templates outside of BitBucket's domain is not supported with the Firefox addon.

  • Similar to how the pull request template feature works, it is now possible to configure the extension to replace the default merge commit message for pull requests with a template that has access to dynamically injected variables like the pull request title, description, source and destination branch, and more. Click here for a more in-depth explanation

Some images

Syntax highlighting
syntax-hl1 syntax-hl2
Pull request list
(notice the source branch name and creation date)
source-branch
The Options page.
Diff ignore and Load all diffs
options Diff ignore
pullrequest-ignore
Load all diffs
load-all-diffs
Collapse diff Occurrences highlighter
collapse-diff bottom-collapse occurrences-highlighter
Sidebar counters
expanded
Expanded
collapsed
Collapsed

Installing

refined-bitbucket is available on the Google Chrome Web Store and Add-ons for Firefox. When installed, go check the extension's Options to customize it to your needs.

Sometimes the extension is not immediately picked up by the browser after installation. If this happens to you, log out of Bitbucket and then log back in, or clear your cache.

Default Key Mapping

The following are the default key mappings

Tab Selection

bitbucket pull request tabs

Key Action
1 Selects the Overview tab
2 Selects the Commits tab
3 Selects the Activity tab

Page Navigation and Scrolling

Upper case letters mean that you need to press shift and the letter

Key Action
N (Shift+n) Scrolls to the Next comment on the page.
P (Shift+p) Scrolls to the Previous comment on the page.
g g Scrolls to the top of the page
G (Shift+g) Scrolls to the bottom of the page

Can I use this on Bitbucket Server?

Sadly, no :(. Although Bitbucket Server and Bitbucket Cloud share a similar name, both are actually two completely different products. Read this comment for a more detailed explanation.

Compiling & Contributing

Contributions are very appreciated! Even if you can't contribute with a pull request, if you stumble upon any weird behavior or bugs, let us know with an issue!

If you want to run a development version of the extension, clone the repo and run the following commands:

npm install
npm run watch

This will watch any changes in the src folder and compile them to the extension folder.

Chrome Development

To test in Chrome, activate the Developer mode in chrome://extensions, click "Load unpacked extension..." and browse to that folder. If you're new to Chrome extension development, take some time to read Google's documentation on extensions.

Firefox Development

To test in Firefox, open about:debugging in a new tab and click "Load Temporary Add-on". Navigate to the extension folder and load manifest.json. For further Firefox add-on development & debugging help, please refer to Mozilla's documentation.

Integration

There is a test suite included. Before sending a pull request please make sure all tests are passing by running:

npm test

License

MIT © refined-bitbucket