Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 6.46 KB

README.md

File metadata and controls

85 lines (57 loc) · 6.46 KB
Raw

Mojira Plus Browser Extension

This is a browser extension enabling various additional features on Mojang's bug tracker Mojira for helpers, moderators, and other Mojira power users.

This extension has primarily been created for and tested in Mozilla Firefox. However, it should also work in Chromium-based browsers, such as Google Chrome, Opera, and modern versions of Microsoft Edge.

Helper messages

⚠ Please note that the helper messages included in this extension may only be used on the bug tracker by helpers, moderators or Mojang staff. Do not use them yourself if you do not belong to one of these groups, as it may confuse users regarding your role.

This extension simplifies the mod and helper workflow on Mojira. It integrates the helper messages from the helper-messages repository directly into the Mojira interface, so that messages can be pasted very easily without the need of visiting another website.

On top of that, it always keeps the messages up-to-date with the latest version from the helper-messages repository.

More information about how to use this feature of the extension can be found below.

Custom activity module sorting

This extension adds two additional sort modes to the activity section on bug reports: "Newest last" and "Oldest last". They are the same as "Oldest first" and "Newest first", respectively, but instead of omitting items at the bottom of the list when there are too many, they omit items at the top of the list. This restores the behaviour from previous versions of Jira.

Postpone button

The postpone button is only seldomly used, and instead usually is clicked by mistake. This extension provides an option to either hide it completely or show a warning before the issue is actually postponed.

Installation

Extension store (recommended)

Download and install the extension on the Mozilla add-on page or the Chrome web store.

Firefox (manual)

  1. Select the latest version of the extension on the releases page.
  2. Click on the .xpi file
  3. Follow the instructions on the popups that show up in order to install the extension

You now have installed the extension successfully. If this is enabled in the browser settings, it will be automatically updated whenever there's a new version of it available.

Google Chrome and other Chromium-based browsers (manual)

  1. Select the latest version of the extension on the releases page.
  2. Download the .zip file
  3. Extract the .zip file into a folder and place it somewhere on your system
  4. Open chrome://extensions
  5. Enable developer mode
  6. Click on "Load unpacked extension"
  7. Select the folder you placed the source files in

You now have installed the extension successfully. It will not be automatically updated, and on every browser restart you will be warned about having developer extensions enabled.

Usage

When the addon recognizes a Mojira text field, it automatically highlights it in a green color to indicate that the addon is active. At the same time, it adds an additional "Add Message" button to the toolbar of that text field. You can use that button to insert messages and view all available messages along with their shortcuts.

You can also insert messages by typing the shortcut of the message prefixed with a configurable prefix into the text field.

Currently, both methods only work with the "Text" version of the text field. In "Visual" mode, the addon will not function properly!

Once a text field is initialized, its available messages will no longer change, even if the addon settings have been changed. You need to reload the page in order for any potential changes to take effect.

Message updates

The addon regularily checks whether the helper messages have been updated, and if they have, it automatically saves the new messages and continues to use the new version. This is indicated by a badge on the Mojira icon.

While the addon is checking for updates, the badge is green and displays a question mark.

When the addon has found an update, the badge turns blue and contains the letter "i", and if an error occurred, it is red with an exclamation mark. These two badges can be dismissed by clicking on the icon.

Settings

You can configure the addon by clicking the Mojira icon in the browser's toolbar. There you can configure which messages you want to use, and how often (if at all) the addon should check for message updates.

Contributing

Issues and pull requests are always very much appreciated. If you want to help developing the extension, here are a few tips:

  • Run npm i in order to install the needed dependencies. Currently this only includes the type definitions for web extensions.
  • You need to install web-ext globally (use npm i -g web-ext)
    • You might encounter warnings when installing it if you use NPM version 7 or newer, but you should be able to ignore them
    • web-ext is not a (dev) dependency of this project because of the large amount of dependencies it has, causing unnecessary maintenance cost.
    • Update web-ext regularily.
  • Run npm run build in order to build the current version of the extension and to load the required dependencies into the correct folder.
  • Run web-ext run in order to launch a blank instance of Firefox where your addon is running. The addon is reloaded every time a file is changed.
  • You can visit about:debugging in that Firefox instance and access the addon's console and dev interface from the "This Firefox" tab.
  • You can run npm run lint in order to check whether the addon has any issues that might prevent it from being signed.

Publishing

When a new version is released, it first needs to be signed by Mozilla. After this is done, the addon file is uploaded to the "releases" page and the version manifest in the releases branch is updated.

For the Chromium version of the extension, the file from npm run build can directly be used.