Skip to content
This repository was archived by the owner on Jan 9, 2019. It is now read-only.

Commit 3b95fe6

Browse files
author
Daniel Beus
committed
Added documentation to the README.md for plugin usage
1 parent 5333a03 commit 3b95fe6

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# gulp-mstest
1+
gulp-mstest
2+
==========
23
Gulp wrapper for running MSTest
4+
5+
Usage
6+
---------
7+
Use gulp-mstest like any other gulp plugin:
8+
```
9+
var gulp = require('gulp'),
10+
mstest = require('gulp-mstest');
11+
12+
gulp.task('mstest', function () {
13+
return gulp.src('mytestlibrary.dll')
14+
.pipe(mstest());
15+
});
16+
```
17+
18+
###Options
19+
Gulp-Mstest has a few minor settings that determine what gets output to the console. By default, nothing is printed to the console -- you will need to tie in another stream to get output. This is beneficial because it allows you to put the test results wherever you want (e.g. file, console, web service, etc.). However, if you'd like to have output, here are the settings to do so:
20+
21+
- outputEachResult: This will output the pass or fail status of each test as it is run
22+
- Example: 'Passed: MyUnitTest'
23+
- errorMessage: This will output the full error message generated from mstest as each test is run. outputEachResult must be set to true for these to be output.
24+
- errorStackTrace: This will output the full stack trace generated from mstest as each test is run. outputEachResult must be set to true for these to be output.
25+
- outputFinalCount: This will output the total number of tests that passed
26+
- Example: 'Passed 3/5'
27+
- quitOnFailed: This causes gulp-mstest to use a gulp plugin error if any of the tests in a dll failed to pass. This is useful when there are multiple test packages that must run and you want to be notified as soon as one fails.
28+
- If errorMessage or errorStackTrace are on, they will be output with the failed message

index.js

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ module.exports = function (opts) {
1616
return;
1717
}
1818

19+
gutil.log(gutil.colors.italic(gutil.colors.bold('Running tests in ' + file.path)));
20+
1921
try {
2022
var msTest = new MSTest();
2123
msTest.testContainer = file.path;

0 commit comments

Comments
 (0)