jpm

The Node-based replacement for cfx. Enables you to test, run, and package add-ons.

Voir aussi le tutoriel jpm pour débuter.

jpm usage is:

jpm [command] [options]

jpm supports the following global options:

-h, --help        - show a help message and exit
-V, --version     - print the jpm version number

Installation

jpm is distributed using the node package manager npm, so to get jpm you need to have npm installed, if you haven't already. npm is included in Node.js. To install npm, you can either visit nodejs.org and download the latest binary or if you have a package manager like APT installed on your system, you might want to use this package manager to install npm. For example, if you are using an Ubuntu or Debian operating system, execute sudo apt-get install nodejs followed by sudo apt-get install npm in a terminal window.

After that you can install jpm just as you would any other npm package:

npm install jpm --global

Depending on your setup, you might need to run this as an administrator:

sudo npm install jpm --global

Or, you can install jpm using git:

git clone https://github.com/mozilla-jetpack/jpm.git
cd jpm
npm install
npm link

À l'invite de commande, tapez:

jpm

You should see a screen summarizing the available jpm commands. Note that unlike cfx, jpm is available in every command prompt you start, as long as you installed it with the --global flag.

If you get an error message saying  /usr/bin/env: node: No such file or directory and you have installed nodejs through a package manager, nodejs may have been installed in the wrong directory. A corresponding topic at stackoverflow.org might help you to solve this problem. Basically, you can solve it by creating a symlink to the node:

sudo ln -s "$(which nodejs)" /usr/bin/node

Problems?

If you don't see this, ask for help. SDK users and project team members discuss problems and proposals on the project mailing list. Someone else may have had the same problem you do, so try searching the list. You're welcome to post a question, too. You can also chat with other SDK users in #jetpack on Mozilla's IRC network.

Command reference

There are six jpm commands:

jpm init

This command initializes a new add-on from scratch.

Create a new directory, change into it, and run jpm init.

mkdir my-addon
cd my-addon
jpm init

You'll then be asked to supply some information about your add-on: this will be used to create your add-on's package.json file.

• title
• name: this defaults to the name of the directory in which you are running jpm init. Unless an id field is present in package.json, jpm will prepend "@" to name and use the result as the id field in the add-on's install manifest.
• version
• description
• entry point (which maps to "main" in package.json)
• author
• engines (supported applications)
• license

Most of these fields have a default, which is shown in brackets after the question. If you just press Enter, your add-on will get the default value.

Once you've supplied a value or accepted the default for these properties, you'll be shown the complete contents of "package.json" and asked to accept it.

Then jpm will create an skeleton add-on, as a starting point for your own add-on development, with the following file structure:

• my-addon
  • index.js
  • package.json
  • test
    • test-index.js

jpm run

This command runs a new instance of Firefox with the add-on installed:

jpm run

jpm run accepts the following options:

jpm run -b /path/to/Firefox/Nightly

jpm run --binary-args -jsconsole

jpm run --binary-args '-url mzl.la -jsconsole'

jpm test

Use this command to run an add-on's unit tests. It will:

• look for a directory called "test" under the add-on's root
• open every file in there whose name starts with "test-" (note the hyphen after "test" in the filename. jpm test will include a file called "test-myCode.js", but will exclude files called "test_myCode.js" or "testMyCode.js")
• call every function exported from that file whose name starts with "test"

jpm test

See the tutorial on unit testing and the reference documentation for the assert module for more details on this.

jpm test accepts the following options:

jpm test -b /path/to/Firefox/Nightly

jpm test --binary-args -jsconsole

jpm test --binary-args '-url mzl.la -jsconsole'

jpm test --filter base64:btoa

jpm test --stop-on-error

jpm test --times 2

jpm xpi

This command packages the add-on as an XPI file, which is the install file format for Mozilla add-ons.

jpm xpi

It looks for a file called package.json in the current directory and creates the corresponding XPI file. It ignores any ZIPs or XPIs in the add-on's root, and any test files. It includes all other files. If you want to exclude extra files, see the .jpmignore file.

Once you have built an XPI file you can distribute your add-on by submitting it to addons.mozilla.org.

jpm xpi accepts the following option:

jpm xpi -v

jpm post

This command packages the add-on as an XPI file then posts it to some url.

jpm post

It looks for a file called package.json in the current directory and creates a XPI file with which to post to the --post-url.

jpm post accepts the following options:

jpm post --post-url https://localhost:8888/

jpm post --post-url https://localhost:8888/ -v

jpm watchpost

This command packages the add-on as an XPI file then posts it to some url whenever a file in the current working directory changes.

jpm watchpost

Creates a XPI whenever a file in the current working directory changes and posts that to the --post-url.

jpm watchpost accepts the following options:

jpm watchpost --post-url https://localhost:8888/

jpm watchpost --post-url https://localhost:8888/ -v

jpm sign

This command retrieves a new XPI for your add-on signed by Mozilla. This allows you to self-host your add-on so that users can install it without error when signed add-ons are required.

jpm sign --api-key ${AMO_API_KEY} --api-secret ${AMO_API_SECRET}

This creates an XPI, submits it to the addons.mozilla.org signing API, then downloads a new signed XPI to the working directory if it passes validation. Here are some possible outcomes of running the sign command:

• Your add-on passed validation, was signed by Mozilla, and a new signed XPI was downloaded to your working directory.
• Your add-on failed validation, was not signed, and you got a link to a detailed report. After fixing the validation errors, you can run the command again.
• Your add-on at this exact version number already exists so it was not signed. You will need to increment the version number in your package.json file and run the command again.

Under the hood, jpm sign creates an unlisted add-on inside addons.mozilla.org which means you must distribute the XPI file yourself in order for your users to install it. If you need to create a listed add-on, just submit it directly to addons.mozilla.org where it will be signed automatically. See the debugging section if you're experiencing difficulty installing a signed add-on.

jpm sign accepts the following options:

jpm sign ... --api-url-prefix https://addons-dev.allizom.org/api/v3

Techniques

Selecting a browser version

By default, jpm run and jpm test will run the release version of Firefox. You can instruct jpm to use a different version in one of two ways:

• you can use the -b or --binary option to instruct jpm to run a different version of Firefox. You can supply a path to a specific binary:

  jpm run -b /path/to/Firefox/Nightly

  As a shorthand for this, you can pass "nightly", "aurora", "beta", or "firefox" and jpm will look in the default location for these Firefox versions:

  jpm run -b nightly

• you can set the JPM_FIREFOX_BINARY environment variable with the path to the version of Firefox you want to run. When you invoke jpm run or jpm test without the -b option, jpm will first check  JPM_FIREFOX_BINARY, and use this as the path if it is set.

Using .jpmignore to ignore files

Using .jpmignore is similar to using .gitignore with git, .hgignore with Mercurial, or .npmignore with npm. By using this file you can let jpm know which files you would like it to ignore when building a .xpi file with jpm xpi.

Here is an example:

# Ignore .DS_Store files created by mac
.DS_Store

# Ignore any zip or xpi files
*.zip
*.xpi

A .jpmignore file with the above contents would ignore all zip files and .DS_Store files from the xpi generated by jpm xpi.

Using profiles

By default, jpm run uses a new profile each time it is executed. This means that any profile-specific data entered from one run of jpm will not, by default, be available in the next run.

This includes, for example, any extra add-ons you installed, or your history, or any data stored using the simple-storage API.

To make jpm use a specific profile, pass the --profile option, specifying the name of the profile you wish to use, or the path to the profile.

jpm run --profile boogaloo

jpm run --profile path/to/boogaloo

If you supply --profile but its argument is not the name of or path to an existing profile, jpm will open the profile manager,  enabling you to select and existing profile or create a new one:

jpm run --profile i-dont-exist

Developing without browser restarts

Because jpm run restarts the browser each time you invoke it, it can be a little cumbersome if you are making very frequent changes to an add-on. An alternative development model is to use the Extension Auto-Installer add-on: this listens for new XPI files on a specified port and installs them automatically. That way you can test new changes without needing to restart the browser:

• make a change to your add-on
• run jpm post --post-url https://localhost:8888/, to make a xpi and post it.

You could even automate this workflow with a simple script. For example:

jpm watchpost --post-url https://localhost:8888/

Note that the logging level defined for the console is different when you use this method, compared to the logging level used when an add-on is run using jpm run. This means that if you want to see output from console.log() messages, you'll have to tweak a setting. See the documentation on logging levels for the details on this.

Overloading the built-in modules

The SDK modules you use to implement your add-on are built into Firefox. When you run or package an add-on using jpm run or jpm xpi, the add-on will use the versions of the modules in the version of Firefox that hosts it.

As an add-on developer, this is usually what you want. But if you're developing the SDK modules themselves, of course, it isn't. In this case you need to:

• get a local copy of the SDK modules that you want: this usually means checking out the SDK from its GitHub repo
• set the JETPACK_ROOT environment variable to your local copy
• pass the -o option to jpm run or jpm xpi:

jpm run -o

This instructs jpm to use the local copies of the SDK modules, not the ones in Firefox. If you don't want to set the JETPACK_ROOT environment variable, you can pass the location of your copy of the SDK modules along with -o:

jpm run -o "/path/to/SDK/"

Supporting updates for self-hosted add-ons

When you make updates to your add-on to add features or fix bugs, you'll want any previously installed versions of the add-on to update themselves to the new version.

If you list your add-on on addons.mozilla.org, then all you have to do here is submit the new version; add-ons default to checking addons.mozilla.org for new versions of themselves. You can stop reading this section.

If you do not list your add-on on addons.mozilla.org, you need to generate a Mozilla-signed XPI and tell Firefox where it can find new versions of your add-on. The way this works is:

• you run jpm sign anytime you need to create a new version
• you host the signed add-on XPI and update it when you need to
• you host an "update manifest", which, among other things, contains a URL pointing to the XPI
• your add-on tells Firefox where it can find the update manifest

To do this, include two extra keys in package.json:

• updateURL: this is a URL which will be included in the built XPI file (technically, it's in the install manifest which jpm xpi builds). It points to your update manifest. The updateURL value may be HTTPS. If it isn't, then you'll also need to sign the update manifest, and then include the public key using the updateKey field in package.json. See Securing updates for more on this.
• updateLink: this is the URL which will be included in the update manifest file. It points to the XPI, and must be an HTTPS URL.

If you include updateURL and updateLink (and also updateKey in case updateURL is not HTTPS), then jpm xpi will:

• embed the value you supplied for updateURL in the XPI it generates
• generate an update manifest alongside the XPI, and embed the value you supplied for updateLink in the manifest

You then host the update manifest at updateURL, and host new versions of the XPI at updateLink.

For some more details on this, see Automatic Add-on Update Checking.