gulp-tslint-jenkins-reporter/src/reporter.js

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

'use strict'

const defaults = require('lodash.defaults')
const sortBy = require('lodash.sortby')
const File = require('vinyl')
const fs = require('fs')
const path = require('path')
const duplexer = require('duplexer')
const Stream = require('readable-stream')
const upath = require('upath')
const mkdirp = require('mkdirp')
const Formatter = require('./formatter')

function report(options) {
  const inputStream = new Stream.Transform({ objectMode: true })
  const outputStream = new Stream.PassThrough({ objectMode: true })
  const stream = duplexer(inputStream, outputStream)
  let filesBuffer = []

  const settings = getSettings(options)
  const formatter = new Formatter(settings)

  inputStream._transform = (file, unused, done) => {
    const vinyl = new File(file)
    const reportPath = getReportedFilePath(settings, vinyl)

    filesBuffer.push({
      xml: formatter.formatFile(reportPath, file.tslint.failures),
      path: reportPath,
    })

    outputStream.write(file)
    done()
  }

  inputStream._flush = done => {
    if (settings.sort) {
      filesBuffer = sortBy(filesBuffer, 'path')
    }

    const content = formatter.formatStream(filesBuffer, settings)
    outputStream.end()

    mkdirp(settings.outputDir, () => {
      fs.writeFile(settings.filename, content, err => {
        if (err) {
          console.error(err)
        }

        done()
      })
    })
  }

  return stream
}

function getSettings(options) {
  const settings = options || {}

  defaults(settings, {
    sort: false,
    filename: 'checkstyle.xml',
    severity: 'error',
    pathBase: '',
    pathPrefix: '',
  })

  settings.filename = upath.normalize(settings.filename)
  settings.outputDir = path.dirname(settings.filename)

  if (settings.pathBase) {
    settings.pathBase = upath.normalize(settings.pathBase)
  }

  if (settings.pathPrefix) {
    settings.pathPrefix = upath.normalize(settings.pathPrefix)
  }

  return settings
}

function getReportedFilePath(settings, vinyl) {
  let result = upath.normalize(vinyl.path)

  if (settings) {
    if (settings.pathBase) {
      const index = result.indexOf(settings.pathBase)
      if (index > 0) {
        result = result.substr(index + settings.pathBase.length)
      }
    }

    if (settings.pathPrefix) {
      result = path.join(settings.pathPrefix, result)
    }
  }

  if (path.sep === path.win32.sep) {
    result = result.replace(/\//, path.win32.sep)
  }

  return result
}

module.exports = { getReportedFilePath, getSettings, report }