# gulp-jshint-xml-file-reporter

> A JSHint reporter to be used with gulp-jshint that will provide XML (i.e. checkstyle and junit), that can be used by CI tools such as jenkins

Latest version **0.5.1** (published 2015-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-jshint-xml-file-reporter
pnpm add gulp-jshint-xml-file-reporter
yarn add gulp-jshint-xml-file-reporter
bun add gulp-jshint-xml-file-reporter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2015-03-16 |
| First published | 2014-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Lourenzo Ferreira |
| Maintainers | lourenzo |
| Keywords | gulp, jshint, jslint, checkstyle, junit, integration, xml, ci, jenkins |

## Links

- npm: https://www.npmjs.com/package/gulp-jshint-xml-file-reporter
- Repository: https://github.com/lourenzo/gulp-jshint-xml-file-reporter
- Issues: https://github.com/lourenzo/gulp-jshint-xml-file-reporter/issues
- npm.io page: https://npm.io/package/gulp-jshint-xml-file-reporter

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 0.5.1 (latest) — 2015-03-16
- 0.5.0 — 2015-03-13
- 0.3.3 — 2015-02-11
- 0.3.1 — 2014-12-19
- 0.3.0 — 2014-12-12
- 0.2.0 — 2014-12-11
- 0.1.4 — 2014-12-10
- 0.1.3 — 2014-12-10
- 0.1.2 — 2014-12-10
- 0.1.1 — 2014-12-10
- 0.1.0 — 2014-12-10

## README

Gulp JSHint XML File Reporter
=============================
[![Build Status](https://travis-ci.org/lourenzo/gulp-jshint-xml-file-reporter.svg)](https://travis-ci.org/lourenzo/gulp-jshint-xml-file-reporter)

Information
-----------

<table>
    <tr>
        <td>Package</td>
        <td>gulp-jshint-xml-file-reporter</td>
    </tr>
    <tr>
        <td>Description</td>
        <td>
            A JSHint reporter to be used by `gulp-jshint` that will provide a jslint.xml file that can be used by CI tools as jenkins.
        </td>
    </tr>
    <tr>
        <td>Node Version</td>
        <td>>= 0.4</td>
    </tr>
</table>

Install
-------

`npm install gulp-jshint-xml-file-reporter --save-dev`


Usage
-----

```javascript
var gulp = require('gulp'),
    jshint = require('gulp-jshint'),
    jshintXMLReporter = require('gulp-jshint-xml-file-reporter');

gulp.task('lint', function () {
    return gulp.src('./**/*.js')
        .pipe(jshint())
        .pipe(jshint.reporter(jshintXMLReporter))
        .on('end', jshintXMLReporter.writeFile({
            format: 'checkstyle',
            filePath: './jshint.xml'
        }));
});
```

Options
-------

```javascript
{
    format: String // (checkstyle | jslint | junit) - defaults to checkstyle
    filePath: String // Path to write a file - defaults to jshint.xml
    alwaysReport: Boolean // Will write a report file even if there are
                          // no failing tests - defaults to false
}
```

Release History
---------------
- 2015-03-13    `0.5.0` - Added option to generate empty files
- 2015-02-23    `0.4.0` - Renamed jslint_xml formater to jslint
- 2015-02-23    `0.3.4` - Added error messaging to warn the user when an emitter does not exist
- 2015-02-11    `0.3.3` - Added JUnit Emitter


Inspired by:
------------

* [Gulp JSHint File Reporter](https://github.com/spenceralger/gulp-jshint-file-reporter)
* [JSHint's jslint_xml reporter](https://github.com/jshint/jshint/blob/master/src/reporters/jslint_xml.js)
* [JSHint checkstyle reporter](https://github.com/mila-labs/jshint-checkstyle-file-reporter)

---
_Source: https://npm.io/package/gulp-jshint-xml-file-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
