sdc-build-wp 1.0.10 → 1.3.2

package/.eslintrc

@@ -0,0 +1,19 @@
+{
+	"parserOptions": {
+		"ecmaVersion": 6,
+		"sourceType": "module",
+		"ecmaFeatures": {
+			"jsx": true
+		}
+	},
+	"rules": {
+		"semi": 1,
+		"indent": [1, "tab"],
+		"no-multiple-empty-lines": [
+			1,
+			{
+				"max": 1
+			}
+		]
+	}
+}

package/.stylelintrc

@@ -0,0 +1,15 @@
+{
+  "rules": {
+    "indentation": "tab",
+    "max-empty-lines": 1,
+    "rule-empty-line-before": [
+      "always",
+      {
+        "ignore": [
+          "after-comment"
+        ]
+      }
+    ],
+    "color-no-invalid-hex": true
+  }
+}

package/index.js

@@ -1,42 +1,41 @@
 #!/usr/bin/env node
-const pathConfig = require('path');
-const path = pathConfig.resolve(__dirname, '.');
-const parentPath = process.cwd();
-const ourPackage = require(process.cwd() + '/package.json');
-const argv = require('minimist')(process.argv.slice(2));
-const chokidar = require('chokidar');
-const glob = require('glob');
+import path from 'path';
+import project from './lib/project.js';
+import parseArgs from 'minimist';
+const argv = parseArgs(process.argv.slice(2));
+import chokidar from 'chokidar';
+import glob from 'glob';
 
-const bustCache = require(path + '/lib/bustCache.js');
-const buildSass = require(path + '/lib/style.js');
-const buildJS = require(path + '/lib/scripts.js');
-const buildImages = require(path + '/lib/images.js');
-const buildFonts = require(path + '/lib/fonts.js');
-const buildBrowserSync = require(path + '/lib/browsersync.js');
+import bustCache from './lib/bustCache.js';
+import buildSass from './lib/style.js';
+import buildJS from './lib/scripts.js';
+import buildImages from './lib/images.js';
+import buildFonts from './lib/fonts.js';
+import buildBrowserSync from './lib/browsersync.js';
 
 let chokidarOpts = {
 	ignoreInitial: true
 };
 
 function bustFunctionsCache() {
-	bustCache(parentPath + '/functions.php');
+	bustCache(project.path + '/functions.php');
 }
 
 function frontrunImages() {
-	[parentPath + '/_src/images/', parentPath + '/_src/images/**/*/'].forEach((block) => {
+	[project.path + '/_src/images/', project.path + '/_src/images/**/*/'].forEach((block) => {
 		glob(block, {}, function(err, directory) {
 			directory.forEach((dir) => {
 				buildImages(dir);
-			})
+			});
 		});
 	});
 }
 
 let entries = {};
-for (const [name, files] of Object.entries(ourPackage.sdc.entries)) {
+for (const [name, files] of Object.entries(project.package.sdc.entries)) {
 	entries[name] = [];
 	files.forEach(function(file) {
-		entries[name].push(parentPath + file);
+		entries[name].push(project.path + file);
 	});
 }
 
@@ -44,7 +43,7 @@ let filesSass = [];
 
 for (const [name, files] of Object.entries(entries)) {
 	files.forEach(function(file) {
-		switch (pathConfig.parse(file).ext) {
+		switch (path.parse(file).ext) {
 			case '.scss':
 				filesSass.push(file);
 				break;
@@ -67,7 +66,7 @@ filesSass.forEach((file) => {
 	bustFunctionsCache();
 });
 if (argv.watch) {
-	chokidar.watch(parentPath + '/_src/style/**/*', chokidarOpts).on('all', (event, path) => {
+	chokidar.watch(project.path + '/_src/style/**/*', chokidarOpts).on('all', (event, path) => {
 		filesSass.forEach((file) => {
 			buildSass(file);
 			bustFunctionsCache();
@@ -76,12 +75,12 @@ if (argv.watch) {
 }
 frontrunImages()
 if (argv.watch) {
-	chokidar.watch(parentPath + '/_src/images/**/*', chokidarOpts).on('all', (event, path) => {
+	chokidar.watch(project.path + '/_src/images/**/*', chokidarOpts).on('all', (event, path) => {
 		frontrunImages();
 	});
 }
 
-buildFonts(parentPath + '/_src/fonts');
+buildFonts(project.path + '/_src/fonts');
 
 if (argv.watch) {
 	buildBrowserSync();

package/lib/browsersync.js

@@ -1,21 +1,29 @@
-const parentPath = process.cwd();
-const ourPackage = require(parentPath + '/package.json');
-const browserSync = require('browser-sync').create();
+import project from '../lib/project.js';
+import { create as bsCreate } from 'browser-sync';
+const browserSync = bsCreate();
 
 const buildBrowserSync = () => {
 	browserSync.init({
-		port: ourPackage.sdc?.port || 3000,
-		proxy: ourPackage.sdc?.browsersync?.localProxyURL,
+		port: project.package.sdc?.port || 3000,
+		proxy: project.package.sdc?.browsersync?.localProxyURL,
 		files: [
-			parentPath + '/dist/**/*',
-			parentPath + '/**/*.php'
+			project.path + '/dist/**/*',
+			project.path + '/**/*.php'
 		],
-		open: ourPackage.sdc?.open || false,
+		open: project.package.sdc?.open || false,
 		https: (process.env.SSL_KEY_PATH && process.env.SSL_CRT_PATH ? {
 			key: process.env.SSL_KEY_PATH,
 			cert: process.env.SSL_CRT_PATH
-		} : false)
+		} : false),
+		ui: false,
+		notify: {
+			styles: {
+				top: 'auto',
+				bottom: '0',
+				borderRadius: '5px 0px 0px'
+			}
+		}
 	});
 };
 
-module.exports = buildBrowserSync;
+export default buildBrowserSync;

package/lib/bustCache.js

@@ -1,13 +1,8 @@
-const fs = require('fs');
-const pathConfig = require('path');
-const parentPath = process.cwd();
-const ourPackage = require(process.cwd() + '/package.json');
+import fs from 'fs';
 
 const bustCache = (file) => {
 	fs.readFile(file, 'utf8', function (err, data) {
-		if (err) {
-			return console.log(err);
-		}
+		if (err) { return console.log(err); }
 		var result = data.replace(/(\$cacheVersion\ \=\ \')(.*)(\'\;)/g, "$1" + new Date().getTime() + "$3");
 		fs.writeFile(file, result, 'utf8', function (err) {
 			if (err) return console.log(err);
@@ -15,4 +10,4 @@ const bustCache = (file) => {
 	});
 };
 
-module.exports = bustCache;
+export default bustCache;

package/lib/fonts.js

@@ -1,11 +1,19 @@
-const parentPath = process.cwd();
-const log = require('./logging.js');
-const fs = require('fs-extra');
+import project from '../lib/project.js';
+import log from './logging.js';
+import fs from 'fs-extra';
+import { readdir } from 'fs/promises';
 
 const buildFonts = async (fonts) => {
 	let timerStart = Date.now();
-	await fs.copy(fonts, parentPath + '/dist/fonts');
-	log('success', `Built /dist/fonts in ${Date.now() - timerStart}ms`);
+	try {
+		const fontsDir = await readdir(fonts);
+		if (fontsDir.length == 0) { throw new Error('No files in directory'); }
+		await fs.copy(fonts, project.path + '/dist/fonts');
+		log('success', `Built /dist/fonts in ${Date.now() - timerStart}ms`);
+	} catch {
+		log('info', `No files present at ${fonts.replace(project.path, '')}/. Skipping font copy`);
+		return false;
+	}
 };
 
-module.exports = buildFonts;
+export default buildFonts;

package/lib/images.js

@@ -1,22 +1,21 @@
-const pathConfig = require('path');
-const parentPath = process.cwd();
-const log = require('./logging.js');
-const imagemin = require('imagemin');
-const imageminJpegtran = require('imagemin-jpegtran');
-const imageminPngquant = require('imagemin-pngquant');
-const imageminSvgo = require('imagemin-svgo');
+import project from '../lib/project.js';
+import log from './logging.js';
+import imagemin from 'imagemin';
+import imageminJpegtran from 'imagemin-jpegtran';
+import imageminPngquant from 'imagemin-pngquant';
+import imageminSvgo from 'imagemin-svgo';
 
 const buildImages = async (images) => {
 	let timerStart = Date.now();
 	const files = await imagemin([images + '*'], {
-		destination: parentPath + '/dist/images/' + (images.replace(parentPath + '/_src/images/', '')),
+		destination: project.path + '/dist/images/' + (images.replace(project.path + '/_src/images/', '')),
 		plugins: [
 			imageminJpegtran(),
 			imageminPngquant(),
 			imageminSvgo()
 		]
 	});
-	log('success', `Built /dist/images/${images.replace(parentPath + '/_src/images/', '')} in ${Date.now() - timerStart}ms`);
+	log('success', `Built /dist/images/${images.replace(project.path + '/_src/images/', '')} in ${Date.now() - timerStart}ms`);
 };
 
-module.exports = buildImages;
+export default buildImages;

package/lib/logging.js

@@ -1,11 +1,9 @@
 // based heavily on Nick Salloum's 'node-pretty-log'
 // https://github.com/callmenick/node-pretty-log
-
-const chalk = require('chalk');
+import chalk from 'chalk';
 
 function getTime() {
-	const now = new Date();
-	return now.toLocaleTimeString('en-US');
+	return new Date().toLocaleTimeString('en-US');
 }
 
 function log(type, ...messages) {
@@ -13,7 +11,7 @@ function log(type, ...messages) {
 		case 'success':
 			console.log.call(
 				console,
-				chalk.green('✓'),
+				chalk.green('✔'),
 				chalk.gray(getTime()),
 				...messages
 			);
@@ -21,7 +19,7 @@ function log(type, ...messages) {
 		case 'error':
 			console.log.call(
 				console,
-				chalk.red('×'),
+				chalk.red('✖'),
 				chalk.bgRed.gray(getTime()),
 				...messages
 			);
@@ -29,12 +27,13 @@ function log(type, ...messages) {
 		case 'warn':
 			console.log.call(
 				console,
-				chalk.yellow('!'),
+				chalk.yellow('⚠'),
 				chalk.bgYellow.gray(getTime()),
 				...messages
 			);
 			break;
 		case 'info':
+		default:
 			console.log.call(
 				console,
 				chalk.blue('ℹ'),
@@ -42,14 +41,7 @@ function log(type, ...messages) {
 				...messages
 			);
 			break;
-		default:
-			console.log.call(
-				console,
-				chalk.blue('ℹ'),
-				chalk.gray(getTime()),
-				...messages
-			);
 	}
 }
 
-module.exports = log;
+export default log;

package/lib/project.js

@@ -0,0 +1,6 @@
+import { readFile } from 'fs/promises';
+
+export default {
+	path: process.cwd(),
+	package: JSON.parse(await readFile(new URL(process.cwd() + '/package.json', import.meta.url)))
+};

package/lib/scripts.js

@@ -1,12 +1,28 @@
-const pathConfig = require('path');
-const parentPath = process.cwd();
-const ourPackage = require(process.cwd() + '/package.json');
-const log = require('./logging.js');
-const esbuild = require('esbuild');
+import path from 'path';
+import project from '../lib/project.js';
+import log from './logging.js';
+import esbuild from 'esbuild';
+import { ESLint } from 'eslint';
+import { readFile } from 'fs/promises';
 
 const buildJS = async (entry) => {
-	let entryLabel = `/dist/scripts/${pathConfig.parse(entry).base.replace('.js', '.min.js')}`;
+	let entryLabel = `/dist/scripts/${path.parse(entry).base.replace('.js', '.min.js')}`;
 	let timerStart = Date.now();
+	try {
+		const eslint = new ESLint({
+			baseConfig: JSON.parse(await readFile(new URL('../.eslintrc', import.meta.url))),
+			fix: true
+		});
+		const lintresults = await eslint.lintFiles([entry]);
+		await ESLint.outputFixes(lintresults);
+		const formatter = await eslint.loadFormatter('stylish');
+		const formatterOutput = formatter.format(lintresults);
+		if (formatterOutput) { console.log(formatterOutput.replace(project.path + '/_src/scripts/', '')); }
+	} catch (error) {
+		console.log(error);
+		log('error', `Failed linting ${entry.replace(project.path + '/_src/scripts/', '')} - See above error.`);
+		return false;
+	}
 	try {
 		const result = await esbuild.build({
 			platform: 'node',
@@ -29,4 +45,4 @@ const buildJS = async (entry) => {
 	log('success', `Built ${entryLabel} in ${Date.now() - timerStart}ms`);
 };
 
-module.exports = buildJS;
+export default buildJS;

package/lib/style.js

@@ -1,46 +1,63 @@
-const fs = require('fs');
-const pathConfig = require('path');
-const parentPath = process.cwd();
-const ourPackage = require(process.cwd() + '/package.json');
-const log = require('./logging.js');
-const sass = require('sass');
-const postcss = require('postcss');
-const autoprefixer = require('autoprefixer');
-const sortMQ = require('postcss-sort-media-queries');
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import project from '../lib/project.js';
+import log from './logging.js';
+import sass from 'sass';
+import postcss from 'postcss';
+import autoprefixer from 'autoprefixer';
+import sortMQ from 'postcss-sort-media-queries';
+import stylelint from 'stylelint';
 
 const buildSass = (entry) => {
 	let timerStart = Date.now();
-	let outFile = parentPath + '/dist/style/' + pathConfig.parse(entry).name + '.min.css';
-	let entryLabel = outFile.replace(parentPath, '');
-	sass.render({
-		file: entry,
-		outFile: outFile,
-		outputStyle: 'compressed'
-	}, function(error, result) {
-		if (error) {
-			console.log(error);
-			log('error', `Failed building ${entryLabel} - See above error.`);
+	let outFile = project.path + '/dist/style/' + path.parse(entry).name + '.min.css';
+	let entryLabel = outFile.replace(project.path, '');
+	stylelint.lint({
+		configFile: path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../.stylelintrc'),
+		formatter: 'string',
+		files: [entry],
+		customSyntax: 'postcss-scss',
+		fix: true
+	}).then((data) => {
+		if (data.errored) {
+			console.log(data.output);
+			log('error', `Failed linting ${entry.replace(project.path + '/_src/style/', '')} - See above error.`);
 			return false;
 		}
-		if (!fs.existsSync(parentPath + '/dist')) {
-			fs.mkdirSync(parentPath + '/dist');
-		}
-		if (!fs.existsSync(parentPath + '/dist/style')) {
-			fs.mkdirSync(parentPath + '/dist/style');
-		}
-		postcss([
-			autoprefixer(),
-			sortMQ()
-		]).process(result.css, { from: undefined }).then(resultPost => {
-			fs.writeFile(outFile, resultPost.css, function(err) {
-				if (err) {
-					console.log(err);
-				} else {
-					log('success', `Built ${entryLabel} in ${Date.now() - timerStart}ms`);
-				}
+		sass.render({
+			file: entry,
+			outFile: outFile,
+			outputStyle: 'compressed'
+		}, function(error, result) {
+			if (error) {
+				console.log(error.formatted);
+				log('error', `Failed building ${entryLabel} - See above error.`);
+				return false;
+			}
+			if (!fs.existsSync(project.path + '/dist')) {
+				fs.mkdirSync(project.path + '/dist');
+			}
+			if (!fs.existsSync(project.path + '/dist/style')) {
+				fs.mkdirSync(project.path + '/dist/style');
+			}
+			postcss([
+				autoprefixer(),
+				sortMQ()
+			]).process(result.css, { from: undefined }).then(resultPost => {
+				fs.writeFile(outFile, resultPost.css, function(err) {
+					if (err) {
+						console.log(err);
+						log('error', `Failed saving ${entryLabel} - See above error.`);
+						return false;
+					} else {
+						log('success', `Built ${entryLabel} in ${Date.now() - timerStart}ms`);
+					}
+				});
 			});
 		});
 	});
+
 };
 
-module.exports = buildSass;
+export default buildSass;

package/package.json

@@ -1,19 +1,20 @@
 {
   "name": "sdc-build-wp",
-  "version": "1.0.10",
+  "version": "1.3.2",
   "description": "Custom WordPress build process.",
-	"author": {
-		"name": "Robert Sefer",
-		"email": "rob@seferdesign.com",
-		"url": "https://seferdesign.com"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git://github.com/SeferDesign/sdc-build-wp.git"
-	},
-	"scripts": {
-		"test": "echo \"Skipping tests.\""
-	},
+  "author": {
+    "name": "Robert Sefer",
+    "email": "rob@seferdesign.com",
+    "url": "https://seferdesign.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/SeferDesign/sdc-build-wp.git"
+  },
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Skipping tests.\""
+  },
   "bin": {
     "sdc-build-wp": "./index.js"
   },
@@ -22,16 +23,19 @@
     "browser-sync": "^2.27.7",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.2",
-    "esbuild": "^0.13.11",
+    "esbuild": "^0.13.14",
+    "eslint": "^8.2.0",
     "fs-extra": "^10.0.0",
     "glob": "^7.2.0",
-    "imagemin": "^7.0.1",
+    "imagemin": "^8.0.1",
     "imagemin-jpegtran": "^7.0.0",
     "imagemin-pngquant": "^9.0.2",
-    "imagemin-svgo": "^9.0.0",
+    "imagemin-svgo": "^10.0.0",
     "minimist": "^1.2.5",
     "postcss": "^8.3.11",
+    "postcss-scss": "^4.0.2",
     "postcss-sort-media-queries": "^4.1.0",
-    "sass": "^1.43.4"
+    "sass": "^1.43.4",
+    "stylelint": "^14.1.0"
   }
 }