feat: migrate to @sapphire/result and re-export the package (#376)

package.json

@@ -31,6 +31,7 @@
 		"@sapphire/discord.js-utilities": "^4.6.0",
 		"@sapphire/pieces": "^3.2.0",
 		"@sapphire/ratelimits": "^2.3.0",
+		"@sapphire/result": "^1.0.0",
 		"@sapphire/stopwatch": "^1.3.0",
 		"@sapphire/utilities": "^3.3.0",
 		"lexure": "^0.17.0",

src/index.ts

@@ -43,14 +43,13 @@ export {
 	StoreRegistry,
 	StoreRegistryEntries
 } from '@sapphire/pieces';
+export * from '@sapphire/result';
 export type { Awaitable } from '@sapphire/utilities';
 export * from './lib/errors/ArgumentError';
 export * from './lib/errors/Identifiers';
 export * from './lib/errors/PreconditionError';
 export * from './lib/errors/UserError';
 export * from './lib/parsers/Args';
-export * from './lib/parsers/Maybe';
-export * from './lib/parsers/Result';
 export * from './lib/plugins/Plugin';
 export * from './lib/plugins/PluginManager';
 export * from './lib/plugins/symbols';

src/lib/parsers/Args.ts

@@ -1,5 +1,6 @@
 import type { ChannelTypes, GuildBasedChannelTypes } from '@sapphire/discord.js-utilities';
 import { container } from '@sapphire/pieces';
+import { err, isErr, isOk, isSome, maybe, ok, type Err, type Maybe, type Ok, type Result } from '@sapphire/result';
 import type {
 	CategoryChannel,
 	DMChannel,
@@ -21,8 +22,6 @@ import { UserError } from '../errors/UserError';
 import type { EmojiObject } from '../resolvers';
 import type { Argument, IArgument } from '../structures/Argument';
 import type { MessageCommand } from '../structures/Command';
-import { isSome, maybe, Maybe } from './Maybe';
-import { Err, err, isErr, isOk, ok, Ok, Result } from './Result';
 
 /**
  * The argument parser to be used in {@link Command}.
@@ -126,7 +125,9 @@ export class Args {
 		);
 		if (result === null) return this.missingArguments();
 		if (isOk(result)) return result as Ok<ArgType[K]>;
-		return result;
+
+		// We need to typecast here because TS doesn't resolve that the type from @sapphire/result is identical to that of Lexure
+		return result as Result<ArgType[K], UserError>;
 	}
 
 	/**
@@ -299,7 +300,11 @@ export class Args {
 			);
 			if (result === null) break;
 			if (isErr(result)) {
-				if (output.length === 0) return result;
+				if (output.length === 0) {
+					// We need to typecast here because TS doesn't resolve that the type from @sapphire/result is identical to that of Lexure
+					return result as Result<ArgType[K][], UserError>;
+				}
+
 				break;
 			}
 

src/lib/resolvers/boolean.ts

@@ -1,5 +1,5 @@
+import { err, ok, Result } from '@sapphire/result';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 
 const baseTruths = ['1', 'true', '+', 't', 'yes', 'y'] as const;
 const baseFalses = ['0', 'false', '-', 'f', 'no', 'n'] as const;

src/lib/resolvers/channel.ts

@@ -1,8 +1,8 @@
 import { ChannelMentionRegex, ChannelTypes } from '@sapphire/discord.js-utilities';
 import { container } from '@sapphire/pieces';
+import { err, ok, Result } from '@sapphire/result';
 import type { Message, Snowflake } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 
 export function resolveChannel(parameter: string, message: Message): Result<ChannelTypes, Identifiers.ArgumentChannelError> {
 	const channelId = (ChannelMentionRegex.exec(parameter)?.[1] ?? parameter) as Snowflake;

src/lib/resolvers/date.ts

@@ -1,5 +1,5 @@
+import { err, ok, Result } from '@sapphire/result';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 
 export function resolveDate(
 	parameter: string,

src/lib/resolvers/dmChannel.ts

@@ -1,7 +1,7 @@
 import { isDMChannel } from '@sapphire/discord.js-utilities';
+import { err, ok, Result } from '@sapphire/result';
 import type { DMChannel, Message } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 import { resolveChannel } from './channel';
 
 export function resolveDMChannel(

src/lib/resolvers/emoji.ts

@@ -1,7 +1,7 @@
 import { EmojiRegex, TwemojiRegex } from '@sapphire/discord-utilities';
+import { Err, err, Ok, ok } from '@sapphire/result';
 import { Util } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import { Err, err, Ok, ok } from '../parsers/Result';
 
 export function resolveEmoji(parameter: string): Ok<EmojiObject> | Err<Identifiers> {
 	const twemoji = TwemojiRegex.exec(parameter)?.[0] ?? null;

src/lib/resolvers/enum.ts

@@ -1,5 +1,5 @@
+import { err, ok, Result } from '@sapphire/result';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 
 export function resolveEnum(
 	parameter: string,

src/lib/resolvers/float.ts

@@ -1,5 +1,5 @@
+import { err, ok, Result } from '@sapphire/result';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 
 export function resolveFloat(
 	parameter: string,

src/lib/resolvers/guildCategoryChannel.ts

@@ -1,7 +1,7 @@
 import { isCategoryChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { CategoryChannel, Guild } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildCategoryChannel(

src/lib/resolvers/guildChannel.ts

@@ -1,8 +1,8 @@
 import { ChannelMentionRegex, SnowflakeRegex } from '@sapphire/discord-utilities';
 import type { GuildBasedChannelTypes } from '@sapphire/discord.js-utilities';
+import { err, ok, Result } from '@sapphire/result';
 import type { Guild, Snowflake } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import { err, ok, Result } from '../parsers/Result';
 
 export function resolveGuildChannel(parameter: string, guild: Guild): Result<GuildBasedChannelTypes, Identifiers.ArgumentGuildChannelError> {
 	const channel = resolveById(parameter, guild) ?? resolveByQuery(parameter, guild);

src/lib/resolvers/guildNewsChannel.ts

@@ -1,7 +1,7 @@
 import { isNewsChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, NewsChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildNewsChannel(

src/lib/resolvers/guildNewsThreadChannel.ts

@@ -1,7 +1,7 @@
 import { isNewsThreadChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, ThreadChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildNewsThreadChannel(

src/lib/resolvers/guildPrivateThreadChannel.ts

@@ -1,7 +1,7 @@
 import { isPrivateThreadChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, ThreadChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildPrivateThreadChannel(

src/lib/resolvers/guildPublicThreadChannel.ts

@@ -1,7 +1,7 @@
 import { isPublicThreadChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, ThreadChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildPublicThreadChannel(

src/lib/resolvers/guildStageVoiceChannel.ts

@@ -1,7 +1,7 @@
 import { isStageChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, StageChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildStageVoiceChannel(

src/lib/resolvers/guildTextChannel.ts

@@ -1,7 +1,7 @@
 import { isTextChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, TextChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildTextChannel(

src/lib/resolvers/guildThreadChannel.ts

@@ -1,7 +1,7 @@
 import { isThreadChannel } from '@sapphire/discord.js-utilities';
+import type { Result } from '@sapphire/result';
 import type { Guild, ThreadChannel } from 'discord.js';
 import { Identifiers } from '../errors/Identifiers';
-import type { Result } from '../parsers/Result';
 import { resolveGuildChannelPredicate } from '../utils/resolvers/resolveGuildChannelPredicate';
 
 export function resolveGuildThreadChannel(