Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 1.35 KB

DEVELOPER.md

File metadata and controls

85 lines (54 loc) · 1.35 KB

Submitting Changes

Do NOT submit changes to the built files in the dist folder. These are generated before releases.

To run tests

Make sure your environment is set up with:

yarn

In a separate process, run the WebSockets server:

yarn ws-server

Run the browser tests using Karma:

yarn test

Run the node.js tests:

yarn test-node

Run tslint:

yarn lint

Run format with clang-format:

yarn format

Run all checks (lint/format/browser test/test-node):

yarn ci

Before Commit

Please make sure you pass all following checks before commit

  • gulp lint (tslint)
  • gulp format:enforce (clang-format)
  • gulp promisetest (promise a+ test)
  • yarn test (karma browser test)
  • gulp test-node (node test)

You can run

yarn ci

to do all those checks for you. You can also add the script into your git pre-commit hook

echo -e 'exec npm run ci' > .git/hooks/pre-commit
chmod u+x .git/hooks/pre-commit 

Webdriver Test

zone.js also supports running webdriver e2e tests.

  1. run locally
yarn webdriver-start
yarn webdriver-http
yarn webdriver-test
  1. run locally with sauce connect
// export SAUCE_USERNAME and SAUCE_ACCESS_KEY
export SAUCE_USERNAME=XXXX
export SAUCE_ACCESS_KEY=XXX

sc -u $SAUCE_USERNAME -k $SAUCE_ACCESS_KEY
yarn webdriver-http
yarn webdriver-sauce-test