commandkit 0.1.10 → 0.1.11-dev.20240202064607

package/bin/index.cjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+require('source-map-support').install();
+import('commandkit/cli');

package/package.json

@@ -1,58 +1,69 @@
 {
-    "name": "commandkit",
-    "description": "Beginner friendly command & event handler for Discord.js",
-    "version": "0.1.10",
-    "license": "MIT",
-    "main": "./dist/index.js",
-    "module": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
-    "bin": "./bin/index.mjs",
-    "exports": {
-        ".": {
-            "require": "./dist/index.js",
-            "import": "./dist/index.mjs",
-            "types": "./dist/index.d.ts"
-        }
+  "name": "commandkit",
+  "description": "Beginner friendly command & event handler for Discord.js",
+  "version": "0.1.11-dev.20240202064607",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "bin": "./bin/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
     },
-    "files": [
-        "dist",
-        "bin"
-    ],
-    "scripts": {
-        "lint": "tsc",
-        "dev": "tsup --watch",
-        "build": "tsup",
-        "deploy": "npm publish",
-        "deploy-dev": "npm publish --access public --tag dev",
-        "test": "cd ./tests && node ../bin/index.mjs dev",
-        "test:build": "cd ./tests && node ../bin/index.mjs build",
-        "test:prod": "cd ./tests && node ../bin/index.mjs start"
-    },
-    "repository": {
-        "url": "git+https://github.com/underctrl-io/commandkit.git"
-    },
-    "homepage": "https://commandkit.js.org",
-    "keywords": [
-        "discord.js",
-        "command handler",
-        "event handler"
-    ],
-    "dependencies": {
-        "commander": "^11.1.0",
-        "dotenv": "^16.3.1",
-        "ora": "^7.0.1",
-        "rfdc": "^1.3.0",
-        "rimraf": "^5.0.5",
-        "tsup": "^7.2.0"
-    },
-    "devDependencies": {
-        "@types/node": "^20.5.9",
-        "discord.js": "^14.13.0",
-        "tsconfig": "workspace:*",
-        "tsx": "^3.12.8",
-        "typescript": "^5.1.6"
-    },
-    "peerDependencies": {
-        "discord.js": "^14"
+    "./cli": {
+      "require": "./dist/environment/cli.js",
+      "import": "./dist/environment/cli.mjs",
+      "types": "./dist/environment/cli.d.ts"
     }
-}
+  },
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "deploy": "npm publish",
+    "test": "vitest",
+    "test:dev": "cd ./tests && node ../bin/index.mjs dev",
+    "test:build": "cd ./tests && node ../bin/index.mjs build",
+    "test:prod": "cd ./tests && node ../bin/index.mjs start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/underctrl-io/commandkit",
+    "directory": "packages/commandkit"
+  },
+  "homepage": "https://commandkit.js.org",
+  "keywords": [
+    "discord.js",
+    "command handler",
+    "event handler"
+  ],
+  "dependencies": {
+    "dotenv-cra": "^3.0.3",
+    "ora": "^8.0.1",
+    "rfdc": "^1.3.1",
+    "rimraf": "^5.0.5",
+    "source-map-support": "^0.5.21",
+    "tsup": "^8.0.1",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.6",
+    "@types/yargs": "^17.0.32",
+    "discord.js": "^14.14.1",
+    "esbuild-plugin-version-injector": "^1.2.1",
+    "tsconfig": "workspace:*",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.3",
+    "vitest": "^1.2.1"
+  },
+  "peerDependencies": {
+    "discord.js": "^14"
+  }
+}

package/bin/build.mjs

@@ -1,107 +0,0 @@
-// @ts-check
-
-import { readFile, writeFile } from 'node:fs/promises';
-import { join } from 'node:path';
-import { build } from 'tsup';
-import { Colors, erase, findCommandKitConfig, panic, write } from './common.mjs';
-import ora from 'ora';
-
-export async function bootstrapProductionBuild(config) {
-    const {
-        sourcemap = false,
-        minify = false,
-        outDir = 'dist',
-        antiCrash = true,
-        src,
-        main,
-        requirePolyfill: polyfillRequire,
-    } = await findCommandKitConfig(config);
-
-    const status = ora('Creating optimized production build...\n').start();
-    const start = performance.now();
-
-    erase(outDir);
-
-    try {
-        await build({
-            clean: true,
-            format: ['esm'],
-            dts: false,
-            skipNodeModulesBundle: true,
-            minify,
-            shims: true,
-            banner: {
-                js: '/* Optimized production build generated by CommandKit */',
-            },
-            sourcemap,
-            keepNames: true,
-            outDir,
-            silent: true,
-            watch: false,
-            entry: [src, '!dist', '!.commandkit', `!${outDir}`],
-        });
-
-        await injectShims(outDir, main, antiCrash, polyfillRequire);
-
-        status.succeed(
-            Colors.green(`Build completed in ${(performance.now() - start).toFixed(2)}ms!`),
-        );
-        write(
-            Colors.green(
-                `\nRun ${Colors.magenta(`commandkit start`)} ${Colors.green('to start your bot.')}`,
-            ),
-        );
-    } catch (e) {
-        status.fail(`Build failed after ${(performance.now() - start).toFixed(2)}ms!`);
-        panic(e);
-    }
-}
-
-export async function injectShims(outDir, main, antiCrash, polyfillRequire) {
-    const path = join(process.cwd(), outDir, main);
-
-    const head = ['\n\n;await (async()=>{', "  'use strict';"].join('\n');
-    const tail = '\n})();';
-    const requireScript = polyfillRequire
-        ? [
-              '// --- CommandKit require() polyfill ---',
-              '  if (typeof require === "undefined") {',
-              '    const { createRequire } = await import("node:module");',
-              '    const __require = createRequire(import.meta.url);',
-              '    Object.defineProperty(globalThis, "require", {',
-              '      value: (id) => {',
-              '        return __require(id);',
-              '      },',
-              '      configurable: true,',
-              '      enumerable: false,',
-              '      writable: true,',
-              '    });',
-              '  }',
-              '// --- CommandKit require() polyfill ---',
-          ].join('\n')
-        : '';
-
-    const antiCrashScript = antiCrash
-        ? [
-              '// --- CommandKit Anti-Crash Monitor ---',
-              "  // 'uncaughtException' event is supposed to be used to perform synchronous cleanup before shutting down the process",
-              '  // instead of using it as a means to resume operation.',
-              '  // But it exists here due to compatibility reasons with discord bot ecosystem.',
-              "  const p = (t) => `\\x1b[33m${t}\\x1b[0m`, b = '[CommandKit Anti-Crash Monitor]', l = console.log, e1 = 'uncaughtException', e2 = 'unhandledRejection';",
-              '  if (!process.eventNames().includes(e1)) // skip if it is already handled',
-              '    process.on(e1, (e) => {',
-              '      l(p(`${b} Uncaught Exception`)); l(p(b), p(e.stack || e));',
-              '    })',
-              '  if (!process.eventNames().includes(e2)) // skip if it is already handled',
-              '    process.on(e2, (r) => {',
-              '      l(p(`${b} Unhandled promise rejection`)); l(p(`${b} ${r.stack || r}`));',
-              '    });',
-              '// --- CommandKit Anti-Crash Monitor ---',
-          ].join('\n')
-        : '';
-
-    const contents = await readFile(path, 'utf-8');
-    const finalScript = [head, requireScript, antiCrashScript, tail, '\n\n', contents].join('\n');
-
-    return writeFile(path, finalScript);
-}

package/bin/common.mjs

@@ -1,102 +0,0 @@
-// @ts-check
-
-import { rimrafSync } from 'rimraf';
-import { join } from 'node:path';
-import fs from 'node:fs';
-
-const resetColor = '\x1b[0m';
-
-export const Colors = {
-    reset: (text) => `${text}${resetColor}`,
-    bright: (text) => `\x1b[1m${text}${resetColor}`,
-    dim: (text) => `\x1b[2m${text}${resetColor}`,
-    underscore: (text) => `\x1b[4m${text}${resetColor}`,
-    blink: (text) => `\x1b[5m${text}${resetColor}`,
-    reverse: (text) => `\x1b[7m${text}${resetColor}`,
-    hidden: (text) => `\x1b[8m${text}${resetColor}`,
-
-    black: (text) => `\x1b[30m${text}${resetColor}`,
-    red: (text) => `\x1b[31m${text}${resetColor}`,
-    green: (text) => `\x1b[32m${text}${resetColor}`,
-    yellow: (text) => `\x1b[33m${text}${resetColor}`,
-    blue: (text) => `\x1b[34m${text}${resetColor}`,
-    magenta: (text) => `\x1b[35m${text}${resetColor}`,
-    cyan: (text) => `\x1b[36m${text}${resetColor}`,
-    white: (text) => `\x1b[37m${text}${resetColor}`,
-
-    bgBlack: (text) => `\x1b[40m${text}${resetColor}`,
-    bgRed: (text) => `\x1b[41m${text}${resetColor}`,
-    bgGreen: (text) => `\x1b[42m${text}${resetColor}`,
-    bgYellow: (text) => `\x1b[43m${text}${resetColor}`,
-    bgBlue: (text) => `\x1b[44m${text}${resetColor}`,
-    bgMagenta: (text) => `\x1b[45m${text}${resetColor}`,
-    bgCyan: (text) => `\x1b[46m${text}${resetColor}`,
-    bgWhite: (text) => `\x1b[47m${text}${resetColor}`,
-};
-
-export function write(message) {
-    process.stdout.write(message);
-    process.stdout.write('\n');
-}
-
-/**
- * @returns {never}
- */
-export function panic(message) {
-    write(Colors.red(`Error: ${message}`));
-    process.exit(1);
-}
-
-export function findPackageJSON() {
-    const cwd = process.cwd();
-    const target = join(cwd, 'package.json');
-
-    if (!fs.existsSync(target)) {
-        panic('Could not find package.json in current directory.');
-    }
-
-    return JSON.parse(fs.readFileSync(target, 'utf8'));
-}
-
-const possibleFileNames = [
-    'commandkit.json',
-    'commandkit.config.json',
-    'commandkit.js',
-    'commandkit.config.js',
-    'commandkit.mjs',
-    'commandkit.config.mjs',
-    'commandkit.cjs',
-    'commandkit.config.cjs',
-];
-
-export async function findCommandKitConfig(src) {
-    const cwd = process.cwd();
-    const locations = src ? [join(cwd, src)] : possibleFileNames.map((name) => join(cwd, name));
-
-    for (const location of locations) {
-        try {
-            return await loadConfigInner(location);
-        } catch (e) {
-            continue;
-        }
-    }
-
-    panic('Could not locate commandkit config.');
-}
-
-async function loadConfigInner(target) {
-    const isJSON = target.endsWith('.json');
-
-    /**
-     * @type {import('..').CommandKitConfig}
-     */
-    const config = await import(`file://${target}`, {
-        assert: isJSON ? { type: 'json' } : undefined,
-    }).then((conf) => conf.default || conf);
-
-    return config;
-}
-
-export function erase(dir) {
-    rimrafSync(dir);
-}

package/bin/development.mjs

@@ -1,168 +0,0 @@
-// @ts-check
-import { config as dotenv } from 'dotenv';
-import { join } from 'node:path';
-import { build } from 'tsup';
-import { Colors, erase, findCommandKitConfig, panic, write } from './common.mjs';
-import { parseEnv } from './parse-env.mjs';
-import child_process from 'node:child_process';
-import ora from 'ora';
-import { injectShims } from './build.mjs';
-
-const RESTARTING_MSG_PATTERN = /^Restarting '|".+'|"\n?$/;
-const FAILED_RUNNING_PATTERN = /^Failed running '.+'|"\n?$/;
-
-export async function bootstrapDevelopmentServer(opts) {
-    const {
-        src,
-        main,
-        watch = Boolean(opts.noWatch),
-        nodeOptions = [],
-        envExtra = true,
-        clearRestartLogs = true,
-        outDir,
-        requirePolyfill,
-    } = await findCommandKitConfig(opts.config);
-
-    if (!src) {
-        panic('Could not find src in commandkit.json');
-    }
-
-    if (!main) {
-        panic('Could not find main in commandkit.json');
-    }
-
-    const watchMode = watch;
-    const status = ora(Colors.green('Starting a development server...\n')).start();
-    const start = performance.now();
-
-    if (watchMode && !nodeOptions.includes('--watch')) {
-        nodeOptions.push('--watch');
-    } else if (!watchMode && nodeOptions.includes('--watch')) {
-        nodeOptions.splice(nodeOptions.indexOf('--watch'), 1);
-    }
-
-    if (!nodeOptions.includes('--enable-source-maps')) {
-        nodeOptions.push('--enable-source-maps');
-    }
-
-    erase('.commandkit');
-
-    try {
-        await build({
-            clean: true,
-            format: ['esm'],
-            dts: false,
-            skipNodeModulesBundle: true,
-            minify: false,
-            shims: true,
-            sourcemap: 'inline',
-            keepNames: true,
-            outDir: '.commandkit',
-            silent: true,
-            entry: [src, '!dist', '!.commandkit', `!${outDir}`].filter(Boolean),
-            watch: watchMode,
-            async onSuccess() {
-                return await injectShims('.commandkit', main, false, requirePolyfill);
-            },
-        });
-
-        status.succeed(
-            Colors.green(`Dev server started in ${(performance.now() - start).toFixed(2)}ms!\n`),
-        );
-
-        if (watchMode) write(Colors.cyan('Watching for file changes...\n'));
-
-        const processEnv = {};
-
-        const env = dotenv({
-            path: join(process.cwd(), '.env'),
-            // @ts-expect-error
-            processEnv,
-        });
-
-        if (envExtra) {
-            parseEnv(processEnv);
-        }
-
-        if (env.error) {
-            write(Colors.yellow(`[DOTENV] Warning: ${env.error.message}`));
-        }
-
-        if (env.parsed) {
-            write(Colors.blue('[DOTENV] Loaded .env file!'));
-        }
-
-        /**
-         * @type {child_process.ChildProcessWithoutNullStreams}
-         */
-        const ps = child_process.spawn(
-            'node',
-            [...nodeOptions, join(process.cwd(), '.commandkit', main)],
-            {
-                env: {
-                    ...process.env,
-                    ...processEnv,
-                    NODE_ENV: 'development',
-                    // @ts-expect-error
-                    COMMANDKIT_DEV: true,
-                    // @ts-expect-error
-                    COMMANDKIT_PRODUCTION: false,
-                },
-                cwd: process.cwd(),
-            },
-        );
-
-        let isLastLogRestarting = false,
-            hasStarted = false;
-
-        ps.stdout.on('data', (data) => {
-            const message = data.toString();
-
-            if (FAILED_RUNNING_PATTERN.test(message)) {
-                write(Colors.cyan('Failed running the bot, waiting for changes...'));
-                isLastLogRestarting = false;
-                if (!hasStarted) hasStarted = true;
-                return;
-            }
-
-            if (clearRestartLogs && !RESTARTING_MSG_PATTERN.test(message)) {
-                write(message);
-                isLastLogRestarting = false;
-            } else {
-                if (isLastLogRestarting || !hasStarted) {
-                    if (!hasStarted) hasStarted = true;
-                    return;
-                }
-                write(Colors.cyan('⌀ Restarting the bot...'));
-                isLastLogRestarting = true;
-            }
-
-            if (!hasStarted) hasStarted = true;
-        });
-
-        ps.stderr.on('data', (data) => {
-            const message = data.toString();
-
-            if (
-                message.includes(
-                    'ExperimentalWarning: Watch mode is an experimental feature and might change at any time',
-                )
-            )
-                return;
-
-            write(Colors.red(message));
-        });
-
-        ps.on('close', (code) => {
-            write('\n');
-            process.exit(code ?? 0);
-        });
-
-        ps.on('error', (err) => {
-            panic(err);
-        });
-    } catch (e) {
-        status.fail(`Error occurred after ${(performance.now() - start).toFixed(2)}ms!\n`);
-        panic(e.stack ?? e);
-    }
-}

package/bin/index.mjs

@@ -1,39 +0,0 @@
-#!/usr/bin/env node
-
-// @ts-check
-
-import { Command } from 'commander';
-import { bootstrapDevelopmentServer } from './development.mjs';
-import { bootstrapProductionServer } from './production.mjs';
-import { bootstrapProductionBuild } from './build.mjs';
-
-const program = new Command('commandkit');
-
-program
-    .command('dev')
-    .description('Start your bot in development mode.')
-    .option('-c, --config <path>', 'Path to your commandkit config file.', './commandkit.js')
-    .action(() => {
-        const options = program.opts();
-        bootstrapDevelopmentServer(options);
-    });
-
-program
-    .command('start')
-    .description('Start your bot in production mode after running the build command.')
-    .option('-c, --config <path>', 'Path to your commandkit.json file.', './commandkit.js')
-    .action(() => {
-        const options = program.opts();
-        bootstrapProductionServer(options.config);
-    });
-
-program
-    .command('build')
-    .description('Build your project for production usage.')
-    .option('-c, --config <path>', 'Path to your commandkit.json file.', './commandkit.json')
-    .action(() => {
-        const options = program.opts();
-        bootstrapProductionBuild(options.config);
-    });
-
-program.parse();

package/bin/parse-env.mjs

@@ -1,61 +0,0 @@
-// @ts-check
-
-import { randomUUID } from 'node:crypto';
-
-const valuesMap = {
-    true: true,
-    false: false,
-    null: null,
-    undefined: undefined,
-    __UUIDv4__: () => randomUUID(),
-};
-
-const VALUE_PREFIXES = {
-    JSON: 'JSON::',
-    DATE: 'DATE::',
-};
-
-function catcher(fn) {
-    try {
-        fn();
-        return true;
-    } catch {
-        return false;
-    }
-}
-
-export function parseEnv(src) {
-    for (const key in src) {
-        const value = src[key];
-
-        if (typeof value !== 'string') continue;
-
-        if (value.startsWith(VALUE_PREFIXES.JSON)) {
-            catcher(() => (src[key] = JSON.parse(value.replace(VALUE_PREFIXES.JSON, ''))));
-            continue;
-        }
-
-        if (value.startsWith(VALUE_PREFIXES.DATE)) {
-            src[key] = new Date(value.replace(VALUE_PREFIXES.DATE, ''));
-            continue;
-        }
-
-        if (value.includes(',')) {
-            src[key] = value.split(',').map((v) => v.trim());
-            continue;
-        }
-
-        if (/^[0-9]+n$/.test(value)) {
-            src[key] = BigInt(value);
-            continue;
-        }
-
-        if (value in valuesMap) {
-            src[key] =
-                typeof valuesMap[value] === 'function' ? valuesMap[value]() : valuesMap[value];
-            continue;
-        }
-    }
-
-    return src;
-}

package/bin/production.mjs

@@ -1,83 +0,0 @@
-// @ts-check
-import { config as dotenv } from 'dotenv';
-import { existsSync } from 'node:fs';
-import { join } from 'node:path';
-import { Colors, findCommandKitConfig, panic, write } from './common.mjs';
-import { parseEnv } from './parse-env.mjs';
-import child_process from 'node:child_process';
-
-export async function bootstrapProductionServer(config) {
-    const {
-        main,
-        outDir = 'dist',
-        envExtra = true,
-        sourcemap,
-    } = await findCommandKitConfig(config);
-
-    if (!existsSync(join(process.cwd(), outDir, main))) {
-        panic('Could not find production build, maybe run `commandkit build` first?');
-    }
-
-    try {
-        const processEnv = {};
-
-        const env = dotenv({
-            path: join(process.cwd(), '.env'),
-            // @ts-expect-error
-            processEnv,
-        });
-
-        if (envExtra) {
-            parseEnv(processEnv);
-        }
-
-        if (env.error) {
-            write(Colors.yellow(`[DOTENV] Warning: ${env.error.message}`));
-        }
-
-        if (env.parsed) {
-            write(Colors.blue('[DOTENV] Loaded .env file!'));
-        }
-
-        /**
-         * @type {child_process.ChildProcessWithoutNullStreams}
-         */
-        const ps = child_process.spawn(
-            'node',
-            [sourcemap ? '--enable-source-maps' : '', join(process.cwd(), outDir, main)].filter(
-                Boolean,
-            ),
-            {
-                env: {
-                    ...process.env,
-                    ...processEnv,
-                    NODE_ENV: 'production',
-                    // @ts-expect-error
-                    COMMANDKIT_DEV: false,
-                    //  @ts-expect-error
-                    COMMANDKIT_PROD: true,
-                },
-                cwd: process.cwd(),
-            },
-        );
-
-        ps.stdout.on('data', (data) => {
-            write(data.toString());
-        });
-
-        ps.stderr.on('data', (data) => {
-            write(Colors.red(data.toString()));
-        });
-
-        ps.on('close', (code) => {
-            write('\n');
-            process.exit(code ?? 0);
-        });
-
-        ps.on('error', (err) => {
-            panic(err);
-        });
-    } catch (e) {
-        panic(e);
-    }
-}