tpa-seed

An element providing a starting point for your own reusable TPA elements.

Getting Started For Quickly

Recommended for experienced developers only.

Install global dependencies

npm install -g bower polylint polyserve web-component-tester web-component-tester-istanbul

Install local dependencies

npm run deps

Host component with API mocks

npm run serve

Run the unit tests

npm run test

Getting Started

Dependencies

Element dependencies are managed via Bower. You can install that via:

npm install -g bower

Then, go ahead and download the element's dependencies:

bower install

Linting Your Element

If you wish to lint your element, we recommend that you use Polylint to take into account Polymer linting specificities.

You can install it via:

npm install -g polylint

And you can run it via:

polylint -i tpa-seed.html

or

polylint

If your bower.json file has main pointed to your component

"main": "tpa-seed.html",

If your element contains errors, they will appear on the console.

Note: that it is possible to use Polylint with Atom and Sublime with the appropriate package/plugin.

For more options regarding polylint, please refer to the documentation.

Playing With Your Element

If you wish to work on your element in isolation, we recommend that you use Polyserve to keep your element's bower dependencies in line. You can install it via:

npm install -g polyserve

And you can run it via:

npm run serve

Do not run via polyserve if you depend on the API mocking host

Once running, you can preview your element at http://localhost:8080/components/tpa-seed/, where tpa-seed is the name of the directory containing it.

API Blueprint

Hosting API Blueprint mocks is provided via Drakov

The hosting of the mocks combined with polyserve is via Proxy Middleware

Testing Your Element

Simply navigate to the /test directory of your element to run its tests. If you are using Polyserve: http://localhost:8080/components/tpa-seed/test/

Unit Testing

The tests are compatible with web-component-tester.

Code coverage is provided by Istanbul

Install them via:

npm install -g web-component-tester web-component-tester-istanbul

Then, you can run your tests on all of your local browsers via:

npm run test

or

wct

WCT Tips

wct -l chrome will only run tests in chrome.

wct -p will keep the browsers alive after test runs (refresh to re-run).

wct test/some-file.html will test only the files you specify.

Yeoman support

If you'd like to use Yeoman to scaffold your element that's possible. The TPA generator-tpa generator has a tpa subgenerator.