wpgulp.config.js

/**
 * WPGulp Configuration File
 *
 * 1. Edit the variables as per your project requirements.
 * 2. In paths you can add <<glob or array of globs>>.
 *
 * @package
 */
// Project options.

const env = require('dotenv').config(); // eslint-disable-line

// Local project URL of your already running WordPress site.
// > Could be something like "wpgulp.local" or "localhost"
// > depending upon your local WordPress setup.
const projectURL = `${ process.env.PROJECT_URL }`;

// Theme/Plugin URL. Leave it like it is; since our gulpfile.js lives in the root folder.
const protocol = 'http';
const browserAutoOpen = false;
const injectChanges = true;
const https = false;

// >>>>> Style options.
// Path to main .scss file.
const styleSRC = './assets/sass/*.scss';

// Path to place the compiled CSS file. Default set to root folder.
const styleDestination = './build/css/';

// Available options → 'compact' or 'compressed' or 'nested' or 'expanded'
const outputStyle = 'compressed';
const errLogToConsole = true;
const precision = 10;

// JS Vendor options.

// Path to JS vendor folder.
const jsVendorSRC = './assets/js/vendor/*.js';

// Path to JS vendor scripts folder name.
const jsVendorDirectoryPath = './assets/js/vendor/';

// Ignore vendor directory array
const jsVendorIgnoreDirectory = [ 'node_modules/**', './', 'custom/**' ];

// Path to place the compiled JS vendors file.
const jsVendorDestination = './build/js/';

// Compiled JS vendors file name. Default set to vendors i.e. vendors.js.
const jsVendorFile = 'vendor';

// JS Custom options.

// Path to JS custom scripts folder.
const jsCustomSRC = './assets/js/custom/*.js';

// Path to JS custom scripts folder name.
const jsCustomDirectoryPath = './assets/js/custom/';

// Ignore custom directory array
const jsCustomIgnoreDirectory = [ 'node_modules/**', './', 'vendor/**' ];

// Path to place the compiled JS custom scripts file.
const jsCustomDestination = './build/js/';

// Compiled JS custom file name. Default set to custom i.e. custom.js.
const jsCustomFile = 'custom';

// Images options.

// Source folder of images which should be optimized and watched.
// > You can also specify types e.g. raw/**.{png,jpg,gif} in the glob.
const imgSRC = './assets/img/**/*';

// Destination folder of optimized images.
// > Must be different from the imagesSRC folder.
const imgDST = './build/img/';

// >>>>> Watch files paths.
// Path to all *.scss files inside css folder and inside them.
const watchStyles = './assets/sass/**/*.scss';

// Path to all vendor JS files.
const watchJsVendor = './assets/js/vendor/**/*.js';

// Path to all custom JS files.
const watchJsCustom = './assets/js/custom/**/*.js';

// Path to all PHP files.
const watchPhp = './**/*.php';

// >>>>> Zip file config.
// Must have.zip at the end.
const zipName = 'file.zip';

// Must be a folder outside of the zip folder.
const zipDestination = './../'; // Default: Parent folder.
const zipIncludeGlob = [ './**/*' ]; // Default: Include all files/folders in current directory.

// Default ignored files and folders for the zip file.
const zipIgnoreGlob = [
	'!./{node_modules,node_modules/**/*}',
	'!./.git',
	'!./.svn',
	'!./gulpfile.babel.js',
	'!./wpgulp.config.js',
	'!./.eslintrc.js',
	'!./.eslintignore',
	'!./.editorconfig',
	'!./phpcs.xml.dist',
	'!./vscode',
	'!./package.json',
	'!./package-lock.json',
	'!./assets/css/**/*',
	'!./assets/css',
	'!./assets/img/raw/**/*',
	'!./assets/img/raw',
	`!${ imgSRC }`,
	`!${ styleSRC }`,
	`!${ jsCustomSRC }`,
	`!${ jsVendorSRC }`
];

// >>>>> Translation options.
// Your text domain here.
const textDomain = `${ process.env.TEXT_DOMAIN }`;

// Name of the translation file.
const translationFile = `${ process.env.THEME_NAME }.pot`;

// Where to save the translation files.
const translationDestination = './languages';

// Package name.
const packageName = `${ process.env.THEME_NAME }`;

// Where can users report bugs.
const bugReport = `${ process.env.AUTHOR_WEBSITE }/contact/`;

// Last translator Email ID.
const lastTranslator = `Arischvaran Puvanesvaran <${ process.env.AUTHOR_EMAIL }>`;

// Team's Email ID.
const team = `Arischvaran Puvanesvaran <${ process.env.AUTHOR_EMAIL }>`;

// Browsers you care about for auto-prefixing. Browserlist https://github.com/ai/browserslist
// The following list is set as per WordPress requirements. Though; Feel free to change.
const BROWSERS_LIST = [ 'last 2 version', '> 1%' ];

// Export.
module.exports = {
	projectURL,
	protocol,
	browserAutoOpen,
	injectChanges,
	https,
	styleSRC,
	styleDestination,
	outputStyle,
	errLogToConsole,
	precision,
	jsVendorSRC,
	jsVendorDirectoryPath,
	jsVendorIgnoreDirectory,
	jsVendorDestination,
	jsVendorFile,
	jsCustomSRC,
	jsCustomDirectoryPath,
	jsCustomIgnoreDirectory,
	jsCustomDestination,
	jsCustomFile,
	imgSRC,
	imgDST,
	watchStyles,
	watchJsVendor,
	watchJsCustom,
	watchPhp,
	zipName,
	zipDestination,
	zipIncludeGlob,
	zipIgnoreGlob,
	textDomain,
	translationFile,
	translationDestination,
	packageName,
	bugReport,
	lastTranslator,
	team,
	BROWSERS_LIST
};