Add initial command handler placeholders

- Referencing `ChatModule.sendMessage` switch-cases
- Added `TODO` type to keep track of implementation plans

Author: MarkH817

package.json

@@ -16,7 +16,10 @@
   },
   "imports": {
     "#assets/*": "./src/assets/*",
+    "#commands": "./src/commands/index.ts",
+    "#commands/*": "./src/commands/*",
     "#components/*": "./src/components/*",
+    "#composables/*": "./src/composables/*",
     "#constants": "./src/constants/index.ts",
     "#constants/*": "./src/constants/*",
     "#models": "./src/models/index.ts",

src/commands/handlers/channel.ts

@@ -0,0 +1,18 @@
+import type { TODO } from '#models';
+
+/**
+ * Join a channel.
+ * `/join <channel>`
+ */
+export const join: TODO = null;
+/**
+ * Leave a channel.
+ * `/leave <channel>`
+ */
+export const leave: TODO = null;
+/**
+ * Switch channel
+ * `/goto <channel>`
+ * `/goto #general`
+ */
+export const goto: TODO = null;

src/commands/handlers/help.ts

@@ -0,0 +1,7 @@
+import type { TODO } from '#models';
+
+/**
+ * - `/help` - Get list of commands available
+ * - `/help <command>` - Get command-specific help message
+ */
+export const help: TODO = null;

src/commands/handlers/index.ts

@@ -0,0 +1,5 @@
+export * as channel from './channel';
+export * as help from './help';
+export * as operator from './operator';
+export * as settings from './settings';
+export * as user from './user';

src/commands/handlers/operator.ts

@@ -0,0 +1,72 @@
+import type { TODO } from '#models';
+
+/**
+ * Ban user from channel(s).
+ * `/ban <channel> <username> [reason]`
+ * `/ban * <username> [reason]`
+ */
+export const ban: TODO = null;
+/**
+ * Unban user from channel(s).
+ * `/unban <channel> <username>`
+ * `/unban * <username>`
+ */
+export const unban: TODO = null;
+/**
+ * Quiet user from channel(s).
+ * `/quiet <channel> <username>`
+ * `/quiet * <username>`
+ */
+export const quiet: TODO = null;
+/**
+ * Unquiet user from channel(s).
+ * `/unquiet <channel> <username>`
+ * `/unquiet * <username>`
+ */
+export const unquiet: TODO = null;
+/**
+ * Send notice to channel(s).
+ * `/notice <channel> <message>`
+ * `/notice * <message>`
+ */
+export const notice: TODO = null;
+/**
+ * Ban hostmask (form: `user!nick@host`).
+ * `/banmask <channel> <mask>`
+ */
+export const banmask: TODO = null;
+/**
+ * Unban hostmask.
+ * `/unbanmask <channel> <mask>`
+ */
+export const unbanmask: TODO = null;
+/**
+ * Get username by nick.
+ * `/user <nick>`
+ */
+export const user: TODO = null;
+/**
+ * Get nicks by username.
+ * `/nicks <username>`
+ */
+export const nicks: TODO = null;
+/**
+ * Kick user from channel(s).
+ * `/kick <channel> <username> [reason]`
+ */
+export const kick: TODO = null;
+/**
+ * Get list of bans
+ * `/banlist`
+ */
+export const banlist: TODO = null;
+/**
+ * Change your nickname.
+ * `/changenick <newNick>`
+ */
+export const changenick: TODO = null;
+/**
+ * Allow operator to send a RAW command through the websocket.
+ * `/execute <line>`
+ */
+export const execute: TODO = null;

src/commands/handlers/settings.ts

@@ -0,0 +1,49 @@
+import type { TODO } from '#models';
+
+/**
+ * Change custom emoticon slot.
+ * `/emoticon <slot#> <emoticon>`
+ */
+export const emoticon: TODO = null;
+/**
+ * Get list of custom emoticons.
+ * `/emoticon-list`
+ */
+export const emoticonList: TODO = null;
+/**
+ * Change notification indicator that appears in page title.
+ * `/indicator <indicator>`
+ */
+export const indicator: TODO = null;
+/**
+ * Update font size.
+ * `/size <newFontSize>`
+ * Aliases: `/textsize`, `/fontsize`
+ */
+export const size: TODO = null;
+/**
+ * View/update notification keywords.
+ * - `/keywords`
+ * - `/keywords add <keywords>`
+ * - `/keywords remove <keywords>`
+ */
+export const keywords: TODO = null;
+/**
+ * - `/notifications`
+ * - `/notifications enable <channel>`
+ * - `/notifications disable <channel>`
+ */
+export const notifications: TODO = null;
+/**
+ * Updates username color.
+ * - `/color <hexColor>`
+ * - `/color <r>, <g>, <b>`
+ * - `/color <namedColor>`
+ */
+export const color: TODO = null;
+/**
+ * Toggle chat feature.
+ * `/toolbar enable <chatFeature>`
+ * `/toolbar disable <chatFeature>`
+ */
+export const toolbar: TODO = null;

src/commands/handlers/user.ts

@@ -0,0 +1,39 @@
+import type { TODO } from '#models';
+
+/**
+ * Post message as an action.
+ * `/me <message>`
+ */
+export const me: TODO = null;
+/**
+ * Hide messages from a user.
+ * `/ignore <username>`
+ */
+export const ignore: TODO = null;
+/**
+ * Show currently ignored users.
+ * `/ignore-list`
+ */
+export const ignoreList: TODO = null;
+/**
+ * Show messages from user.
+ */
+export const unignore: TODO = null;
+/**
+ * Disconnect from chat.
+ * `/disconnect`
+ */
+export const disconnect: TODO = null;
+/**
+ * Set self as away.
+ *
+ * `/away <reason>`
+ * If `<reason>` is not given, the default away message is provided instead.
+ */
+export const away: TODO = null;
+/**
+ * Set self as back.
+ *
+ * `/unaway`
+ */
+export const unaway: TODO = null;

src/commands/index.ts

@@ -0,0 +1,4 @@
+import log from 'loglevel';
+import * as Handlers from './handlers';
+
+log.debug(Handlers);

src/models/index.ts

@@ -3,4 +3,5 @@ export * from './ban-status';
 export * from './channel';
 export * from './connection-status';
 export * from './message';
+export * from './todo';
 export * from './user';

src/models/todo.ts

@@ -0,0 +1 @@
+export type TODO<T = unknown> = T;