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