node package manager

jshint-loader

npm deps test chat

jshint Loader

jshint loader for Webpack.

Install

npm i jshint-loader --save

Usage

Apply the jshint loader as pre/postLoader in your webpack configuration:

module.exports = {
    module: {
        preLoaders: [
            {
                test: /\.js$/, // include .js files 
                exclude: /node_modules/, // exclude any and all files in the node_modules folder 
                loader: "jshint-loader"
            }
        ]
    },
 
    // more options in the optional jshint object 
    jshint: {
        // any jshint option http://www.jshint.com/docs/options/ 
        // i. e. 
        camelcase: true,
 
        // jshint errors are displayed by default as warnings 
        // set emitErrors to true to display them as errors 
        emitErrors: false,
 
        // jshint to not interrupt the compilation 
        // if you want any file with jshint errors to fail 
        // set failOnHint to true 
        failOnHint: false,
 
        // custom reporter function 
        reporter: function(errors) { }
    }
}

Custom reporter

By default, jshint-loader will provide a default reporter.

However, if you prefer a custom reporter, pass a function under the reporter key in jshint options. (see usage above)

The reporter function will be passed an array of errors/warnings produced by jshint with the following structure:

[
{
    id:        [string, usually '(error)'],
    code:      [string, error/warning code],
    reason:    [string, error/warning message],
    evidence:  [string, a piece of code that generated this error]
    line:      [number]
    character: [number]
    scope:     [string, message scope;
                usually '(main)' unless the code was eval'ed]
 
    [+ a few other legacy fields that you don't need to worry about.]
},
// ... 
// more errors/warnings 
]

The reporter function will be excuted with the loader context as this. You may emit messages using this.emitWarning(...) or this.emitError(...). See webpack docs on loader context.

Note: jshint reporters are not compatible with jshint-loader! This is due to the fact that reporter input is only processed from one file; not multiple files. Error reporting in this manner differs from tranditional reporters for jshint since the loader plugin (i.e. jshint-loader) is executed for each source file; and thus the reporter is executed for each file.

The output in webpack CLI will usually be:

...
 
WARNING in ./path/to/file.js
<reporter output>
 
...

`

Maintainers


Juho Vepsäläinen
Joshua Wiens
Kees Kluskens
Sean Larkin

Unleash awesomeness

Private packages, team management tools, and powerful integrations. Get started with npm Orgs

how? learn more

Collaborators list

Stats

Try it out

Keywords

None

Dependencies (3)

loader-utils, rcloader, strip-json-comments

Dependents (22)

@boldgrid/components, boldgrid-components, webpack-seed, m-bridge, garlictech-workflows-client, caipi, becklyn-gulp, decisive, jsxhint-loader, lifter, webpack-angularity-solution, make-shift-brew-ui, arch3, slingshot-build, khoom, chameleon-styles, @boldgrid/controls, @boldgrid/components, and more