@sapphire/cli 1.3.0 → 1.3.1-next.85ea98b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/cli",
-  "version": "1.3.0",
+  "version": "1.3.1-next.85ea98b.0",
   "description": "CLI for Sapphire Framework",
   "author": "@sapphire",
   "license": "MIT",
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "@favware/colorette-spinner": "^1.0.1",
-    "@sapphire/result": "^2.4.0",
+    "@sapphire/result": "^2.4.1",
     "colorette": "^2.0.19",
     "commander": "^9.4.0",
     "execa": "^6.1.0",
@@ -49,8 +49,8 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.3",
-    "@commitlint/config-conventional": "^17.0.3",
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
     "@favware/cliff-jumper": "^1.8.7",
     "@favware/npm-deprecate": "^1.0.5",
     "@sapphire/eslint-config": "^4.3.8",
@@ -59,10 +59,10 @@
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^18.7.8",
     "@types/prompts": "^2.0.14",
-    "@typescript-eslint/eslint-plugin": "^5.33.1",
-    "@typescript-eslint/parser": "^5.33.1",
+    "@typescript-eslint/eslint-plugin": "^5.36.1",
+    "@typescript-eslint/parser": "^5.36.1",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.22.0",
+    "eslint": "^8.23.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",
     "globby": "^13.1.2",
@@ -72,7 +72,7 @@
     "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.2"
   },
   "resolutions": {
     "ansi-regex": "^5.0.1",
@@ -117,5 +117,5 @@
     "access": "public"
   },
   "prettier": "@sapphire/prettier-config",
-  "packageManager": "yarn@3.2.2"
+  "packageManager": "yarn@3.2.3"
 }

package/templates/.sapphirerc.json.sapphire

@@ -1,14 +1,14 @@
 {
-  "projectLanguage": "{{language}}",
-  "locations": {
-    "base": "src",
-    "arguments": "arguments",
-    "commands": "commands",
-    "listeners": "listeners",
-    "preconditions": "preconditions"
-  },
-  "customFileTemplates": {
-    "enabled": false,
-    "location": ""
-  }
+	"projectLanguage": "{{language}}",
+	"locations": {
+		"base": "src",
+		"arguments": "arguments",
+		"commands": "commands",
+		"listeners": "listeners",
+		"preconditions": "preconditions"
+	},
+	"customFileTemplates": {
+		"enabled": false,
+		"location": ""
+	}
 }

package/templates/components/argument.js.sapphire

@@ -1,15 +1,22 @@
 { "category": "arguments" }
 ---
-import { Argument } from "@sapphire/framework";
+const { Argument } = require('@sapphire/framework');
 
-export class UserArgument extends Argument {
-    constructor(context, options) {
-        super(context, {
-            ...options
-        });
-    }
+class UserArgument extends Argument {
+	/**
+	 * @param {Argument.Context} context
+	 */
+	constructor(context) {
+		super(context, {
+			// Any Argument options you want here
+		});
+	}
 
-    async run(parameter) {
-        return this.ok(parameter);
-    }
+	async run(parameter) {
+		return this.ok(parameter);
+	}
 }
+
+module.exports = {
+	UserArgument
+};

package/templates/components/argument.ts.sapphire

@@ -1,17 +1,17 @@
 { "category": "arguments" }
 ---
 import { ApplyOptions } from '@sapphire/decorators';
-import { Argument, ArgumentOptions } from "@sapphire/framework";
+import { Argument, ArgumentOptions } from '@sapphire/framework';
 
 @ApplyOptions<ArgumentOptions>({})
 export class UserArgument extends Argument<string> {
-  async run(parameter: string) {
-    return this.ok(parameter);
-  }
+	async run(parameter: string) {
+		return this.ok(parameter);
+	}
 }
 
 declare module '@sapphire/framework' {
-  interface ArgType {
-    {{name}}: string;
-  }
+	interface ArgType {
+		{{name}}: string;
+	}
 }

package/templates/components/contextmenucommand.js.sapphire

@@ -1,25 +1,38 @@
 { "category": "commands" }
 ---
-const { Command } = require('@sapphire/framework')
+const { Command } = require('@sapphire/framework');
+const { ApplicationCommandType } = require('discord-api-types/v10');
 
 class UserCommand extends Command {
-    constructor(context, options) {
-        super(context, {
-            ...options,
+	/**
+	 * @param {Command.Context} context
+	 */
+	constructor(context) {
+		super(context, {
+			// Any Command options you want here
 			name: 'command'
-        });
-    }
+		});
+	}
 
-    registerApplicationCommands(registry) {
-		registry.registerContextMenuCommand({
-			name: this.name,
-			type: 'MESSAGE'
-		})
+	/**
+	 * @param {Command.Registry} registry
+	 */
+	registerApplicationCommands(registry) {
+		registry.registerContextMenuCommand((builder) =>
+			builder //
+				.setName(this.name)
+				.setType(ApplicationCommandType.Message)
+		);
 	}
 
+	/**
+	 * @param {Command.ContextMenuInteraction} interaction
+	 */
 	async contextMenuRun(interaction) {
-		return await interaction.reply({content: "Hello world!"})
+		return await interaction.reply({ content: 'Hello world!' });
 	}
 }
 
-exports.UserCommand = UserCommand;
+module.exports = {
+	UserCommand
+};

package/templates/components/contextmenucommand.ts.sapphire

@@ -2,19 +2,21 @@
 ---
 import { ApplyOptions } from '@sapphire/decorators';
 import { Command } from '@sapphire/framework';
+import { ApplicationCommandType } from 'discord-api-types/v10';
 
 @ApplyOptions<Command.Options>({
 	description: 'A basic contextMenu command'
 })
 export class UserCommand extends Command {
 	public override registerApplicationCommands(registry: Command.Registry) {
-		registry.registerContextMenuCommand({
-			name: this.name,
-			type: 'MESSAGE'
-		})
+		registry.registerContextMenuCommand((builder) =>
+			builder //
+				.setName(this.name)
+				.setType(ApplicationCommandType.Message)
+		);
 	}
 
 	public async contextMenuRun(interaction: Command.ContextMenuInteraction) {
-		return await interaction.reply({content: "Hello world!"});
+		return await interaction.reply({ content: 'Hello world!' });
 	}
 }

package/templates/components/listener.js.sapphire

@@ -3,13 +3,18 @@
 const { Listener } = require('@sapphire/framework');
 
 class UserEvent extends Listener {
-    constructor(context, options = {}) {
-        super(context, {
-            ...options
-        });
-    }
+	/**
+	 * @param {Listener.Context} context
+	 */
+	constructor(context) {
+		super(context, {
+			// Any Listener options you want here
+		});
+	}
 
-    run() {}
+	run() {}
 }
 
-exports.UserEvent = UserEvent;
+module.exports = {
+	UserEvent
+}

package/templates/components/listener.ts.sapphire

@@ -5,5 +5,5 @@ import { Listener, ListenerOptions } from '@sapphire/framework';
 
 @ApplyOptions<ListenerOptions>({})
 export class UserEvent extends Listener {
-  public run() {}
+	public run() {}
 }

package/templates/components/messagecommand.js.sapphire

@@ -1,17 +1,25 @@
 { "category": "commands" }
 ---
-const { SubCommandPluginCommand } = require('@sapphire/plugin-subcommands');
+const { Command } = require('@sapphire/framework');
 
-class UserCommand extends SubCommandPluginCommand {
-    constructor(context, options) {
-        super(context, {
-            ...options
-        });
-    }
+class UserCommand extends Command {
+	/**
+	 * @param {Command.Context} context
+	 */
+	constructor(context) {
+		super(context, {
+			// Any Command options you want here
+		});
+	}
 
-    async messageRun(message) {
-        return message.channel.send('Hello world!');
-    }
+	/**
+	 * @param {import('discord.js').Message} message
+	 */
+	async messageRun(message) {
+		return message.channel.send('Hello world!');
+	}
 }
 
-exports.UserCommand = UserCommand;
+module.exports = {
+	UserCommand
+};

package/templates/components/messagecommand.ts.sapphire

@@ -1,13 +1,13 @@
 { "category": "commands" }
 ---
 import { ApplyOptions } from '@sapphire/decorators';
-import { SubCommandPluginCommand, SubCommandPluginCommandOptions } from '@sapphire/plugin-subcommands';
+import { Command } from '@sapphire/framework';
 import type { Message } from 'discord.js';
 
-@ApplyOptions<SubCommandPluginCommandOptions>({
+@ApplyOptions<Command.Options>({
 	description: 'A basic command'
 })
-export class UserCommand extends SubCommandPluginCommand {
+export class UserCommand extends Command {
 	public async messageRun(message: Message) {
 		return message.channel.send('Hello world!');
 	}

package/templates/components/precondition.js.sapphire

@@ -3,9 +3,28 @@
 const { Precondition } = require('@sapphire/framework');
 
 class UserPrecondition extends Precondition {
-	run(message) {
+	/**
+	 * @param {import('discord.js').Message} message
+	 */
+	messageRun(message) {
+		return this.ok();
+	}
+
+	/**
+	 * @param {import('discord.js').CommandInteraction} interaction
+	 */
+	chatInputRun(interaction) {
+		return this.ok();
+	}
+
+	/**
+	 * @param {import('discord.js').ContextMenuInteraction} interaction
+	 */
+	contextMenuRun(interaction) {
 		return this.ok();
 	}
 }
 
-module.exports.UserPrecondition = UserPrecondition;
+module.exports = {
+	UserPrecondition
+};

package/templates/components/precondition.ts.sapphire

@@ -1,16 +1,24 @@
 { "category": "preconditions" }
 ---
 import { Precondition } from '@sapphire/framework';
-import type { Message } from 'discord.js';
+import type { CommandInteraction, ContextMenuInteraction, Message } from 'discord.js';
 
 export class UserPrecondition extends Precondition {
-  public run(message: Message) {
-    return this.ok();
-  }
+	public override messageRun(message: Message) {
+		return this.ok();
+	}
+
+	public override chatInputRun(interaction: CommandInteraction) {
+		return this.ok();
+	}
+
+	public override contextMenuRun(interaction: ContextMenuInteraction) {
+		return this.ok();
+	}
 }
 
 declare module '@sapphire/framework' {
-  interface Preconditions {
-    {{name}}: never;
-  }
+	interface Preconditions {
+		{{name}}: never;
+	}
 }

package/templates/components/slashcommand.js.sapphire

@@ -3,24 +3,37 @@
 const { Command } = require('@sapphire/framework')
 
 class UserCommand extends Command {
-    constructor(context, options) {
-        super(context, {
-            ...options,
+	/**
+	 * @param {Command.Context} context
+	 */
+	constructor(context) {
+		super(context, {
+			// Any Command options you want here
 			name: 'command',
 			description: 'A basic slash command'
-        });
-    }
+		});
+	}
 
-    registerApplicationCommands(registry) {
-		registry.registerChatInputCommand({
-			name: this.name,
-			description: this.description
-		})
+	/**
+	 * @param {Command.Registry} registry
+	 */
+	registerApplicationCommands(registry) {
+		registry.registerChatInputCommand(
+			(builder) =>
+				builder //
+					.setName(this.name)
+					.setDescription(this.description)
+		);
 	}
 
+	/**
+	 * @param {Command.ChatInputInteraction} interaction
+	 */
 	async chatInputRun(interaction) {
-		return await interaction.reply({content: "Hello world!"})
+		return await interaction.reply({ content: 'Hello world!' });
 	}
 }
 
-exports.UserCommand = UserCommand;
+module.exports = {
+	UserCommand
+}

package/templates/components/slashcommand.ts.sapphire

@@ -8,13 +8,14 @@ import { Command } from '@sapphire/framework';
 })
 export class UserCommand extends Command {
 	public override registerApplicationCommands(registry: Command.Registry) {
-		registry.registerChatInputCommand({
-			name: this.name,
-			description: this.description
-		})
+		registry.registerChatInputCommand((builder) =>
+			builder //
+				.setName(this.name)
+				.setDescription(this.description)
+		);
 	}
 
-	public async chatInputRun(interaction: Command.ChatInputInteraction) {
-		return await interaction.reply({content: "Hello world!"});
+	public override async chatInputRun(interaction: Command.ChatInputInteraction) {
+		return await interaction.reply({ content: 'Hello world!' });
 	}
 }

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

@@ -1,63 +1,50 @@
 {
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "title": "Sapphire CLI Config",
-  "description": "Scheme for Sapphire CLI Config (@sapphire/cli)",
-  "type": "object",
-  "properties": {
-    "projectLanguage": {
-      "description": "Project language (ts | js)",
-      "type": "string"
-    },
-    "locations": {
-      "description": "Categories and their locations",
-      "type": "object",
-      "properties": {
-        "base": {
-          "type": "string"
-        },
-        "arguments": {
-          "type": "string"
-        },
-        "commands": {
-          "type": "string"
-        },
-        "listeners": {
-          "type": "string"
-        },
-        "preconditions": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "base",
-        "arguments",
-        "commands",
-        "listeners",
-        "preconditions"
-      ]
-    },
-    "customFileTemplates": {
-      "description": "Settings about custom component (piece) templates",
-      "type": "object",
-      "properties": {
-        "enabled": {
-          "description": "Enable custom file templates",
-          "type": "boolean"
-        },
-        "location": {
-          "description": "Location of your custom file templates",
-          "type": "string"
-        }
-      },
-      "required": [
-        "enabled",
-        "location"
-      ]
-    }
-  },
-  "required": [
-    "projectLanguage",
-    "locations",
-    "customFileTemplates"
-  ]
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"title": "Sapphire CLI Config",
+	"description": "Scheme for Sapphire CLI Config (@sapphire/cli)",
+	"type": "object",
+	"properties": {
+		"projectLanguage": {
+			"description": "Project language (ts | js)",
+			"type": "string"
+		},
+		"locations": {
+			"description": "Categories and their locations",
+			"type": "object",
+			"properties": {
+				"base": {
+					"type": "string"
+				},
+				"arguments": {
+					"type": "string"
+				},
+				"commands": {
+					"type": "string"
+				},
+				"listeners": {
+					"type": "string"
+				},
+				"preconditions": {
+					"type": "string"
+				}
+			},
+			"required": ["base", "arguments", "commands", "listeners", "preconditions"]
+		},
+		"customFileTemplates": {
+			"description": "Settings about custom component (piece) templates",
+			"type": "object",
+			"properties": {
+				"enabled": {
+					"description": "Enable custom file templates",
+					"type": "boolean"
+				},
+				"location": {
+					"description": "Location of your custom file templates",
+					"type": "string"
+				}
+			},
+			"required": ["enabled", "location"]
+		}
+	},
+	"required": ["projectLanguage", "locations", "customFileTemplates"]
 }