Gruntfile.js

   1 /* eslint-env node */
   2
   3 module.exports = function ( grunt ) {
   4
   5         var wgServer = process.env.MW_SERVER,
   6                 wgScriptPath = process.env.MW_SCRIPT_PATH,
   7                 karmaProxy = {};
   8
   9         grunt.loadNpmTasks( 'grunt-banana-checker' );
  10         grunt.loadNpmTasks( 'grunt-contrib-copy' );
  11         grunt.loadNpmTasks( 'grunt-contrib-watch' );
  12         grunt.loadNpmTasks( 'grunt-eslint' );
  13         grunt.loadNpmTasks( 'grunt-jsonlint' );
  14         grunt.loadNpmTasks( 'grunt-karma' );
  15         grunt.loadNpmTasks( 'grunt-stylelint' );
  16
  17         karmaProxy[ wgScriptPath ] = {
  18                 target: wgServer + wgScriptPath,
  19                 changeOrigin: true
  20         };
  21
  22         grunt.initConfig( {
  23                 eslint: {
  24                         options: {
  25                                 reportUnusedDisableDirectives: true
  26                         },
  27                         all: [
  28                                 '**/*.js',
  29                                 '!docs/**',
  30                                 '!node_modules/**',
  31                                 '!resources/lib/**',
  32                                 '!resources/src/jquery.tipsy/**',
  33                                 '!resources/src/mediawiki.libs.jpegmeta/**',
  34                                 // Third-party code of PHPUnit coverage report
  35                                 '!tests/coverage/**',
  36                                 '!vendor/**',
  37                                 // Explicitly say "**/*.js" here in case of symlinks
  38                                 '!extensions/**/*.js',
  39                                 '!skins/**/*.js'
  40                         ]
  41                 },
  42                 jsonlint: {
  43                         all: [
  44                                 '**/*.json',
  45                                 '!{docs/js,extensions,node_modules,skins,vendor}/**'
  46                         ]
  47                 },
  48                 banana: {
  49                         options: {
  50                                 disallowBlankTranslations: false
  51                         },
  52                         core: 'languages/i18n/',
  53                         exif: 'languages/i18n/exif/',
  54                         api: 'includes/api/i18n/',
  55                         installer: 'includes/installer/i18n/'
  56                 },
  57                 stylelint: {
  58                         src: '{resources/src,mw-config}/**/*.{css,less}'
  59                 },
  60                 watch: {
  61                         files: [
  62                                 '.{stylelintrc,eslintrc.json}',
  63                                 '**/*',
  64                                 '!{docs,extensions,node_modules,skins,vendor}/**'
  65                         ],
  66                         tasks: 'test'
  67                 },
  68                 karma: {
  69                         options: {
  70                                 proxies: karmaProxy,
  71                                 files: [ {
  72                                         pattern: wgServer + wgScriptPath + '/index.php?title=Special:JavaScriptTest/qunit/export',
  73                                         watched: false,
  74                                         included: true,
  75                                         served: false
  76                                 } ],
  77                                 logLevel: 'DEBUG',
  78                                 frameworks: [ 'qunit' ],
  79                                 reporters: [ 'mocha' ],
  80                                 singleRun: true,
  81                                 autoWatch: false,
  82                                 // Some tests in extensions don't yield for more than the default 10s (T89075)
  83                                 browserNoActivityTimeout: 60 * 1000,
  84                                 // Karma requires Same-Origin (or CORS) by default since v1.1.1
  85                                 // for better stacktraces. But we load the first request from wgServer
  86                                 crossOriginAttribute: false
  87                         },
  88                         main: {
  89                                 browsers: [ 'Chrome' ]
  90                         },
  91                         chromium: {
  92                                 browsers: [ 'Chromium' ]
  93                         },
  94                         firefox: {
  95                                 browsers: [ 'Firefox' ]
  96                         }
  97                 },
  98                 copy: {
  99                         jsduck: {
 100                                 src: 'resources/**/*',
 101                                 dest: 'docs/js/modules',
 102                                 expand: true,
 103                                 rename: function ( dest, src ) {
 104                                         return require( 'path' ).join( dest, src.replace( 'resources/', '' ) );
 105                                 }
 106                         }
 107                 }
 108         } );
 109
 110         grunt.registerTask( 'assert-mw-env', function () {
 111                 if ( !process.env.MW_SERVER ) {
 112                         grunt.log.error( 'Environment variable MW_SERVER must be set.\n' +
 113                                 'Set this like $wgServer, e.g. "http://localhost"'
 114                         );
 115                 }
 116                 if ( !process.env.MW_SCRIPT_PATH ) {
 117                         grunt.log.error( 'Environment variable MW_SCRIPT_PATH must be set.\n' +
 118                                 'Set this like $wgScriptPath, e.g. "/w"' );
 119                 }
 120                 return !!( process.env.MW_SERVER && process.env.MW_SCRIPT_PATH );
 121         } );
 122
 123         grunt.registerTask( 'lint', [ 'eslint', 'banana', 'stylelint' ] );
 124         grunt.registerTask( 'qunit', [ 'assert-mw-env', 'karma:main' ] );
 125
 126         grunt.registerTask( 'test', [ 'lint' ] );
 127         grunt.registerTask( 'default', 'test' );
 128 };