@sapphire/cli 1.6.0-next.afa4afb.0 → 1.6.0

package/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to this project will be documented in this file.
 
+# [1.6.0](https://github.com/sapphiredev/cli/compare/v1.5.0...v1.6.0) - (2023-04-12)
+
+## 🏠 Refactor
+
+- Remove `with-docker` template ([1b485f8](https://github.com/sapphiredev/cli/commit/1b485f836d656022dd761cc13862fa9a970142a7))
+- Stricter typing for config parsing ([ab0efb3](https://github.com/sapphiredev/cli/commit/ab0efb3c602843b76bf64e135c0a448288227462))
+- **new:** Make yarn v3 the default ([30499ea](https://github.com/sapphiredev/cli/commit/30499ea72a52c31220794f41da695494145c9b08))
+- **CreateFileFromTemplate:** Better internal code naming ([3189772](https://github.com/sapphiredev/cli/commit/3189772a1b85ecc2bad2949ed8d339ff0541cebf))
+- Better error messages for `generate` when template doesn't exist ([dc34e1e](https://github.com/sapphiredev/cli/commit/dc34e1ecda585eeb7024d716fbf401e8e18a9b93))
+
+## 🐛 Bug Fixes
+
+- Better error messages when creating file ([afa4afb](https://github.com/sapphiredev/cli/commit/afa4afba579f4877eecbe447a9728b71b4042b0c))
+- Fixed JSON config file ([6fe3d0c](https://github.com/sapphiredev/cli/commit/6fe3d0c87a0ba70a802d73c73028832b77c0077b))
+- **templates:** Adhere to strict type checking rules ([b455738](https://github.com/sapphiredev/cli/commit/b455738705d475d99357f758d9eeea505d43c2f2))
+
+## 🚀 Features
+
+- Add route in prompt (#220) ([60451d6](https://github.com/sapphiredev/cli/commit/60451d6e2c92ef42c07f592d2923177aa9386595))
+- **templates:** Add interaction handler templates (#216) ([650ec76](https://github.com/sapphiredev/cli/commit/650ec76c3c17e2ae5d480994daac4b42bacbfc34))
+- Add `interactive-tools` plugin for yarn v3 installs ([c417d97](https://github.com/sapphiredev/cli/commit/c417d970f139da1827fe914f69903f90df436907))
+
+## 🪞 Styling
+
+- Add prettierignore file ([2d24595](https://github.com/sapphiredev/cli/commit/2d24595e347a9e4d24ca6926e35fb60945e11725))
+
 # [1.5.0](https://github.com/sapphiredev/cli/compare/v1.4.0...v1.5.0) - (2023-04-10)
 
 ## 🐛 Bug Fixes

package/dist/commands/generate.js

@@ -40,8 +40,16 @@ async function fetchConfig() {
  * @returns A string with a hint for the user
  */
 function parseCommonHints(component) {
-    if (component.toLowerCase() === 'command' || component.toLowerCase() === 'commands') {
-        return `\nHint: You wrote "${component}", instead of "messagecommand", "slashcommand", or "contextmenucommand"`;
+    const newLine = '\n';
+    const lowerCaseComponent = component.toLowerCase();
+    if (lowerCaseComponent === 'command' || lowerCaseComponent === 'commands') {
+        return `${newLine}Hint: You wrote "${component}", instead of "messagecommand", "slashcommand", or "contextmenucommand"`;
+    }
+    if (lowerCaseComponent === 'interaction-handler' ||
+        lowerCaseComponent === 'interaction-handlers' ||
+        lowerCaseComponent === 'interactionhandler' ||
+        lowerCaseComponent === 'interactionhandlers') {
+        return `${newLine}Hint: You wrote "${component}", instead of "buttoninteractionhandler", "autocompleteinteractionhandler", "modalinteractionhandler", or "selectmenuinteractionhandler"`;
     }
     return '';
 }

package/dist/commands/init.js

@@ -20,7 +20,9 @@ export default async () => {
             arguments: response.arguments,
             commands: response.commands,
             listeners: response.listeners,
-            preconditions: response.preconditions
+            preconditions: response.preconditions,
+            'interaction-handlers': response['interaction-handlers'],
+            routes: response.routes ?? ''
         },
         customFileTemplates: {
             enabled: response.cftEnabled,

package/dist/prompts/PromptInit.js

@@ -47,6 +47,23 @@ export const PromptInit = [
         message: 'Where do you store your preconditions? (do not include the base)',
         initial: 'preconditions'
     },
+    {
+        type: 'text',
+        name: 'interaction-handlers',
+        message: 'Where do you store your interaction handlers? (do not include the base)',
+        initial: 'interaction-handlers'
+    },
+    {
+        type: 'confirm',
+        name: 'rEnabled',
+        message: 'Would you use the api plugin?'
+    },
+    {
+        type: (prev) => (prev ? 'text' : null),
+        name: 'rLocation',
+        message: 'Where do you store your routes? (do not include the base)',
+        initial: 'routes'
+    },
     {
         type: 'confirm',
         name: 'cftEnabled',

package/dist/prompts/PromptNew.js

@@ -1,7 +1,6 @@
 const tsTemplates = [
     { title: 'Starter template (Recommended)', value: 'with-typescript-starter' },
     { title: 'Complete template', value: 'with-typescript-complete' },
-    { title: 'with Docker', value: 'with-docker' },
     { title: 'with tsup', value: 'with-tsup' },
     { title: 'with SWC', value: 'with-swc' }
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/cli",
-  "version": "1.6.0-next.afa4afb.0",
+  "version": "1.6.0",
   "description": "CLI for Sapphire Framework",
   "author": "@sapphire",
   "license": "MIT",
@@ -48,7 +48,10 @@
     "@commitlint/config-conventional": "^17.4.4",
     "@favware/cliff-jumper": "^2.0.0",
     "@favware/npm-deprecate": "^1.0.7",
+    "@sapphire/decorators": "*",
     "@sapphire/eslint-config": "^4.4.0",
+    "@sapphire/framework": "*",
+    "@sapphire/plugin-api": "*",
     "@sapphire/prettier-config": "^1.4.5",
     "@sapphire/ts-config": "^4.0.0",
     "@types/js-yaml": "^4.0.5",
@@ -57,6 +60,7 @@
     "@typescript-eslint/eslint-plugin": "^5.58.0",
     "@typescript-eslint/parser": "^5.58.0",
     "cz-conventional-changelog": "^3.3.0",
+    "discord.js": "*",
     "eslint": "^8.38.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",

package/templates/.sapphirerc.json.sapphire

@@ -6,6 +6,7 @@
 		"commands": "commands",
 		"listeners": "listeners",
 		"preconditions": "preconditions",
+		"interaction-handlers": "interaction-handlers",
 		"routes": "routes"
 	},
 	"customFileTemplates": {

package/templates/.sapphirerc.yml.sapphire

@@ -5,6 +5,7 @@ locations:
   commands: commands
   listeners: listeners
   preconditions: preconditions
+  interaction-handlers: interaction-handlers
   routes: routes
 customFileTemplates:
   enabled: false

package/templates/components/autocompleteinteractionhandler.js.sapphire

@@ -0,0 +1,50 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class AutocompleteHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.Autocomplete
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').AutocompleteInteraction} interaction
+	 * @param {import('discord.js').ApplicationCommandOptionChoiceData[]} result
+	 */
+	async run(interaction, result) {
+		return interaction.respond(result);
+	}
+
+	/**
+	 * @param {import('discord.js').AutocompleteInteraction} interaction
+	 */
+	async parse(interaction) {
+		// Only run this interaction for the command with ID '1000000000000000000'
+		if (interaction.commandId !== '1000000000000000000') return this.none();
+		// Get the focussed (current) option
+		const focusedOption = interaction.options.getFocused(true);
+		// Ensure that the option name is one that can be autocompleted, or return none if not.
+		switch (focusedOption.name) {
+			case 'search': {
+				// Search your API or similar. This is example code!
+				const searchResult = await myApi.searchForSomething(focusedOption.value);
+				// Map the search results to the structure required for Autocomplete
+				return this.some(searchResult.map((match) => ({ name: match.name, value: match.key })));
+			}
+			default:
+				return this.none();
+		}
+	}
+}
+
+module.exports = {
+	AutocompleteHandler
+};

package/templates/components/autocompleteinteractionhandler.ts.sapphire

@@ -0,0 +1,32 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import { AutocompleteInteraction, type ApplicationCommandOptionChoiceData } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.Autocomplete
+})
+export class AutocompleteHandler extends InteractionHandler {
+	public override async run(interaction: AutocompleteInteraction, result: ApplicationCommandOptionChoiceData[]) {
+		return interaction.respond(result);
+	}
+
+	public override async parse(interaction: AutocompleteInteraction) {
+		// Only run this interaction for the command with ID '1000000000000000000'
+		if (interaction.commandId !== '1000000000000000000') return this.none();
+		// Get the focussed (current) option
+		const focusedOption = interaction.options.getFocused(true);
+		// Ensure that the option name is one that can be autocompleted, or return none if not.
+		switch (focusedOption.name) {
+			case 'search': {
+				// Search your API or similar. This is example code!
+				const searchResult = await myApi.searchForSomething(focusedOption.value);
+				// Map the search results to the structure required for Autocomplete
+				return this.some(searchResult.map((match) => ({ name: match.name, value: match.key })));
+			}
+			default:
+				return this.none();
+		}
+	}
+}

package/templates/components/buttoninteractionhandler.js.sapphire

@@ -0,0 +1,39 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class ButtonHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.Button
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').ButtonInteraction} interaction
+	 */
+	async run(interaction) {
+		await interaction.reply({
+			content: 'Hello from a button interaction handler!',
+			// Let's make it so only the person who pressed the button can see this message!
+			ephemeral: true
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').ButtonInteraction} interaction
+	 */
+	parse(interaction) {
+		if (interaction.customId !== 'my-awesome-button') return this.none();
+		return this.some();
+	}
+}
+
+module.exports = {
+	ButtonHandler
+};

package/templates/components/buttoninteractionhandler.ts.sapphire

@@ -0,0 +1,24 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import type { ButtonInteraction } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.Button
+})
+export class ButtonHandler extends InteractionHandler {
+	public async run(interaction: ButtonInteraction) {
+		await interaction.reply({
+			content: 'Hello from a button interaction handler!',
+			// Let's make it so only the person who pressed the button can see this message!
+			ephemeral: true
+		});
+	}
+
+	public override parse(interaction: ButtonInteraction) {
+		if (interaction.customId !== 'my-awesome-button') return this.none();
+
+		return this.some();
+	}
+}

package/templates/components/modalinteractionhandler.js.sapphire

@@ -0,0 +1,39 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class ModalHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.ModalSubmit
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').ModalSubmitInteraction} interaction
+	 */
+	async run(interaction) {
+		await interaction.reply({
+			content: 'Thank you for submitting the form!',
+			ephemeral: true
+		});
+	  }
+
+	/**
+	 * @param {import('discord.js').ModalSubmitInteraction} interaction
+	 */
+	parse(interaction) {
+		if (interaction.customId !== 'hello-popup') return this.none();
+	
+		return this.some();
+	}
+}
+
+module.exports = {
+	ModalHandler
+};

package/templates/components/modalinteractionhandler.ts.sapphire

@@ -0,0 +1,23 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import type { ModalSubmitInteraction } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.ModalSubmit
+})
+export class ModalHandler extends InteractionHandler {
+	public async run(interaction: ModalSubmitInteraction) {
+		await interaction.reply({
+			content: 'Thank you for submitting the form!',
+			ephemeral: true
+		});
+	}
+
+	public override parse(interaction: ModalSubmitInteraction) {
+		if (interaction.customId !== 'hello-popup') return this.none();
+	
+		return this.some();
+	}
+}

package/templates/components/route.js.sapphire

@@ -1,6 +1,7 @@
 { "category": "routes" }
 ---
 const { methods, Route } = require('@sapphire/plugin-api');
+
 class UserRoute extends Route {
 	/**
 	 * @param {Route.Context} context

package/templates/components/selectmenuinteractionhandler.js.sapphire

@@ -0,0 +1,39 @@
+{ "category": "interaction-handlers" }
+---
+const { InteractionHandler, InteractionHandlerTypes } = require('@sapphire/framework');
+
+class MenuHandler extends InteractionHandler {
+	/**
+	 * @param {InteractionHandler.Context} context
+	 * @param {InteractionHandler.Options} options
+	 */
+	constructor(context, options) {
+		super(context, {
+			...options,
+			interactionHandlerType: InteractionHandlerTypes.SelectMenu
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').StringSelectMenuInteraction} interaction
+	 */
+	async run(interaction) {
+		await interaction.reply({
+			// Remember how we can have multiple values? Let's get the first one!
+			content: `You selected: ${interaction.values[0]}`
+		});
+	}
+
+	/**
+	 * @param {import('discord.js').StringSelectMenuInteraction} interaction
+	 */
+	parse(interaction) {
+		if (interaction.customId !== 'my-echo-select') return this.none();
+
+    	return this.some();
+	}
+}
+
+module.exports = {
+	MenuHandler
+};

package/templates/components/selectmenuinteractionhandler.ts.sapphire

@@ -0,0 +1,23 @@
+{ "category": "interaction-handlers" }
+---
+import { ApplyOptions } from '@sapphire/decorators';
+import { InteractionHandler, InteractionHandlerTypes } from '@sapphire/framework';
+import type { StringSelectMenuInteraction } from 'discord.js';
+
+@ApplyOptions<InteractionHandler.Options>({
+	interactionHandlerType: InteractionHandlerTypes.SelectMenu
+})
+export class MenuHandler extends InteractionHandler {
+	public override async run(interaction: StringSelectMenuInteraction) {
+		await interaction.reply({
+			// Remember how we can have multiple values? Let's get the first one!
+			content: `You selected: ${interaction.values[0]}`
+		});
+	}
+
+	public override parse(interaction: StringSelectMenuInteraction) {
+		if (interaction.customId !== 'my-echo-select') return this.none();
+
+		return this.some();
+	}
+}

package/templates/schemas/.sapphirerc.scheme.json

@@ -27,11 +27,14 @@
 				"preconditions": {
 					"type": "string"
 				},
+				"interaction-handlers": {
+					"type": "string"
+				},
 				"routes": {
 					"type": "string"
 				}
 			},
-			"required": ["base", "arguments", "commands", "listeners", "preconditions"]
+			"required": ["base", "arguments", "commands", "listeners", "preconditions", "interaction-handlers"]
 		},
 		"customFileTemplates": {
 			"description": "Settings about custom component (piece) templates",