From b838fdb2d260b730eb6e1076820b753f0bffc1c0 Mon Sep 17 00:00:00 2001 From: girst Date: Wed, 27 Nov 2019 22:10:58 +0100 Subject: [PATCH] Require Firefox 68 and Update Documentation since the removal of the XBL-aware getAllElements() code path, this extension is less useful on .xul pages (i.e. some about: pages) in older Firefoxen. Users of older versions of Firefox (or derivatives) should stay on v0.22.2. While nobody is stopping you from downgrading or ignoring the min-version requirement, you don't gain any new functionality and might have a degraded experience with v0.23.x. --- README.md | 19 ++++++------------- documentation/installation.md | 4 +++- documentation/tools.md | 6 ++++-- package.json | 2 +- 4 files changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 05ff9be..ff13869 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,23 @@ # VimFx – Vim keyboard shortcuts for Firefox -**Note:** VimFx is a _legacy_ Firefox extension, which is **not** [compatible -with Firefox 57+][firefox-57+]. (And never will be.) +**Note:** VimFx is a _legacy_ extension for Firefox 68+, requiring the +[LegacyFox] shim ([see also]). -If you’re looking for a replacement for VimFx, check out these extensions: +If you’re looking for a WebExtension replacement for VimFx, check out these +extensions: - [Vimium-FF] - [Saka Key] - [Vim Vixen] - [Tridactyl] -You might also want to check out how to [patch Firefox to work with VimFx] and -its accompanying [blog post]. - -(VimFx won’t be transformed into a WebExtension, because it is a big task that -nobody has felt like tackling and not all necessary APIs are available. However, -the source code is free, so if you feel like giving it a shot you can totally do -so!) - [firefox-57+]: https://support.mozilla.org/en-US/kb/firefox-add-technology-modernizing [Vimium-FF]: https://addons.mozilla.org/firefox/addon/vimium-ff/ [Saka Key]: https://addons.mozilla.org/firefox/addon/saka-key/ [Vim Vixen]: https://addons.mozilla.org/firefox/addon/vim-vixen/ [Tridactyl]: https://addons.mozilla.org/firefox/addon/tridactyl-vim/ -[patch Firefox to work with VimFx]: https://github.com/girst/LegacyFox -[blog post]: https://gir.st/blog/legacyfox.htm +[LegacyFox]: https://github.com/girst/LegacyFox +[see also]: https://gir.st/blog/legacyfox.htm --- diff --git a/documentation/installation.md b/documentation/installation.md index c594e69..cfd9ab2 100644 --- a/documentation/installation.md +++ b/documentation/installation.md @@ -1,9 +1,11 @@ # Installation -First off, you need a Firefox version old enough to support _legacy_ extensions. +First off, you need Firefox version 68+ (or a compatible fork) and the +[LegacyFox] shim. See [README.md] for more information. [README.md]: ../README.md +[LegacyFox]: https://github.com/girst/LegacyFox ## ⚠️ NO LONGER AVAILABLE ⚠️
Option 1: [addons.mozilla.org] \(AMO) diff --git a/documentation/tools.md b/documentation/tools.md index 75de0a2..10522d4 100644 --- a/documentation/tools.md +++ b/documentation/tools.md @@ -41,8 +41,7 @@ Note that the built .xpi file is [unsigned]. ### Development -First off, you need a Firefox version old enough to support _legacy_ extensions. -See [README.md] for more information. +First off, you need Firefox version 68 (or a compatible fork) and [LegacyFox]. 1. Create a new [Firefox profile] for development. @@ -51,9 +50,12 @@ See [README.md] for more information. An easy workflow is code, `gulp`, test, repeat. (Use `gulp -t` to also run the unit tests.) +Note that loading VimFx as temporary extension does not work in Firefox Quantum. + [README.md]: ../README.md [Firefox Profile]: https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles [Extension Auto-Installer]: https://addons.mozilla.org/firefox/addon/autoinstaller +[LegacyFox]: https://github.com/girst/LegacyFox ## Gulp tasks diff --git a/package.json b/package.json index cefef6b..c22cb97 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "VimFx", "version": "0.22.2", "firefoxVersions": { - "min": "45.0", + "min": "68.0", "max": "*" }, "license": "MIT", -- 2.39.3