exposed utility function to report file operations

this helps promote consistent reporting within plugins

in the process, updated and fixed CHANGELOG ("significant changes"
sounded too much like breaking changes)

Author: FND

CHANGELOG.md

@@ -2,16 +2,35 @@ faucet-pipeline-core version history
 ====================================
 
 
+v1.2.0
+------
+
+_2018-11-29_
+
+improvements for end users:
+
+* ensured parent paths (i.e. `../`) are permitted where configuration expects
+  relative paths
+* ensured consistent manifest representation, avoiding changes due to arbitrary
+  ordering
+
+improvements for developers:
+
+* added `loadExtension` utility function to prompt for installation of missing
+  packages
+* added `reportFileStatus` utility function
+* fixed `Manifest#toJSON` return value
+
+
 v1.1.0
 ------
 
 _2018-10-23_
 
-significant changes for end users:
+improvements for end users:
 
 * `manifest.target` is now optional, defaulting to an in-memory manifest
-* ensured parent paths (i.e. `../`) are considered relative as well
 
-programmatic API:
+improvements for developers:
 
 * added `resolvePath` utility function

lib/manager.js

@@ -3,7 +3,7 @@
 let Manifest = require("./manifest");
 let createFile = require("./util/files");
 let resolvePath = require("./util/resolve");
-let { abort, generateFingerprint } = require("./util");
+let { reportFileStatus, abort, generateFingerprint } = require("./util");
 let path = require("path");
 
 module.exports = class AssetManager {
@@ -33,7 +33,7 @@ module.exports = class AssetManager {
 			then(_ => this.manifest &&
 					this._updateManifest(originalPath, filepath, targetDir)).
 			then(_ => {
-				this._report(originalPath, error);
+				reportFileStatus(originalPath, this.referenceDir, error);
 				if(error && this.exitOnError) {
 					throw error;
 				}
@@ -57,13 +57,4 @@ module.exports = class AssetManager {
 		actualPath = path.relative(referenceDir, actualPath);
 		return this.manifest.set(originalPath, actualPath, targetDir);
 	}
-
-	_report(filepath, error) {
-		let relPath = path.relative(this.referenceDir, filepath);
-		if(error) {
-			console.error(`✗ ${relPath}: ${error.message || error}`);
-		} else {
-			console.error(`✓ ${relPath}`);
-		}
-	}
 };

lib/util/index.js

@@ -6,6 +6,13 @@ let crypto = require("crypto");
 exports.abort = abort;
 exports.repr = repr;
 
+// reports success or failure for a given file path (typically regarding
+// compilation or write operations)
+exports.reportFileStatus = (filepath, referenceDir, error) => {
+	let ref = path.relative(referenceDir, filepath);
+	console.error(error ? `✗ ${ref}: ${error.message || error}` : `✓ ${ref}`);
+};
+
 // attempts to `require` a module, prompting the user to install the
 // corresponding package if it is unavailable
 exports.loadExtension = (pkg, errorMessage, supplier = pkg) => {

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "faucet-pipeline-core",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "faucet-pipeline's core library",
 	"author": "FND",
 	"contributors": [
@@ -28,7 +28,7 @@
 		"browserslist": "~4.3.4",
 		"minimist": "~1.2.0",
 		"mkdirp": "~0.5.1",
-		"nite-owl": "~3.3.2"
+		"nite-owl": "~5.0.0"
 	},
 	"devDependencies": {
 		"eslint-config-fnd": "^1.6.0",