refactor(commands/help): Move examples to a dedicated file

Author: Danktuary

commands/add.js

@@ -20,19 +20,6 @@ module.exports = class AddCommand extends Command {
 					flag: ['--reverse', '-r'],
 				},
 			],
-			options: {
-				help: {
-					examples: [
-						':emojiName:',
-						'EmojiName :emojiName:',
-						':emojiName: EmojiName',
-						'EmojiName https://i.imgur.com/8jGJzmd.png',
-						'https://i.imgur.com/8jGJzmd.png EmojiName',
-						'EmojiName https://i.imgur.com/8jGJzmd.png --reverse',
-						'EmojiName (supply only a name with an image attachment)',
-					],
-				},
-			},
 		})
 	}
 

commands/approve.js

@@ -16,15 +16,6 @@ module.exports = class ApproveCommand extends Command {
 					'default': 'emoji',
 				},
 			],
-			options: {
-				help: {
-					examples: [
-						'EmojiName (if `--mode=x` argument is omitted, defaults to `emoji`)',
-						'EmojiName --mode=emoji (approves a pending emoji poll)',
-						'EmojiName --mode=rename (approves a pending rename poll)',
-					],
-				},
-			},
 		})
 	}
 

commands/data/examples.js

@@ -0,0 +1,38 @@
+module.exports = {
+	add: [
+		':emojiName:',
+		'EmojiName :emojiName:',
+		':emojiName: EmojiName',
+		'EmojiName https: //i.imgur.com/8jGJzmd.png',
+		'https: //i.imgur.com/8jGJzmd.png EmojiName',
+		'EmojiName https: //i.imgur.com/8jGJzmd.png --reverse',
+		'EmojiName (supply only a name with an image attachment)',
+	],
+	approve: [
+		'EmojiName (if `--mode=x` argument is omitted, defaults to `emoji`)',
+		'EmojiName --mode=emoji (approves a pending emoji poll)',
+		'EmojiName --mode=rename (approves a pending rename poll)',
+	],
+	deny: [
+		'EmojiName (if `--mode=x` argument is omitted, defaults to `emoji`)',
+		'EmojiName --mode=emoji (approves a pending emoji poll)',
+		'EmojiName --mode=rename (approves a pending rename poll)',
+	],
+	'emoji-search': ['EmojiName', ':emoji:'],
+	help: ['', 'add'],
+	rename: [
+		'oldName newName (if `--mode=x` argument is omitted, defaults to `emoji`)',
+		'oldName newName --mode=poll (renames a pending poll you\'ve made)',
+		':oldEmoji: newName',
+		'newName :oldEmoji:',
+	],
+	server: ['1'],
+	sync: [
+		'all',
+		'invites',
+		'info 2 (`1` is invalid)',
+		'galleries',
+		'gallery 2',
+		'status',
+	],
+}

commands/deny.js

@@ -15,15 +15,6 @@ module.exports = class DenyCommand extends Command {
 					'default': 'emoji',
 				},
 			],
-			options: {
-				help: {
-					examples: [
-						'EmojiName (if `--mode=x` argument is omitted, defaults to `emoji`)',
-						'EmojiName --mode=emoji (approves a pending emoji poll)',
-						'EmojiName --mode=rename (approves a pending rename poll)',
-					],
-				},
-			},
 		})
 	}
 

commands/emoji-search.js

@@ -17,11 +17,6 @@ module.exports = class EmojiSearchCommand extends Command {
 					},
 				},
 			],
-			options: {
-				help: {
-					examples: ['EmojiName', ':emoji:'],
-				},
-			},
 		})
 	}
 

commands/help.js

@@ -1,6 +1,7 @@
 const { MessageEmbed } = require('discord.js')
 const { Command } = require('discord-akairo')
 const { colors } = require('../config.js')
+const examples = require('./data/examples.js')
 const textUtil = require('../util/text.js')
 const permissionsUtil = require('../util/permissions.js')
 
@@ -26,11 +27,6 @@ module.exports = class HelpCommand extends Command {
 					},
 				},
 			],
-			options: {
-				help: {
-					examples: ['', 'add'],
-				},
-			},
 		})
 	}
 
@@ -60,12 +56,11 @@ module.exports = class HelpCommand extends Command {
 			embed.addField('User permissions needed', permissionsUtil.formatNames(command.userPermissions), true)
 		}
 
-		// NOTE: `Command.options` has been removed; need to approach this differently
-		// const { help: helpData = {} } = command.options;
+		const { [command]: commandExamples } = examples
 
-		// if (helpData.examples && helpData.examples.length) {
-		// 	embed.addField('Examples', helpData.examples.map(example => `${prefix}${command.id} ${example}`).join('\n'));
-		// }
+		if (commandExamples && commandExamples.length) {
+			embed.addField('Examples', commandExamples.map(example => `${prefix}${command.id} ${example}`).join('\n'))
+		}
 
 		return message.util.send(embed)
 	}

commands/rename.js

@@ -25,16 +25,6 @@ module.exports = class RenameCommand extends Command {
 					match: 'rest',
 				},
 			],
-			options: {
-				help: {
-					examples: [
-						'oldName newName (if `--mode=x` argument is omitted, defaults to `emoji`)',
-						'oldName newName --mode=poll (renames a pending poll you\'ve made)',
-						':oldEmoji: newName',
-						'newName :oldEmoji:',
-					],
-				},
-			},
 		})
 	}
 

commands/server.js

@@ -17,11 +17,6 @@ module.exports = class ServerCommand extends Command {
 					},
 				},
 			],
-			options: {
-				help: {
-					examples: ['1'],
-				},
-			},
 		})
 	}
 

commands/sync.js

@@ -32,18 +32,6 @@ module.exports = class SyncCommand extends Command {
 					flag: ['--force', '-f'],
 				},
 			],
-			options: {
-				help: {
-					examples: [
-						'all',
-						'invites',
-						'info 2 (`1` is invalid)',
-						'galleries',
-						'gallery 2',
-						'status',
-					],
-				},
-			},
 		})
 	}