| Store | Cart

ActiveState Docs

Komodo 7.1 Documentation


Komodo Extensions

Komodo extensions (also known as add-ons) are used to extend the functionality of the IDE. Komodo is based upon the Mozilla framework, so it has the same extension capabilities as Firefox does, which means the Mozilla extension documentation also applies to Komodo as well. These Mozilla resources are a great place to begin understanding the fundamentals of extensions.

Add-on Dialog

Use the Tools > Add-ons menu to open the Add-ons management dialog. The Extensions tab will show you the currently installed add-ons, most of which are included through the default Komodo installation. Use the Get Add-ons tab to browse the recommended Add-ons or use the filter field search for a particular extension. Choose an extension and click on the download or Install links. You can also read the add-on tutorial covering the add-on dialog features.

Creating an Extension

Extensions usually come in two flavours:

  • Feature Extensions: these add new interfaces, components and functionality to Komodo.
  • Language Extensions: which adds (or improves) support for a particular programming language in Komodo.
Note that the type of add-on you wish to create will affect how you go about the creating process.

Feature Extensions

The best way to start creating a new Komodo feature is by utilizing the Komodo macro system, which you can use to quickly and easily create new functionality for Komodo, such as adding user interfaces, responding to keypresses, opening files, or performing text manipulation in the Komodo editor.

You can see great examples of Komodo macros on the ActiveState Code site. By the way, you can write macros in either JavaScript or Python - so you get to choose which language works best for you.

If you wish - you may then turn your macro into a Komodo add-on (so it's easily installable and will automatically update when you make changes to it). To get started, use the Project -> New -> New Project from Template and select the Create Komodo Extension project. When using a Komodo extension project, you'll find there is a "Build and Install" macro added to your Komodo toolbox, which you can use to create and install the extension xpi file.

Language Extensions

Language extensions are used to extend Komodo's knowledge of programming languages (like Java, Matlab, Mel). This can control things like Language Detection, Code Coloring, Editor Indentation, Syntax Checking, Code Intelligence (completions and calltips) and Debugging.

The easiest way to create a new Komodo language is to use the Project -> New Project from Template and select the Create Komodo Language project. Fill out the add-on details, then you can customize the language details (like the comment styles, keywords and code intelligence) and create the project. You'll find there is a "Build and Install" macro added to your Komodo toolbox, which you can use to create and install the extension xpi file.

Once you've got the basics of the language down, you can further tweak the generated files to your liking and then re-build and re-install the add-on to test it out. Below is a description for the generated files and folders of the add-on:

  • install.rdf, chrome.manifest Registration information for the add-on (e.g. name, author, homepage) and the user interface to load for the add-on.
  • content Contains the UI elements that are loaded into the Komodo UI, as well as loading any necessary JavaScript files.
  • components Controls the registration of the language within Komodo, provides information about the language (name, file extension, etc...).
  • pylib Provides code intelligence facilities, for code completion popups, calltips and code browser information.
  • udl The UDL files provide syntax highlighting (coloring) for your language, including keyword, strings, numbers and comment styling.
  • templates The templates folder holds the custom language templates that will be availalbe in Komodo's New File from Template dialogs.

User Defined Languages (UDL)

Komodo's system for defining multi-language syntax lexing (coloring) is called UDL (User Defined Languages). UDL files are written in a language called Luddite, which then gets compiled into a Scintilla lexer package for use inside Komodo. All udl files are stored inside the "udl" folder of your extension.

Syntax Checking

The Komodo documentation for linters is quite extensive, and there is also a good article on adding syntax checking to a Komodo extension on the ActiveState blog.

Code Intelligence

Code Intelligence is enabled in a Komodo language extension by adding a pylib/codeintel_langname.py file to your extension. It works by first triggering a completion event and then responding to an evalutation request.

  • Trigger - whenever a keypress occurs in Komodo, the trg_from_pos Python method in your codeintel_language file will be called. It will be up to you to decide if you want to offer completions at that point - when you do, then you'll need to return a Trigger() instance.
  • Evaluation - handles the lookup for completion/calltips. The async_eval_at_trg method is called when the trg_from_pos method has returned a trigger. It's job is to provide the list of completions or the calltip string.
  • API Catalogs - are a collection of class/function/variable information. API Catalogs are only applicable for the default Komodo Code Intelligence languages (i.e. Python, JavaScript, PHP, ...). You can achieve the same affect as an API Catalog by defining/outlining a code file and then including that on the language search path.

Extension Development Tools and Useful Links

  • Komodo Developer Add-on

    This extension provides helper tools for working with JavaScript and Python inside of Komodo. If you want to play around with the JavaScript API, do some simple python coding tests, probe the Komodo API for an extension, or play with the internals of Komodo, then this is for you! When installed, you can use the Tools > Extension Developer menu to access the JavaScript Shell and Python Shell, from which you can control and interact with Komodo.

  • DOM Inspector

    The DOM Inspector is a tool that can be used to inspect and edit the UI structuring used by Komodo. The DOM can be navigated using a two-paned window displaying a variety of different views on the document and all nodes within. With this tool you can interact with the DOM Elements, JavaScript objects and the CSS styling. Once installed, use the Tools > DOM Inspector to launch and inspect Komodo. See the Mozilla Intro here for using the DOM Inspector, or check out this DOM Inspector video.

  • OpenKomodo Grok

    Grok provides a fast source code search engine. You can use this online search tool to find code examples for working with different parts of Komodo. For example, here is a list of hits for the Komodo hyperlinks feature.

  • Error Console

    You can use this one-line Komodo JavaScript macro to open the error console - which will bring up a dialog that will show page errors and JavaScript loading errors:

                  window.openDialog("chrome://global/content/console.xul", "_blank");

  • Mozilla Extension Development Documentation

    Thanks to Komodo being based upon the Mozilla framework, Komodo has the same extension capabilities as the Firefox browser, making Komodo extension development a breeze - you can even re-purpose existing Firefox extensions to work within Komodo.

  • Komodo Edit Add-Ons

    These are Komodo Edit add-ons that are included in the regular Komodo Edit installers. You will also find these add-ons in the "extensions" directory of your Komodo installation.

  • OpenKomodo Add-Ons

    These are Komodo add-ons that have been developed by ActiveState that are not included in the regular Komodo installers. A lot of these are hosted on the ActiveState Community site.