grunt-mozilla-addon-sdk
Download and Run Mozilla Addon SDK
Getting Started
This plugin requires Grunt ~0.4.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-mozilla-addon-sdk --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-mozilla-addon-sdk');
The "mozilla-addon-sdk" tasks
Overview
In your project's Gruntfile, add a section named mozilla-addon-sdk
to the data object passed into grunt.initConfig()
to define a Mozilla Addon SDK to download and use.
grunt.initConfig({
"mozilla-addon-sdk": {
'1_14': {
options: {
revision: "1.14"
}
},
'master': {
options: {
revision: "master",
github: true,
}
}
},
"mozilla-cfx-xpi": {
'stable': {
options: {
"mozilla-addon-sdk": "1_14",
extension_dir: "ff_extension",
dist_dir: "tmp/dist-stable"
}
},
'experimental': {
options: {
"mozilla-addon-sdk": "master",
extension_dir: "ff_extension",
dist_dir: "tmp/dist-experimental"
}
},
},
"mozilla-cfx": {
'run_stable': {
options: {
"mozilla-addon-sdk": "1_14",
extension_dir: "ff_extension",
command: "run"
}
},
'run_experimental': {
options: {
"mozilla-addon-sdk": "master",
extension_dir: "ff_extension",
command: "run"
}
}
}
});
Custom cfx command could be defined using a section named mozilla-cfx
:
grunt.initConfig({
"mozilla-addon-sdk": {
"1_14": {
...
}
},
"mozilla-cfx": {
custom_command: {
options: {
"mozilla-addon-sdk": "1_14",
extension_dir: "ff_extension",
command: "run",
arguments: "-b /usr/bin/firefox-nightly -p /tmp/PROFILE_REUSED"
}
}
}
})
NOTE: all tasks use FIREFOX_BIN
and FIREFOX_PROFILE
environment variables, if defined, to customize the Firefox binary and Firefox profile dir used to run or test the extension.
mozilla-addon-sdk
"mozilla-addon-sdk" is a grunt multi-task which supports the following task options
revision
Type: String
Default value: undefined
A string value that is used as the Mozilla Addon SDK revision to download and use to
build addon xpi.
github
Type: Bool
Default value: false
A boolean value used to download a Mozilla Addon SDK from a github repo archive.
By default its value is false (addon-sdk archive downloaded from official
ftp.mozilla.org releases), set it to true if you want to use a development release
from github.
github_user
Type: String
Default value: mozilla
A string value used as Github User for addon-sdk github archive to downloads, it could
be used to use a different github fork of the original mozilla addon-sdk repo.
mozilla-cfx-xpi
"mozilla-addon-sdk" is a grunt multi-task which builds addon xpi archives using the
available addon-sdk revisions.
"mozilla-addon-sdk"
Type: String
Default value: null
A string value used to set the addon-sdk (as named in the "mozilla-addon-sdk" section) to
be used to create the xpi archive.
extension_dir
Type: String
Default value: null
A string value that is used as the path which contains the addon extension to build.
dist_dir
Type: String
Default value: null
A string value that is used as the path where the generated addon xpi should be moved.
mozilla-cfx
"mozilla-addon-sdk" is a grunt multi-task which run cfx command line tool on a extension
directory using the available addon-sdk revisions.
"mozilla-addon-sdk"
Type: String
Default value: null
A string value used to set the addon-sdk (as named in the "mozilla-addon-sdk" section) to
be used to run the defined cfx command.
extension_dir
Type: String
Default value: null
A string value that is used as the path which contains the addon extension to build.
command
Type: String
Default value: null
A string value that is used as the cfx command to run.
arguments
Type: String
A string value that is used to pass arguments to the cfx command to run.
Usage Examples
Download and unpack Mozilla Addon SDK:
$ grunt mozilla-addon-sdk
Running "mozilla-addon-sdk:1_14" (mozilla-addon-sdk) task
Downloading: https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.14.tar.gz
Running "mozilla-addon-sdk:master" (mozilla-addon-sdk) task
Downloading: https://github.com/mozilla/addon-sdk/archive/master.tar.gz
Done, without errors.
Generate addon XPI
$ grunt mozilla-cfx-xpi
Running "mozilla-cfx-xpi:release" (mozilla-cfx-xpi) task
Creating dist dir '/home/rpl/PROJECTS/2013/MOZILLA/DEVTOOLS-EXT/grunt-mozilla-addon-sdk/tmp/dist'...
Creating xpi...
Generated XPI: /home/rpl/PROJECTS/2013/MOZILLA/DEVTOOLS-EXT/grunt-mozilla-addon-sdk/tmp/dist/test-addon.xpi
Done, without errors.
Release History
- 0.3.2 - fix issues handling space chars in the paths
- 0.3.1 - use
FIREFOX_BIN
and FIREFOX_PROFILE
environment variables in cfx
helper - 0.3.0 - support multiple addon-sdk (NOTE: config syntax changes)
- 0.2.0 - added windows support and custom cfx command using 'mozilla-cfx' grunt multi-task
- 0.1.0 - initial release (download and xpi sub-tasks)