generator-discord 1.1.4 → 1.1.6

package/src/index.ts

@@ -1,147 +1,158 @@
-import Generator from 'yeoman-generator';
-import path from 'path';
-
-
-const TEMPLATE_DIR = '../templates/';
-const USER_DIR = '.';
-
-const OPEN = '<%= ';
-const CLOSE = ' %>';
-
-const BOT_NAME = 'bot-name';
-const BOT_TOKEN = 'bot-token';
-
-interface Answers {
-    botName: string;
-    botType: string;
-    botToken: string;
-    openWithCode: boolean;
-}
-
-
-export default class DiscordGenerator extends Generator {
-    private answers: Answers;
-
-    constructor(args: string | string[], options: Generator.GeneratorOptions) {
-        super(args, options);
-    }
-
-    async prompting(): Promise<void> {
-        this.logo();
-        this.answers = await this.prompt([
-            {
-                type: 'input',
-                name: 'botName',
-                message: 'Your Discord Bot name:',
-                default: 'my-bot',
-                validate: (input: string): boolean | string =>
-                new RegExp("^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$").test(input)
-                    ? true
-                    : 'Your Discord Bot name does not match the pattern of: ^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$',
-
-            },
-            {
-                type: 'list',
-                name: 'botType',
-                message: 'The type of Discord Bot you want to create.',
-                choices: [
-                    {
-                        name: 'New Discord Bot (TypeScript)',
-                        value: 'typescript'
-                    },
-                    {
-                        name: 'New Discord Bot (JavaScript)',
-                        value: 'javascript'
-                    }
-                    ,
-                    {
-                        name: 'New Discord Bot (Python)',
-                        value: 'python'
-                    }
-                ]
-            },
-            {
-                type: 'input',
-                name: 'botToken',
-                message: 'Your Discord Bot Token. (Enter to leave blank)',
-                default: 'your-bot-token'
-            }
-        ]);
-    }
-
-    logo(): void {
-        this.log("  \x1b[36m_____  _                       _   \x1b[31m_     ");
-        this.log(" \x1b[36m|  __ \\(_)                     | | \x1b[31m(_)    ");
-        this.log(" \x1b[36m| |  | |_ ___  ___ ___  _ __ __| |  \x1b[33m_ ___ ");
-        this.log(" \x1b[36m| |  | | / __|/ __/ _ \\| '__/ _` | \x1b[33m| / __|");
-        this.log(" \x1b[36m| |__| | \\__ \\ (_| (_) | | | (_| |\x1b[37m_\x1b[32m| \\__ \\");
-        this.log(" \x1b[36m|_____/|_|___/\\___\\___/|_|  \\__,_\x1b[37m(_) \x1b[32m|___/");
-        this.log("                                   \x1b[34m_/ |    ");
-        this.log("                                  \x1b[35m|__/     ");
-        this.log("\x1b[0m");
-    }
-
-    writing(): void {
-        this.sourceRoot(path.join(__dirname, TEMPLATE_DIR + this.answers.botType));
-        ['.'].forEach(
-            (path: string) => {
-                const replaceWords = (
-                    answers: Answers,
-                    content: Buffer
-                ): string =>
-                    [
-                        [BOT_NAME, this.answers.botName],
-                        [BOT_TOKEN, this.answers.botToken]
-                    ].reduce(
-                        (acc: string, [templateWord, userAnswer]) =>
-                            acc.replace(
-                                new RegExp(
-                                    `${OPEN}${templateWord}${CLOSE}`,
-                                    'g'
-                                ),
-                                userAnswer
-                            ),
-                        content.toString()
-                    );
-                this.fs.copy(
-                    this.templatePath(path),
-                    this.destinationPath(
-                        USER_DIR,
-                        this.answers.botName,
-                        path
-                    ),
-                    {
-                        process: (content: Buffer) =>
-                            replaceWords(this.answers, content)
-                    }
-                );
-            }
-        );
-    }
-    async install(): Promise<void> {
-        this.log('');
-        this.log('Your Discord Bot ' + this.answers.botName + ' has been created!');
-        const answer = await this.prompt({
-            type: 'list',
-            name: 'openWithCode',
-            message: 'Do you want to open your Discord Bot with Visual Studio Code?',
-            choices: [
-                {
-                    name: 'open with `code`',
-                    value: true
-                },
-                {
-                    name: 'skip',
-                    value: false
-                }
-            ]
-        });
-        this.log('');
-        if (answer && answer.openWithCode) {
-            this.spawnCommand('code', [this.destinationPath(
-                USER_DIR,
-                this.answers.botName
-            )]);
-        }
-    }
-}
+import Generator from 'yeoman-generator';
+import path from 'path';
+
+
+const TEMPLATE_DIR = '../templates/';
+const USER_DIR = '.';
+
+const OPEN = '<%= ';
+const CLOSE = ' %>';
+
+const BOT_NAME = 'bot-name';
+const BOT_TOKEN = 'bot-token';
+
+interface Answers {
+    botName: string;
+    botType: string;
+    botToken: string;
+    openWithCode: boolean;
+}
+
+
+export default class DiscordGenerator extends Generator {
+    private answers: Answers;
+
+    constructor(args: string | string[], options: Generator.GeneratorOptions) {
+        super(args, options);
+    }
+
+    async prompting(): Promise<void> {
+        this.logo();
+        this.answers = await this.prompt([
+            {
+                type: 'input',
+                name: 'botName',
+                message: 'Your Discord Bot name:',
+                default: 'my-bot',
+                validate: (input: string): boolean | string =>
+                    new RegExp("^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$").test(input)
+                        ? true
+                        : 'Invalid bot name. Please use only lowercase letters, numbers, and hyphens. Must start with a letter.'
+            },
+            {
+                type: 'list',
+                name: 'botType',
+                message: 'The type of Discord Bot you want to create.',
+                choices: [
+                    {
+                        name: 'New Discord Bot (TypeScript)',
+                        value: 'typescript'
+                    },
+                    {
+                        name: 'New Discord Bot (JavaScript)',
+                        value: 'javascript'
+                    }
+                    ,
+                    {
+                        name: 'New Discord Bot (Python)',
+                        value: 'python'
+                    }
+                ]
+            },
+            {
+                type: 'input',
+                name: 'botToken',
+                message: 'Your Discord Bot Token. (Enter to leave blank)',
+                default: 'your-bot-token'
+            }
+        ]);
+    }
+
+    logo(): void {
+        this.log("  \x1b[36m_____  _                       _   \x1b[31m_     ");
+        this.log(" \x1b[36m|  __ \\(_)                     | | \x1b[31m(_)    ");
+        this.log(" \x1b[36m| |  | |_ ___  ___ ___  _ __ __| |  \x1b[33m_ ___ ");
+        this.log(" \x1b[36m| |  | | / __|/ __/ _ \\| '__/ _` | \x1b[33m| / __|");
+        this.log(" \x1b[36m| |__| | \\__ \\ (_| (_) | | | (_| |\x1b[37m_\x1b[32m| \\__ \\");
+        this.log(" \x1b[36m|_____/|_|___/\\___\\___/|_|  \\__,_\x1b[37m(_) \x1b[32m|___/");
+        this.log("                                   \x1b[34m_/ |    ");
+        this.log("                                  \x1b[35m|__/     ");
+        this.log("\x1b[0m");
+    }
+
+    writing(): void {
+        this.sourceRoot(path.join(__dirname, TEMPLATE_DIR + this.answers.botType));
+        ['.'].forEach(
+            (path: string) => {
+                const replaceWords = (
+                    answers: Answers,
+                    content: Buffer
+                ): string =>
+                    [
+                        [BOT_NAME, this.answers.botName],
+                        [BOT_TOKEN, this.answers.botToken]
+                    ].reduce(
+                        (acc: string, [templateWord, userAnswer]) =>
+                            acc.replace(
+                                new RegExp(
+                                    `${OPEN}${templateWord}${CLOSE}`,
+                                    'g'
+                                ),
+                                userAnswer
+                            ),
+                        content.toString()
+                    );
+                this.fs.copy(
+                    this.templatePath(path),
+                    this.destinationPath(
+                        USER_DIR,
+                        this.answers.botName,
+                        path
+                    ),
+                    {
+                        process: (content: Buffer) =>
+                            replaceWords(this.answers, content)
+                    }
+                );
+            }
+        );
+    }
+    async install(): Promise<void> {
+        this.log('');
+        if (this.answers.botType === 'typescript' || this.answers.botType === 'javascript') {
+            const options = { cwd: this.destinationPath(USER_DIR, this.answers.botName) };
+            this.spawnCommandSync('npm', ['install'], options);
+            if(this.answers.botType === 'typescript') {
+                this.spawnCommandSync('npm', ['run', 'build'], options);
+            }
+        }
+
+        this.log('Your Discord Bot ' + this.answers.botName + ' has been created!');
+
+    }
+
+    async end(): Promise<void> {
+        const answer = await this.prompt({
+            type: 'list',
+            name: 'openWithCode',
+            message: 'Do you want to open your Discord Bot with Visual Studio Code?',
+            choices: [
+                {
+                    name: 'open with `code`',
+                    value: true
+                },
+                {
+                    name: 'skip',
+                    value: false
+                }
+            ]
+        });
+        this.log('');
+        if (answer && answer.openWithCode) {
+            this.spawnCommand('code', [this.destinationPath(
+                USER_DIR,
+                this.answers.botName
+            )]);
+        }
+    }
+}

package/templates/javascript/config.json

@@ -1,3 +1,3 @@
-{
-    "token":"<%= bot-token %>"
+{
+    "token":"<%= bot-token %>"
 }

package/templates/javascript/package.json

@@ -1,13 +1,13 @@
-{
-  "name": "<%= bot-name %>",
-  "displayName": "<%= bot-name %>",
-  "description": "Please enter a brief description here",
-  "version": "1.0.0",
-  "main": "./src/index.js",
-  "scripts": {
-    "start": "node ./src/index.js"
-  },
-  "dependencies": {
-    "discord.js": "^13.13.1"
-  }
-}
+{
+  "name": "<%= bot-name %>",
+  "displayName": "<%= bot-name %>",
+  "description": "Please enter a brief description here",
+  "version": "1.0.0",
+  "main": "./src/index.js",
+  "scripts": {
+    "start": "node ./src/index.js"
+  },
+  "dependencies": {
+    "discord.js": "^13.13.1"
+  }
+}

package/templates/javascript/src/index.js

@@ -1,26 +1,42 @@
-const { Client, Intents } = require('discord.js');
-const { token } = require('../config.json');
-
-// Create a new client instance with Intents that specify which privileged intents your bot requires
-const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
-
-
-// Run this code when the client is ready. This event will only trigger one time after logging in
-client.once('ready', () => {
-  console.log(`Bot is logged in as ${client.user.tag}.`);
-});
-
-// Listen for messages
-client.on('messageCreate', async message => {
-  const { content } = message;
-  // Reply with "Pong!" when someone says "!ping"
-  if (content === "!ping") {
-    return await message.reply("Pong!");
-  }
-});
-
-
-// Login to Discord with your app's token
-client.login(token);
-
-// For more information about the Discord.js library, visit https://discord.js.org/#/docs/main/stable/general/welcome
+const { Client, Intents } = require('discord.js');
+const { token } = require('../config.json');
+
+// Create a new client instance with Intents that specify which privileged intents your bot requires
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
+const prefix = '!';
+
+// Run this code when the client is ready. This event will only trigger one time after logging in
+client.once('ready', () => {
+  console.log(`Bot is logged in as ${client.user.tag}.`);
+});
+
+
+// Listen for messages
+client.on('messageCreate', async message => {
+  // Ignore messages that don't start with the prefix or are from a bot
+  if (!message.content.startsWith(prefix) || message.author.bot) return;
+
+  // Split the message into command and arguments
+  const args = message.content.slice(prefix.length).trim().split(/ +/);
+  const command = args.shift()?.toLowerCase();
+
+  // ping - bot will reply with Pong!
+  if (command === 'ping') {
+    await message.reply('Pong!');
+  }
+  // say <message> - bot will send the message
+  else if (command === 'say') {
+    if (!args.length) {
+      await message.channel.send(`You didn't provide any arguments, ${message.author}!`);
+      return;
+    }
+    await message.channel.send(args.join(' '));
+    return;
+  }
+});
+
+
+// Login to Discord with your app's token
+client.login(token);
+
+// For more information about the Discord.js library, visit https://discord.js.org/#/docs/main/stable/general/welcome∏

package/templates/python/bot.py

@@ -1,21 +1,21 @@
-import discord
-from discord.ext import commands
-
-# Define bot prefix and create bot instance
-bot_prefix = "!"
-bot = commands.Bot(command_prefix=bot_prefix)
-
-# Define bot events
-@bot.event
-async def on_ready():
-    print(f"Logged in as {bot.user.name} ({bot.user.id})")
-
-# Define bot commands
-@bot.command()
-async def ping(ctx):
-    await ctx.send("Pong!")
-
-# Run bot with bot token
-bot.run("<%= bot-token %>")
-
+import discord
+from discord.ext import commands
+
+# Define bot prefix and create bot instance
+bot_prefix = "!"
+bot = commands.Bot(command_prefix=bot_prefix)
+
+# Define bot events
+@bot.event
+async def on_ready():
+    print(f"Logged in as {bot.user.name} ({bot.user.id})")
+
+# Define bot commands
+@bot.command()
+async def ping(ctx):
+    await ctx.send("Pong!")
+
+# Run bot with bot token
+bot.run("<%= bot-token %>")
+
 # For more information on how to use discord.py, visit https://discordpy.readthedocs.io/en/latest/

package/templates/typescript/config.json

@@ -1,3 +1,3 @@
-{
-    "token":"<%= bot-token %>"
+{
+    "token":"<%= bot-token %>"
 }

package/templates/typescript/package.json

@@ -1,16 +1,16 @@
-{
-  "name": "<%= bot-name %>",
-  "displayName": "<%= bot-name %>",
-  "description": "Please enter a brief description here",
-  "version": "1.0.0",
-  "main": "./src/index.ts",
-  "scripts": {
-    "start": "tsc && node ./dist/src/index.js",
-    "watch": "tsc -w",
-    "build": "tsc"
-  },
-  "dependencies": {
-    "discord.js": "^13.13.1",
-    "typescript": "^4.9.5"
-  }
-}
+{
+  "name": "<%= bot-name %>",
+  "displayName": "<%= bot-name %>",
+  "description": "Please enter a brief description here",
+  "version": "1.0.0",
+  "main": "./src/index.ts",
+  "scripts": {
+    "start": "tsc && node ./dist/src/index.js",
+    "watch": "tsc -w",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "discord.js": "^13.13.1",
+    "typescript": "^4.9.5"
+  }
+}

package/templates/typescript/src/index.ts

@@ -1,27 +1,42 @@
-import { Client, Intents } from 'discord.js';
-import { token } from '../config.json';
-
-// Create a new client instance with Intents that specify which privileged intents your bot requires
-const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
-
-// Run this code when the client is ready. This event will only trigger one time after logging in
-client.once('ready', () => {
-    console.log(`Bot is logged in as ${client.user.tag}.`);
-});
-
-
-// Listen for messages
-client.on('messageCreate', async message => {
-    const { content } = message;
-    // Reply with "Pong!" when someone says "!ping"
-    if (content === "!ping") {
-        await message.reply("Pong!");
-        return;
-    }
-});
-
-
-// Login to Discord with your app's token
-client.login(token);
-
-// For more information about the Discord.js library, visit https://discord.js.org/#/docs/main/stable/general/welcome
+import { Client, Intents } from 'discord.js';
+import { token } from '../config.json';
+
+// Create a new client instance with Intents that specify which privileged intents your bot requires
+const client = new Client({ intents: [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES] });
+const prefix = '!';
+
+// Run this code when the client is ready. This event will only trigger one time after logging in
+client.once('ready', () => {
+    console.log(`Bot is logged in as ${client.user.tag}.`);
+});
+
+
+// Listen for messages
+client.on('messageCreate', async message => {
+    // Ignore messages that don't start with the prefix or are from a bot
+    if(!message.content.startsWith(prefix) || message.author.bot) return;
+
+    // Split the message into command and arguments
+    const args = message.content.slice(prefix.length).trim().split(/ +/);
+    const command = args.shift()?.toLowerCase();
+    
+    // ping - bot will reply with Pong!
+    if(command === 'ping') {
+       await message.reply('Pong!');
+    }
+    // say <message> - bot will send the message
+    else if(command === 'say') {
+        if(!args.length) {
+            await message.channel.send(`You didn't provide any arguments, ${message.author}!`);
+            return;
+        }
+        await message.channel.send(args.join(' '));
+        return;
+    }
+});
+
+
+// Login to Discord with your app's token
+client.login(token);
+
+// For more information about the Discord.js library, visit https://discord.js.org/#/docs/main/stable/general/welcome∏

package/templates/typescript/tsconfig.json

@@ -1,24 +1,24 @@
-{
-    "compilerOptions": {
-      "target": "ES6",
-      "module": "commonjs",
-      "lib": ["ESNext"],
-      "sourceMap": true,
-      "outDir": "dist",
-      "strict": false,
-      "noUnusedLocals": true,
-      "noImplicitReturns": true,
-      "moduleResolution": "node",
-      "esModuleInterop": true,
-      "skipLibCheck": true,
-      "resolveJsonModule": true,
-      "forceConsistentCasingInFileNames": true
-    },
-    "include": [
-       "src/**/*.ts",
-    ],
-    "exclude": [
-       "dist",
-       "node_modules"
-    ]
-  }
+{
+    "compilerOptions": {
+      "target": "ES6",
+      "module": "commonjs",
+      "lib": ["ESNext"],
+      "sourceMap": true,
+      "outDir": "dist",
+      "strict": false,
+      "noUnusedLocals": true,
+      "noImplicitReturns": true,
+      "moduleResolution": "node",
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "resolveJsonModule": true,
+      "forceConsistentCasingInFileNames": true
+    },
+    "include": [
+       "src/**/*.ts",
+    ],
+    "exclude": [
+       "dist",
+       "node_modules"
+    ]
+  }