Gruntfile.js

/* jshint node:true */
/* global module */
module.exports = function (grunt) {
	var sass = require('node-sass'),
		SOURCE_DIR = 'src/',
		BUILD_DIR = 'buddyboss-platform/',

		BP_CSS = [
			'**/*.css',
			'!**/*.min.css',
			'!**/vendor/*.css'
		],

		// CSS exclusions, for excluding files from certain tasks, e.g. rtlcss
		BP_EXCLUDED_CSS = [
			'!**/*-rtl.css',
			'!bp-forums/**/*.css'
		],

		BP_JS = [
			'**/*.js',
			'!**/*.min.js',
			'!bp-forums/**/*.js',
			'!**/vendor/**/*.js'
		],

		BP_EXCLUDED_MISC = [],

		// SASS generated "Twenty*"" CSS files
		BP_SCSS_CSS_FILES = [
			// '!bp-templates/bp-legacy/css/twenty*.css',
			'!bp-templates/bp-nouveau/css/buddypress.css',
			'!bp-core/admin/css/hello.css',
			'!bp-core/css/medium-editor-beagle.css',
			'!bp-core/css/medium-editor.css'
		],

		stylelintConfigCss = require('stylelint-config-wordpress/index.js'),
		stylelintConfigScss = require('stylelint-config-wordpress/scss.js');

	if (typeof stylelintConfigCss.rules !== 'undefined') {
		stylelintConfigCss.rules = Object.assign(stylelintConfigCss.rules, {
			'no-descending-specificity': null,
			'selector-pseudo-element-colon-notation': null,
			'no-duplicate-selectors': null,
			'selector-class-pattern': null,
			'selector-id-pattern': null
		});
	}
	if (typeof stylelintConfigScss.rules !== 'undefined') {
		stylelintConfigScss.rules = Object.assign(stylelintConfigScss.rules, {
			'no-descending-specificity': null,
			'selector-pseudo-element-colon-notation': null,
			'no-duplicate-selectors': null,
			'selector-class-pattern': null,
			'selector-id-pattern': null,
			'font-family-no-missing-generic-family-keyword': null,
			'selector-combinator-space-after': null
		});
	}

	require('matchdep').filterDev(['grunt-*', '!grunt-legacy-util']).forEach(grunt.loadNpmTasks);
	grunt.util = require('grunt-legacy-util');

	grunt.initConfig({
		pkg: grunt.file.readJSON('package.json'),
		checkDependencies: {
			options: {
				packageManager: 'npm'
			},
			src: {}
		},
		jshint: {
			options: grunt.file.readJSON('.jshintrc'),
			grunt: {
				src: ['Gruntfile.js']
			},
			core: {
				expand: true,
				cwd: SOURCE_DIR,
				src: BP_JS.concat([
					'!**/vendor/*.js',
					'!**/lib/*.js',
					'!**/*.min.js',
					'!**/emojione-edited.js',
					'!**/emojionearea-edited.js',
					'!**/node_modules/**/*.js',
				]),

				/**
				 * Limit JSHint's run to a single specified file:
				 *
				 * grunt jshint:core --file=filename.js
				 *
				 * Optionally, include the file path:
				 *
				 * grunt jshint:core --file=path/to/filename.js
				 *
				 * @param {String} filepath
				 * @returns {Bool}
				 */
				filter: function (filepath) {
					var index, file = grunt.option('file');

					// Don't filter when no target file is specified
					if (!file) {
						return true;
					}

					// Normalise filepath for Windows
					filepath = filepath.replace(/\\/g, '/');
					index = filepath.lastIndexOf('/' + file);

					// Match only the filename passed from cli
					if (filepath === file || (-1 !== index && index === filepath.length - (file.length + 1))) {
						return true;
					}

					return false;
				}
			}
		},
		sass: {
			options: {
				outputStyle: 'expanded',
				implementation: sass,
				//indentType: 'tab',
				//indentWidth: '1'
			},
			nouveau: {
				cwd: SOURCE_DIR,
				extDot: 'last',
				expand: true,
				ext: '.css',
				flatten: true,
				src: ['bp-templates/bp-nouveau/sass/buddypress.scss'],
				dest: SOURCE_DIR + 'bp-templates/bp-nouveau/css/'
			},
			admin: {
				cwd: SOURCE_DIR,
				extDot: 'last',
				expand: true,
				ext: '.css',
				flatten: true,
				src: ['bp-core/admin/sass/*.scss'],
				dest: SOURCE_DIR + 'bp-core/admin/css/'
			}
		},
		rtlcss: {
			options: {
				opts: {
					processUrls: false,
					autoRename: false,
					clean: true
				},
				saveUnmodified: false
			},
			core: {
				expand: true,
				cwd: SOURCE_DIR,
				dest: SOURCE_DIR,
				extDot: 'last',
				ext: '-rtl.css',
				src: BP_CSS.concat(BP_EXCLUDED_CSS, BP_EXCLUDED_MISC)
			}
		},
		checktextdomain: {
			options: {
				correct_domain: false,
				text_domain: ['buddyboss'],
				keywords: [
					'__:1,2d',
					'_e:1,2d',
					'_x:1,2c,3d',
					'_n:1,2,4d',
					'_ex:1,2c,3d',
					'_nx:1,2,4c,5d',
					'esc_attr__:1,2d',
					'esc_attr_e:1,2d',
					'esc_attr_x:1,2c,3d',
					'esc_html__:1,2d',
					'esc_html_e:1,2d',
					'esc_html_x:1,2c,3d',
					'_n_noop:1,2,3d',
					'_nx_noop:1,2,3c,4d'
				]
			},
			files: {
				cwd: SOURCE_DIR,
				src: ['**/*.php'].concat(BP_EXCLUDED_MISC),
				expand: true
			}
		},
		makepot: {
			src: {
				options: {
					cwd: SOURCE_DIR,
					domainPath: '/languages',
					exclude: ['node_modules/*'], // List of files or directories to ignore.
					mainFile: 'bp-loader.php',
					potFilename: 'buddyboss.pot',
					potHeaders: { // Headers to add to the generated POT file.
						poedit: true, // Includes common Poedit headers.
						'Last-Translator': 'BuddyBoss <support@buddyboss.com>',
						'Language-Team': 'BuddyBoss <support@buddyboss.com>',
						'report-msgid-bugs-to': 'https://www.buddyboss.com/contact/',
						'x-poedit-keywordslist': true // Include a list of all possible gettext functions.
					},
					type: 'wp-plugin',
					updateTimestamp: true, // Whether the POT-Creation-Date should be updated without other changes.
					updatePoFiles: false // Whether to update PO files in the same directory as the POT file.
				}
			}
		},
		imagemin: {
			core: {
				expand: true,
				cwd: SOURCE_DIR,
				src: ['**/*.{gif,jpg,jpeg,png}'].concat(BP_EXCLUDED_MISC),
				dest: SOURCE_DIR
			}
		},
		clean: {
			all: [BUILD_DIR]
		},
		copy: {
			files: {
				files: [
					{
						cwd: SOURCE_DIR,
						dest: BUILD_DIR,
						dot: true,
						expand: true,
						src: ['**', '!**/.{svn,git}/**'].concat(BP_EXCLUDED_MISC)
					},
					{
						dest: BUILD_DIR,
						dot: true,
						expand: true,
						src: ['composer.json']
					}
				]
			}
		},
		uglify: {
			core: {
				cwd: SOURCE_DIR,
				dest: SOURCE_DIR,
				extDot: 'last',
				expand: true,
				ext: '.min.js',
				src: BP_JS.concat([
					'!**/vendor/*.js',
					'!**/lib/*.js',
					'!**/*.min.js',
					'!**/emojione-edited.js',
					'!**/emojionearea-edited.js',
					'!**/node_modules/**/*.js',
				])
			}
		},
		stylelint: {
			css: {
				options: {
					config: stylelintConfigCss,
					format: 'css'
				},
				expand: true,
				cwd: SOURCE_DIR,
				src: BP_CSS.concat(BP_EXCLUDED_CSS, BP_EXCLUDED_MISC, BP_SCSS_CSS_FILES,
					[
						'!**/*.min.css',
						'!**/admin/**/*.css',
						'!**/emojionearea-edited.css'
					]
				)
			},
			scss: {
				options: {
					config: stylelintConfigScss,
					format: 'scss'
				},
				expand: true,
				cwd: SOURCE_DIR,
				src: ['**/*.scss', '!**/vendors/**/*.scss']
			}
		},
		cssmin: {
			minify: {
				cwd: SOURCE_DIR,
				dest: SOURCE_DIR,
				extDot: 'last',
				expand: true,
				ext: '.min.css',
				src: BP_CSS
			}
		},
		phpunit: {
			'default': {
				cmd: 'phpunit',
				args: ['-c', 'phpunit.xml.dist']
			},
			'multisite': {
				cmd: 'phpunit',
				args: ['-c', 'tests/phpunit/multisite.xml']
			},
			'codecoverage': {
				cmd: 'phpunit',
				args: ['-c', 'tests/phpunit/codecoverage.xml']
			}
		},
		exec: {
			cli: {
				command: 'git add .; git commit -am "grunt release build";',
				cwd: '.',
				stdout: false
			}
		},
		jsvalidate: {
			options: {
				globals: {},
				esprimaOptions: {},
				verbose: false
			},
			src: {
				files: {
					src: [
						SOURCE_DIR + '/**/*.js',
						'!**/emojione-edited.js',
						'!**/emojionearea-edited.js',
						'!**/vendor/**/*.js',
						'!**/node_modules/**/*.js'
					].concat(BP_EXCLUDED_MISC)
				}
			}
		},
		compress: {
			main: {
				options: {
					archive: 'buddyboss-platform-plugin.zip'
				},
				files: [{
					src: BUILD_DIR + '**',
					dest: '.'
				}]
			}
		},
	});


	/**
	 * Register tasks.
	 */
	grunt.registerTask('src', ['checkDependencies', 'jsvalidate', 'jshint', 'stylelint', 'sass', 'rtlcss', 'checktextdomain', /*'imagemin',*/ 'uglify', 'cssmin', 'makepot:src']);
	grunt.registerTask('build', ['exec:cli', 'clean:all', 'copy:files', 'compress', 'clean:all']);
	grunt.registerTask('release', ['src', 'build']);

	// Testing tasks.
	grunt.registerMultiTask('phpunit', 'Runs PHPUnit tests, including the ajax and multisite tests.', function () {
		grunt.util.spawn({
			args: this.data.args,
			cmd: this.data.cmd,
			opts: {stdio: 'inherit'}
		}, this.async());
	});

	grunt.registerTask('test', 'Run all unit test tasks.', ['phpunit:default', 'phpunit:multisite']);

	grunt.registerTask('jstest', 'Runs all JavaScript tasks.', ['jsvalidate', 'jshint']);

	// Travis CI Tasks.
	grunt.registerTask('travis:grunt', 'Runs Grunt build task.', ['src']);
	grunt.registerTask('travis:phpunit', ['jsvalidate', 'jshint', 'checktextdomain', 'test']);
	grunt.registerTask('travis:codecoverage', 'Runs PHPUnit tasks with code-coverage generation.', ['phpunit:codecoverage']);

	// Patch task.
	grunt.renameTask('patch_wordpress', 'patch');

	// Default task.
	grunt.registerTask('default', ['src']);
};