chore(SlashCommandBuilder): improve message when missing required params

[wwselleck]

When you try to call toJSON on a SlashCommandBuilder that has not had a name or description set, or has any options that are missing a name or description, you get the following error:

.../node_modules/@sapphire/shapeshift/src/validators/StringValidator.ts:73
                return this.ip(6);
                  ^
Error: Expected a string primitive
    at StringValidator.handle (.../node_modules/@sapphire/shapeshift/src/validators/StringValidator.ts:73:19)

In my opinion, this error message is a bit cryptic and makes it difficult to figure out what the issue is. This PR adds explicit checks for missing command/options names/descriptions, and throws a more useful error message.

Status and versioning classification:

• This PR changes the library's interface (methods or parameters added)
  • It changes the type of error that is thrown by SlashCommandBuilder::toJSON
• This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
  • If any dependents are making checks against the error thrown by SlashCommandBuilder::toJSON, this PR would break that

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
discord-js	⬜️ Ignored (Inspect)			Apr 28, 2023 11:20pm
discord-js-guide	⬜️ Ignored (Inspect)			Apr 28, 2023 11:20pm

[wwselleck]

name and description are casted as non-undefined on SlashCommandBuilder, but I figure they should be treated as potentially undefined wherever they can be, since they can be undefined.

[codecov]

Codecov Report

Merging #9468 (f8fdd34) into main (77191a2) will increase coverage by 0.02%.
The diff coverage is 93.33%.

@@            Coverage Diff             @@
##             main    #9468      +/-   ##
==========================================
+ Coverage   59.29%   59.31%   +0.02%     
==========================================
  Files         223      223              
  Lines       14633    14646      +13     
  Branches     1258     1263       +5     
==========================================
+ Hits         8676     8688      +12     
- Misses       5917     5918       +1     
  Partials       40       40              

Flag	Coverage Δ
builders	98.55% <93.33%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...lders/src/interactions/slashCommands/Assertions.ts	97.34% <93.33%> (-0.66%)	⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[kyranet]

You don't need to create this (and make the function return non-shapeshift errors), you can use the MissingPropertyError error class from @sapphire/shapeshift, which is exported.

Using the aforementioned class:

import { MissingPropertyError } from '@sapphire/shapeshift';

throw new MissingPropertyError('name');