felixfoertsch/webextensions-examples
1
0
Fork 0
mirror of https://github.com/mdn/webextensions-examples.git synced 2026-04-16 06:18:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix headline formatting in mocha-client-tests README (#213)

Browse Source
This commit is contained in:
kabir-plod
2017-04-30 12:44:14 +08:00
committed by wbamberg
parent ae1c2176ea
commit cf7b2a6499
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
mocha-client-tests/README.md
View File

@@ -1,12 +1,12 @@
#Mocha client tests for WebExtensions
##Introduction
# Mocha client tests for WebExtensions
## Introduction
This example shows two methods of testing a WebExtension:
* Running tests from within the addon
* Running tests from the commandline using Karma
See https://github.com/Standard8/example-webextension for a more complete example of WebExtension test configuration.
##Install Dependencies:
## Install Dependencies:
```
npm install
```
@@ -16,11 +16,11 @@ To run tests from within the addon:
npm install
```
##Testing within the Addon
## Testing within the Addon
This gives you the possibility to run client tests inside the addon with the mocha UI.
If you don't want to use the mocha UI, you can install [WebConsole-reporter](https://github.com/eeroan/WebConsole-reporter).
###Run with web-ext cli
### Run with web-ext cli
Just run `npm run web-ext` (will work with FF dev edition), if you have error with web-ext cli please add path for FF binary file with `--firefox-binary /path/to/firefox-bin`
[(web-ext docs)](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/web-ext_command_reference).
@@ -30,10 +30,10 @@ When the addon starts, click on the mocha icon in your browser bar to run the te
This will test `./addon/background.js` with `./addon/tests/lib/background-messaging.test.js`.
##Testing from the Commandline
## Testing from the Commandline
This uses [Karma](http://karma-runner.github.io) to run tests from the commandline. Just type `npm test` to test `./addon/background.js` with `./tests/lib/background.test.js`.
###Debug Mode
### Debug Mode
Use `npm run test:debug` to run Karma in watch mode. Whenever you modify a Javascript file, the tests will automatically rerun.
You can install [karma-notification-reporter](https://www.npmjs.com/package/karma-notification-reporter) to display test results in a desktop notification. You'll need to add `--reporters=dots,notification` to the `test:debug` command line of