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