@atlassian/connect-module-core

Connect-Client - Module Framework and Core Modules

npm run <script>	Description
build	Production ready output (es6)
clean	Clean .lib (rm -rf ./lib)
lint	Run tslint
test	Run unit tests.
yarn run ts-coverage-remap	Generate coverage report (results are stored in coverage/html-ts)

Development

Make sure you have typescript, typings and webpack installed globally. npm install -g typescript typings webpack.

Run npm install followed by typings install and you should be good to go.

#Dev Loop

Run npm run build to clean, lint, compile and test.

Before raising a PR

• Run lint
• Run tests
• Check your code is well covered - we aim for > 90% coverage where possible. To view coverage report use npm run coverage and browse the coverage dir.

Consuming

For es5:

import ... from '@atlassian/connect-module-core'

For es2015:

import ... from '@atlassian/connect-module-core/dist/es2015'