|author||Frank Borden <firstname.lastname@example.org>||Thu Sep 08 17:54:34 2022 +0200|
|committer||Frank Borden <email@example.com>||Thu Sep 08 20:01:14 2022 +0200|
Adjust readme to refer to new dev server It does not serve plugins so added a note that you should serve plugin files directly Change-Id: I4a91cbe2b4e7004ac699e013087aa792aebf1c3b
Gerrit FE Dev helper is a chrome extension that will focus on helping frontend developers on Gerrit development.
As mentioned in readme from polygerrit-ui, we already support to start your local host for developing / debugging / testing, but it has quite a few restrictions:
To solve these pain points, I created this chrome extension that basically just proxy all assets requests or any requests to local server, and you will have the ability to inject any plugins from local as well.
See in release notes.
npm install npm run build
Then you should have
gerrit_fe_dev_helper.zip that you can test with, or download from chrome web store here: https://chrome.google.com/webstore/detail/gerrit-fe-dev-helper/jimgomcnodkialnpmienbomamgomglkd.
After you installed and enabled the extension, you should see something similar to demo.png.
Or if you are developing a plugin, serve your plugin locally via any means. Ex:
npx http-server -c-1 --cors
Gerrit dev helper is enabled), and now your gerrit assets should be loaded from local server
The extension comes with a set of default rules, but you can change the rules by just clicking the extension icon again.
The extension supports six different type of rules:
The two options of injecting any plugins meant to help you develop your plugins for your gerrit sites.
injectHtmlPlugin rule or use
redirect rule if its an existing html plugin.
For single-file js plugins, use
injectJsPlugin rule or use
redirect if its an exising js plugin.
For multi-file modularized js plugins (you have import / export in source code), you have two options:
injectJsModule, this will load the js with
type="module", and due to restriction of
type="module", Gerrit won't be able to recognize the plugin without a proper url set when calling
Gerrit.install, so you also need to tweak your code to call
Gerrit.install(callback, undefined, 'http://localhost:8081/plugins_/checks/gr-checks/gr-checks.js')to let Gerrit treat it as a legit plugin
type="module", and then treat it as a html plugin
Either way, you need to block the existing plugin if its already on the page.
Please don't hesitate to contact firstname.lastname@example.org for support on this extension.