Developer Guide

RDP Inspector is an open source project and we are open for patches. If you find an issue, or want a new feature, create a new report in our issue tracker.

Hack on RDP Inspector

Read following instructions describing how to contribute to the project.

1. Install JPM: npm install jpm -g (read more about installing jpm)
2. Get RDP Inspector source: git clone https://github.com/firebug/rdp-inspector.git
3. Install required NPM modules: npm install
4. Make changes in the source code
5. Run jpm run -b nightly in the source directory (learn more about jpm commands)
6. Send a pull request (read about using pull requests)

Build XPI

Building the final XPI package is done through JPM.

jpm xpi

Note that jpm is using new bootstrap.js file that is only compatible with Firefox 38+. If you want to support Firefox 37 you need to download previous version of the bootstrap.js from jpm core. You need to check out tag 0.0.5 to get the right version.

Repository Structure

Structure of the extension follows Jetpack standards.

• data HTML pages
• chrome Stylesheets, localization files
• lib Javascript files.
• test JPM Test files (tests addon privileged code)
• karma-test Karma Test files (tests content unprivileged code)

Testing

RDP Inspector is integrated with Travis (hosted continuous integration service).

RDP Inspector uses two test suites:

• javascript code running in a content unprivileged iframe uses a Karma-based test suite
• javascript code running in a addon privileged context uses the JPM-based test suite

In order to run all RDP Inspector test suites locally on your machine, type the following command in the source directory:

npm run test

In order to run only the karma-based test suite for a single run and print the test specs report in the console:

npm run karma-tests

During development can be useful to run the karma-based test suite in a persistent "server + auto-watch" mode, in this mode Firefox will be launched only once and the test cases will re-run automatically on every changes on the watched files

npm run watch-karma-tests

FIREFOX_BIN environment variable can be used to customize/force the path of the Firefox version launched:

FIREFOX_BIN=/path/to/firefox npm run watch-karma-tests

COVERAGE environment variable enables code coverage report generation in the coverage directory:

COVERAGE=true npm run watch-karma-tests

Learn more about the jpm test and karma commands.

All JPM tests are located within test directory, all Karma tests are located within karma-tests.

Translations

RDP Inspector translations are maintained on BabelZilla.org. If you want to became a translator create an account on the site and join the RDP Inspector team! You can also read forum dedicated to RDP Inspector. If you see an issue with existing translations create a report.

Contact Us

There are several ways how you can reach folks behind this extension

• Newsgroups We are using the same group as for Firebug.
• Issue List Just file a bug (or request for feature) report directly.
• Online Chat Join the RDP Inspector room

License

RDP Inspector is released under a BSD License.