Skip to content

Grunt Tasks

Cameron Taylor edited this page Nov 16, 2017 · 3 revisions

Below is an overview of all of the grunt tasks that are defined. This is not a complete list, but they are the most common. All grunt tasks should be run from within the scripts directory.

To run a task, simply run grunt TASK_NAME where TASK_NAME comes from one of the tables below.

MODULE is a placeholder for each module name.

TypeScript Linting

Uses grunt-tslint

Task Description
tslint Run linting on all modules
tslint:MODULE Run linting on a specific module, excluding its tests
tslint:MODULE-test Run linting on a specific module, including its tests

TypeScript Compiling

Uses grunt-ts

Task Description
ts Compile all modules
ts:MODULE Compile a specific module, excluding its tests
ts:MODULE-test Compile a specific module, including its tests

TypeScript Linting and Compiling

Allows performing both linting and compiling as single tasks.

Task Description
build-MODULE Lint and Compile a specific module in parallel, excluding tests
build-MODULE-test Lint and Compile a specific module in parallel, including tests
build Build all modules, individual modules are linted/compiled in parallel, but the module chain is done in an order that preserves their dependencies. Does not include tests.
build-test Build all modules, individual modules are linted/compiled in parallel, but the module chain is done in an order that preserves their dependencies. Includes tests.

Testing

Task Description
test-MODULE Run all tests for a specific module.
test Run all tests for all modules.
build_and_test-MODULE First, build the module with tests, then run all tests for the module.
build_and_test First, build all modules with their tests, then run all tests for all modules.

Development

Task Description
MODULE First, compile/lint in parallel. If that succeeds, then that module's .ts files are watched for any changes made by the developer. When a change is made, the module is re-linted and re-compiled in parallel.
develop Lint/compile all modules with build. Once done, the service is started on localhost:3000. All .ts files are watched for changes and re-linted and compiled instantly. When the service's code changes, the service is also restarted.