Fix #235 Rewrite NTT as webextension

.gitignore

@@ -1,4 +1,2 @@
-./xpi/
-{8620c15f-30dc-4dba-a131-7c5d20cf4a29}
-*.xpi
 .DS_Store
+web-ext-artifacts/

History.md

@@ -1,3 +1,7 @@
+4.0 / TBD
+==================
+  * Rewrite extension to use the WebExtension API since the legacy XUL format is no longer supported (#235)
+
 3.10 / 2017-05-16
 ==================
   * Update maxVersions of applications in install.rdf (#238)

README.md

@@ -1,44 +1,70 @@
 # Nightly Tester Tools
-Nightly Tester Tools is an addon for aiding testers of nightly builds of Mozilla apps like Firefox and Thunderbird. Some features are:
-
-* Copy Build ID to Clipboard
-* Copy List of Extensions to Clipboard
-* Copy about:support to Pastebin
-* Open Profile Folder
-* Open Pushlog
-* Screenshots utility
-* Title bar customization
+
+Nightly Tester Tools (NTT) is an add-on for aiding testers of Nightly builds of Mozilla apps including Firefox.
+
+<img src="screenshot.png" alt="Screenshot" width="400" height="300">
+
+## Features
+
+* Copy the build ID or list of extensions to the clipboard using the toolbar button
+* Insert the build ID or list of extensions into a textbox using the context menu
+* Option to customize the Title Bar
+
+## Limitations
+
+There are a couple of known issues due to the limited [WebExtensions APIs](https://developer.mozilla.org/Add-ons/WebExtensions/API):
+
+* The changeset cannot be retrieved
+* The extension list does not include system add-ons
+* Some variables are not available for the custom title template
+
+The following features found in the original XUL-based extension are not yet implemented, and some of them may not be implemented again:
+
+* Copy `about:support` to Pastebin
+* Open the profile folder (Use `about:support` or `about:profile` page instead to open it)
+* Open the pushlog
+* Screenshot utility (Use [Firefox Screenshots](https://support.mozilla.org/kb/firefox-screenshots) instead)
 * Crash options
-* Extension compatibility fixing
+* Extension compatibility fixer
+* Menu items under Tools
+
+## Compatibility
+
+The current WebExtension version is only compatible with Firefox. Use legacy [version 3.10](https://addons.mozilla.org/firefox/addon/nightly-tester-tools/versions/3.10) for Thunderbird and SeaMonkey.
 
-# Install
-You can install the latest stable NTT from [addons.mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/nightly-tester-tools/). To install for development, clone the repo:
+## Install
 
-    git clone git://github.com/mozilla/nightlytt.git
+You can install the latest stable NTT from [addons.mozilla.org](https://addons.mozilla.org/firefox/addon/nightly-tester-tools/).
 
-then add a file titled '{8620c15f-30dc-4dba-a131-7c5d20cf4a29}' to the "extensions" directory in your [profile folder](http://kb.mozillazine.org/Profile_folder) with the text:
+To install for development, clone the repo:
 
-    ~/nightlytt/
+```
+git clone git://github.com/mozilla/nightlytt.git
+```
 
-or whatever the path to your nightlytt folder is.
+Install the [`web-ext` command line tool](https://developer.mozilla.org/Add-ons/WebExtensions/Getting_started_with_web-ext):
 
-To package the extension into an xpi for distribution simply `ant` and the default dev script/target will be invoked:
+```
+npm install --global web-ext
+```
 
-    ant
+To test with Firefox:
 
-You can override the build number used in the filename:
+```
+web-ext run -s extension
+```
 
-    ant -Dbuild.number=1
+To build for release:
+```
+web-ext build -s extension
+```
 
-To build for release (no build number in filename):
+You can also [temporarily install the extension](https://developer.mozilla.org/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) in your Firefox without having to use `web-ext`.
 
-    ant release
+## Development
 
-# Development
 All bugs and feature requests are filed in the Nightly Tester Tools project at GitHub. You can [view the list of open issues](https://github.com/mozilla/nightlytt/issues), or you can [file a new issue](https://github.com/mozilla/nightlytt/issues/new). Check out [the wiki](https://wiki.mozilla.org/Auto-tools/Projects/NightlyTesterTools) for a list of current and proposed features and feel free to file bugs and submit patches.
 
-This project uses [.editorconfig](http://editorconfig.org/#overview), which sets defaults for the formatting of the code. So enjoy the use of [compatible editor](http://editorconfig.org/#download). Just download and install the corresponding plugin.
+This project uses [`.editorconfig`](http://editorconfig.org/#overview), which sets defaults for the formatting of the code. So enjoy the use of [compatible editor](http://editorconfig.org/#download). Just download and install the corresponding plugin.
 
-# Related Add-ons
-* [Add-on Compatibility Reporter](https://addons.mozilla.org/en-US/firefox/addon/add-on-compatibility-reporter/)
-* [Screengrab (fix version)](https://addons.mozilla.org/en-US/firefox/addon/screengrab-fix-version/)
+Also, it's encouraged to use the `web-ext lint` command to [check the code](https://developer.mozilla.org/Add-ons/WebExtensions/Getting_started_with_web-ext#Checking_for_code_lint).

extension/_locales/en_US/messages.json

@@ -0,0 +1,113 @@
+{
+  "extension_name": {
+    "message": "Nightly Tester Tools"
+  },
+  "extension_description": {
+    "message": "Useful tools for the nightly tester."
+  },
+  "copy_build_info": {
+    "message": "Copy Build ID to Clipboard"
+  },
+  "insert_build_info": {
+    "message": "Insert Build ID into Textbox"
+  },
+  "insert_build_info_context": {
+    "message": "Insert Build ID"
+  },
+  "copy_extension_list": {
+    "message": "Copy List of Extensions to Clipboard"
+  },
+  "insert_extension_list": {
+    "message": "Insert List of Extensions into Textbox"
+  },
+  "insert_extension_list_context": {
+    "message": "Insert List of Extensions"
+  },
+  "open_options_page": {
+    "message": "Options…"
+  },
+  "customize_title": {
+    "message": "Customize Title Bar"
+  },
+  "enable_custom_title": {
+    "message": "Use custom title"
+  },
+  "custom_template": {
+    "message": "Custom title template:"
+  },
+  "variable_table_caption": {
+    "message": "The following variables can be used in the title (case insensitive)."
+  },
+  "variable_key": {
+    "message": "Variable"
+  },
+  "variable_desc": {
+    "message": "Description"
+  },
+  "variable_value": {
+    "message": "Value"
+  },
+  "variable_AppID": {
+    "message": "Application Identifier"
+  },
+  "variable_Vendor": {
+    "message": "Application Vendor"
+  },
+  "variable_Name": {
+    "message": "Application Name"
+  },
+  "variable_Version": {
+    "message": "Application Version"
+  },
+  "variable_AppBuildID": {
+    "message": "Application Build Identifier"
+  },
+  "variable_Changeset": {
+    "message": "Built from that changeset"
+  },
+  "variable_PlatformBuildID": {
+    "message": "Gecko Platform Build Identifier"
+  },
+  "variable_PlatformVersion": {
+    "message": "Gecko Platform Version"
+  },
+  "variable_GeckoBuildID": {
+    "message": "Gecko Build Identifier"
+  },
+  "variable_GeckoVersion": {
+    "message": "Gecko Version"
+  },
+  "variable_BrandName": {
+    "message": "Application Brand Name"
+  },
+  "variable_UserAgent": {
+    "message": "User Agent String"
+  },
+  "variable_Locale": {
+    "message": "Current Locale"
+  },
+  "variable_OS": {
+    "message": "Compilation OS"
+  },
+  "variable_Processor": {
+    "message": "Compilation Processor"
+  },
+  "variable_Compiler": {
+    "message": "Compiler"
+  },
+  "variable_DefaultTitle": {
+    "message": "Default Application Title"
+  },
+  "variable_TabTitle": {
+    "message": "Current Tab's Title"
+  },
+  "variable_Profile": {
+    "message": "Current Profile"
+  },
+  "variable_Toolkit": {
+    "message": "Graphics Toolkit"
+  },
+  "variable_TabsCount": {
+    "message": "Count of visible tabs"
+  }
+}

extension/_locales/ja/messages.json

@@ -0,0 +1,113 @@
+{
+  "extension_name": {
+    "message": "Nightly Tester Tools"
+  },
+  "extension_description": {
+    "message": "開発版のテスト利用者のための有用なツールを提供します"
+  },
+  "copy_build_info": {
+    "message": "ビルド ID をクリップボードにコピー"
+  },
+  "insert_build_info": {
+    "message": "ビルド ID をテキストボックスに挿入"
+  },
+  "insert_build_info_context": {
+    "message": "ビルド ID を挿入"
+  },
+  "copy_extension_list": {
+    "message": "アドオンの一覧をクリップボードにコピー"
+  },
+  "insert_extension_list": {
+    "message": "アドオンの一覧をテキストボックスに挿入"
+  },
+  "insert_extension_list_context": {
+    "message": "アドオンの一覧を挿入"
+  },
+  "open_options_page": {
+    "message": "オプション..."
+  },
+  "customize_title": {
+    "message": "タイトルバーのカスタマイズ"
+  },
+  "enable_custom_title": {
+    "message": "カスタマイズしたタイトルを使用する"
+  },
+  "custom_template": {
+    "message": "書式"
+  },
+  "variable_table_caption": {
+    "message": "タイトルには以下の変数が使用できます (大文字小文字は区別しません)"
+  },
+  "variable_key": {
+    "message": "変数"
+  },
+  "variable_desc": {
+    "message": "説明"
+  },
+  "variable_value": {
+    "message": "現在の値"
+  },
+  "variable_AppID": {
+    "message": "アプリケーション ID"
+  },
+  "variable_Vendor": {
+    "message": "アプリケーションのベンダー"
+  },
+  "variable_Name": {
+    "message": "アプリケーションの名称"
+  },
+  "variable_Version": {
+    "message": "アプリケーションのバージョン"
+  },
+  "variable_AppBuildID": {
+    "message": "アプリケーションのビルド ID"
+  },
+  "variable_Changeset": {
+    "message": "ビルド元のチェンジセット"
+  },
+  "variable_PlatformBuildID": {
+    "message": "Gecko プラットフォームのビルド ID"
+  },
+  "variable_PlatformVersion": {
+    "message": "Gecko プラットフォームのバージョン"
+  },
+  "variable_GeckoBuildID": {
+    "message": "Gecko のビルド ID"
+  },
+  "variable_GeckoVersion": {
+    "message": "Gecko のバージョン"
+  },
+  "variable_BrandName": {
+    "message": "アプリケーションのブランド名"
+  },
+  "variable_UserAgent": {
+    "message": "ユーザーエージェント文字列"
+  },
+  "variable_Locale": {
+    "message": "現在の言語"
+  },
+  "variable_OS": {
+    "message": "コンパイルの対象 OS"
+  },
+  "variable_Processor": {
+    "message": "コンパイルの対象プロセッサー"
+  },
+  "variable_Compiler": {
+    "message": "コンパイラー"
+  },
+  "variable_DefaultTitle": {
+    "message": "現在のアプリケーションのタイトル"
+  },
+  "variable_TabTitle": {
+    "message": "現在のタブのタイトル"
+  },
+  "variable_Profile": {
+    "message": "現在のプロファイル"
+  },
+  "variable_Toolkit": {
+    "message": "グラフィックツールキット"
+  },
+  "variable_TabsCount": {
+    "message": "表示されたタブの数"
+  }
+}