Development Guide

This section of the Source Modules wiki contains information regarding creating a Source Module. Please read through this section thoroughly to get a better understanding of the Source Modules system and how to create your own Source Module.

Scripts

This subsection of the page contains information about all the scripts used currently in the Source Modules project. To run a script, at the root directory of your copy of the Source Modules code repository on your local development machine, run the following command in your favourite shell's command-line interface.

yarn run <script>

Script	Description
build	Transpile modules' files from src folder to build folder as well as generates API documentation.
build:docs	Generates the Source Modules' API documentation in build/documentation.
build:modules	Transpile modules' files from src folder to build folder.
lint	Check code for errors.
lint:fix	Check and automatically fix code errors.
module	Run the module generator command-line app to create a new Source Module bundle or tab.
test	Run all unit tests once.
test:watch	Run all unit tests, watch files for changes and rerun tests related to changed files.

Coding Standards