Nomadic People Migration

    gulp-reporter

    2.10.0 • Public • Published

    gulp-reporter

    NPM version Travis AppVeyor Codecov David

    Error report for: CSSLint EditorConfig ESLint HTMLHint JSCS JSHint JSONLint PostCSS Standard StyLint TSLint XO

    Analyzing blame of the error, only fail for errors that belong to current GIT user.

    Install

    npm install gulp-reporter

    Usage

    gulp.src('test/fixtures/eslint/invalid.js')
      .pipe(eslint())
      .pipe(reporter(options));

    demo

    API

    reporter(options)

    or

    reporter((file) => options)

    options.browser

    Type: boolean

    Default: false

    Report error messages right in your browser.

    options.output

    Type: boolean|function|WritableStream

    Default: true and false for Special output format

    Report error messages in fancy-log or your function|WritableStream

    options.sort

    Type: boolean|function

    Default: true

    Messages will be sorted by fileName/severity/line/column, or your function.

    options.author

    Type: {name?: string|RegExp, email?: string|RegExp}

    Default: Read from GIT pre-commit environment and fallbacks with GIT commad git log --max-count=1 --no-merges

    Do not fail for errors that not belong to specified author.

    Do not work when options.blame set to false

    options.expires

    Type: string for time periods, number of unix timestamp, Date

    Do not fail for old errors that create early specified time.

    Do not work when options.blame set to false

    options.maxLineLength

    Type: number

    Default: 512

    Hide each error in lines that length greater than this threshold.

    options.mapper

    Type: function|null

    Default: null

    Convert errors.

    reporter({
      mapper: file => {
        const path = file.path;
        return error => {
          // Do not report unrelated errors.
          if (error.fileName === path) {
            return error
          }
        }
      }
    })
    

    options.fail

    Type: boolean|function

    Default: true

    Stop a task/stream if an error has been reported for any file, but wait for all of them to be processed first.

    options.blame

    Type: boolean

    Default: true

    Enable or disable git-blame related features (options.author, options.expires).

    Language localization support for HTMLHint JSHint EditorConfig:

    • en
    • zh_CN
    • zh_TW

    POSIX systems: The returned locale refers to the LC_MESSAGE category, suitable for selecting the language used in the user interface for message translation.

    Special output format

    Related

    Install

    npm i gulp-reporter

    DownloadsWeekly Downloads

    20,940

    Version

    2.10.0

    License

    MIT

    Unpacked Size

    655 kB

    Total Files

    40

    Last publish

    Collaborators

    • gucong