CRS Starter

Introduction

This is a small template project to help with library development. It includes all the required building blocks already set up ready to use. There are a couple of conventions to consider.

1. Source code is in the "src folder"
2. Tests have the same name as the src file but also includes ".test" at the end of the name. For example "my-class.test.js"
3. index.js found in the src folder is the bundling entry and exports the library api using the export function

Standard features included

1. Jest tests configured for ES6
2. Rollup bundling with minification using Tensor
3. Build publish folder

Scripts

The package.json file has two scripts defined for common use.

1. Test
2. Bundle
3. Publish

Tests

Jest is set up to allow es6 using Babel.
It also includes code completion.

Publish

Use the publish node script to bundle your files and copy them to the publish folder.
The following files will automatically be copied to the publish folder:

1. All your files located in the dist folder
2. package.json file with the version number updated
3. readme.md

If you want other files to be included, update "distribute" function in the /build/publish.js file.