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-eslint' );
  12         grunt.loadNpmTasks( 'grunt-karma' );
  13         grunt.loadNpmTasks( 'grunt-stylelint' );
  14         grunt.loadNpmTasks( 'grunt-svgmin' );
  15
  16         karmaProxy[ wgScriptPath ] = {
  17                 target: wgServer + wgScriptPath,
  18                 changeOrigin: true
  19         };
  20
  21         grunt.initConfig( {
  22                 eslint: {
  23                         options: {
  24                                 reportUnusedDisableDirectives: true,
  25                                 extensions: [ '.js', '.json' ],
  26                                 cache: true
  27                         },
  28                         all: [
  29                                 '**/*.js{,on}',
  30                                 '!docs/**',
  31                                 '!node_modules/**',
  32                                 '!resources/lib/**',
  33                                 '!resources/src/jquery.tipsy/**',
  34                                 '!resources/src/mediawiki.libs.jpegmeta/**',
  35                                 // Third-party code of PHPUnit coverage report
  36                                 '!tests/coverage/**',
  37                                 '!vendor/**',
  38                                 // Explicitly say "**/*.js" here in case of symlinks
  39                                 '!extensions/**/*.js{,on}',
  40                                 '!skins/**/*.js{,on}'
  41                         ]
  42                 },
  43                 banana: {
  44                         options: {
  45                                 requireLowerCase: false,
  46                                 disallowBlankTranslations: false
  47                         },
  48                         core: 'languages/i18n/',
  49                         exif: 'languages/i18n/exif/',
  50                         api: 'includes/api/i18n/',
  51                         installer: 'includes/installer/i18n/'
  52                 },
  53                 stylelint: {
  54                         src: '{resources/src,mw-config}/**/*.{css,less}'
  55                 },
  56                 svgmin: {
  57                         options: {
  58                                 js2svg: {
  59                                         indent: '\t',
  60                                         pretty: true
  61                                 },
  62                                 multipass: true,
  63                                 plugins: [ {
  64                                         cleanupIDs: false
  65                                 }, {
  66                                         removeDesc: false
  67                                 }, {
  68                                         removeRasterImages: true
  69                                 }, {
  70                                         removeTitle: false
  71                                 }, {
  72                                         removeViewBox: false
  73                                 }, {
  74                                         removeXMLProcInst: false
  75                                 }, {
  76                                         sortAttrs: true
  77                                 } ]
  78                         },
  79                         all: {
  80                                 files: [ {
  81                                         expand: true,
  82                                         cwd: 'resources/src',
  83                                         src: [
  84                                                 '**/*.svg'
  85                                         ],
  86                                         dest: 'resources/src/',
  87                                         ext: '.svg'
  88                                 } ]
  89                         }
  90                 },
  91                 watch: {
  92                         files: [
  93                                 '.{stylelintrc,eslintrc.json}',
  94                                 '**/*',
  95                                 '!{docs,extensions,node_modules,skins,vendor}/**'
  96                         ],
  97                         tasks: 'test'
  98                 },
  99                 karma: {
 100                         options: {
 101                                 customLaunchers: {
 102                                         ChromeCustom: {
 103                                                 base: 'ChromeHeadless',
 104                                                 // Chrome requires --no-sandbox in Docker/CI.
 105                                                 // Newer CI images expose CHROMIUM_FLAGS which sets this (and
 106                                                 // anything else it might need) automatically. Older CI images,
 107                                                 // (including Quibble for MW) don't set it yet.
 108                                                 flags: ( process.env.CHROMIUM_FLAGS ||
 109                                                         ( process.env.ZUUL_PROJECT ? '--no-sandbox' : '' )
 110                                                 ).split( ' ' )
 111                                         }
 112                                 },
 113                                 proxies: karmaProxy,
 114                                 files: [ {
 115                                         pattern: wgServer + wgScriptPath + '/index.php?title=Special:JavaScriptTest/qunit/export',
 116                                         watched: false,
 117                                         included: true,
 118                                         served: false
 119                                 } ],
 120                                 logLevel: 'DEBUG',
 121                                 frameworks: [ 'qunit' ],
 122                                 reporters: [ 'mocha' ],
 123                                 singleRun: true,
 124                                 autoWatch: false,
 125                                 // Some tests in extensions don't yield for more than the default 10s (T89075)
 126                                 browserNoActivityTimeout: 60 * 1000,
 127                                 // Karma requires Same-Origin (or CORS) by default since v1.1.1
 128                                 // for better stacktraces. But we load the first request from wgServer
 129                                 crossOriginAttribute: false
 130                         },
 131                         main: {
 132                                 browsers: [ 'ChromeCustom' ]
 133                         },
 134                         firefox: {
 135                                 browsers: [ 'FirefoxHeadless' ]
 136                         }
 137                 },
 138                 copy: {
 139                         jsduck: {
 140                                 src: 'resources/**/*',
 141                                 dest: 'docs/js/modules',
 142                                 expand: true,
 143                                 rename: function ( dest, src ) {
 144                                         return require( 'path' ).join( dest, src.replace( 'resources/', '' ) );
 145                                 }
 146                         }
 147                 }
 148         } );
 149
 150         grunt.registerTask( 'assert-mw-env', function () {
 151                 if ( !process.env.MW_SERVER ) {
 152                         grunt.log.error( 'Environment variable MW_SERVER must be set.\n' +
 153                                 'Set this like $wgServer, e.g. "http://localhost"'
 154                         );
 155                 }
 156                 if ( !process.env.MW_SCRIPT_PATH ) {
 157                         grunt.log.error( 'Environment variable MW_SCRIPT_PATH must be set.\n' +
 158                                 'Set this like $wgScriptPath, e.g. "/w"' );
 159                 }
 160                 return !!( process.env.MW_SERVER && process.env.MW_SCRIPT_PATH );
 161         } );
 162
 163         grunt.registerTask( 'minify', 'svgmin' );
 164         grunt.registerTask( 'lint', [ 'eslint', 'banana', 'stylelint' ] );
 165         grunt.registerTask( 'qunit', [ 'assert-mw-env', 'karma:main' ] );
 166 };