node-firefox-launch-app
v1.1.0
Published
Launch an app on a Firefox runtime
Downloads
39
Readme
node-firefox-launch-app
Launch an installed app on a runtime.
This is part of the node-firefox project.
NOTE: This module is super experimental and the API is not totally stable yet. Use under your own responsibility.
Installation
From git
git clone https://github.com/mozilla/node-firefox-launch-app.git
cd node-firefox-launch-app
npm install
If you want to update later on:
cd node-firefox-launch-app
git pull origin master
npm install
npm
npm install node-firefox-launch-app
Usage
launchApp(options) // returns a Promise
where options
is a plain Object
which must contain the following:
manifestURL
: the manifest URL in the client (you must have obtained this after a call to node-firefox-find-app. It's something that looks like:manifestURL: 'app://13ab1444-736d-8c4b-83a6-b83afb5f1ea4/manifest.webapp'
in the result fromfindApp
.client
: the remote client where we want to launch this app
If no options
are provided, or if options
is an empty Object
({}
), then launchApp
will fail (how can you launch you don't know what app exactly in you don't know where?)
Installing and launching a packaged app on a simulator
var startSimulator = require('node-firefox-start-simulator');
var connect = require('node-firefox-connect');
var installApp = require('node-firefox-install-app');
var findApp = require('node-firefox-find-app');
var launchApp = require('node-firefox-launch-app');
var manifestJSON = loadJSON(path.join(appPath, 'manifest.webapp'));
startSimulator().then(function(simulator) {
connect(simulator.port).then(function(client) {
installApp({
appPath: appPath,
client: client
}).then(function() {
findApp({
client: client,
manifest: manifestJSON
}).then(function(apps) {
if(apps.length > 0) {
var firstApp = apps[0];
launchApp({ manifestURL: firstApp.manifestURL });
}
});
});
});
});
You can have a look at the examples
folder for a complete example.
Running the tests
After installing, you can simply run the following from the module folder:
npm test
To add a new unit test file, create a new file in the tests/unit
folder. Any file that matches test.*.js
will be run as a test by the appropriate test runner, based on the folder location.
We use gulp
behind the scenes to run the test; if you don't have it installed globally you can use npm gulp
from inside the project's root folder to run gulp
.
Code quality and style
Because we have multiple contributors working on our projects, we value consistent code styles. It makes it easier to read code written by many people! :-)
Our tests include unit tests as well as code quality ("linting") tests that make sure our test pass a style guide and JSHint. Instead of submitting code with the wrong indentation or a different style, run the tests and you will be told where your code quality/style differs from ours and instructions on how to fix it.
License
This program is free software; it is distributed under an Apache License.
Copyright
Copyright (c) 2015 Mozilla (Contributors).