Merge pull request #1 from DiscordFactory/cli-next

LeadcodeDev · web-flow · commit 7a89fcf5901d · 2021-10-09T19:23:21.000+02:00
Cli next
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@discord-factory/core-commands",
-  "version": "1.2.0",
+  "version": "2.0.1",
   "description": "",
   "main": "build/index.js",
   "author": "Baptiste Parmantier <baptiste.parmantier.pro@gmail.com>",
@@ -35,10 +35,11 @@
     "verbose": true
   },
   "dependencies": {
-    "@discord-factory/core-next": "^1.3.0",
+    "@discord-factory/core-next": "2.0.0",
     "@leadcodedev/logger": "^1.0.0",
     "@typescript-eslint/eslint-plugin": "^4.31.1",
     "@typescript-eslint/parser": "^4.31.1",
-    "discord.js": "^13.1.0"
+    "discord.js": "^13.1.0",
+    "enquirer": "^2.3.6"
   }
 }
diff --git a/src/commands/MakeCommand.ts b/src/commands/MakeCommand.ts
@@ -1,17 +1,21 @@
-import { CLICommand, BaseAddonCommand } from '@discord-factory/core-next'
+import { CLI, BaseCli, CliContextRuntime } from '@discord-factory/core-next'
 import Addon from '../index'
 import path from 'path'
 import fs from 'fs'
 import Logger from '@leadcodedev/logger'
 
-@CLICommand({
-  name: 'Create command file',
+@CLI({
   prefix: 'make:command',
-  usages: ['filename']
+  description: 'Generate a new command file at the given location',
+  args: ['filename'],
+  config: {
+    allowUnknownOptions: false,
+    ignoreOptionDefaultValue: false
+  }
 })
-export default class MakeCommand extends BaseAddonCommand<Addon> {
-  public async run (filename: string): Promise<void> {
-    const location = path.parse(filename)
+export default class MakeCommand extends BaseCli<Addon> {
+  public async run ({ args }: CliContextRuntime): Promise<void> {
+    const location = path.parse(args.filename as string)
     const targetFile = path.join(process.cwd(), 'src', location.dir, `${location.name}.ts`)
 
     const templateFile = await fs.promises.readFile(
@@ -29,7 +33,7 @@ export default class MakeCommand extends BaseAddonCommand<Addon> {
       await fs.promises.writeFile(targetFile, fileData)
       Logger.send('info', `File was created in ${targetFile.replace(/\\/g, '\\\\')}`)
     } catch (e) {
-      console.log(e)
+      Logger.send('error', 'An error has occurred')
     }
   }
 }
diff --git a/src/commands/MakeContextMenu.ts b/src/commands/MakeContextMenu.ts
@@ -1,17 +1,21 @@
-import { CLICommand, BaseAddonCommand } from '@discord-factory/core-next'
+import { CLI, BaseCli, CliContextRuntime } from '@discord-factory/core-next'
 import Addon from '../index'
 import path from 'path'
 import fs from 'fs'
 import Logger from '@leadcodedev/logger'
 
-@CLICommand({
-  name: 'Create context menu file',
+@CLI({
   prefix: 'make:context-menu',
-  usages: ['filename']
+  description: 'Generate a new context-menu file at the given location',
+  args: ['filename'],
+  config: {
+    allowUnknownOptions: false,
+    ignoreOptionDefaultValue: false
+  }
 })
-export default class MakeContextMenu extends BaseAddonCommand<Addon> {
-  public async run (filename: string): Promise<void> {
-    const location = path.parse(filename)
+export default class MakeContextMenu extends BaseCli<Addon> {
+  public async run ({ args }: CliContextRuntime): Promise<void> {
+    const location = path.parse(args.filename as string)
     const targetFile = path.join(process.cwd(), 'src', location.dir, `${location.name}.ts`)
 
     const templateFile = await fs.promises.readFile(
@@ -29,7 +33,7 @@ export default class MakeContextMenu extends BaseAddonCommand<Addon> {
       await fs.promises.writeFile(targetFile, fileData)
       Logger.send('info', `File was created in ${targetFile.replace(/\\/g, '\\\\')}`)
     } catch (e) {
-      console.log(e)
+      Logger.send('error', 'An error has occurred')
     }
   }
 }
diff --git a/src/commands/MakeEcosystem.ts b/src/commands/MakeEcosystem.ts
@@ -1,16 +1,19 @@
-import { CLICommand, BaseAddonCommand } from '@discord-factory/core-next'
+import { CLI, BaseCli } from '@discord-factory/core-next'
 import Addon from '../index'
 import path from 'path'
 import fs from 'fs'
 import Logger from '@leadcodedev/logger'
 
-@CLICommand({
-  name: 'Create ecosystem file',
+@CLI({
   prefix: 'pm2:ecosystem',
-  usages: []
+  description: 'Generate a new ecosystem.config.js file at root project',
+  config: {
+    allowUnknownOptions: false,
+    ignoreOptionDefaultValue: false
+  }
 })
-export default class MakeEcosystem extends BaseAddonCommand<Addon> {
-  public async run (filename: string): Promise<void> {
+export default class MakeEcosystem extends BaseCli<Addon> {
+  public async run (): Promise<void> {
     const targetFile = path.join(process.cwd(), 'ecosystem.config.js')
 
     const templateFile = await fs.promises.readFile(
@@ -21,7 +24,7 @@ export default class MakeEcosystem extends BaseAddonCommand<Addon> {
       await fs.promises.writeFile(targetFile, templateFile)
       Logger.send('info', 'Ecosystem file was create in your root project.')
     } catch (e) {
-      console.log(e)
+      Logger.send('error', 'An error has occurred')
     }
   }
 }
diff --git a/src/commands/MakeEvent.ts b/src/commands/MakeEvent.ts
@@ -1,33 +1,85 @@
-import { CLICommand, BaseAddonCommand } from '@discord-factory/core-next'
+import { CLI, BaseCli, CliContextRuntime } from '@discord-factory/core-next'
 import Addon from '../index'
 import path from 'path'
-import fs from 'fs'
 import Logger from '@leadcodedev/logger'
+import { prompt } from 'enquirer'
+import { eventList, makeFileName } from '../utils'
+import fs from 'fs'
 
-@CLICommand({
-  name: 'Create event file',
+@CLI({
   prefix: 'make:event',
-  usages: ['filename']
+  description: 'Generate a new event file at the given location',
+  args: ['filename'],
+  config: {
+    allowUnknownOptions: false,
+    ignoreOptionDefaultValue: false
+  }
 })
-export default class MakeEvent extends BaseAddonCommand<Addon> {
-  public async run (filename: string): Promise<void> {
-    const location = path.parse(filename)
+export default class MakeEvent extends BaseCli<Addon> {
+  public async run ({ args }: CliContextRuntime): Promise<void> {
+    const location = path.parse(args.filename as string)
     const targetFile = path.join(process.cwd(), 'src', location.dir, `${location.name}.ts`)
 
+    const result = await this.choiceEvent() as { event: string }
+    const eventParams = eventList[result.event] as string
+    const types = eventParams.includes(',')
+      ? eventParams.split(',')
+      : [eventParams]
+
+    const paramsTypes = this.getUniqueTypes(types
+      .flatMap((param: string) => param.split(': ')[1])
+      .filter((a) => a !== 'string' && a !== 'number' && a !== 'null' && a !== 'undefined')
+    )
+
+    const importParamsTypes = paramsTypes
+      .join(', ')
+
     const templateFile = await fs.promises.readFile(
       path.join(__dirname, '..', '..', 'src', 'templates', 'Event.txt'),
       { encoding: 'utf-8' }) as unknown as string
 
-    const filenameUpper = location.name.charAt(0).toUpperCase() + location.name.slice(1)
-
     try {
       await fs.promises.mkdir(path.join(process.cwd(), 'src', location.dir), { recursive: true })
-      const fileData = templateFile.replace(/\$fileName/g, filenameUpper)
+      const fileData = templateFile
+        .replace(/\$fileName/g, makeFileName(location.name))
+        .replace(/\$event/g, result.event)
+        .replace(/\$params/g, eventParams)
+        .replace(/\$imports/g, `import { ${importParamsTypes} } from 'discord.js'`)
 
       await fs.promises.writeFile(targetFile, fileData)
       Logger.send('info', `File was created in ${targetFile.replace(/\\/g, '\\\\')}`)
     } catch (e) {
-      console.log(e)
+      Logger.send('error', e.message)
     }
   }
+
+  protected async choiceEvent (): Promise<any> {
+    try {
+      return prompt({
+        name: 'event',
+        message: 'Please choose an event from the list below',
+        type: 'autocomplete',
+        choices: Object.keys(eventList),
+      })
+    } catch {
+      Logger.send('error', 'An error has occurred')
+    }
+  }
+
+  private getUniqueTypes(duplicateTypes) {
+    const array: string[] = []
+    duplicateTypes.forEach((type: string) => {
+      const whitelistedType = type
+        .replace(/\| null/g, '')
+        .replace(/\| number/g, '')
+        .replace(/\| string/g, '')
+        .replace(/\| undefined/g, '')
+        .trim()
+
+      if (!array.includes(whitelistedType)) {
+        array.push(whitelistedType)
+      }
+    })
+    return array
+  }
 }
diff --git a/src/commands/MakeHook.ts b/src/commands/MakeHook.ts
@@ -1,17 +1,21 @@
-import { CLICommand, BaseAddonCommand } from '@discord-factory/core-next'
+import { CLI, BaseCli, CliContextRuntime } from '@discord-factory/core-next'
 import Addon from '../index'
 import path from 'path'
 import fs from 'fs'
 import Logger from '@leadcodedev/logger'
 
-@CLICommand({
-  name: 'Create hook file',
+@CLI({
   prefix: 'make:hook',
-  usages: ['filename']
+  description: 'Generate a new command file at the given location',
+  args: ['filename'],
+  config: {
+    allowUnknownOptions: false,
+    ignoreOptionDefaultValue: false
+  }
 })
-export default class MakeHook extends BaseAddonCommand<Addon> {
-  public async run (filename: string): Promise<void> {
-    const location = path.parse(filename)
+export default class MakeHook extends BaseCli<Addon> {
+  public async run ({ args }: CliContextRuntime): Promise<void> {
+    const location = path.parse(args.filename as string)
     const targetFile = path.join(process.cwd(), 'src', location.dir, `${location.name}.ts`)
 
     const templateFile = await fs.promises.readFile(
@@ -27,7 +31,7 @@ export default class MakeHook extends BaseAddonCommand<Addon> {
       await fs.promises.writeFile(targetFile, fileData)
       Logger.send('info', `File was created in ${targetFile.replace(/\\/g, '\\\\')}`)
     } catch (e) {
-      console.log(e)
+      Logger.send('error', 'An error has occurred')
     }
   }
 }
diff --git a/src/templates/Event.txt b/src/templates/Event.txt
@@ -1,8 +1,9 @@
 import { Event, BaseEvent } from 'ioc:factory/Core/Event'
+$imports
 
-@Event('myEvent')
+@Event('$event')
 export default class $fileName extends BaseEvent {
-  public async run (args: string[]): Promise<void> {
+  public async run ($params): Promise<void> {
     // Your code here
   }
 }
diff --git a/src/utils/index.ts b/src/utils/index.ts
@@ -0,0 +1,74 @@
+export function makeFileName (name: string) {
+  return name.charAt(0).toUpperCase() + name.slice(1)
+}
+
+export const eventList = {
+  applicationCommandCreate: 'command: ApplicationCommand',
+  applicationCommandDelete: 'command: ApplicationCommand',
+  applicationCommandUpdate: 'before: ApplicationCommand | null, after: ApplicationCommand',
+  channelCreate: 'channel: GuildChannel',
+  channelDelete: 'channel: DMChannel | GuildChannel',
+  channelPinsUpdate: 'channel: TextBasedChannels, date: Date',
+  channelUpdate: 'before: DMChannel | GuildChannel, after: DMChannel | GuildChannel',
+  debug: 'message: string',
+  warn: 'message: string',
+  emojiCreate: 'emoji: GuildEmoji',
+  emojiDelete: 'emoji: GuildEmoji',
+  emojiUpdate: 'before: GuildEmoji, after: GuildEmoji',
+  error: 'error: Error',
+  guildBanAdd: 'ban: GuildBan',
+  guildBanRemove: 'ban: GuildBan',
+  guildCreate: 'guild: Guild',
+  guildDelete: 'guild: Guild',
+  guildUnavailable: 'guild: Guild',
+  guildIntegrationsUpdate: 'guild: Guild',
+  guildMemberAdd: 'member: GuildMember',
+  guildMemberAvailable: 'member: GuildMember | PartialGuildMember',
+  guildMemberRemove: 'member: GuildMember | PartialGuildMember',
+  guildMembersChunk: '',
+  guildMemberUpdate: 'before: GuildMember | PartialGuildMember, after: GuildMember',
+  guildUpdate: 'before: Guild, after: Guild',
+  inviteCreate: 'invite: Invite',
+  inviteDelete: 'invite: Invite',
+  message: 'message: Message',
+  messageCreate: 'message: Message',
+  messageDelete: 'message: Message | PartialMessage',
+  messageReactionRemoveAll: 'message: Message | PartialMessage',
+  messageReactionRemoveEmoji: 'reaction: MessageReaction | PartialMessageReaction',
+  messageDeleteBulk: 'messages: Collection<Snowflake, Message | PartialMessage>',
+  messageReactionAdd: 'reaction: MessageReaction | PartialMessageReaction, user: User | PartialUser',
+  messageReactionRemove: 'reaction: MessageReaction | PartialMessageReaction, user: User | PartialUser',
+  messageUpdate: 'before: Message | PartialMessage, after: Message | PartialMessage',
+  presenceUpdate: 'before: Presence | null, after: Presence',
+  rateLimit: 'rateLimitData: RateLimitData',
+  invalidRequestWarning: 'invalidRequestWarningData: InvalidRequestWarningData',
+  ready: 'client: Client<true>',
+  invalidated: '',
+  roleCreate: 'role: Role',
+  roleDelete: 'role: Role',
+  roleUpdate: 'before: Role, after: Role',
+  threadCreate: 'thread: ThreadChannel',
+  threadDelete: 'thread: ThreadChannel',
+  threadListSync: 'threads: Collection<Snowflake, ThreadChannel>',
+  threadMemberUpdate: 'before: ThreadMember, after: ThreadMember',
+  threadMembersUpdate: '',
+  threadUpdate: 'before: ThreadChannel, after: ThreadChannel',
+  typingStart: 'typing: Typing',
+  userUpdate: 'before: User | PartialUser, after: User',
+  voiceJoin: 'state: VoiceState',
+  voiceLeave: 'state: VoiceState',
+  voiceStateUpdate: 'before: VoiceState, after: VoiceState',
+  webhookUpdate: 'channel: TextChannel',
+  interactionCreate: 'interaction: Interaction',
+  shardDisconnect: 'closeEvent: CloseEvent, shardId: number',
+  shardError: 'error: Error, shardId: number',
+  shardReady: 'shardId: number, unavailableGuilds: Set<Snowflake> | undefined',
+  shardReconnecting: 'shardId: number',
+  shardResume: 'shardId: number, replayedEvents: number',
+  stageInstanceCreate: 'stageInstance: StageInstance',
+  stageInstanceUpdate: 'before: StageInstance | null, after: StageInstance',
+  stageInstanceDelete: 'stageInstance: StageInstance',
+  stickerCreate: 'sticker: Sticker',
+  stickerDelete: 'sticker: Sticker',
+  stickerUpdate: 'before: Sticker, after: Sticker',
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,9 @@`
`1`	`1`	`import { Event, BaseEvent } from 'ioc:factory/Core/Event'`
	`2`	`+$imports`
`2`	`3`
`3`		`-@Event('myEvent')`
	`4`	`+@Event('$event')`
`4`	`5`	`export default class $fileName extends BaseEvent {`
`5`		`- public async run (args: string[]): Promise<void> {`
	`6`	`+ public async run ($params): Promise<void> {`
`6`	`7`	`// Your code here`
`7`	`8`	`}`
`8`	`9`	`}`