mozilla

Revision 362021 of Setting up an extension development environment

• Revision slug: Setting_up_extension_development_environment
• Revision title: Setting up an extension development environment
• Revision id: 362021
• Created:
• Creator: Gerv
• Is current revision? No
• Comment

Revision Content

This article gives suggestions on how to set up your Mozilla application for extension development. Unless otherwise specified, these suggestions apply to both Firefox and Thunderbird as well as SeaMonkey version 2.0 and above.

Overview

• Create a development user profile to run your development firefox session; with special development preferences in about:config.
• Install some Firefox development extensions to your dev profile.
• Edit files in the extensions folder of your profile and restart the application with the dev profile.

Development profile

To avoid performance degradation from development-related prefs and extensions, and to avoid losing your personal data, you can use a separate profile for development work.

You can run two instances of Thunderbird or Firefox at the same time by using separate profiles and starting the application with the -no-remote parameter. For example, the following command will start Firefox with a profile called "dev" whether an instance of Firefox is already running or not.

On Ubuntu (and many other Linux distributions):

/usr/bin/firefox -no-remote -P dev

On some other distributions of Linux/Unix:

/usr/local/bin/firefox -no-remote -P dev


On Mac OS Snow Leopard (10.6) and newer:

/Applications/Firefox.app/Contents/MacOS/firefox-bin -no-remote -P dev &


On Mac OS Leopard (10.5) and older, you must request the 32-bit portion of the Universal Binary (https://bugzilla.mozilla.org/show_bug.cgi?id=622970):

arch -arch i386 /Applications/Firefox.app/Contents/MacOS/firefox-bin -no-remote -P dev &


On Windows:

Start -> Run "%ProgramFiles%\Mozilla Firefox\firefox.exe" -no-remote -P dev


On Windows 64 bit:

Start -> Run "%ProgramFiles(x86)%\Mozilla Firefox\firefox.exe" -no-remote -P dev

To start Thunderbird or SeaMonkey instead of Firefox, substitute "thunderbird" or "seamonkey" for "firefox" in the examples above.

If the profile specified does not exist (or if no profile is specified), Thunderbird or Firefox will display the Profile Manager. To run with the default profile, specify "default" as the profile (or omit the "-P" switch).

(There is a thread in the Mozillazine forums that explains how to use both stable and development versions of Firefox to check extension compatibility. See Installing Firefox 3 or Minefield while keeping Firefox 2.)

To make the numerous restarts easier, you can make one for reading documentation / for regular use, and the other one for extensions' testing, and run them at the same time using the no-remote command switch as described at http://kb.mozillazine.org/Command_line_arguments . The first one often needs lots of restarts, and you can launch both of them at the same time, like these two shortcuts on Windows:

...firefox.exe -no-remote -p "profile1"

...firefox.exe -no-remote -p "profile2"

These are Windows-specific lines. If you find the same instructions for Linux / Mac OS / etc please place them here too.

On Mac, create a bash script, name it with file extension ".command".  The profile option is "-P" (cap P).

#!/bin/bash

"..."/Contents/MacOS/firefox -P "profile1"

replace "..." with some real path. It is simple - just two shortcuts on the desktop - and lets you keep one of the profiles always open.

Development command flags

As of Gecko 2 (Firefox 4), JavaScript files are cached ("fastload"). The -purgecaches command-line flag disables this behavior. Alternatively, you can set the MOZ_PURGE_CACHES environment variable. See this bug for more information.

Development preferences

Installing the Developer Profile extension sets up the development environment described below.

There is a set of development preferences that, when enabled, allows you to view more information about application activity, thus making debugging easier. However,  these preferences can degrade performance, so you may want to use a separate development profile when you enable these preferences. For more information about Mozilla preferences, refer to the mozillaZine article on "about:config".

Not all preferences are defined by default, and are therefore not listed in about:config by default. You will have to create new (boolean) entries for them.

• javascript.options.showInConsole = true. Logs errors in chrome files to the Error Console.
• nglayout.debug.disable_xul_cache = true. Disables the XUL cache so that changes to windows and dialogs do not require a restart. This assumes you're using directories rather than JARs. Changes to XUL overlays will still require reloading of the document overlaid.
• browser.dom.window.dump.enabled = true. Enables the use of the dump() statement to print to the standard console. See {{ Domxref("window.dump") }} for more info. You can use {{ Interface("nsIConsoleService") }} instead of dump() from a privileged script.
• javascript.options.strict = true. Enables strict JavaScript warnings in the Error Console. Note that since many people have this setting turned off when developing, you will see lots of warnings for problems with their code in addition to warnings for your own extension. You can filter those with Console2.
• devtools.chrome.enabled = true. This enables to run JavaScript code snippets in the chrome context of the Scratchpad from the Tools menu. Don't forget to switch from content to browser as context.
• extensions.logging.enabled = true. This will send more detailed information about installation and update problems to the Error Console. (Note that the extension manager automatically restarts the application at startup sometimes, which may mean you won't have time to see the messages logged before the automatic restart happens. To see them, prevent the automatic restart by setting the environment NO_EM_RESTART to 1 before starting the application.)
• nglayout.debug.disable_xul_fastload = true. For Gecko 2.0+ (Firefox 4.0+). See this bug for more information. Although the bug has been closed, it is believed that this pref is still relevant.
• You might also want to set dom.report_all_js_exceptions = true. See Exception logging in JavaScript for details.
• devtools.errorconsole.deprecation_warnings. Detect deprecated code use.

{{WarningStart()}}Never set {{pref("nglayout.debug.disable_xul_fastload")}} to true in a production environment; it exists solely to aid in debugging. In particular, add-ons should never change this preference.{{WarningEnd()}}.

The Error Console is disabled by default starting in Firefox 4. You can re-enable it by changing the devtools.errorconsole.enabled preference to true and restarting the browser. With this, javascript.options.showInConsole is also set to true by default.

Accessing Firefox development preferences

To change preference settings in Firefox or SeaMonkey, type about:config in the Location Bar. Alternatively, use the Extension Developer's Extension, which provides a menu interface for Firefox settings.

Accessing Thunderbird development preferences

To change preference settings in Thunderbird, open the "Preferences" (Unix) or "Options" (Windows) interface. On the "Advanced" page, select the "General" tab then click the "Config Editor" button.

Firefox extension proxy file

Extension files are normally installed in the user profile. However, it is usually easier to place extension files in a temporary location, which also protects source files from accidental deletion. This section explains how to create a proxy file that points to an extension that is installed in a location other than the user profile.

1. Get the extension ID from the extension's install.rdf file.
2. Create a file in the "extensions" directory under your profile directory with the extension's ID as the file name (for example "your_profile_directory/extensions/{46D1B3C0-DB7A-4b1a-863A-6EE6F77ECB58}"). (How to find your profile directory) Alternatively, rather than using a GUID, create a unique ID using the format "name@yourdomain" (for example chromebug@mydomain.com) - then the proxy filename will be same as that ID, with no curly brackets {}.
3. The contents of this file should be the path to the directory that contains your install.rdf file, for example /full/path/to/yourExtension/ on Mac and Linux, and C:\full\path\to\yourExtension\ on Windows. Remember to include the closing slash and remove any trailing whitespace.

• Note: If you already installed the extension via XPI, you should uninstall it first before creating the pointer file.
• Also note that the use of proxy files requires that the extension's chrome.manifest defines its chrome urls using traditional directories, rather than a JARed structure. See below.
4. Place the file in the extensions folder of your profile and restart the application.

Using directories rather than JARs

Regardless of whether you choose to eventually package your extension's chrome in a JAR or in directories, developing in directories is simpler. If you choose a JARed structure for releasing, you can still develop with a directory structure by editing your chrome.manifest. For example, rather than having

content	myExtension	jar:chrome/myExtension.jar!/content/


use

content	myExtension	chrome/content/


{{ h1_gecko_minversion("Preventing the first launch extension selector", "8.0") }}

Starting in Firefox 8, on the first launch of a new version of Firefox, it presents user interface letting users select which third party add-ons to keep. This lets them weed out add-ons that were installed without their knowledge, or that are no longer needed.

However, this interface can be disruptive when debugging add-ons. You can avoid this by setting the preference extensions.autoDisableScopes to 14.

{{ languages( { "de": "de/Einrichten_einer_Entwicklungsumgebung_für_Erweiterungen", "fr": "fr/Configuration_d'un_environnement_de_développement_d'extensions", "ja": "ja/Setting_up_extension_development_environment", "zh-cn": "cn/Setting_up_extension_development_environment", "pl": "pl/Przygotowanie_środowiska_programowania_rozszerzenia", "ru": "ru/Настройка_среды_разработки_расширений" } ) }}

Revision Source

<p>This article gives suggestions on how to set up your Mozilla application for extension development. Unless otherwise specified, these suggestions apply to both Firefox and Thunderbird as well as SeaMonkey version 2.0 and above.</p>
<h3 id="Overview">Overview</h3>
<ul>
<li>Create a development <a href="#Development_profile">user profile</a> to run your development firefox session; with special <a href="#Development_preferences">development preferences</a> in <code>about:config</code>.</li>
<li>Install some Firefox <a href="#Development_extensions">development extensions</a> to your dev profile.</li>
<li>Edit files in the extensions folder of your profile and restart the application with the dev profile.</li>
</ul>
<h3 id="Development_profile">Development profile</h3>
<p>To avoid performance degradation from development-related prefs and extensions, and to avoid losing your personal data, you can use a separate profile for development work.</p>
<p>You can run two instances of Thunderbird or Firefox at the same time by using separate profiles and starting the application with the <code>-no-remote</code> parameter. For example, the following command will start Firefox with a profile called "dev" whether an instance of Firefox is already running or not.</p>
<p>On Ubuntu (and many other Linux distributions):</p>
<pre>
/usr/bin/firefox -no-remote -P dev</pre>
<p>On some other distributions of Linux/Unix:</p>
<pre>
/usr/local/bin/firefox -no-remote -P dev
</pre>
<p>On Mac OS Snow Leopard (10.6) and newer:</p>
<pre class="eval">
/Applications/Firefox.app/Contents/MacOS/firefox-bin -no-remote -P dev &amp;
</pre>
<p>On Mac OS Leopard (10.5) and older, you must request the 32-bit portion of the Universal Binary (<a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=622970" title="https://bugzilla.mozilla.org/show_bug.cgi?id=622970">https://bugzilla.mozilla.org/show_bug.cgi?id=622970</a>):</p>
<pre class="eval">
arch -arch i386 /Applications/Firefox.app/Contents/MacOS/firefox-bin -no-remote -P dev &amp;
</pre>
<p>On Windows:</p>
<pre class="eval">
Start -&gt; Run "%ProgramFiles%\Mozilla Firefox\firefox.exe" -no-remote -P dev
</pre>
<p>On Windows 64 bit:</p>
<pre class="eval">
Start -&gt; Run "%ProgramFiles(x86)%\Mozilla Firefox\firefox.exe" -no-remote -P dev</pre>
<p>To start Thunderbird or SeaMonkey instead of Firefox, substitute "thunderbird" or "seamonkey" for "firefox" in the examples above.</p>
<p>If the profile specified does not exist (or if no profile is specified), Thunderbird or Firefox will display the Profile Manager. To run with the default profile, specify "default" as the profile (or omit the "-P" switch).</p>
<p>(There is a thread in the <a class="external" href="http://forums.mozillazine.org/" title="http://forums.mozillazine.org/">Mozillazine forums</a> that explains how to use both stable and development versions of Firefox to check extension compatibility. See <a class="external" href="http://forums.mozillazine.org/viewtopic.php?t=613873">Installing Firefox 3 or Minefield while keeping Firefox 2</a>.)</p>
<p>To make the numerous restarts easier, you can make one for reading documentation / for regular use, and the other one for extensions' testing, and run them at the same time using the <code>no-remote </code>command switch as described at <a class="external" href="http://kb.mozillazine.org/Command_line_arguments" title="http://kb.mozillazine.org/Command_line_arguments">http://<span>kb.mozillazine.org/Command_line_arguments</span></a> .<span> The first one often needs lots of restarts, and you can launch both of them at the same time, like these two shortcuts on Windows:</span></p>
<p><code><span>...firefox.exe -no-remote -p "profile1"</span></code></p>
<p><code><span>...firefox.exe -no-remote -p "profile2"</span></code></p>
<div class="note">
These are Windows-specific lines. If you find the same instructions for Linux / Mac OS / etc please place them here too.</div>
<p>On Mac, create a bash script, name it with file extension ".command". &nbsp;The profile option is "-P" (cap P).</p>
<p><code>#!/bin/bash</code></p>
<p><code>"..."/Contents/MacOS/firefox -P "profile1"</code></p>
<p>replace "..." with some real path. It is simple - just two shortcuts on the desktop - and lets you keep one of the profiles always open.</p>
<h3 id="Development_command_flags">Development command flags</h3>
<p>As of&nbsp;Gecko 2 (Firefox 4), JavaScript files are cached&nbsp;("fastload"). The <code>-purgecaches</code> command-line flag disables this behavior. Alternatively, you can set the MOZ_PURGE_CACHES&nbsp;environment variable. See <a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=531886" title="https://bugzilla.mozilla.org/show_bug.cgi?id=531886">this bug</a> for more information.</p>
<h3 id="Development_preferences">Development preferences</h3>
<p>There is a set of development preferences that, when enabled, allows you to view more information about application activity, thus making debugging easier. However,&nbsp; these preferences can degrade performance, so you may want to use a separate development profile when you enable these preferences. For more information about Mozilla preferences, refer to the mozillaZine article on "<a class="external" href="http://kb.mozillazine.org/About:config" title="http://kb.mozillazine.org/About:config">about:config</a>".</p>
<p>Not all preferences are defined by default, and are therefore not listed in <code>about:config</code> by default. You will have to create new (boolean) entries for them.</p>
<ul>
<li><strong>javascript.options.showInConsole</strong> = <strong>true</strong>. Logs errors in chrome files to the <a href="/en/Error_Console" title="en/Error_Console">Error Console</a>.</li>
<li><strong>nglayout.debug.disable_xul_cache</strong> = <strong>true</strong>. Disables the XUL cache so that changes to windows and dialogs do not require a restart. This assumes you're <a href="#Using_directories_rather_than_JARs">using directories rather than JARs</a>. Changes to XUL overlays will still require reloading of the document overlaid.</li>
<li><strong>browser.dom.window.dump.enabled</strong> = <strong>true</strong>. Enables the use of the <span style="font-family: Courier New;">dump()</span> statement to print to the standard console. See <span style="font-family: Courier New;">{{ Domxref("window.dump") }}</span> for more info. You can use <span style="font-family: Courier New;">{{ Interface("nsIConsoleService") }}</span> instead of <code>dump()</code>&nbsp;from a privileged script.</li>
<li><strong>javascript.options.strict</strong> = <strong>true</strong>. Enables strict JavaScript warnings in the Error Console. Note that since many people have this setting turned off when developing, you will see lots of warnings for problems with their code in addition to warnings for your own extension. You can filter those with <a class="link-https" href="https://addons.mozilla.org/en-US/firefox/addon/1815">Console<sup>2</sup></a>.</li>
<li><strong>devtools.chrome.enabled = true.</strong> This enables to run JavaScript code snippets in the chrome context of the Scratchpad from the Tools menu. Don't forget to switch from content to browser as context.</li>
<li><strong>extensions.logging.enabled</strong> = <strong>true</strong>. This will send more detailed information about installation and update problems to the <a href="/en/Error_Console" title="en/Error Console">Error Console</a>. (Note that the extension manager automatically restarts the application at startup sometimes, which may mean you won't have time to see the messages logged before the automatic restart happens. To see them, prevent the automatic restart by setting the environment NO_EM_RESTART to 1 before starting the application.)</li>
<li><strong>nglayout.debug.disable_xul_fastload = true</strong>. For Gecko 2.0+&nbsp;(Firefox 4.0+). See <a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=531886" title="https://bugzilla.mozilla.org/show_bug.cgi?id=531886">this bug</a> for more information. Although the bug has been closed, it is believed that this pref is still relevant.</li>
<li>You might also want to set <strong>dom.report_all_js_exceptions = true</strong>. See <a class="internal" href="/en/Exception_logging_in_JavaScript" title="en/Exception logging in JavaScript">Exception logging in JavaScript</a> for details.</li>
<li><strong>devtools.errorconsole.deprecation_warnings</strong>. Detect deprecated code use.</li>
</ul>
<p>{{WarningStart()}}<strong>Never</strong> set {{pref("nglayout.debug.disable_xul_fastload")}} to true in a production environment; it exists solely to aid in debugging. In particular, add-ons should never change this preference.{{WarningEnd()}}.</p>
<div class="geckoVersionNote">
<p>The Error Console is disabled by default starting in Firefox 4. You can re-enable it by changing the <code>devtools.errorconsole.enabled</code> preference to <code>true</code> and restarting the browser. With this, <code>javascript.options.showInConsole</code> is also set to <code>true</code> by default.</p>
</div>
<h4 id="Accessing_Firefox_development_preferences">Accessing Firefox development preferences</h4>
<h4 id="Accessing_Thunderbird_development_preferences">Accessing Thunderbird development preferences</h4>
<p>To change preference settings in Thunderbird, open the "Preferences" (Unix) or "Options" (Windows) interface. On the "Advanced" page, select the "General" tab then click the "Config Editor" button.</p>
<h3 id="Development_extensions">Development extensions</h3>
<ul>
<li><a class="link-https" href="https://addons.mozilla.org/en-US/firefox/addon/6622">DOM Inspector</a>, used to inspect and edit the live DOM of any web document or XUL application (Firefox and Thunderbird)</li>
<li><a class="external" href="http://webdesigns.ms11.net/chromeditp.html">Chrome Edit Plus</a> a user file editor (Firefox and Thunderbird)</li>
<li><a class="external" href="http://dactyl.sf.net/pentadactyl/">Pentadactyl</a>, a general purpose extension with builtin tools for extension development, including a command line with chrome JavaScript evaluation (including property and function argument completion) and the ability to demand-load external JavaScript and CSS files into window chrome.</li>
<li><a class="external" href="http://getfirebug.com/releases/chromebug/">Chromebug</a> combines elements of a JavaScript debugger and DOM (Firefox, "kinda works for Thunderbird")</li>
<li><a class="link-https" href="https://github.com/bard/mozrepl/wiki">MozRepl</a> explore and modify Firefox and other Mozilla apps while they run (Firefox and Thunderbird)</li>
<li><a class="external" href="http://xpcomviewer.mozdev.org">XPCOMViewer</a> an XPCOM inspector (Firefox and Thunderbird)</li>
<li><a class="internal" href="/en/JavaScript/Shells" title="En/JavaScript shells">JavaScript shells</a> to test snippets of JavaScript (Firefox and Thunderbird)</li>
<li><a class="external" href="http://code.google.com/p/crashme/">Crash Me Now!</a> useful for testing debug symbols and the crash reporting system (Firefox and Thunderbird)</li>
</ul>
<h3 id="Firefox_extension_proxy_file">Firefox extension proxy file</h3>
<p>Extension files are normally installed in the user profile. However, it is usually easier to place extension files in a temporary location, which also protects source files from accidental deletion. This section explains how to create a proxy file that points to an extension that is installed in a location other than the user profile.</p>
<ol>
<li>Get the extension ID from the extension's install.rdf file.</li>
<li>Create a file in the "<code>extensions</code>" directory under your profile directory with the extension's ID as the file name (for example "<code>your_profile_directory/extensions/{46D1B3C0-DB7A-4b1a-863A-6EE6F77ECB58}</code>"). (<a class="external" href="http://kb.mozillazine.org/Profile_folder">How to find your profile directory</a>) Alternatively, rather than using a GUID, create a unique ID using the format "name@yourdomain" (for example <span class="nowiki"><code>chromebug@mydomain.com</code></span>) - then the proxy filename will be same as that ID, with no curly brackets {}.</li>
<li>
<p>The contents of this file should be the path to the directory that contains your install.rdf file, for example <code><span class="nowiki">/full/path/to/yourExtension/</span></code> on Mac and Linux, and <code><span class="nowiki">C:\full\path\to\yourExtension\</span></code> on Windows. Remember to include the closing slash and remove any trailing whitespace.</p>
<ul>
<li>Note: If you already installed the extension via XPI, you should uninstall it first before creating the pointer file.</li>
<li>Also note that the use of proxy files requires that the extension's chrome.manifest defines its chrome urls using traditional directories, rather than a JARed structure. See below.</li>
</ul>
</li>
<li>Place the file in the extensions folder of your profile and restart the application.</li>
</ol>
<h3 id="Using_directories_rather_than_JARs">Using directories rather than JARs</h3>
<p>Regardless of whether you choose to eventually package your extension's chrome in a JAR or in directories, developing in directories is simpler. If you choose a JARed structure for releasing, you can still develop with a directory structure by editing your chrome.manifest. For example, rather than having</p>
<pre class="eval">
content	myExtension	jar:chrome/myExtension.jar!/content/
</pre>
<p>use</p>
<pre class="eval">
content	myExtension	chrome/content/
</pre>
<p>{{ h1_gecko_minversion("Preventing the first launch extension selector", "8.0") }}</p>
<p>Starting in Firefox 8, on the first launch of a new version of Firefox, it presents user interface letting users select which third party add-ons to keep. This lets them weed out add-ons that were installed without their knowledge, or that are no longer needed.</p>
<p>However, this interface can be disruptive when debugging add-ons. You can avoid this by setting the preference <code>extensions.autoDisableScopes</code> to 14.</p>
<p>{{ languages( { "de": "de/Einrichten_einer_Entwicklungsumgebung_für_Erweiterungen", "fr": "fr/Configuration_d'un_environnement_de_développement_d'extensions", "ja": "ja/Setting_up_extension_development_environment", "zh-cn": "cn/Setting_up_extension_development_environment", "pl": "pl/Przygotowanie_środowiska_programowania_rozszerzenia", "ru": "ru/Настройка_среды_разработки_расширений" } ) }}</p>