gulpfile.js

/**
 * Supported Packages
 * List here all dependencies necessary to run required tasks.
 *
 * @since 1.0.0
 */
const fs = require("fs");
const gulp = require("gulp");

const clean = require("gulp-clean");
const copy = require("gulp-copy");
const archiver = require("gulp-archiver");

const makepot = require("gulp-wp-pot");
const gettext = require("gulp-gettext");

const phpcs = require("gulp-phpcs"); // @todo: Include in a `test` task
const phpunit = require("gulp-phpunit"); // @todo: Include in a `test` task

/**
 * Package (pkg)
 *
 * @desc Call `package.json` file.
 *
 * @since 1.0.0
 */
const pkg = require("./package.json");

/**
 * Development Paths & Files
 *
 * @since 1.0.0
 */
const srcFiles = {
	phpcs: ["leighton-quito.php", "leighton-quito-loader.php"],
	makepot: ["leighton-quito.php", "leighton-quito-loader.php", "includes/**/*.php", "api/**/*.php"],
};

/**
 * Makepot
 *
 * @desc Gulp task to create POT files.
 *
 * @since 1.0.0
 */
gulp.task("makepot", () =>
	gulp
		.src(srcFiles.makepot)
		.pipe(
			makepot({
				domain: pkg.name,
				package: "Leighton Quito",
				bugReport: "https://github.com/iamleigh/leighton-quito-amp/issues",
				metadataFile: "leighton-quito.php",
			})
		)
		.pipe(gulp.dest(`languages/${pkg.name}.pot`))
);

/**
 * Get Text
 *
 * @desc Grab languages files.
 *
 * @since 1.0.0
 */
gulp.task("gettext", () => gulp.src("languages/*.po").pipe(gettext()).pipe(gulp.dest("languages")));

/**
 * Translate (i18n)
 *
 * @desc Run `makepot` and `gettext` tasks in parallel.
 *
 * @since 1.0.0
 */
gulp.task("i18n", gulp.parallel(["makepot", "gettext"]));

/**
 * Package
 *
 * @desc Pack the plugin for release.
 *
 * @since 1.0.0
 */
gulp.task(
	"package",
	gulp.series(
		() => gulp.src(["dist", pkg.name, `${pkg.name}.*.zip`], { read: false, allowEmpty: true }).pipe(clean()),

		() =>
			gulp
				.src([
					"leighton-quito.php",
					"leighton-quito-loader.php",
					"uninstall.php",
					"LICENSE",
					"README.md",
					"api/**/*",
					"assets/css/**/*",
					"assets/images/**/*",
					"assets/js/**/*",
					"languages/**",
					"includes/**/*",
					"vendor/autoload.php",
					"vendor/bin/**/*",
					"vendor/composer/**/*",
					"vendor/myclabs/**/*",
				])
				.pipe(copy(pkg.name)),

		() =>
			gulp
				.src(pkg.name + "/**/*", { base: "." })
				.pipe(archiver(`${pkg.name}.${pkg.version}.zip`))
				.pipe(gulp.dest(".")),

		(done) =>
			fs.rename(pkg.name, "dist", (err) => {
				if (err) throw err;
				done();
			})
	)
);

/**
 * Challenge Package
 *
 * @desc Pack the plugin to submit for challenge.
 *
 * @since 1.0.0
 */
gulp.task(
	"challenge",
	gulp.series(
		() =>
			gulp
				.src(["challenge", pkg.name, `${pkg.name}-challenge.*.zip`], { read: false, allowEmpty: true })
				.pipe(clean()),

		() => gulp.src(["**/*", "!dist/**/*", "!challenge/**/*", "!node_modules/**/*"]).pipe(copy(pkg.name)),

		() =>
			gulp
				.src(pkg.name + "/**/*", { base: "." })
				.pipe(archiver(`${pkg.name}-challenge.${pkg.version}.zip`))
				.pipe(gulp.dest(".")),

		(done) =>
			fs.rename(pkg.name, "challenge", (err) => {
				if (err) throw err;
				done();
			})
	)
);