TID Node Workshop - Steel Client
var catanSteelClient = ;var client = catanSteelClient;client;
The project is managed using Grunt Task Runner.
For a list of available task, type
The following sections show the available options in detail.
Module mocking during testing can be done with proxyquire
To run tests, type
Tests reports can be used together with Jenkins to monitor project quality metrics by means of TAP or XUnit plugins.
To generate TAP report in
Uses provided .jshintrc and .gjslintrc flag files. The latter requires Python and its use can be disabled while creating the project skeleton with grunt-init. To check source code style, type
Checkstyle reports can be used together with Jenkins to monitor project quality metrics by means of Checkstyle
and Violations plugins.
To generate Checkstyle and JSLint reports under
Support for continuous testing by modifying a src file or a test. For continuous testing, type
Generates HTML documentation under
site/doc/. It can be used together with jenkins by means of DocLinks plugin.
For compiling source code documentation, type
# Currently not supported on Windowsgrunt doc
Generates HTML coverage under
site/coverage/ and coverage report in
The latter one can be used together with Jenkins to monitor project quality metrics by means of Cobertura plugin.
For analyzing the code coverage of your test, type
# Currently not supported on Windowsgrunt coverage
Analizes code complexity using Plato and stores the report under
site/report/. It can be used together with jenkins
by means of DocLinks plugin.
For complexity report, type
Update the contributors for the project
Initialize your environment with git hooks
There is a grunt task to generate the GitHub pages of the project, publishing also coverage, complexity and JSDocs pages. In order to initialize the GitHub pages, use:
This will also create a site folder under the root of your repository. This site folder is detached from your repository's history, and associated to the gh-pages branch, created for publishing. This initialization action should be done only once in the project history. Once the site has been initialized, publish with the following command:
This command will only work after the developer has executed init-dev-env (that's the goal that will create the detached site).
This command will also launch the coverage, doc and complexity task (see in the above sections).