generator-discord 1.1.0 → 1.1.1

package/README.md

@@ -10,6 +10,7 @@
 <div id="badges" align="center">
   
    [![Build](https://github.com/emilkrebs/generator-discord/actions/workflows/build.yml/badge.svg)](https://github.com/emilkrebs/generator-discord/actions/workflows/build.yml)
+      [![Tests](https://github.com/emilkrebs/generator-discord/actions/workflows/test.yml/badge.svg)](https://github.com/emilkrebs/generator-discord/actions/workflows/test.yml)
    [![downloads](https://img.shields.io/npm/dw/generator-discord?color=orange)](https://www.npmjs.com/package/generator-discord)
    [![version](https://img.shields.io/npm/v/generator-discord)](https://www.npmjs.com/package/generator-discord)	
   

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "generator-discord",
   "displayName": "Generator-Discord",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "main": "./app/index.js",
   "description": "Yeoman generator for Discord.js",
   "keywords": [
@@ -19,7 +19,8 @@
   "files": [
     "app",
     "templates",
-    "src"
+    "src",
+    "test"
   ],
   "types": "app/index.d.ts",
   "author": "Emil Krebs",

package/templates/javascript/package.json

@@ -8,6 +8,6 @@
     "start": "node ./src/index.js"
   },
   "dependencies": {
-    "discord.js": "^13.8.0"
+    "discord.js": "^13.13.1"
   }
 }

package/templates/typescript/package.json

@@ -10,7 +10,7 @@
     "build": "tsc"
   },
   "dependencies": {
-    "discord.js": "^13.8.0",
-    "typescript": "^4.7.2"
+    "discord.js": "^13.13.1",
+    "typescript": "^4.9.5"
   }
 }

package/test/generator.test.ts

@@ -0,0 +1,79 @@
+// write a unit test for the yeoman generator
+
+import { describe, test } from 'vitest';
+import path from 'path';
+import { createHelpers } from 'yeoman-test';
+import {EOL} from 'os'
+
+const typescriptAnswers = {
+    botName: 'typescript-bot',
+    botType: 'typescript',
+    botToken: 'xxx',
+}
+
+const pythonAnswers = {
+    botName: 'python-bot',
+    botType: 'python',
+    botToken: 'xxxx',
+}
+
+describe('Check if the generator works', () => {
+    test('Should generate typescript files', async () => {
+        const context = createHelpers({}).run(path.join(__dirname, '../app'));
+        context.targetDirectory = path.join(__dirname, '../test-temp'); // generate in test-temp
+        context.cleanTestDirectory(true); // clean-up test-temp
+        await context.onGenerator(generator => generator.destinationRoot(context.targetDirectory, false))
+            .withAnswers(typescriptAnswers)
+            .then((result) => {
+                result.assertFile([`${typescriptAnswers.botName}/package.json`]);
+                result.assertFile([`${typescriptAnswers.botName}/config.json`]);
+                result.assertFile([`${typescriptAnswers.botName}/src/index.ts`]);
+                result.assertFileContent(`${typescriptAnswers.botName}/config.json`, CONFIG_JSON_EXPECTED);
+            });
+        context.cleanup(); // clean-up
+    }, 120_000);
+    test('Should generate python files', async () => {
+        const context = createHelpers({}).run(path.join(__dirname, '../app'));
+        context.targetDirectory = path.join(__dirname, '../test-temp'); // generate in test-temp
+        context.cleanTestDirectory(true); // clean-up test-temp
+        await context.onGenerator(generator => generator.destinationRoot(context.targetDirectory, false))
+            .withAnswers(pythonAnswers)
+            .then((result) => {
+                result.assertFile([`${pythonAnswers.botName}/bot.py`]);
+                result.assertFileContent(`${pythonAnswers.botName}/bot.py`, BOT_PY_EXPECTED);
+            });
+        context.cleanup(); // clean-up
+    }, 120_000);
+});
+
+
+function normilizeEOL(str: string) {
+    return str.replace(/\r?\n/g, EOL);
+}
+
+// norminlize end of line
+const CONFIG_JSON_EXPECTED = normilizeEOL(`{
+    "token":"xxx"
+}`);
+
+const BOT_PY_EXPECTED = normilizeEOL(`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("xxxx")
+
+# For more information on how to use discord.py, visit https://discordpy.readthedocs.io/en/latest/`);