/* jshint node:true */ module.exports = function( grunt ) { 'use strict'; var sass = require( 'node-sass' ); grunt.initConfig({ // Setting folder templates. dirs: { css: 'assets/css', fonts: 'assets/fonts', images: 'assets/images', js: 'assets/js', php: 'includes' }, // JavaScript linting with JSHint. jshint: { options: { jshintrc: '.jshintrc' }, all: [ '<%= dirs.js %>/admin/*.js', '!<%= dirs.js %>/admin/*.min.js', '<%= dirs.js %>/frontend/*.js', '!<%= dirs.js %>/frontend/*.min.js' ] }, // Sass linting with Stylelint. stylelint: { options: { configFile: '.stylelintrc' }, all: [ '<%= dirs.css %>/*.scss', '!<%= dirs.css %>/select2.scss' ] }, // Minify .js files. uglify: { options: { ie8: true, parse: { strict: false }, output: { comments : /@license|@preserve|^!/ } }, admin: { files: [{ expand: true, cwd: '<%= dirs.js %>/admin/', src: [ '*.js', '!*.min.js' ], dest: '<%= dirs.js %>/admin/', ext: '.min.js' }] }, vendor: { files: { '<%= dirs.js %>/accounting/accounting.min.js': ['<%= dirs.js %>/accounting/accounting.js'], '<%= dirs.js %>/jquery-blockui/jquery.blockUI.min.js': ['<%= dirs.js %>/jquery-blockui/jquery.blockUI.js'], '<%= dirs.js %>/jquery-cookie/jquery.cookie.min.js': ['<%= dirs.js %>/jquery-cookie/jquery.cookie.js'], '<%= dirs.js %>/js-cookie/js.cookie.min.js': ['<%= dirs.js %>/js-cookie/js.cookie.js'], '<%= dirs.js %>/jquery-flot/jquery.flot.min.js': ['<%= dirs.js %>/jquery-flot/jquery.flot.js'], '<%= dirs.js %>/jquery-flot/jquery.flot.pie.min.js': ['<%= dirs.js %>/jquery-flot/jquery.flot.pie.js'], '<%= dirs.js %>/jquery-flot/jquery.flot.resize.min.js': ['<%= dirs.js %>/jquery-flot/jquery.flot.resize.js'], '<%= dirs.js %>/jquery-flot/jquery.flot.stack.min.js': ['<%= dirs.js %>/jquery-flot/jquery.flot.stack.js'], '<%= dirs.js %>/jquery-flot/jquery.flot.time.min.js': ['<%= dirs.js %>/jquery-flot/jquery.flot.time.js'], '<%= dirs.js %>/jquery-payment/jquery.payment.min.js': ['<%= dirs.js %>/jquery-payment/jquery.payment.js'], '<%= dirs.js %>/jquery-qrcode/jquery.qrcode.min.js': ['<%= dirs.js %>/jquery-qrcode/jquery.qrcode.js'], '<%= dirs.js %>/jquery-serializejson/jquery.serializejson.min.js': [ '<%= dirs.js %>/jquery-serializejson/jquery.serializejson.js' ], '<%= dirs.js %>/jquery-tiptip/jquery.tipTip.min.js': ['<%= dirs.js %>/jquery-tiptip/jquery.tipTip.js'], '<%= dirs.js %>/jquery-ui-touch-punch/jquery-ui-touch-punch.min.js': [ '<%= dirs.js %>/jquery-ui-touch-punch/jquery-ui-touch-punch.js' ], '<%= dirs.js %>/prettyPhoto/jquery.prettyPhoto.init.min.js': ['<%= dirs.js %>/prettyPhoto/jquery.prettyPhoto.init.js'], '<%= dirs.js %>/prettyPhoto/jquery.prettyPhoto.min.js': ['<%= dirs.js %>/prettyPhoto/jquery.prettyPhoto.js'], '<%= dirs.js %>/flexslider/jquery.flexslider.min.js': ['<%= dirs.js %>/flexslider/jquery.flexslider.js'], '<%= dirs.js %>/zoom/jquery.zoom.min.js': ['<%= dirs.js %>/zoom/jquery.zoom.js'], '<%= dirs.js %>/photoswipe/photoswipe.min.js': ['<%= dirs.js %>/photoswipe/photoswipe.js'], '<%= dirs.js %>/photoswipe/photoswipe-ui-default.min.js': ['<%= dirs.js %>/photoswipe/photoswipe-ui-default.js'], '<%= dirs.js %>/round/round.min.js': ['<%= dirs.js %>/round/round.js'], '<%= dirs.js %>/selectWoo/selectWoo.full.min.js': ['<%= dirs.js %>/selectWoo/selectWoo.full.js'], '<%= dirs.js %>/selectWoo/selectWoo.min.js': ['<%= dirs.js %>/selectWoo/selectWoo.js'], '<%= dirs.js %>/stupidtable/stupidtable.min.js': ['<%= dirs.js %>/stupidtable/stupidtable.js'], '<%= dirs.js %>/zeroclipboard/jquery.zeroclipboard.min.js': ['<%= dirs.js %>/zeroclipboard/jquery.zeroclipboard.js'] } }, frontend: { files: [{ expand: true, cwd: '<%= dirs.js %>/frontend/', src: [ '*.js', '!*.min.js' ], dest: '<%= dirs.js %>/frontend/', ext: '.min.js' }] }, flexslider: { files: [{ '<%= dirs.js %>/flexslider/jquery.flexslider.min.js': ['<%= dirs.js %>/flexslider/jquery.flexslider.js'] }] } }, // Compile all .scss files. sass: { compile: { options: { implementation: sass, sourceMap: 'none' }, files: [{ expand: true, cwd: '<%= dirs.css %>/', src: ['*.scss'], dest: '<%= dirs.css %>/', ext: '.css' }] } }, // Generate RTL .css files. rtlcss: { woocommerce: { expand: true, cwd: '<%= dirs.css %>', src: [ '*.css', '!select2.css', '!*-rtl.css' ], dest: '<%= dirs.css %>/', ext: '-rtl.css' } }, // Minify all .css files. cssmin: { minify: { expand: true, cwd: '<%= dirs.css %>/', src: ['*.css'], dest: '<%= dirs.css %>/', ext: '.css' } }, // Concatenate select2.css onto the admin.css files. concat: { admin: { files: { '<%= dirs.css %>/admin.css' : ['<%= dirs.css %>/select2.css', '<%= dirs.css %>/admin.css'], '<%= dirs.css %>/admin-rtl.css' : ['<%= dirs.css %>/select2.css', '<%= dirs.css %>/admin-rtl.css'] } } }, // Watch changes for assets. watch: { css: { files: ['<%= dirs.css %>/*.scss'], tasks: ['sass', 'rtlcss', 'postcss', 'cssmin', 'concat'] }, js: { files: [ '<%= dirs.js %>/admin/*js', '<%= dirs.js %>/frontend/*js', '!<%= dirs.js %>/admin/*.min.js', '!<%= dirs.js %>/frontend/*.min.js' ], tasks: ['jshint', 'uglify'] } }, // Generate POT files. makepot: { options: { type: 'wp-plugin', domainPath: 'i18n/languages', potHeaders: { 'report-msgid-bugs-to': 'https://github.com/woocommerce/woocommerce/issues', 'language-team': 'LANGUAGE ' } }, dist: { options: { potFilename: 'woocommerce.pot', exclude: [ 'apigen/.*', 'vendor/.*', 'tests/.*', 'tmp/.*' ] } } }, // Check textdomain errors. checktextdomain: { options:{ text_domain: 'woocommerce', keywords: [ '__:1,2d', '_e:1,2d', '_x:1,2c,3d', 'esc_html__:1,2d', 'esc_html_e:1,2d', 'esc_html_x:1,2c,3d', 'esc_attr__:1,2d', 'esc_attr_e:1,2d', 'esc_attr_x:1,2c,3d', '_ex:1,2c,3d', '_n:1,2,4d', '_nx:1,2,4c,5d', '_n_noop:1,2,3d', '_nx_noop:1,2,3c,4d' ] }, files: { src: [ '**/*.php', // Include all files '!apigen/**', // Exclude apigen/ '!includes/libraries/**', // Exclude libraries/ '!node_modules/**', // Exclude node_modules/ '!tests/**', // Exclude tests/ '!vendor/**', // Exclude vendor/ '!tmp/**' // Exclude tmp/ ], expand: true } }, // Exec shell commands. shell: { options: { stdout: true, stderr: true }, apidocs: { command: [ 'vendor/bin/apigen generate -q', 'cd apigen', 'php hook-docs.php' ].join( '&&' ) }, e2e_test: { command: 'npm run --silent test:single tests/e2e-tests/' + grunt.option( 'file' ) }, e2e_tests: { command: 'npm run --silent test' }, e2e_tests_grep: { command: 'npm run --silent test:grep "' + grunt.option( 'grep' ) + '"' }, contributors: { command: [ 'echo "Generating contributor list since <%= fromDate %>"', './node_modules/.bin/githubcontrib --owner woocommerce --repo woocommerce --fromDate <%= fromDate %>' + ' --authToken <%= authToken %> --cols 6 --sortBy contributions --format md --sortOrder desc' + ' --showlogin true > contributors.md' ].join( '&&' ) } }, prompt: { contributors: { options: { questions: [ { config: 'fromDate', type: 'input', message: 'What date (YYYY-MM-DD) should we get contributions since?' }, { config: 'authToken', type: 'input', message: '(optional) Provide a personal access token.' + ' This will allow 5000 requests per hour rather than 60 - use if nothing is generated.' } ] } } }, // Clean the directory. clean: { apidocs: { src: [ 'wc-apidocs' ] }, blocks: { src: [ '<%= dirs.js %>/blocks', '<%= dirs.css %>/blocks', '<%= dirs.php %>/blocks' ] } }, // PHP Code Sniffer. phpcs: { options: { bin: 'vendor/bin/phpcs' }, dist: { src: [ '**/*.php', // Include all php files. '!apigen/**', '!includes/api/legacy/**', '!includes/libraries/**', '!node_modules/**', '!tests/cli/**', '!tmp/**', '!vendor/**' ] } }, // Autoprefixer. postcss: { options: { processors: [ require( 'autoprefixer' )({ browsers: [ '> 0.1%', 'ie 8', 'ie 9' ] }) ] }, dist: { src: [ '<%= dirs.css %>/*.css' ] } }, // Copy block files from npm package. copy: { js: { expand: true, cwd: 'node_modules/@woocommerce/block-library/build', src: '*.js', dest: '<%= dirs.js %>/blocks/', options: { process: ( content ) => content.replace( /'woo-gutenberg-products-block'/g, "'woocommerce'" ) } }, css: { expand: true, cwd: 'node_modules/@woocommerce/block-library/build', src: '*.css', dest: '<%= dirs.css %>/blocks/' }, php: { expand: true, cwd: 'node_modules/@woocommerce/block-library/assets/php', src: '*.php', dest: '<%= dirs.php %>/blocks/', rename: ( dest, src ) => dest + '/' + src.replace( '-wgpb-', '-wc-' ), options: { process: ( content ) => content // Replace textdomain. .replace( /'woo-gutenberg-products-block'/g, "'woocommerce'" ) // Replace source for JS files. .replace( /plugins_url\( 'build\/([\w-]*)\.js', WGPB_PLUGIN_FILE \)/g, "WC()->plugin_url() . '/assets/js/blocks/$1.js'" ) // Replace source for CSS files. .replace( /plugins_url\( 'build\/([\w-]*)\.css', WGPB_PLUGIN_FILE \)/g, "WC()->plugin_url() . '/assets/css/blocks/$1.css'" ) // Replace class & constant prefixes. .replace( /WGPB_/g, 'WC_' ) .replace( /FP_VERSION/g, 'WGPB_VERSION' ) // Replace file imports .replace( /-wgpb-/g, '-wc-' ) } } } }); // Load NPM tasks to be used here. grunt.loadNpmTasks( 'grunt-sass' ); grunt.loadNpmTasks( 'grunt-shell' ); grunt.loadNpmTasks( 'grunt-phpcs' ); grunt.loadNpmTasks( 'grunt-rtlcss' ); grunt.loadNpmTasks( 'grunt-postcss' ); grunt.loadNpmTasks( 'grunt-stylelint' ); grunt.loadNpmTasks( 'grunt-wp-i18n' ); grunt.loadNpmTasks( 'grunt-checktextdomain' ); grunt.loadNpmTasks( 'grunt-contrib-jshint' ); grunt.loadNpmTasks( 'grunt-contrib-uglify' ); grunt.loadNpmTasks( 'grunt-contrib-cssmin' ); grunt.loadNpmTasks( 'grunt-contrib-concat' ); grunt.loadNpmTasks( 'grunt-contrib-copy' ); grunt.loadNpmTasks( 'grunt-contrib-watch' ); grunt.loadNpmTasks( 'grunt-contrib-clean' ); grunt.loadNpmTasks( 'grunt-prompt' ); // Register tasks. grunt.registerTask( 'default', [ 'js', 'css', 'blocks', 'i18n' ]); grunt.registerTask( 'js', [ 'jshint', 'uglify:admin', 'uglify:frontend', 'uglify:flexslider' ]); grunt.registerTask( 'css', [ 'sass', 'rtlcss', 'postcss', 'cssmin', 'concat' ]); grunt.registerTask( 'assets', [ 'js', 'css' ]); grunt.registerTask( 'blocks', [ 'clean:blocks', 'copy' ]); grunt.registerTask( 'docs', [ 'clean:apidocs', 'shell:apidocs' ]); grunt.registerTask( 'contributors', [ 'prompt:contributors', 'shell:contributors' ]); // Only an alias to 'default' task. grunt.registerTask( 'dev', [ 'default' ]); grunt.registerTask( 'i18n', [ 'checktextdomain', 'makepot' ]); grunt.registerTask( 'e2e-tests', [ 'shell:e2e_tests' ]); grunt.registerTask( 'e2e-tests-grep', [ 'shell:e2e_tests_grep' ]); grunt.registerTask( 'e2e-test', [ 'shell:e2e_test' ]); };