create-commandkit 1.0.1 → 1.1.0

package/README.md

@@ -3,7 +3,7 @@
     <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/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>
 </div>
 
@@ -13,12 +13,10 @@ A command-line interface (CLI) to quickly generate a discord.js bot using Comman
 
 ## Usage
 
-Run one of the following commands:
+Run the following command in your terminal:
 
 ```sh
-npm create commandkit
-pnpm create commandkit
-yarn create commandkit
+npm create commandkit@latest
 ```
 
 ## Setup Options
@@ -28,7 +26,8 @@ yarn create commandkit
 - Module type (ESM/CommonJS)
 - Bot token (written to .env)
 
-## Repositories
+## Links
 
-- [CommandKit](https://github.com/underctrl-io/commandkit)
-- [create-commandkit](https://github.com/m1-dev/create-commandkit)
+- [GitHub](https://github.com/m1-dev/create-commandkit)
+- [Discord](https://ctrl.lol/discord)
+- [npm](https://npmjs.com/package/create-commandkit)

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "create-commandkit",
     "description": "Start a new CommandKit project with ease.",
-    "version": "1.0.1",
+    "version": "1.1.0",
     "main": "src/index.js",
     "bin": "src/index.js",
     "type": "commonjs",
@@ -13,8 +13,8 @@
     ],
     "dependencies": {
         "@clack/prompts": "^0.7.0",
-        "gradient-string": "^2.0.2",
+        "colors": "^1.4.0",
         "fs-extra": "^11.1.1",
-        "colors": "^1.4.0"
+        "gradient-string": "^2.0.2"
     }
-}
+}

package/src/{config.js → constants.js}

@@ -1,4 +1,6 @@
 const gradient = require('gradient-string');
+const colors = require('colors');
+const fs = require('fs-extra');
 
 exports.templates = {
     js: {
@@ -35,4 +37,10 @@ exports.hints = {
     typescript: gradient(exports.colors.ts)('TypeScript')
 }
 
-exports.commandkit = gradient(exports.colors.commandkit)('CommandKit');
+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,4 +1,4 @@
-const { templates } = require('../config');
+const { templates } = require('../constants');
 const fs = require('fs-extra');
 
 module.exports = async ({ type, dir, lang }) => {

package/src/functions/installDeps.js

@@ -1,4 +1,4 @@
-const { commands } = require('../config');
+const { commands } = require('../constants');
 const { execSync: ex } = require('child_process');
 
 module.exports = async ({ manager, dir, stdio = 'pipe' }) => {

package/src/functions/setup.js

@@ -1,5 +1,5 @@
 const { execSync: ex } = require('child_process');
-const { commands } = require('../config');
+const { commands } = require('../constants');
 
 const fs = require('fs-extra');
 const path = require('path');

package/src/index.js

@@ -1,55 +1,60 @@
 #!/usr/bin/env node
 console.clear();
 
-const { gray } = require('colors');
-const { commandkit, hints } = require('./config');
+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 prompts = require('@clack/prompts');
 const path = require('path');
-
-const gradient = require('gradient-string');
+const fs = require('fs-extra');
 
 (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 });
+    const dir = path.resolve(process.cwd(), await prompts.text({
+        message: 'Enter a project directory:',
+        placeholder: 'Leave blank for current directory',
+        defaultValue: '.',
+        validate: (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' });
 
-    spinner.stop('Setup done.');
-
-    prompts.outro(gradient.summer('Happy coding!'));
+    console.log(outroMsg);
 })();

package/src/static/outroMessage.txt

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