# Connect-Client - Module Framework and Core Modules #

|`npm run <script>`|Description|
|:------------------|:-----------|
|`build`|Production ready output (es2015/es5)|
|`clean`|Clean .lib (rm -rf ./dist)|
|`lint`|Run tslint|
|`test`|Run unit tests|
|`compat`|Check supported browser compatibility|
|`coverage`|Generate coverage report (results are stored in coverage/)|

# 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 #

* Make sure you have a green build on your branch
* 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.
* Include changes to package-lock.json

# Consuming

For es5:

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

For es2015:

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

# Publishing

Manually bump package.json

`npm publish` to publish externally

then comment out .npmrc and

`npm publish` again to publish internally (for the Bamboo build)