Google Git
Sign in
gerrit / plugins / codemirror-editor / de723fb887100a0da85673ba9fcd7b02ae1364e3
commitde723fb887100a0da85673ba9fcd7b02ae1364e3[log] [tgz]
authorPaladox none <thomasmulhall410@yahoo.com>Mon Aug 02 00:31:59 2021 +0000
committerPaladox none <thomasmulhall410@yahoo.com>Tue Aug 03 23:29:31 2021 +0000
treee90e26ca0fdf6ff1c962a5fe4aa1fcd07783b6ce
parente0a67217ae5359797570481cbb6e8aa1f5e0a7c3 [diff]
Improve performance in the editor

We stop setting viewportMargin and instead use the default value.

We also add support for the inbuilt search support within codemirror.
This is because with the removal of viewportMargin you cannot use
the browsers search to search for the code.

In my view i think this is a good trade off as you'll still be able to
search using the codemirror searching support whilst improving performance for large documents.

In GWTUI we didn't set viewportMargin.

Bug: Issue 14845
Change-Id: I84f12168c4784cf40ca102f025b7805b44bc9d9a
4 files changed
tree: e90e26ca0fdf6ff1c962a5fe4aa1fcd07783b6ce
  1. gr-editor/
  2. java/
  3. test/
  4. .eslintrc.json
  5. .gitignore
  6. .mailmap
  7. BUILD
  8. LICENSE
  9. package-lock.json
  10. package.json
  11. README.md
README.md

CodeMirror Editor

A plugin that uses CodeMirror to provide a rich code editing experience in PolyGerrit.

UI plugin

This plugin is rewritten into Polymer 3 syntax. The gr-editor.js is the main entry for the plugin.

But to support the lazy load on the codemirror with supported languages, we still have the codemirror-element.html as an asset which still built separately as an html.

We may consider drop the selectively language support and in favor of all-in-one bundle in the future or change build rule to support bundle css in js to move off of the html completely.

UI tests

To run UI tests here will need install dependencies from both npm and bower.

npm run wct-test should take care both for you, read more in package.json.

You will need polymer-bridges which is a submodule you can clone from: https://gerrit-review.googlesource.com/admin/repos/polymer-bridges

As polymer 3 no longer support Polymer.importHref anymore, this plugin still supports it through a custom implementation in gr-editor.js.

Test plugin on Gerrit

  1. Build the bundle locally with: bazel build :codemirror_editor
  2. Serve your generated ‘codemirror_editor.js’ somewhere, you can put it under gerrit/plugins/codemirror-editor/ folder and it will automatically served at http://localhost:8081/plugins_/codemirror-editor/
  3. Use FE dev helper, https://gerrit.googlesource.com/gerrit-fe-dev-helper/, inject the local served ‘codemirror_editor.js’ to the page

If your plugin is already enabled, then you can block it and then inject the compiled local verison.

See more about how to use dev helper extension to help you test here: https://gerrit.googlesource.com/gerrit-fe-dev-helper/+/master