@pikokr/command.ts 5.5.0 → 5.6.0-dev.3

package/src/core/components/ComponentArgumentDecorator.ts

@@ -1,11 +1,3 @@
-/*
-* File: ComponentArgumentDecorator.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
 import _ from 'lodash'
 
 export class ComponentArgumentDecorator<Options = unknown> {

package/src/core/components/decoratorCreator.ts

@@ -1,17 +1,9 @@
-/*
- * File: decoratorCreator.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import { Collection } from 'discord.js'
-import { ComponentHookStore } from '../hooks'
+import type { ComponentHookStore } from '../hooks'
 import { getComponentHookStore } from '../hooks/componentHook'
 import { ComponentStoreSymbol } from '../symbols'
-import { BaseComponent } from './BaseComponent'
-import { ComponentArgumentDecorator } from './ComponentArgumentDecorator'
+import type { BaseComponent } from './BaseComponent'
+import type { ComponentArgumentDecorator } from './ComponentArgumentDecorator'
 
 export type ComponentStore = Collection<string | symbol, BaseComponent>
 export type ComponentArgumentStore = Collection<number, ComponentArgumentDecorator>
@@ -69,7 +61,7 @@ export const getComponentArgumentStore = (target: object, key: string | symbol):
 export const createArgumentDecorator = <Options>(type: typeof ComponentArgumentDecorator<Options>) => {
   return (options: Options): ParameterDecorator => {
     return (target, key, idx) => {
-      var arg: ComponentArgumentDecorator<Options> = new type(options)
+      const arg: ComponentArgumentDecorator<Options> = new type(options)
 
       const store = getComponentArgumentStore(target, key)
 

package/src/core/components/index.ts

@@ -1,13 +1,5 @@
-/*
-* File: index.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
-import 'reflect-metadata'
-export * from './decoratorCreator'
-export * from './ComponentArgument'
-export * from './ComponentArgumentDecorator'
-export * from './BaseComponent'
+import 'reflect-metadata'
+export * from './decoratorCreator'
+export * from './ComponentArgument'
+export * from './ComponentArgumentDecorator'
+export * from './BaseComponent'

package/src/core/converter/index.ts

@@ -1,27 +1,20 @@
-/*
- * File: index.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import { BaseComponent } from '../components/BaseComponent'
 import { createComponentDecorator } from '../components/decoratorCreator'
 
-type Options = { component: unknown; type: Function; parameterless: boolean }
+type Options<T> = { component: unknown; type: T; parameterless: boolean }
 
-type OptionsArg = Omit<Options, 'parameterless'> & { parameterless?: boolean }
+type OptionsArg<T> = Omit<Options<T>, 'parameterless'> & { parameterless?: boolean }
 
-export class ConverterComponent extends BaseComponent {
-  options: Options
+export class ConverterComponent<T> extends BaseComponent {
+  options: Options<T>
 
-  constructor(options: OptionsArg) {
+  constructor(options: OptionsArg<T>) {
     super()
-    this.options = options as Options
+    this.options = options as Options<T>
   }
 }
 
-export const argConverter = (options: OptionsArg) => createComponentDecorator(new ConverterComponent(options))
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const argConverter = <T>(options: OptionsArg<T>) => createComponentDecorator(new ConverterComponent(options))
 
 export { Options as ArgumentConvertOptions, OptionsArg as ArgumentConvertOptionsArg }

package/src/core/extensions/CTSExtension.ts

@@ -1,11 +1,3 @@
-/*
- * File: CTSExtension.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import chalk from 'chalk'
 import { Extension } from './Extension'
 

package/src/core/extensions/Extension.ts

@@ -1,15 +1,7 @@
-/*
- * File: Extension.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import chalk from 'chalk'
 import { Collection } from 'discord.js'
-import { Logger } from 'tslog'
-import { ComponentArgument } from '../components/ComponentArgument'
+import type { Logger } from 'tslog'
+import type { ComponentArgument } from '../components/ComponentArgument'
 import { ConverterComponent } from '../converter'
 import { CommandClient } from '../structures'
 
@@ -33,12 +25,12 @@ export class Extension {
     component: unknown,
     argList: unknown[],
     args: Collection<number, ComponentArgument>,
-    getConverterArgs: (arg: ComponentArgument, index: number, converter: ConverterComponent) => unknown[] | Promise<unknown[]>,
+    getConverterArgs: (arg: ComponentArgument, index: number, converter: ConverterComponent<unknown>) => unknown[] | Promise<unknown[]>,
   ) {
-    const items = new Collection<unknown, { ext: object; component: ConverterComponent }>()
+    const items = new Collection<unknown, { ext: object; component: ConverterComponent<unknown> }>()
 
     for (const extension of this.commandClient.registry.extensions) {
-      for (const converter of this.commandClient.registry.getComponentsWithType<ConverterComponent>(extension, ConverterComponent)) {
+      for (const converter of this.commandClient.registry.getComponentsWithType<ConverterComponent<unknown>>(extension, ConverterComponent)) {
         if (converter.options.component != component) continue
 
         items.set(converter.options.type, { component: converter, ext: extension })

package/src/core/extensions/index.ts

@@ -1,9 +1 @@
-/*
-* File: index.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
 export * from './Extension'

package/src/core/hooks/componentHook.ts

@@ -1,17 +1,9 @@
-/*
- * File: componentHook.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import { Collection } from 'discord.js'
 import { ComponentHookSymbol } from '../symbols'
 
-export type ComponentHookFn = (...args: any[]) => void | Promise<void>
+export type ComponentHookFn<T extends unknown[]> = (...args: T) => void | Promise<void>
 
-export type ComponentHookStore = Collection<string, ComponentHookFn[]>
+export type ComponentHookStore = Collection<string, ComponentHookFn<unknown[]>[]>
 
 export const getComponentHookStore = (target: object, property: string | symbol): ComponentHookStore => {
   let data = Reflect.getMetadata(ComponentHookSymbol, target, property) as ComponentHookStore
@@ -24,7 +16,7 @@ export const getComponentHookStore = (target: object, property: string | symbol)
   return data
 }
 
-export const createComponentHook = (name: string, fn: ComponentHookFn): MethodDecorator => {
+export const createComponentHook = <T extends unknown[]>(name: string, fn: ComponentHookFn<T>): MethodDecorator => {
   return (target, key) => {
     const store = getComponentHookStore(target, key)
 
@@ -35,6 +27,7 @@ export const createComponentHook = (name: string, fn: ComponentHookFn): MethodDe
       store.set(name, hooks)
     }
 
+    // @ts-expect-error unknown type
     hooks.unshift(fn)
   }
 }

package/src/core/hooks/index.ts

@@ -1,11 +1,3 @@
-/*
- * File: index.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
-export * from './moduleHook'
-export { createComponentHook, type ComponentHookFn } from './componentHook'
-export type { ComponentHookStore } from './componentHook'
+export * from './moduleHook'
+export { createComponentHook, type ComponentHookFn } from './componentHook'
+export type { ComponentHookStore } from './componentHook'

package/src/core/hooks/moduleHook.ts

@@ -1,15 +1,8 @@
-/*
- * File: moduleHook.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import { Collection } from 'discord.js'
 import { ModuleHookStoreSymbol } from '../symbols'
+import type { ComponentHookFn } from './componentHook'
 
-export type ModuleHookStore = Collection<string, Function[]>
+export type ModuleHookStore = Collection<string, ComponentHookFn<unknown[]>[]>
 
 export const getModuleHookStore = (target: object) => {
   let result: ModuleHookStore | null = Reflect.getMetadata(ModuleHookStoreSymbol, target)

package/src/core/index.ts

@@ -1,11 +1,3 @@
-/*
-* File: index.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
 export * from './components'
 export * from './hooks'
 export * from './converter'

package/src/core/listener/index.ts

@@ -1,11 +1,3 @@
-/*
- * File: index.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import _ from 'lodash'
 import { BaseComponent } from '../components/BaseComponent'
 import { createComponentDecorator } from '../components/decoratorCreator'

package/src/core/structures/CommandClient.ts

@@ -1,17 +1,12 @@
-/*
- * File: CommandClient.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import chalk from 'chalk'
-import { Client, Snowflake, Team, User } from 'discord.js'
+import type { Client, Snowflake } from 'discord.js'
+import { Team, User } from 'discord.js'
 import EventEmitter from 'events'
-import { ISettingsParam, Logger } from 'tslog'
-import { ApplicationCommandExtension, ApplicationCommandExtensionConfig } from '../../applicationCommand/ApplicationCommandExtension'
-import { TextCommandConfig } from '../../textCommand'
+import type { ISettingsParam } from 'tslog'
+import { Logger } from 'tslog'
+import type { ApplicationCommandExtensionConfig } from '../../applicationCommand/ApplicationCommandExtension'
+import { ApplicationCommandExtension } from '../../applicationCommand/ApplicationCommandExtension'
+import type { TextCommandConfig } from '../../textCommand'
 import { TextCommandExtension } from '../../textCommand/TextCommandExtension'
 import { CommandClientSymbol } from '../symbols'
 import { Registry } from './Registry'

package/src/core/structures/Registry.ts

@@ -1,24 +1,16 @@
-/*
- * File: Registry.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import chalk from 'chalk'
 import { Collection } from 'discord.js'
-import EventEmitter from 'events'
-import _, { result } from 'lodash'
-import { Logger } from 'tslog'
+import type EventEmitter from 'events'
+import _ from 'lodash'
+import type { Logger } from 'tslog'
 import { getComponentStore } from '../components'
 import { getModuleHookStore } from '../hooks'
 import { ListenerComponent } from '../listener'
 import { CommandClientSymbol, FilePathSymbol } from '../symbols'
-import { CommandClient } from './CommandClient'
+import type { CommandClient } from './CommandClient'
 import walkSync from 'walk-sync'
 import path from 'path'
-import { ComponentHookFn } from '../hooks/componentHook'
+import type { ComponentHookFn } from '../hooks/componentHook'
 
 export class Registry {
   extensions: object[] = []
@@ -27,7 +19,7 @@ export class Registry {
 
   logger: Logger<unknown>
 
-  globalHooks: Record<string, ComponentHookFn[]> = {}
+  globalHooks: Record<string, ComponentHookFn<unknown[]>[]> = {}
 
   constructor(logger: Logger<unknown>, public client: CommandClient) {
     this.logger = logger.getSubLogger({
@@ -35,7 +27,7 @@ export class Registry {
     })
   }
 
-  addGlobalHook(name: string, fn: ComponentHookFn) {
+  addGlobalHook(name: string, fn: ComponentHookFn<unknown[]>) {
     let hooks = this.globalHooks[name]
 
     if (!hooks) {
@@ -110,7 +102,7 @@ export class Registry {
 
     const p = require.resolve(file)
 
-    const mod = require(p)
+    const mod = await import(p)
 
     if (typeof mod.setup !== 'function') throw new Error('Extension must have a setup function')
 

package/src/core/structures/index.ts

@@ -1,10 +1,2 @@
-/*
-* File: index.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
 export * from './Registry'
 export * from './CommandClient'

package/src/core/symbols.ts

@@ -1,14 +1,6 @@
-/*
- * File: symbols.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
-export const ComponentStoreSymbol = Symbol()
-export const ComponentArgStoreSymbol = Symbol()
-export const ModuleHookStoreSymbol = Symbol()
-export const CommandClientSymbol = Symbol()
-export const ComponentHookSymbol = Symbol()
-export const FilePathSymbol = Symbol()
+export const ComponentStoreSymbol = Symbol()
+export const ComponentArgStoreSymbol = Symbol()
+export const ModuleHookStoreSymbol = Symbol()
+export const CommandClientSymbol = Symbol()
+export const ComponentHookSymbol = Symbol()
+export const FilePathSymbol = Symbol()

package/src/core/utils/checks.ts

@@ -1,18 +1,11 @@
-/*
- * File: checks.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
-import { BaseInteraction, Interaction, Message } from 'discord.js'
+import type { Interaction } from 'discord.js'
+import { BaseInteraction, Message } from 'discord.js'
 import { createComponentHook } from '../hooks'
-import { ComponentHookFn } from '../hooks/componentHook'
-import { CommandClient } from '../structures'
+import type { ComponentHookFn } from '../hooks/componentHook'
+import type { CommandClient } from '../structures'
 import { OwnerOnlyError } from './errors'
 
-export const createCheckDecorator = (fn: ComponentHookFn) => createComponentHook('beforeCall', fn)
+export const createCheckDecorator = (fn: ComponentHookFn<[CommandClient, Interaction | Message]>) => createComponentHook('beforeCall', fn)
 
 export const ownerOnly = createCheckDecorator(async (client: CommandClient, i: Interaction | Message) => {
   let isOwner = false

package/src/core/utils/errors.ts

@@ -1,9 +1 @@
-/*
-* File: errors.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
 export class OwnerOnlyError {}

package/src/core/utils/index.ts

@@ -1,11 +1,3 @@
-/*
- * File: index.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
-export * from './checks'
-export * from './errors'
-export * from './decorators'
+export * from './checks'
+export * from './errors'
+export * from './decorators'

package/src/index.ts

@@ -1,11 +1,3 @@
-/*
-* File: index.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
-export * from './core'
-export * from './applicationCommand'
-export * from './textCommand'
+export * from './core'
+export * from './applicationCommand'
+export * from './textCommand'

package/src/textCommand/TextCommand.ts

@@ -1,11 +1,3 @@
-/*
- * File: TextCommand.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import { createComponentDecorator } from '../core/components/decoratorCreator'
 import { BaseComponent } from '../core/components/BaseComponent'
 

package/src/textCommand/TextCommandExtension.ts

@@ -1,11 +1,3 @@
-/*
- * File: TextCommandExtension.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
 import { listener } from '../core/listener'
 import { Message } from 'discord.js'
 import { CTSExtension } from '../core/extensions/CTSExtension'
@@ -14,10 +6,7 @@ import { TextCommandRestOption } from './parameters'
 import { argConverter } from '../core'
 
 export type TextCommandConfig = {
-  prefix:
-    | string
-    | string[]
-    | ((msg: Message) => Promise<string | string[]> | string | string[])
+  prefix: string | string[] | ((msg: Message) => Promise<string | string[]> | string | string[])
 }
 
 declare module 'discord.js' {
@@ -68,10 +57,7 @@ export class TextCommandExtension extends CTSExtension {
       const extensions = new Map<TextCommandComponent, object>()
 
       for (const ext of this.commandClient.registry.extensions) {
-        for (const cmd of this.commandClient.registry.getComponentsWithType<TextCommandComponent>(
-          ext,
-          TextCommandComponent
-        )) {
+        for (const cmd of this.commandClient.registry.getComponentsWithType<TextCommandComponent>(ext, TextCommandComponent)) {
           commands.push(cmd)
           extensions.set(cmd, ext)
         }
@@ -112,23 +98,16 @@ export class TextCommandExtension extends CTSExtension {
 
       let argStrings = content.slice(commandNameLength + 1).split(/ /g)
 
-      await this.convertArguments(
-        TextCommandComponent,
-        args,
-        command.argTypes,
-        async (arg, i, converter) => {
-          if (converter.options.parameterless) return [msg]
-
-          if (
-            arg.decorators.find((x) => x.constructor === TextCommandRestOption)
-          ) {
-            const text = argStrings.join(' ')
-            argStrings = []
-            return [text, msg]
-          }
-          return [argStrings.shift(), msg]
+      await this.convertArguments(TextCommandComponent, args, command.argTypes, async (arg, i, converter) => {
+        if (converter.options.parameterless) return [msg]
+
+        if (arg.decorators.find((x) => x.constructor === TextCommandRestOption)) {
+          const text = argStrings.join(' ')
+          argStrings = []
+          return [text, msg]
         }
-      )
+        return [argStrings.shift(), msg]
+      })
 
       await command.execute(ext, args, [msg])
     } catch (e) {

package/src/textCommand/index.ts

@@ -1,11 +1,3 @@
-/*
-* File: index.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
 export * from './TextCommand'
 export type { TextCommandConfig } from './TextCommandExtension'
 export * from './parameters'

package/src/textCommand/parameters.ts

@@ -1,14 +1,6 @@
-/*
- * File: parameters.ts
- *
- * Copyright (c) 2022-2022 pikokr
- *
- * Licensed under MIT License. Please see more defails in LICENSE file.
- */
-
-import { ComponentArgumentDecorator } from '../core'
-import { createArgumentDecorator } from '../core'
-
-export class TextCommandRestOption extends ComponentArgumentDecorator<void> {}
-
-export const rest = createArgumentDecorator(TextCommandRestOption)
+import { ComponentArgumentDecorator } from '../core'
+import { createArgumentDecorator } from '../core'
+
+export class TextCommandRestOption extends ComponentArgumentDecorator<void> {}
+
+export const rest = createArgumentDecorator(TextCommandRestOption)

package/src/utils/types.ts

@@ -0,0 +1 @@
+export type AnyFunction = (...args: unknown[]) => unknown

package/test/index.ts

@@ -6,7 +6,8 @@
  * Licensed under MIT License. Please see more defails in LICENSE file.
  */
 
-import { ApplicationCommandOptionType, ApplicationCommandType, ChatInputCommandInteraction, Client, Message } from 'discord.js'
+import type { ChatInputCommandInteraction, Message } from 'discord.js'
+import { ApplicationCommandOptionType, ApplicationCommandType, Client } from 'discord.js'
 import { applicationCommand, CommandClient, moduleHook, option, ownerOnly, listener, Extension, command, rest, SubCommandGroup } from '../src'
 import 'dotenv/config'
 import { Logger } from 'tslog'
@@ -70,7 +71,7 @@ class Test extends Extension {
 
   @listener({ event: 'ready' })
   async testEvent() {
-    this.logger.info(`Login: ${chalk.green(client.user!.tag)}`)
+    this.logger.info(`Login: ${chalk.green(client.user?.tag ?? 'Unknown')}`)
     await this.commandClient.fetchOwners()
   }
 
@@ -85,7 +86,7 @@ const ext = new Test()
 
 const client = new Client({ intents: ['GuildMessages', 'MessageContent', 'DirectMessages', 'Guilds'] })
 
-const logger = new Logger({  })
+const logger = new Logger({})
 
 const cc = new CommandClient(client, logger)
 
@@ -106,7 +107,7 @@ const run = async () => {
 
   await client.application?.commands.set([])
 
-  await cc.getApplicationCommandsExtension()!.sync()
+  await cc.getApplicationCommandsExtension()?.sync()
 }
 
 run()

package/tsup.config.ts

@@ -1,11 +1,11 @@
-/*
-* File: tsup.config.ts
-* 
-* Copyright (c) 2022-2022 pikokr
-* 
-* Licensed under MIT License. Please see more defails in LICENSE file.
-*/
-
+/*
+ * File: tsup.config.ts
+ *
+ * Copyright (c) 2022-2022 pikokr
+ *
+ * Licensed under MIT License. Please see more defails in LICENSE file.
+ */
+
 import { defineConfig } from 'tsup'
 
 export default defineConfig({

package/.github/workflows/publish.stable.yml

@@ -1,18 +0,0 @@
-on:
-  push:
-    branches:
-      - stable
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16.16
-      - run: yarn
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/publish.yml

@@ -1,20 +0,0 @@
-on:
-  push:
-    branches:
-      - dev
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16.16
-      - run: yarn
-      - run: COMMIT_ID=$(git rev-parse --short HEAD) node publish-version.js
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
-          tag: dev