useful_scripts_and_tasks.adoc

Useful scripts and tasks

The Planner delegates task running to gulp and allows parametric subtasks in the format of npm run <task> -- --subtask.

The scripts section of the package.json file lists the main tasks i.e. build, clean, and test.

The following table lists the available npm scripts managed with gulp tasks:

Task	Subtask	Command	Description
Build	[default] app	npm run build or npm run build -- --app	Builds the planner library
	image	npm run build -- --image	Creates container image for the app
	release	npm run build -- --release	Publishes the library to npm registry
	tarball	npm run build -- --tarball	Packs the library into a tarball
	validate	npm run build -- --validate	Dry runs the build for validation
	watch	npm run build -- --watch	Rebuilds planner library on file changes
Clean	[default] all	npm run clean or npm run clean -- --all	Fully resets the project
	cache	npm run clean -- --cache	Clears npm cache
	config	npm run clean -- --config	Resets app config & env_vars
	dist	npm run clean -- --dist	Removes the build artifacts
	images	npm run clean -- --images	Stops containers & removes the images
	modules	npm run clean -- --modules	Removes all node modules
	temp	npm run clean -- --temp	Removes temp files and artifacts
Tests	unit	npm run tests -- --unit	Runs the unit tests

To further understand the routines triggered by the subtask parameters refer to the gulpfile.