@pixlcore/xycli 1.0.4 → 1.0.5

package/index.js

@@ -380,7 +380,10 @@ const app = {
 	printHelp(heading) {
 		// print named section from help file
 		heading = heading.toLowerCase();
-		var md = fs.readFileSync(Path.join(__dirname, 'docs', 'help.md'), 'utf8').trim() + "\n\n# end sentinel\n";
+		// Git may check this file out with CRLF on Windows. Normalize it before
+		// matching headings so the parser behaves identically on every platform.
+		var md = fs.readFileSync(Path.join(__dirname, 'docs', 'help.md'), 'utf8')
+			.replace(/\r\n?/g, '\n').trim() + "\n\n# end sentinel\n";
 		var re = new RegExp( "(^|\\n)(\\#+)\\s+(" + Tools.escapeRegExp(heading) + ")\\n([\\s\\S]*?)\\n\#+\\s+" );
 		var matches = md.match(re);
 		if (!matches) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pixlcore/xycli",
-	"version": "1.0.4",
+	"version": "1.0.5",
 	"description": "A complete command-line interface for the xyOps workflow automation system.",
 	"author": "Joseph Huckaby <jhuckaby@pixlcore.com>",
 	"homepage": "https://github.com/pixlcore/xycli",

package/test/help.test.js

@@ -1,5 +1,6 @@
 const { test } = require('node:test');
 const assert = require('node:assert/strict');
+const Path = require('node:path');
 const { xy } = require('./helpers/common.js');
 
 // Deliberately shadow any developer-machine configuration. Help and command
@@ -10,12 +11,18 @@ const offlineEnv = {
 };
 
 const offlineFailure = { fail: true, env: offlineEnv };
+const crlfHelpPreload = Path.join(__dirname, 'helpers', 'crlf-help.js');
 
 test('help is available without server credentials', () => {
 	const output = xy(['help'], { env: offlineEnv });
 	assert.match(output, /HELP: OVERVIEW/);
 });
 
+test('help parses a document with Windows line endings', () => {
+	const output = xy(['help'], { env: offlineEnv, preload: crlfHelpPreload });
+	assert.match(output, /HELP: OVERVIEW/);
+});
+
 test('help suggests the closest chapter for a typo', () => {
 	const output = xy(['help', 'event', 'udpate'], offlineFailure);
 	assert.match(output, /Could not find help chapter for "event udpate"\. Did you mean "event update"\?/);

package/test/helpers/crlf-help.js

@@ -0,0 +1,18 @@
+// Force the help document through the same CRLF checkout transformation Git
+// commonly applies on Windows, so this regression is covered on every runner.
+const fs = require('node:fs');
+const Path = require('node:path');
+const readFileSync = fs.readFileSync;
+
+fs.readFileSync = function(file) {
+	var contents = readFileSync.apply(this, arguments);
+	var filename = String(file);
+	var is_help = (Path.basename(filename) == 'help.md') &&
+		(Path.basename(Path.dirname(filename)) == 'docs');
+	
+	if (is_help && (typeof(contents) == 'string')) {
+		return contents.replace(/\r?\n/g, '\r\n');
+	}
+	
+	return contents;
+};