Logging

To follow this tutorial you'll need to have installed the SDK and learned the basics of cfx.

The DOM console object is useful for debugging JavaScript. Because DOM objects aren't available to the main add-on code, the SDK provides its own global console object with most of the same methods as the DOM console, including methods to log error, warning, or informational messages. You don't have to require() anything to get access to the console: it is automatically made available to you.

The console.log() method prints an informational message:

console.log("Hello World");

Try it out:

  • create a new directory, and navigate to it
  • execute cfx init
  • open "lib/main.js" and add the line above
  • execute cfx run, then cfx run again

Firefox will start, and the following line will appear in the command window you used to execute cfx run:

info: Hello World!

console in Content Scripts

You can use the console in content scripts as well as in your main add-on code. The following add-on logs the HTML content of every tab the user loads, by calling console.log() inside a content script:

require("sdk/tabs").on("ready", function(tab) {
  tab.attach({
    contentScript: "console.log(document.body.innerHTML);"
  });
});

console Output

If you are running your add-on from the command line (for example, executing cfx run or cfx test) then the console's messages appear in the command shell you used.

If you've installed the add-on in Firefox then the messages appear in Firefox's Browser Console.

But note that by default, calls to console.log() will not result in any output in the Error Console for any installed add-ons: this includes add-ons installed using the Add-on Builder or using tools like the Extension Auto-installer.

See "Logging Levels" in the console reference documentation for more information on this.

Disabling strict mode

By default, cfx enables JavaScript strict mode, which will cause a lot of JavaScript warnings to be logged to the console. If this makes it harder to interpret logging output, you can disable strict mode by opening the file at python-lib/cuddlefish/prefs.py  and setting "javascript.options.strict" to False.

Learning More

For the complete console API, see its API reference.

Document Tags and Contributors

Contributors to this page: wbamberg, tomica, fixanoid
Last updated by: wbamberg,