create-commandkit 0.0.0 → 1.0.0

package/README.md

@@ -0,0 +1,34 @@
+<div align="center">
+    <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.png" 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/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>
+</div>
+
+# create-commandkit
+
+A command-line interface (CLI) to quickly generate a discord.js bot using CommandKit.
+
+## Usage
+
+Run one of the following commands:
+
+```sh
+npm create commandkit
+pnpm create commandkit
+yarn create commandkit
+```
+
+## Setup Options
+
+- Project directory
+- Package manager (npm/pnpm/yarn)
+- Module type (ESM/CommonJS)
+- Bot token (written to .env)
+
+## Repositories
+
+- [CommandKit](https://github.com/underctrl-io/commandkit)
+- [create-commandkit](https://github.com/m1-dev/create-commandkit)

package/package.json

@@ -1,12 +1,20 @@
 {
-  "name": "create-commandkit",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  }
+    "name": "create-commandkit",
+    "description": "Start a new CommandKit project with ease.",
+    "version": "1.0.0",
+    "main": "src/index.js",
+    "bin": "src/index.js",
+    "type": "commonjs",
+    "license": "MIT",
+    "keywords": [
+        "commandkit",
+        "discord.js",
+        "cli"
+    ],
+    "dependencies": {
+        "@clack/prompts": "^0.7.0",
+        "gradient-string": "^2.0.2",
+        "fs-extra": "^11.1.1",
+        "colors": "^1.4.0"
+    }
 }

package/src/config.js

@@ -0,0 +1,45 @@
+const gradient = require('gradient-string');
+
+
+// import #c586c0
+// export #569cd6
+
+// require #dcdcaa
+// module #4ec9b0
+
+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');

package/src/functions/copyTemplates.js

@@ -0,0 +1,8 @@
+const { templates } = require('../config');
+const { execSync: ex } = require('child_process');
+
+const fs = require('fs-extra');
+
+module.exports = async ({ type, dir, lang }) => {
+    await fs.copy(templates[lang][type], dir);
+}

package/src/functions/installDeps.js

@@ -0,0 +1,6 @@
+const { commands } = require('../config');
+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

@@ -0,0 +1,26 @@
+const { execSync: ex } = require('child_process');
+const { commands } = require('../config');
+
+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);
+
+    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

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+console.clear();
+
+const { gray } = require('colors');
+const { commandkit, hints } = require('./config');
+
+const setup = require('./functions/setup');
+const installDeps = require('./functions/installDeps');
+const copyTemplates = require('./functions/copyTemplates');
+
+const prompts = require('@clack/prompts');
+const path = require('path');
+
+const gradient = require('gradient-string');
+
+(async () => {
+    prompts.intro(`Welcome to ${commandkit}!`);
+
+    const { dir, manager, type, token } = {
+        dir: path.resolve(process.cwd(), await prompts.text({
+            message: 'Enter a project directory:',
+            placeholder: 'Leave blank for current directory',
+            defaultValue: '.',
+        })),
+
+        manager: await prompts.select({
+            message: 'Select a package manager:',
+            options: [{ value: 'npm' }, { value: 'pnpm' }, { value: 'yarn' }],
+        }),
+
+        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}` },
+            ]
+        }),
+
+        token: await prompts.password({
+            message: 'Enter your bot token:',
+            mask: gray('*')
+        })
+    }
+
+    const spinner = prompts.spinner();
+    spinner.start('Setting up project');
+
+    await setup({ manager, token, dir, type });
+    await installDeps({ manager, dir });
+    await copyTemplates({ type, dir, lang: 'js' });
+
+    spinner.stop('Setup done.');
+
+    prompts.outro(gradient.summer('Happy coding!'));
+})();

package/src/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/JavaScript/cjs/src/events/ready/ready.js

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

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

@@ -0,0 +1,21 @@
+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/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/JavaScript/esm/src/events/ready/ready.js

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

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

@@ -0,0 +1,26 @@
+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);