feat: improvements

Author: twlite

.github/workflows/dev-redis.yaml

@@ -0,0 +1,65 @@
+name: (CommandKit Redis) Publish Dev Build
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/redis/**'
+
+jobs:
+  release:
+    name: 🚀 Publish Dev Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: pnpm/action-setup@v2
+        with:
+          version: '9.15.0'
+
+      - name: 📚 Checkout
+        uses: actions/checkout@v3
+
+      - name: 🟢 Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+
+      - name: 🍳 Prepare
+        run: pnpm install
+
+      - name: 🔢 Update Version
+        run: |
+          cd packages/redis
+          node -e "const pkg = require('./package.json'); \
+          const newVersion = pkg.version + '-dev.' + new Date().toISOString().replace(/[:\-T]/g, '').substr(0,14); \
+          pkg.version = newVersion; \
+          require('fs').writeFileSync('./package.json', JSON.stringify(pkg, null, 2));"
+        env:
+          DEBIAN_FRONTEND: noninteractive
+
+      - name: 🧱 Build
+        run: pnpm --filter './packages/redis' run build
+
+      - name: 🚚 Publish
+        run: |
+          cd packages/redis
+          npm publish --access public --tag dev
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
+
+      - name: 🚫 Deprecate Previous Dev Version
+        run: |
+          PACKAGE_NAME=$(node -e "console.log(require('./packages/redis/package.json').name);")
+          ALL_VERSIONS=$(npm info $PACKAGE_NAME versions -json)
+          VERSION_TO_DEPRECATE=$(echo $ALL_VERSIONS | node -e "
+              const versions = JSON.parse(require('fs').readFileSync('/dev/stdin', 'utf-8'));
+              const devVersions = versions.filter(v => v.includes('-dev.'));
+              const versionToDeprecate = devVersions[devVersions.length - 2];
+              console.log(versionToDeprecate);
+          ")
+          echo Deprecating version $VERSION_TO_DEPRECATE
+          npm deprecate $PACKAGE_NAME@$VERSION_TO_DEPRECATE "Deprecated dev version."
+
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

apps/test-bot/commandkit.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from 'commandkit';
+
+export default defineConfig({
+  main: 'index.js',
+  src: 'src',
+});

apps/test-bot/src/app/commands/prompt/middleware.ts

@@ -1,8 +1,8 @@
-import { MiddlewareContext } from 'commandkit';
+import { Logger, MiddlewareContext } from 'commandkit';
 import { MessageFlags } from 'discord.js';
 
 export function beforeExecute(ctx: MiddlewareContext) {
-  console.log('Pre-command middleware');
+  Logger.info('Pre-command middleware');
 
   const user = ctx.isInteraction() ? ctx.interaction.user : ctx.message.author;
 
@@ -21,5 +21,5 @@ export function beforeExecute(ctx: MiddlewareContext) {
 }
 
 export function afterExecute(ctx: MiddlewareContext) {
-  console.log('Post-command middleware executed');
+  Logger.info('Post-command middleware executed');
 }

apps/test-bot/src/index.ts

@@ -1,6 +1,6 @@
 import { CommandKit } from 'commandkit';
 import { Client } from 'discord.js';
-import 'dotenv/config';
+process.loadEnvFile();
 
 const client = new Client({
   intents: ['Guilds', 'GuildMembers', 'GuildMessages', 'MessageContent'],

packages/commandkit/src/app/commands/Context.ts

@@ -6,6 +6,7 @@ import {
   Locale,
   Interaction,
   UserContextMenuCommandInteraction,
+  Client,
 } from 'discord.js';
 import { CommandKit } from '../../CommandKit';
 import { Localization } from '../i18n/Localization';
@@ -97,6 +98,11 @@ export class Context<
    */
   public readonly message: ContextParameters<ExecutionMode>['message'];
 
+  /**
+   * The client instance.
+   */
+  public readonly client: Client;
+
   #store: Map<string, any>;
 
   private _locale: Locale | null = null;
@@ -113,6 +119,7 @@ export class Context<
     // these are assigned to readonly properties to make them accessible via object destructuring
     this.interaction = config.interaction;
     this.message = config.message;
+    this.client = commandkit.client;
     this.#store = config.store ?? new Map();
   }
 

packages/commandkit/src/cache/cache.ts

@@ -252,9 +252,11 @@ export async function invalidate(tag: string): Promise<void> {
     (v) => v.key === tag || v.hash === tag,
   );
 
-  if (!entry) {
-    throw new Error(`Cache key ${tag} was not found.`);
-  }
+  // if (!entry) {
+  //   throw new Error(`Cache key ${tag} was not found.`);
+  // }
+
+  if (!entry) return;
 
   await provider.delete(entry.key);
 }
@@ -280,9 +282,11 @@ export async function revalidate<T = unknown>(
     (v) => v.key === tag || v.hash === tag,
   );
 
-  if (!entry) {
-    throw new Error(`Cache key ${tag} was not found.`);
-  }
+  // if (!entry) {
+  //   throw new Error(`Cache key ${tag} was not found.`);
+  // }
+
+  if (!entry) return undefined as T;
 
   await provider.delete(entry.key);
 

packages/commandkit/src/cli/build.ts

@@ -4,7 +4,6 @@ import { readFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { build } from 'tsup';
 import {
-  Colors,
   copyLocaleFiles,
   erase,
   findCommandKitConfig,
@@ -13,6 +12,7 @@ import {
 } from './common.js';
 import ora from 'ora';
 import { commandkitPlugin } from './esbuild-plugins/plugin';
+import colors from '../utils/colors.js';
 
 export async function bootstrapProductionBuild(config: any) {
   const {
@@ -60,13 +60,13 @@ export async function bootstrapProductionBuild(config: any) {
     await injectShims(outDir, main, antiCrash, polyfillRequire);
 
     status.succeed(
-      Colors.green(
+      colors.green(
         `Build completed in ${(performance.now() - start).toFixed(2)}ms!`,
       ),
     );
     write(
-      Colors.green(
-        `\nRun ${Colors.magenta(`commandkit start`)} ${Colors.green(
+      colors.green(
+        `\nRun ${colors.magenta(`commandkit start`)} ${colors.green(
           'to start your bot.',
         )}`,
       ),

packages/commandkit/src/cli/common.ts

@@ -3,36 +3,9 @@
 import { rimrafSync } from 'rimraf';
 import { join } from 'node:path';
 import fs from 'node:fs';
+import colors from '../utils/colors';
 
-const resetColor = '\x1b[0m';
-
-export const Colors = {
-  reset: (text: string) => `${text}${resetColor}`,
-  bright: (text: string) => `\x1b[1m${text}${resetColor}`,
-  dim: (text: string) => `\x1b[2m${text}${resetColor}`,
-  underscore: (text: string) => `\x1b[4m${text}${resetColor}`,
-  blink: (text: string) => `\x1b[5m${text}${resetColor}`,
-  reverse: (text: string) => `\x1b[7m${text}${resetColor}`,
-  hidden: (text: string) => `\x1b[8m${text}${resetColor}`,
-
-  black: (text: string) => `\x1b[30m${text}${resetColor}`,
-  red: (text: string) => `\x1b[31m${text}${resetColor}`,
-  green: (text: string) => `\x1b[32m${text}${resetColor}`,
-  yellow: (text: string) => `\x1b[33m${text}${resetColor}`,
-  blue: (text: string) => `\x1b[34m${text}${resetColor}`,
-  magenta: (text: string) => `\x1b[35m${text}${resetColor}`,
-  cyan: (text: string) => `\x1b[36m${text}${resetColor}`,
-  white: (text: string) => `\x1b[37m${text}${resetColor}`,
-
-  bgBlack: (text: string) => `\x1b[40m${text}${resetColor}`,
-  bgRed: (text: string) => `\x1b[41m${text}${resetColor}`,
-  bgGreen: (text: string) => `\x1b[42m${text}${resetColor}`,
-  bgYellow: (text: string) => `\x1b[43m${text}${resetColor}`,
-  bgBlue: (text: string) => `\x1b[44m${text}${resetColor}`,
-  bgMagenta: (text: string) => `\x1b[45m${text}${resetColor}`,
-  bgCyan: (text: string) => `\x1b[46m${text}${resetColor}`,
-  bgWhite: (text: string) => `\x1b[47m${text}${resetColor}`,
-};
+let ts: typeof import('typescript') | undefined;
 
 export function write(message: any) {
   process.stdout.write(message);
@@ -42,8 +15,8 @@ export function write(message: any) {
 /**
  * @returns {never}
  */
-export function panic(message: any) {
-  write(Colors.red(`Error: ${message}`));
+export function panic(message: any): never {
+  write(colors.red(`Error: ${message}`));
   process.exit(1);
 }
 
@@ -59,17 +32,10 @@ export function findPackageJSON() {
 }
 
 const possibleFileNames = [
-  'commandkit.json',
-  'commandkit.config.json',
   'commandkit.js',
-  'commandkit.config.js',
   'commandkit.mjs',
-  'commandkit.config.mjs',
   'commandkit.cjs',
-  'commandkit.config.cjs',
   'commandkit.ts',
-  'commandkit.mts',
-  'commandkit.cts',
 ];
 
 export async function findCommandKitConfig(src: string) {
@@ -89,36 +55,71 @@ export async function findCommandKitConfig(src: string) {
   panic(`Could not locate commandkit config from ${cwd}`);
 }
 
-function ensureTypeScript(target: string) {
-  const isTypeScript = /\.(c|m)tsx?$/.test(target);
+async function ensureTypeScript(target: string) {
+  const isTypeScript = /\.(c|m)?tsx?$/.test(target);
 
-  if (isTypeScript && !process.features.typescript) {
-    panic(
-      'You are trying to load commandkit config file that is written in typescript. The current Node.js version does not have TypeScript feature enabled.',
-    );
+  if (!isTypeScript) return false;
+  if (process.features.typescript) return true;
+
+  if (!ts) {
+    try {
+      ts = await import('typescript');
+    } catch {
+      panic('TypeScript must be installed to use TypeScript config files.');
+    }
   }
+
+  return true;
 }
 
 async function loadConfigInner(target: string) {
-  const isJSON = target.endsWith('.json');
-
   await ensureExists(target);
 
-  ensureTypeScript(target);
+  const isTs = await ensureTypeScript(target);
+
+  if (isTs && ts) {
+    const { transpileModule } = ts;
+    const src = fs.readFileSync(target, 'utf8');
+    const { outputText } = transpileModule(src, {
+      compilerOptions: {
+        module: ts.ModuleKind.ESNext,
+        target: ts.ScriptTarget.ESNext,
+        moduleResolution: ts.ModuleResolutionKind.NodeNext,
+      },
+      fileName: target,
+    });
+
+    const nodeModulesPath = join(
+      process.cwd(),
+      'node_modules',
+      '.commandkit_tmp',
+    );
+
+    fs.mkdirSync(nodeModulesPath, { recursive: true });
+
+    const tmpFile = join(nodeModulesPath, 'compiled-commandkit.config.mjs');
+
+    fs.writeFileSync(tmpFile, outputText);
+
+    target = tmpFile;
+  }
 
   /**
    * @type {import('..').CommandKitConfig}
    */
-  // @ts-ignore
-  const config = await import(`file://${target}`, {
-    with: isJSON ? { type: 'json' } : undefined,
-  }).then((conf) => conf.default || conf);
+  const config = await import(`file://${target}`)
+    .then((conf) => conf.default || conf)
+    .catch(console.log);
 
   return config;
 }
 
 async function ensureExists(loc: string) {
-  await fs.promises.access(loc, fs.constants.F_OK);
+  const exists = fs.existsSync(loc);
+
+  if (!exists) {
+    throw new Error(`File not found: ${loc}`);
+  }
 }
 
 export function erase(dir: string) {