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