@pixlcore/xycli 1.0.3 → 1.0.5

package/index.js

@@ -198,6 +198,34 @@ const app = {
 			return;
 		}
 		
+		// Validate local command routing before requiring a configured server. This
+		// keeps help and typo diagnostics available during initial CLI setup. Export
+		// is excluded because it also supports portable resource types that do not
+		// have their own complete command routers yet.
+		if (!('export' in args) && !this['cmd_' + cmd]) {
+			// Allow the user to swap the first two args if the second is a known command.
+			if (this['cmd_' + args.other[0]]) {
+				var new_cmd = args.other[0];
+				args.other[0] = cmd;
+				cmd = new_cmd;
+			}
+			else {
+				var suggestion = this.findClosestString(cmd, TOP_LEVEL_COMMANDS);
+				this.die(
+					"Unknown command: " + cmd + (suggestion ? '. Did you mean "' + suggestion + '"?' : ''),
+					"Available Commands: " + TOP_LEVEL_COMMANDS.join(', ') + "\n\n"
+				);
+			}
+		}
+		
+		// Help is entirely local, so it should work before a user has configured an
+		// API key or server URL, and should never make a network request.
+		if (cmd == 'help') {
+			await this.cmd_help();
+			print("\n");
+			return;
+		}
+		
 		delete args.debug;
 		delete args.echo;
 		delete args.quiet;
@@ -273,22 +301,6 @@ const app = {
 			return;
 		}
 		
-		if (!this['cmd_' + cmd]) {
-			// allow user to swap first two args, if 2nd is known command
-			if (this['cmd_' + args.other[0]]) {
-				var new_cmd = args.other[0];
-				args.other[0] = cmd;
-				cmd = new_cmd;
-			}
-			else {
-				var suggestion = this.findClosestString(cmd, TOP_LEVEL_COMMANDS);
-				this.die(
-					"Unknown command: " + cmd + (suggestion ? '. Did you mean "' + suggestion + '"?' : ''),
-					"Available Commands: " + TOP_LEVEL_COMMANDS.join(', ') + "\n\n"
-				);
-			}
-		}
-		
 		// merge in config from xyops
 		await this.cacheConfig();
 		
@@ -368,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.3",
+	"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,26 +1,47 @@
 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
+// diagnostics must remain useful before the user connects the CLI to xyOps.
+const offlineEnv = {
+	XYOPS_API_KEY: '',
+	XYOPS_BASE_URL: ''
+};
+
+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'], { fail: true });
+	const output = xy(['help', 'event', 'udpate'], offlineFailure);
 	assert.match(output, /Could not find help chapter for "event udpate"\. Did you mean "event update"\?/);
 });
 
 test('help does not suggest an unrelated chapter', () => {
-	const output = xy(['help', 'completely', 'unrelated', 'words'], { fail: true });
+	const output = xy(['help', 'completely', 'unrelated', 'words'], offlineFailure);
 	assert.match(output, /Could not find help chapter for "completely unrelated words"\./);
 	assert.doesNotMatch(output, /Did you mean/);
 });
 
 test('unknown top-level command suggests the closest command', () => {
-	const output = xy(['evnets'], { fail: true });
+	const output = xy(['evnets'], offlineFailure);
 	assert.match(output, /Unknown command: evnets\. Did you mean "events"\?/);
 	assert.match(output, /Available Commands:.*events/);
 });
 
 test('unknown top-level command does not suggest an unrelated command', () => {
-	const output = xy(['completely_unrelated'], { fail: true });
+	const output = xy(['completely_unrelated'], offlineFailure);
 	assert.match(output, /Unknown command: completely_unrelated/);
 	assert.doesNotMatch(output, /Did you mean/);
 });

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;
+};