+mr -h command (by cline)

lib/HelpCommand.js

@@ -0,0 +1,13 @@
+module.exports = class {
+	async todo () {
+		if (!global.FUZZ) {
+			console.log(`mr -h | --help              # this help message
+mr                          # push current branch to its origin
+mr TASK-42                  # switch to existing TASK-42 (create if needed)
+mr TASK-42 from release     # create TASK-42 from release branch
+mr TASK-42 to main          # merge TASK-42 into main
+mr to main                  # merge current branch into main`)
+		}
+		return {todo: []}
+	}
+}

lib/MrCommand.js

@@ -5,6 +5,7 @@ const Push    = require('./PushCommand')
 const Create  = require('./CreateCommand')
 const Switch  = require('./SwitchCommand')
 const Merge   = require('./MergeCommand')
+const Help    = require('./HelpCommand')
 
 module.exports = class MrCommand {
 	static withParsedArgs (parsedArgs) {
@@ -16,6 +17,7 @@ module.exports = class MrCommand {
 			Switch,
 			Create: Switch,
 			Merge,
+			Help,
 		}
 		let commands = {}
 		for (let [name, clazz] of Object.entries (name2command)) {

lib/ParsedArgs.js

@@ -4,6 +4,10 @@ module.exports = class {
 	}
 
 	value() {
+		if (this.argv.includes('-h') || this.argv.includes('--help')) {
+			return {action: 'Help'}
+		}
+
 		const [branch, verb, src_or_dst] = this.argv
 		const usage = `usage: mr TASK-42 [from|to main]`
 

mr.js

@@ -4,7 +4,7 @@ const MrCommand = require('./lib/MrCommand')
 const RunCommand = require('./lib/RunCommand')
 
 const main = async (argv) => {
-	// @todo #0:1h add help --version with usage examples
+	// @todo #0:1h check minimal node version and exit if too old
 	await new RunCommand (
 		await MrCommand.withParsedArgs(
 			new ParsedArgs (

tests/HelpCommand.js

@@ -0,0 +1,32 @@
+const {describe, it, mock} = require ('node:test')
+const assert = require ('assert')
+const MrCommand = require ('../lib/MrCommand')
+const ParsedArgs = require ('../lib/ParsedArgs')
+
+describe('HelpCommand', () => {
+	it ('help command prints help and returns empty todo', async (t) => {
+		const logCalls = []
+		mock.method(console, 'log', function(msg) {
+			logCalls.push(msg)
+		})
+
+		const parsedArgs = new ParsedArgs (['-h'])
+		const todo = await MrCommand.withParsedArgs (parsedArgs).todo()
+
+		assert.deepStrictEqual(todo.todo, [])
+		assert.ok(logCalls[0].startsWith('mr -h | --help'))
+	})
+
+	it ('--help flag works the same way', async (t) => {
+		const logCalls = []
+		mock.method(console, 'log', function(msg) {
+			logCalls.push(msg)
+		})
+
+		const parsedArgs = new ParsedArgs (['--help'])
+		const todo = await MrCommand.withParsedArgs (parsedArgs).todo()
+
+		assert.deepStrictEqual(todo.todo, [])
+		assert.ok(logCalls[0].startsWith('mr -h | --help'))
+	})
+})

tests/ParsedArgs.js

@@ -26,4 +26,10 @@ describe('ParsedArgs', () => {
 	it ('deploy current to release', async (t) => {
 		assert.deepStrictEqual(await new ParsedArgs (toArgv (`to release`)).value (), {src: '__CURRENT_BRANCH__', action: 'Merge', dst: 'release'})
 	})
+	it ('help with -h flag', async (t) => {
+		assert.deepStrictEqual(await new ParsedArgs (['-h']).value (), {action: 'Help'})
+	})
+	it ('help with --help flag', async (t) => {
+		assert.deepStrictEqual(await new ParsedArgs (['--help']).value (), {action: 'Help'})
+	})
 })