create-commandkit 1.1.3 → 1.1.4-dev.20240202064011

package/README.md

@@ -1,33 +1,32 @@
 <div align="center">
-    <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.png" width="60%" />
+    <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg" width="60%" />
     <br />
     <a href="https://ctrl.lol/discord"><img src="https://img.shields.io/discord/1055188344188973066?color=5865F2&logo=discord&logoColor=white" alt="support server" /></a>
-    <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/v/commandkit?maxAge=3600&label=commandkit" alt="commandkit version" /></a>
-    <a href="https://www.npmjs.com/package/create-commandkit"><img src="https://img.shields.io/npm/v/create-commandkit?maxAge=3600&label=create-commandkit" alt="create-commandkit version" /></a>
-    <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a>
+    <a href="https://www.npmjs.com/package/create-commandkit"><img src="https://img.shields.io/npm/v/create-commandkit?maxAge=3600" alt="npm version" /></a>
+    <a href="https://www.npmjs.com/package/create-commandkit"><img src="https://img.shields.io/npm/dt/create-commandkit?maxAge=3600" alt="npm downloads" /></a>
 </div>
 
 # create-commandkit
 
-A command-line interface (CLI) to quickly generate a discord.js bot using CommandKit.
+create-commandkit is a CLI utility to quickly instantiate a Discord bot with CommandKit.
+
+## Features
+
+- Interactive, beautiful command-line interface 🖥️
+- Supports CommonJS and ES Modules 📦
+
+## Documentation
+
+You can find the full documentation [here](https://commandkit.js.org).
 
 ## Usage
 
 Run the following command in your terminal:
 
 ```sh
-npm create commandkit@latest
+npx create-commandkit@latest
 ```
 
-## Setup Options
-
-- Project directory
-- Package manager (npm/pnpm/yarn)
-- Module type (ESM/CommonJS)
-- Bot token (written to .env)
-
-## Links
+## Support and Suggestions
 
-- [GitHub](https://github.com/m1-dev/create-commandkit)
-- [Discord](https://ctrl.lol/discord)
-- [npm](https://npmjs.com/package/create-commandkit)
+Submit any queries or suggestions in our [Discord community](https://ctrl.lol/discord).

package/package.json

@@ -1,20 +1,50 @@
 {
-    "name": "create-commandkit",
-    "description": "Start a new CommandKit project with ease.",
-    "version": "1.1.3",
-    "main": "src/index.js",
-    "bin": "src/index.js",
-    "type": "commonjs",
-    "license": "MIT",
-    "keywords": [
-        "commandkit",
-        "discord.js",
-        "cli"
-    ],
-    "dependencies": {
-        "@clack/prompts": "^0.7.0",
-        "colors": "^1.4.0",
-        "fs-extra": "^11.1.1",
-        "gradient-string": "^2.0.2"
-    }
-}
+  "name": "create-commandkit",
+  "description": "Effortlessly create a CommandKit project",
+  "version": "1.1.4-dev.20240202064011",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "bin": "./dist/index.js",
+  "type": "module",
+  "license": "MIT",
+  "keywords": [
+    "commandkit",
+    "create-commandkit",
+    "discord.js",
+    "discord",
+    "node",
+    "client",
+    "cli",
+    "commands"
+  ],
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/underctrl-io/commandkit",
+    "directory": "packages/create-commandkit"
+  },
+  "homepage": "https://commandkit.js.org",
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "deploy": "npm publish"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.7.0",
+    "colors": "^1.4.0",
+    "fs-extra": "^11.1.1",
+    "gradient-string": "^2.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.6",
+    "@types/gradient-string": "^1.1.5",
+    "@types/fs-extra": "^11.0.4",
+    "typescript": "^5.3.3",
+    "tsconfig": "workspace:*",
+    "tsup": "^8.0.1"
+  }
+}

package/templates/JavaScript/cjs/README.md

@@ -0,0 +1,10 @@
+# Welcome to CommandKit
+
+> This project was generated by [create-commandkit](https://npmjs.com/package/create-commandkit).
+
+Thanks for choosing CommandKit to build your Discord bot!
+
+## Useful links
+
+-   [Documentation](https://commandkit.js.org)
+-   [Discord](https://ctrl.lol/discord)

package/templates/JavaScript/cjs/commandkit.cjs

@@ -0,0 +1,6 @@
+const { defineConfig } = require('commandkit');
+
+module.exports = defineConfig({
+  src: 'src',
+  main: 'index.mjs',
+});

package/templates/JavaScript/cjs/src/commands/General/ping.js

@@ -0,0 +1,19 @@
+module.exports = {
+  /** @type {import('commandkit').CommandData}  */
+  data: {
+    name: 'ping',
+    description: 'Replies with Pong',
+  },
+
+  /**
+   * @param {import('commandkit').SlashCommandProps} param0
+   */
+  run: ({ interaction }) => {
+    interaction.reply('Pong!');
+  },
+
+  /** @type {import('commandkit').CommandOptions} */
+  options: {
+    // https://commandkit.js.org/typedef/CommandOptions
+  },
+};

package/{src/templates → templates}/JavaScript/cjs/src/events/ready/ready.js

@@ -1,4 +1,4 @@
 /** * @param {import('discord.js').Client} client */
 module.exports = (client) => {
-    console.log(`${client.user.tag} is online!`);
-}
+  console.log(`${client.user.tag} is online!`);
+};

package/templates/JavaScript/cjs/src/index.js

@@ -0,0 +1,22 @@
+require('dotenv/config');
+
+const { Client, IntentsBitField } = require('discord.js');
+const { CommandKit } = require('commandkit');
+const { join } = require('path');
+
+const client = new Client({
+  intents: [
+    IntentsBitField.Flags.Guilds,
+    IntentsBitField.Flags.GuildMembers,
+    IntentsBitField.Flags.GuildMessages,
+    IntentsBitField.Flags.MessageContent,
+  ],
+});
+
+new CommandKit({
+  client,
+  eventsPath: join(__dirname, 'events'),
+  commandsPath: join(__dirname, 'commands'),
+});
+
+client.login(process.env.TOKEN);

package/templates/JavaScript/esm/README.md

@@ -0,0 +1,10 @@
+# Welcome to CommandKit
+
+> This project was generated by [create-commandkit](https://npmjs.com/package/create-commandkit).
+
+Thanks for choosing CommandKit to build your Discord bot!
+
+## Useful links
+
+-   [Documentation](https://commandkit.js.org)
+-   [Discord](https://ctrl.lol/discord)

package/templates/JavaScript/esm/commandkit.mjs

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

package/templates/JavaScript/esm/src/commands/General/ping.js

@@ -0,0 +1,17 @@
+/** @type {import('commandkit').CommandData}  */
+export const data = {
+  name: 'ping',
+  description: 'Replies with Pong',
+};
+
+/**
+ * @param {import('commandkit').SlashCommandProps} param0
+ */
+export const run = ({ interaction }) => {
+  interaction.reply('Pong!');
+};
+
+/** @type {import('commandkit').CommandOptions} */
+export const options = {
+  // https://commandkit.js.org/typedef/CommandOptions
+};

package/{src/templates → templates}/JavaScript/esm/src/events/ready/ready.js

@@ -1,4 +1,4 @@
 /** * @param {import('discord.js').Client} client */
 export default (client) => {
-    console.log(`${client.user.tag} is online!`);
-}
+  console.log(`${client.user.tag} is online!`);
+};

package/templates/JavaScript/esm/src/index.js

@@ -0,0 +1,26 @@
+import 'dotenv/config';
+
+import { Client, IntentsBitField } from 'discord.js';
+import { CommandKit } from 'commandkit';
+
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const client = new Client({
+  intents: [
+    IntentsBitField.Flags.Guilds,
+    IntentsBitField.Flags.GuildMembers,
+    IntentsBitField.Flags.GuildMessages,
+    IntentsBitField.Flags.MessageContent,
+  ],
+});
+
+new CommandKit({
+  client,
+  eventsPath: join(__dirname, 'events'),
+  commandsPath: join(__dirname, 'commands'),
+});
+
+client.login(process.env.TOKEN);

package/src/constants.js

@@ -1,46 +0,0 @@
-const gradient = require('gradient-string');
-const colors = require('colors');
-const fs = require('fs-extra');
-
-exports.templates = {
-    js: {
-        esm: `${__dirname}/templates/JavaScript/esm`,
-        cjs: `${__dirname}/templates/JavaScript/cjs`,
-    }
-}
-
-exports.colors = {
-    commandkit: ['#fdba74', '#e4a5a2', '#c288de', '#b27bf9'],
-    import: ['#c586c0', '#c586c0'],
-    export: ['#569cd6', '#569cd6'],
-    require: ['#dcdcaa', '#dcdcaa'],
-    module: ['#4ec9b0', '#4ec9b0'],
-    js: ['#f7e01c', '#f7e01c'],
-    ts: ['#2480c5', '#2480c5']
-}
-
-exports.commands = {
-    init: { npm: 'npm init -y', yarn: 'yarn init -y', pnpm: 'pnpm init' },
-    install: {
-        npm: 'npm install commandkit discord.js dotenv nodemon',
-        yarn: 'yarn add commandkit discord.js dotenv nodemon',
-        pnpm: 'pnpm add commandkit discord.js dotenv nodemon',
-    }
-}
-
-exports.hints = {
-    import: gradient(exports.colors.import)('import'),
-    export: gradient(exports.colors.export)('export'),
-    require: gradient(exports.colors.require)('require'),
-    module: gradient(exports.colors.module)('exports'),
-    javascript: gradient(exports.colors.js)('JavaScript'),
-    typescript: gradient(exports.colors.ts)('TypeScript')
-}
-
-exports.commandkit = gradient(exports.colors.commandkit)('CommandKit');
-exports.outroMsg = `
-${gradient(exports.colors.commandkit)('Thank you for choosing CommandKit!')}
-
-• Documentation: ${colors.blue('https://commandkit.js.org')}
-• Join us on Discord: ${colors.blue('https://ctrl.lol/discord')}
-`;

package/src/functions/copyTemplates.js

@@ -1,6 +0,0 @@
-const { templates } = require('../constants');
-const fs = require('fs-extra');
-
-module.exports = async ({ type, dir, lang }) => {
-    await fs.copy(templates[lang][type], dir);
-}

package/src/functions/installDeps.js

@@ -1,6 +0,0 @@
-const { commands } = require('../constants');
-const { execSync: ex } = require('child_process');
-
-module.exports = async ({ manager, dir, stdio = 'pipe' }) => {
-    ex(commands.install[manager], { cwd: dir, stdio });
-}

package/src/functions/setup.js

@@ -1,33 +0,0 @@
-const { execSync: ex } = require('child_process');
-const { commands } = require('../constants');
-
-const fs = require('fs-extra');
-const path = require('path');
-
-module.exports = async ({ manager, dir, token, type, stdio = 'pipe' }) => {
-    await fs.emptyDir(dir);
-    ex(commands.init[manager], { cwd: dir, stdio });
-
-    const packageJsonPath = path.join(dir, 'package.json');
-    const packageJson = await fs.readJSON(packageJsonPath);
-
-    const nameCleansed = packageJson.name.replace(
-        /^(?:(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)?\/[a-z0-9-._~])|[a-z0-9-~])[a-z0-9-._~]*$/, ''
-    );
-
-    packageJson.name = nameCleansed.length > 0 ? nameCleansed.replace(' ', '') : 'commandkit-app';
-
-    packageJson.name = packageJson.name.toLowerCase();
-    packageJson.type = type == 'esm' ? 'module' : 'commonjs';
-
-    packageJson.main = './src/index.js';
-    packageJson.version = '0.0.0';
-
-    packageJson.scripts = {
-        start: 'node ./src/index.js',
-        dev: 'nodemon --ext js,json,ts ./src/index.js'
-    };
-
-    await fs.writeJSON(packageJsonPath, packageJson, { spaces: 4 });
-    await fs.writeFile(`${dir}/.env`, `TOKEN = ${token}`);
-}

package/src/index.js

@@ -1,61 +0,0 @@
-#!/usr/bin/env node
-console.clear();
-
-const prompts = require('@clack/prompts');
-
-const { gray, cyan } = require('colors');
-const { commandkit, hints, outroMsg } = require('./constants');
-
-const setup = require('./functions/setup');
-const installDeps = require('./functions/installDeps');
-const copyTemplates = require('./functions/copyTemplates');
-
-const path = require('path');
-const fs = require('fs-extra');
-
-(async () => {
-    prompts.intro(`Welcome to ${commandkit}!`);
-
-    const dir = path.resolve(process.cwd(), await prompts.text({
-        message: 'Enter a project directory:',
-        placeholder: 'Leave blank for current directory',
-        defaultValue: '.',
-        validate: (value) => {
-            value = path.resolve(process.cwd(), value);
-            let isEmpty;
-
-            try {
-                const contents = fs.readdirSync(value);
-                isEmpty = contents.length === 0;
-            } catch { isEmpty = true }
-
-            return isEmpty ? undefined : 'Directory is not empty!';
-        }
-    }));
-
-    const manager = await prompts.select({
-        message: 'Select a package manager:',
-        options: [{ value: 'npm' }, { value: 'pnpm' }, { value: 'yarn' }],
-    });
-
-    const type = await prompts.select({
-        message: 'Select a module type:',
-        options: [
-            { label: 'CommonJS', value: 'cjs', hint: `${hints.require} & ${hints.module}` },
-            { label: 'ES Modules', value: 'esm', hint: `${hints.import} & ${hints.export}` },
-        ]
-    });
-
-    const token = await prompts.password({
-        message: 'Enter your bot token:',
-        mask: gray('*')
-    });
-
-    prompts.outro(cyan('Setup complete.'));
-
-    await setup({ manager, dir, token, type });
-    await copyTemplates({ type, dir, lang: 'js' });
-    await installDeps({ manager, dir, stdio: 'inherit' });
-
-    console.log(outroMsg);
-})();

package/src/static/outroMessage.txt

@@ -1,5 +0,0 @@
-Thank you for using CommandKit!
-
-Helpful resources:
-• Documentation — https://commandkit.js.org
-• Join us on Discord — https://ctrl.lol/discord

package/src/templates/JavaScript/cjs/src/commands/General/ping.js

@@ -1,19 +0,0 @@
-module.exports = {
-    /** @type {import('commandkit').CommandData}  */
-    data: {
-        name: 'ping',
-        description: 'Replies with Pong'
-    },
-
-    /**
-     * @param {import('commandkit').SlashCommandProps} param0 
-     */
-    run: ({ interaction }) => {
-        interaction.reply('Pong!');
-    },
-
-    /** @type {import('commandkit').CommandOptions} */
-    options: {
-        // https://commandkit.js.org/typedef/CommandOptions
-    }
-}

package/src/templates/JavaScript/cjs/src/index.js

@@ -1,21 +0,0 @@
-require('dotenv/config');
-
-const { Client, IntentsBitField } = require('discord.js');
-const { CommandKit } = require('commandkit');
-
-const client = new Client({
-    intents: [
-        IntentsBitField.Flags.Guilds,
-        IntentsBitField.Flags.GuildMembers,
-        IntentsBitField.Flags.GuildMessages,
-        IntentsBitField.Flags.MessageContent
-    ]
-});
-
-new CommandKit({
-    client,
-    eventsPath: `${__dirname}/events`,
-    commandsPath: `${__dirname}/commands`
-});
-
-client.login(process.env.TOKEN);

package/src/templates/JavaScript/cjs/welcome.md

@@ -1,8 +0,0 @@
-# Welcome to CommandKit
-
-Thanks for choosing CommandKit to build your Discord bot!
-
-## Useful links
-
-- [Documentation](https://commandkit.js.org)
-- [Discord](https://ctrl.lol/discord)

package/src/templates/JavaScript/esm/src/commands/General/ping.js

@@ -1,17 +0,0 @@
-/** @type {import('commandkit').CommandData}  */
-export const data = {
-    name: 'ping',
-    description: 'Replies with Pong'
-}
-
-/**
- * @param {import('commandkit').SlashCommandProps} param0 
- */
-export const run = ({ interaction }) => {
-    interaction.reply('Pong!');
-}
-
-/** @type {import('commandkit').CommandOptions} */
-export const options = {
-    // https://commandkit.js.org/typedef/CommandOptions
-}

package/src/templates/JavaScript/esm/src/index.js

@@ -1,26 +0,0 @@
-import 'dotenv/config';
-
-import { Client, IntentsBitField } from 'discord.js';
-import { CommandKit } from 'commandkit';
-
-import { dirname as dn } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const dirname = dn(fileURLToPath(import.meta.url));
-
-const client = new Client({
-    intents: [
-        IntentsBitField.Flags.Guilds,
-        IntentsBitField.Flags.GuildMembers,
-        IntentsBitField.Flags.GuildMessages,
-        IntentsBitField.Flags.MessageContent
-    ]
-});
-
-new CommandKit({
-    client,
-    eventsPath: `${dirname}/events`,
-    commandsPath: `${dirname}/commands`
-});
-
-client.login(process.env.TOKEN);

package/src/templates/JavaScript/esm/welcome.md

@@ -1,8 +0,0 @@
-# Welcome to CommandKit
-
-Thanks for choosing CommandKit to build your Discord bot!
-
-## Useful links
-
-- [Documentation](https://commandkit.js.org)
-- [Discord](https://ctrl.lol/discord)