Directory Structure

• Base directory
  • /config
  • /src
  • /static
  • /test
• The /src directory
  • /app
  • /assets
  • /exceptions
  • /messages
  • /providers

Base directory

/config

A folder containing a single index.ts file that exports the application config. Read more about configuration in the Application Configuration article.

/src

This folder contains all your extension’s source code. All of its contents and subfolders will be covered in more detail in the next section of this article.

/static

A space dedicated to store your static assets, like images or documents. These assets can then be accessed from the codebase via the Extension APIs.

/test

The test directory contains a test scaffold based on mocha.

---

The /src directory

/app

The app folder contains all main application logic that needs to be split between the background script and the content script—hence the only two subfolders are app/background and app/content.

Each of these directories includes 2 files and a folder by default.

• main.ts is the entry point of the respective script. This file is provided by Exteranto and should not be changed unless strictly necessary. It boots the framework, registers listeners and loads application config.

• events.ts is both the application “router” and event listener registrar in one. The file is used to register listeners to various events—both cross-script and within a script (bakground/content). Read more about how events and messages work in the Typed Message Passing article.

• /listeners is a default folder to store script-specific listeners. A simple listener is created and registered by Exteranto for demonstration. More about listeners in the previously mentioned Typed Message Passing article.

/assets

This folder contains assets that need to be compiled with the source code. Exteranto supports .sass styling by default.

/exceptions

The exceptions directory contains global definitions for exception classes.

/messages

The messages directory contains global definitions for message classes. Read more about how messages work in the Typed Message Passing article.

/providers

This folder contains service provider classes for registering custom services or events. Read more about these in the Service Providers article.

« Previous (Installation) | Next (Application Configuration) »