gulp-typescript-jenkins-reporter

gulp-typescript pmd reporter, to be used by Jenkins (Hudson). Writes output to an xml file.

Install

1npm install gulp-typescript-jenkins-reporter -D

Usage

1var gulp = require('gulp');
2var ts = require('gulp-typescript');
3var reporter = require('gulp-typescript-jenkins-reporter');
4
5gulp.task('compile', function() {
6	return gulp.src('./src/**/*.ts')
7		.pipe(ts({
8			noImplicitAny: true,
9			out: 'output.js'
10		}, {}, reporter()))
11		.pipe(gulp.dest('./build'));
12});

see gulp-typescript for a detailed documentation on how to compile your project

Advanced usage

1var gulp = require('gulp');
2var ts = require('gulp-typescript');
3var reporter = require('gulp-typescript-jenkins-reporter');
4
5gulp.task('compile', function() {
6	return gulp.src('./src/**/*.ts')
7		.pipe(ts({
8			noImplicitAny: true,
9			out: 'output.js'
10		}, {}, reporter({
11		    filename: 'pmd-report.xml'
12		    pathBase: '/workspace',
13		    pathPrefix: 'project',
14		    sort: false
15		})))
16		.pipe(gulp.dest('./build'));
17});

Options

sort
type: boolean
default: false
will sort the files alphabetically within the report using their path.

filename
type: string
default: pmd.xml
the filename to write the report.

pathBase
type: string
default: ''
If given, the path of the files will be rebased according to the value. For instance, if your file path is

/my/awesome/yet/too/long/path/for/my/file.ts

and that you set

1{
2    pathBase: '/path/for/my'
3}

you will end up with

/my/file.ts

pathPrefix
type: string
default: ''
a prefix to add to the path. Given the previous example, you could also add this :

1{
2    pathBase: '/path/for/my',
3    pathPrefix: '/src'
4}

and end up with

/src/file.ts

LICENSE

The MIT License (MIT)