update deps, add scripts to template

The-Best-Codes · Jan 13, 2025 · 1be6053 · 1be6053
1 parent 900864b
commit 1be6053
Show file tree

Hide file tree

Showing 7 changed files with 139 additions and 20 deletions.
diff --git a/bun.lock b/bun.lock
@@ -172,25 +172,25 @@
 
     "@types/jsonfile": ["@types/[email protected]", "", { "dependencies": { "@types/node": "*" } }, "sha512-D5qGUYwjvnNNextdU59/+fI+spnwtTFmyQP0h+PfIOSkNfpU6AOICUOkm4i0OnSk+NyjdPJrxCDro0sJsWlRpQ=="],
 
-    "@types/node": ["@types/[email protected].5", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-F8Q+SeGimwOo86fiovQh8qiXfFEh2/ocYv7tU5pJ3EXMSSxk1Joj5wefpFK2fHTf/N6HKGSxIDBT9f3gCxXPkQ=="],
+    "@types/node": ["@types/[email protected].6", "", { "dependencies": { "undici-types": "~6.20.0" } }, "sha512-qNiuwC4ZDAUNcY47xgaSuS92cjf8JbSUoaKS77bmLG1rU7MlATVSiw/IlrjtIyyskXBZ8KkNfjK/P5na7rgXbQ=="],
 
     "@types/ws": ["@types/[email protected]", "", { "dependencies": { "@types/node": "*" } }, "sha512-osM/gWBTPKgHV8XkTunnegTRIsvF6owmf5w+JtAfOw472dptdm0dlGv4xCt6GwQRcC2XVOvvRE/0bAoQcL2QkA=="],
 
-    "@typescript-eslint/eslint-plugin": ["@typescript-eslint/eslint-plugin@8.19.1", "", { "dependencies": { "@eslint-community/regexpp": "^4.10.0", "@typescript-eslint/scope-manager": "8.19.1", "@typescript-eslint/type-utils": "8.19.1", "@typescript-eslint/utils": "8.19.1", "@typescript-eslint/visitor-keys": "8.19.1", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", "ts-api-utils": "^2.0.0" }, "peerDependencies": { "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-tJzcVyvvb9h/PB96g30MpxACd9IrunT7GF9wfA9/0TJ1LxGOJx1TdPzSbBBnNED7K9Ka8ybJsnEpiXPktolTLg=="],
+    "@typescript-eslint/eslint-plugin": ["@typescript-eslint/eslint-plugin@8.20.0", "", { "dependencies": { "@eslint-community/regexpp": "^4.10.0", "@typescript-eslint/scope-manager": "8.20.0", "@typescript-eslint/type-utils": "8.20.0", "@typescript-eslint/utils": "8.20.0", "@typescript-eslint/visitor-keys": "8.20.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", "ts-api-utils": "^2.0.0" }, "peerDependencies": { "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-naduuphVw5StFfqp4Gq4WhIBE2gN1GEmMUExpJYknZJdRnc+2gDzB8Z3+5+/Kv33hPQRDGzQO/0opHE72lZZ6A=="],
 
-    "@typescript-eslint/parser": ["@typescript-eslint/parser@8.19.1", "", { "dependencies": { "@typescript-eslint/scope-manager": "8.19.1", "@typescript-eslint/types": "8.19.1", "@typescript-eslint/typescript-estree": "8.19.1", "@typescript-eslint/visitor-keys": "8.19.1", "debug": "^4.3.4" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-67gbfv8rAwawjYx3fYArwldTQKoYfezNUT4D5ioWetr/xCrxXxvleo3uuiFuKfejipvq+og7mjz3b0G2bVyUCw=="],
+    "@typescript-eslint/parser": ["@typescript-eslint/parser@8.20.0", "", { "dependencies": { "@typescript-eslint/scope-manager": "8.20.0", "@typescript-eslint/types": "8.20.0", "@typescript-eslint/typescript-estree": "8.20.0", "@typescript-eslint/visitor-keys": "8.20.0", "debug": "^4.3.4" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-gKXG7A5HMyjDIedBi6bUrDcun8GIjnI8qOwVLiY3rx6T/sHP/19XLJOnIq/FgQvWLHja5JN/LSE7eklNBr612g=="],
 
-    "@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.19.1", "", { "dependencies": { "@typescript-eslint/types": "8.19.1", "@typescript-eslint/visitor-keys": "8.19.1" } }, "sha512-60L9KIuN/xgmsINzonOcMDSB8p82h95hoBfSBtXuO4jlR1R9L1xSkmVZKgCPVfavDlXihh4ARNjXhh1gGnLC7Q=="],
+    "@typescript-eslint/scope-manager": ["@typescript-eslint/scope-manager@8.20.0", "", { "dependencies": { "@typescript-eslint/types": "8.20.0", "@typescript-eslint/visitor-keys": "8.20.0" } }, "sha512-J7+VkpeGzhOt3FeG1+SzhiMj9NzGD/M6KoGn9f4dbz3YzK9hvbhVTmLj/HiTp9DazIzJ8B4XcM80LrR9Dm1rJw=="],
 
-    "@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@8.19.1", "", { "dependencies": { "@typescript-eslint/typescript-estree": "8.19.1", "@typescript-eslint/utils": "8.19.1", "debug": "^4.3.4", "ts-api-utils": "^2.0.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-Rp7k9lhDKBMRJB/nM9Ksp1zs4796wVNyihG9/TU9R6KCJDNkQbc2EOKjrBtLYh3396ZdpXLtr/MkaSEmNMtykw=="],
+    "@typescript-eslint/type-utils": ["@typescript-eslint/type-utils@8.20.0", "", { "dependencies": { "@typescript-eslint/typescript-estree": "8.20.0", "@typescript-eslint/utils": "8.20.0", "debug": "^4.3.4", "ts-api-utils": "^2.0.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-bPC+j71GGvA7rVNAHAtOjbVXbLN5PkwqMvy1cwGeaxUoRQXVuKCebRoLzm+IPW/NtFFpstn1ummSIasD5t60GA=="],
 
-    "@typescript-eslint/types": ["@typescript-eslint/types@8.19.1", "", {}, "sha512-JBVHMLj7B1K1v1051ZaMMgLW4Q/jre5qGK0Ew6UgXz1Rqh+/xPzV1aW581OM00X6iOfyr1be+QyW8LOUf19BbA=="],
+    "@typescript-eslint/types": ["@typescript-eslint/types@8.20.0", "", {}, "sha512-cqaMiY72CkP+2xZRrFt3ExRBu0WmVitN/rYPZErA80mHjHx/Svgp8yfbzkJmDoQ/whcytOPO9/IZXnOc+wigRA=="],
 
-    "@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.19.1", "", { "dependencies": { "@typescript-eslint/types": "8.19.1", "@typescript-eslint/visitor-keys": "8.19.1", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", "ts-api-utils": "^2.0.0" }, "peerDependencies": { "typescript": ">=4.8.4 <5.8.0" } }, "sha512-jk/TZwSMJlxlNnqhy0Eod1PNEvCkpY6MXOXE/WLlblZ6ibb32i2We4uByoKPv1d0OD2xebDv4hbs3fm11SMw8Q=="],
+    "@typescript-eslint/typescript-estree": ["@typescript-eslint/typescript-estree@8.20.0", "", { "dependencies": { "@typescript-eslint/types": "8.20.0", "@typescript-eslint/visitor-keys": "8.20.0", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", "ts-api-utils": "^2.0.0" }, "peerDependencies": { "typescript": ">=4.8.4 <5.8.0" } }, "sha512-Y7ncuy78bJqHI35NwzWol8E0X7XkRVS4K4P4TCyzWkOJih5NDvtoRDW4Ba9YJJoB2igm9yXDdYI/+fkiiAxPzA=="],
 
-    "@typescript-eslint/utils": ["@typescript-eslint/utils@8.19.1", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", "@typescript-eslint/scope-manager": "8.19.1", "@typescript-eslint/types": "8.19.1", "@typescript-eslint/typescript-estree": "8.19.1" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-IxG5gLO0Ne+KaUc8iW1A+XuKLd63o4wlbI1Zp692n1xojCl/THvgIKXJXBZixTh5dd5+yTJ/VXH7GJaaw21qXA=="],
+    "@typescript-eslint/utils": ["@typescript-eslint/utils@8.20.0", "", { "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", "@typescript-eslint/scope-manager": "8.20.0", "@typescript-eslint/types": "8.20.0", "@typescript-eslint/typescript-estree": "8.20.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-dq70RUw6UK9ei7vxc4KQtBRk7qkHZv447OUZ6RPQMQl71I3NZxQJX/f32Smr+iqWrB02pHKn2yAdHBb0KNrRMA=="],
 
-    "@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.19.1", "", { "dependencies": { "@typescript-eslint/types": "8.19.1", "eslint-visitor-keys": "^4.2.0" } }, "sha512-fzmjU8CHK853V/avYZAvuVut3ZTfwN5YtMaoi+X9Y9MA9keaWNHC3zEQ9zvyX/7Hj+5JkNyK1l7TOR2hevHB6Q=="],
+    "@typescript-eslint/visitor-keys": ["@typescript-eslint/visitor-keys@8.20.0", "", { "dependencies": { "@typescript-eslint/types": "8.20.0", "eslint-visitor-keys": "^4.2.0" } }, "sha512-v/BpkeeYAsPkKCkR8BDwcno0llhzWVqPOamQrAEMdpZav2Y9OVjd9dwJyBLJWwf335B5DmlifECIkZRJCaGaHA=="],
 
     "acorn": ["[email protected]", "", { "bin": { "acorn": "bin/acorn" } }, "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA=="],
 
@@ -234,7 +234,7 @@
 
     "concat-map": ["[email protected]", "", {}, "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="],
 
-    "consola": ["consola@3.3.3", "", {}, "sha512-Qil5KwghMzlqd51UXM0b6fyaGHtOC22scxrwrz4A2882LyUMwQjnvaedN1HAeXzphspQ6CpHkzMAWxBTUruDLg=="],
+    "consola": ["consola@3.4.0", "", {}, "sha512-EiPU8G6dQG0GFHNR8ljnZFki/8a+cQwEQ+7wpxdChl02Q8HXlwEZWD5lqAF8vC2sEC3Tehr8hy7vErz88LHyUA=="],
 
     "cross-spawn": ["[email protected]", "", { "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", "which": "^2.0.1" } }, "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA=="],
 
@@ -438,7 +438,7 @@
 
     "typescript": ["[email protected]", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw=="],
 
-    "typescript-eslint": ["typescript-eslint@8.19.1", "", { "dependencies": { "@typescript-eslint/eslint-plugin": "8.19.1", "@typescript-eslint/parser": "8.19.1", "@typescript-eslint/utils": "8.19.1" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-LKPUQpdEMVOeKluHi8md7rwLcoXHhwvWp3x+sJkMuq3gGm9yaYJtPo8sRZSblMFJ5pcOGCAak/scKf1mvZDlQw=="],
+    "typescript-eslint": ["typescript-eslint@8.20.0", "", { "dependencies": { "@typescript-eslint/eslint-plugin": "8.20.0", "@typescript-eslint/parser": "8.20.0", "@typescript-eslint/utils": "8.20.0" }, "peerDependencies": { "eslint": "^8.57.0 || ^9.0.0", "typescript": ">=4.8.4 <5.8.0" } }, "sha512-Kxz2QRFsgbWj6Xcftlw3Dd154b3cEPFqQC+qMZrMypSijPd4UanKKvoKDrJ4o8AIfZFKAF+7sMaEIR8mTElozA=="],
 
     "undici-types": ["[email protected]", "", {}, "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg=="],
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "discraft",
-  "version": "1.6.5-beta.5",
+  "version": "1.6.5-beta.6",
   "description": "Ultimate Discord bot framework",
   "type": "module",
   "packageManager": "[email protected]",
@@ -50,11 +50,11 @@
     "@eslint/js": "^9.18.0",
     "@types/bun": "^1.1.16",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.10.5",
+    "@types/node": "^22.10.6",
     "bun": "^1.1.43",
     "eslint": "^9.18.0",
     "globals": "^15.14.0",
-    "typescript-eslint": "^8.19.1"
+    "typescript-eslint": "^8.20.0"
   },
   "peerDependencies": {
     "typescript": "^5.7.3"
@@ -63,7 +63,7 @@
     "@inquirer/core": "^10.1.3",
     "chokidar": "^4.0.3",
     "commander": "^13.0.0",
-    "consola": "^3.3.3",
+    "consola": "^3.4.0",
     "esbuild": "^0.24.2",
     "esbuild-node-externals": "^1.16.0",
     "fs-extra": "^11.2.0",

diff --git a/templates/js/package.json b/templates/js/package.json
@@ -14,7 +14,7 @@
     "discraft": "latest"
   },
   "dependencies": {
-    "consola": "^3.3.3",
+    "consola": "^3.4.0",
     "discord.js": "^14.17.3",
     "dotenv": "^16.4.7"
   }

diff --git a/templates/ts/package.json b/templates/ts/package.json
@@ -14,7 +14,7 @@
     "discraft": "latest"
   },
   "dependencies": {
-    "consola": "^3.3.3",
+    "consola": "^3.4.0",
     "discord.js": "^14.17.3",
     "dotenv": "^16.4.7"
   }

diff --git a/templates/vercel-ts-ai/README.md b/templates/vercel-ts-ai/README.md
@@ -1 +1,118 @@
 # Discraft Vercel + TypeScript + AI Template
+
+Let's get started creating a serverless Discord bot with Discraft and Vercel!
+This template leverages TypeScript and Google AI for enhanced functionality.
+
+**Note:** If you came here after running `discraft init` with the Vercel template, you can skip to the 'Configuring Google AI' section.
+
+## Prerequisites
+
+Before you begin, make sure you have the following installed:
+
+- [Node.js](https://nodejs.org/en/download/) (preferably version 18.x or higher)
+- [Vercel CLI](https://vercel.com/cli)
+- [Discraft CLI](https://github.com/The-Best-Codes/discraft-js)
+
+## Getting Started
+
+First, create a new directory for your project and navigate to it:
+
+```bash
+mkdir my-discraft-project
+cd my-discraft-project
+```
+
+Now, initialize a new Discraft project, choosing the Vercel template:
+
+```bash
+discraft init
+? Select a template:
+  TypeScript
+  JavaScript
+❯ Vercel + TypeScript + Google AI
+```
+
+This will create a new project with a structure something like this:
+
+```
+my-discraft-project/
+├── commands/
+│   ├── chat.ts
+│   └── ping.ts
+├── public/
+│   └── index.html
+├── scripts/
+│   └── register.ts
+├── utils/
+│   ├── logger.ts
+│   └── types.ts
+├── .env.example
+├── .gitignore
+├── .vercelignore
+├── index.ts
+├── package.json
+├── README.md
+├── tsconfig.json
+└── vercel.json
+```
+
+## Configuring Google AI
+
+This template utilizes the Google AI API for enhanced bot interactions. You'll need to create a Google AI project and obtain an API key. Here's how to configure it:
+
+1. **Obtain API Key:** Visit the [Google AI Studio](https://aistudio.google.com/app/apikey) and obtain an API key.
+2. **Select a Model:** Choose a suitable Google AI model. A good starting point is `gemini-2.0-flash-exp`, as it is currently free, but other models may be appropriate for your needs. You can find available models [here](https://ai.google.dev/models).
+3. **Environment Variables:** The project relies on several environment variables to function correctly. You will need to set these in your `.env` file locally and in the Vercel project settings.
+   - Create a `.env` file in your project's root directory.
+   - Copy the contents of the `.env.example` file, filling in the values with your Discord and Google AI credentials.
+
+Here's what the `.env.example` looks like:
+
+```example
+# You will need to add these secrets to the 'Environment Variables' section of your Vercel project
+# https://vercel.com/docs/projects/environment-variables
+
+# From `General Information > Public Key` | https://discord.com/developers/applications
+DISCORD_PUBLIC_KEY=''
+# From `General Information > App ID` | https://discord.com/developers/applications
+DISCORD_APP_ID=''
+# From `Bot > Token` | https://discord.com/developers/applications
+DISCORD_TOKEN=''
+
+# From `Get API Key` | https://aistudio.google.com/app/apikey
+GOOGLE_AI_API_KEY=''
+# From the Google model list
+GOOGLE_AI_MODEL='gemini-2.0-flash-exp'
+```
+
+**Important:** _Do not commit the `.env` file to your repository._ It should be added to your `.gitignore` file. This is already done for you in the template.
+
+## Deploying to Vercel
+
+1. **Create a Vercel Project:** If you haven't already, create a new project in your Vercel dashboard.
+2. **Set Environment Variables:** In your Vercel project settings, go to "Environment Variables" and add all the variables you configured in your `.env`. You can find the project settings [here](https://vercel.com/dashboard).
+3. **Run a Discraft Build**: In your project directory, run `npm run build` or `discraft vercel build` to create the API routes and files for your bot.
+4. **Deploy:** You can deploy your bot to Vercel by running `npm run deploy` in your project directory.
+
+## Discord Bot Setup
+
+1. **Create a Discord Application:** Go to the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.
+2. **Add a Bot User:** Add a bot user to your application.
+3. **Invite the Bot:** Use the 'OAuth2 > URL Generator' section to create an invite link and add your bot to a server. Select the `applications.commands` scope and send this link to a discord server you own so you can see your bot in action.
+
+## Example Commands
+
+This template comes with a couple of example commands:
+
+- **`/ping`**: Responds with "Pong!".
+- **`/chat <prompt>`**: Uses Google AI to respond to the given prompt.
+
+## Get Help & See Demos
+
+Need some assistance or want to see the bot in action? Join our Discord community!
+[Discraft Support Discord](https://discord.gg/86qMjn4RHQ)
+
+## Contribute
+
+If you have ideas for the bot, or find any issues, you can create a pull request or issue on our github here:
+https://github.com/The-Best-Codes/discraft-js
diff --git a/templates/vercel-ts-ai/package.json b/templates/vercel-ts-ai/package.json
@@ -17,7 +17,7 @@
   "dependencies": {
     "@google/generative-ai": "^0.21.0",
     "@vercel/node": "^5.0.2",
-    "consola": "^3.3.3",
+    "consola": "^3.4.0",
     "discord-api-types": "^0.37.115",
     "discord-interactions": "^4.1.0",
     "discord.js": "^14.17.3",

diff --git a/templates/vercel-ts-ai/template.json b/templates/vercel-ts-ai/template.json
@@ -2,6 +2,7 @@
   "files": [
     "commands",
     "public",
+    "scripts",
     "utils",
     ".env.example",
     ".vercelignore",
@@ -13,8 +14,9 @@
   ],
   "postCopy": {
     "instructions": [
-      "Configure your .env file with your bot public token and app ID",
-      "Add your Google API key to the .env file to enable the chat command"
+      "Copy .env.example to .env",
+      "Add your Discord and Google AI credentials to .env",
+      "Check out the README.md file in your project to learn how to deploy to Vercel"
     ],
     "defaultDevelopment": false,
     "defaultStart": false,