Skip to content

Commit 3034d65

Browse files
committed
refactor: rename boolean variables to follow Dart naming guidelines
1 parent 132735c commit 3034d65

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+187
-187
lines changed

lib/src/api/common/activity.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ final class Activity {
3636
fn: () => ActivityEmoji(
3737
name: json['name'],
3838
id: json['id'],
39-
animated: json['animated'] ?? false)));
39+
isAnimated: json['animated'] ?? false)));
4040
}
4141
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
final class ActivityEmoji {
22
final String name;
33
final String? id;
4-
final bool animated;
4+
final bool isAnimated;
55

66
ActivityEmoji({
77
required this.name,
88
required this.id,
9-
required this.animated,
9+
required this.isAnimated,
1010
});
1111
}

lib/src/api/common/channel_properties.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ final class ChannelProperties {
1818
final Snowflake? serverId;
1919
final Snowflake? categoryId;
2020
final int? position;
21-
final bool nsfw;
21+
final bool isNsfw;
2222
final Snowflake? lastMessageId;
2323
final int? bitrate;
2424
final int? userLimit;
@@ -51,7 +51,7 @@ final class ChannelProperties {
5151
required this.serverId,
5252
required this.categoryId,
5353
required this.position,
54-
required this.nsfw,
54+
required this.isNsfw,
5555
required this.lastMessageId,
5656
required this.bitrate,
5757
required this.userLimit,
@@ -105,7 +105,7 @@ final class ChannelProperties {
105105
serverId: Snowflake.nullable(element['server_id']),
106106
categoryId: Snowflake.nullable(element['parent_id']),
107107
position: element['position'],
108-
nsfw: element['nsfw'] ?? false,
108+
isNsfw: element['nsfw'] ?? false,
109109
lastMessageId: Snowflake.nullable(element['last_message_id']),
110110
bitrate: element['bitrate'],
111111
userLimit: element['user_limit'],

lib/src/api/common/commands/builder/command_definition_builder.dart

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -79,29 +79,29 @@ final class CommandDefinitionBuilder implements CommandBuilder {
7979
final String name = _extractDefaultValue('option', 'name', element);
8080
final String description =
8181
_extractDefaultValue('option', 'description', element);
82-
final bool required = element['required'] ?? false;
82+
final bool isRequired = element['required'] ?? false;
8383

8484
final option = switch (element['type']) {
8585
final String value when value == 'string' => Option.string(
86-
name: name, description: description, required: required),
86+
name: name, description: description, isRequired: isRequired),
8787
final String value when value == 'integer' => Option.integer(
88-
name: name, description: description, required: required),
88+
name: name, description: description, isRequired: isRequired),
8989
final String value when value == 'double' => Option.double(
90-
name: name, description: description, required: required),
90+
name: name, description: description, isRequired: isRequired),
9191
final String value when value == 'string' => Option.boolean(
92-
name: name, description: description, required: required),
92+
name: name, description: description, isRequired: isRequired),
9393
final String value when value == 'user' =>
94-
Option.user(name: name, description: description, required: required),
94+
Option.user(name: name, description: description, isRequired: isRequired),
9595
final String value when value == 'channel' => Option.channel(
96-
name: name, description: description, required: required),
96+
name: name, description: description, isRequired: isRequired),
9797
final String value when value == 'role' =>
98-
Option.role(name: name, description: description, required: required),
98+
Option.role(name: name, description: description, isRequired: isRequired),
9999
final String value when value == 'mention' => Option.mentionable(
100-
name: name, description: description, required: required),
100+
name: name, description: description, isRequired: isRequired),
101101
final String value when value == 'choice.string' => ChoiceOption.string(
102102
name: name,
103103
description: description,
104-
required: required,
104+
isRequired: isRequired,
105105
choices: List.from(element['choices'] ?? [])
106106
.map((element) =>
107107
Choice<String>(element['name'], element['value']))
@@ -110,15 +110,15 @@ final class CommandDefinitionBuilder implements CommandBuilder {
110110
ChoiceOption.integer(
111111
name: name,
112112
description: description,
113-
required: required,
113+
isRequired: isRequired,
114114
choices: List.from(element['choices'] ?? [])
115115
.map((element) =>
116116
Choice(element['name'], int.parse(element['value'])))
117117
.toList()),
118118
final String value when value == 'choice.double' => ChoiceOption.double(
119119
name: name,
120120
description: description,
121-
required: required,
121+
isRequired: isRequired,
122122
choices: List.from(element['choices'] ?? [])
123123
.map((element) =>
124124
Choice(element['name'], double.parse(element['value'])))

lib/src/api/common/commands/command_choice_option.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,25 +39,25 @@ final class ChoiceOption implements CommandOption {
3939
{required String name,
4040
required String description,
4141
required List<Choice<String>> choices,
42-
bool required = false}) =>
42+
bool isRequired = false}) =>
4343
ChoiceOption._(
44-
name, description, CommandOptionType.string, required, null, choices);
44+
name, description, CommandOptionType.string, isRequired, null, choices);
4545

4646
factory ChoiceOption.integer(
4747
{required String name,
4848
required String description,
4949
required List<Choice<int>> choices,
50-
bool required = false}) =>
51-
ChoiceOption._(name, description, CommandOptionType.integer, required,
50+
bool isRequired = false}) =>
51+
ChoiceOption._(name, description, CommandOptionType.integer, isRequired,
5252
null, choices);
5353

5454
factory ChoiceOption.double(
5555
{required String name,
5656
required String description,
5757
required List<Choice<double>> choices,
58-
bool required = false}) =>
58+
bool isRequired = false}) =>
5959
ChoiceOption._(
60-
name, description, CommandOptionType.double, required, null, choices);
60+
name, description, CommandOptionType.double, isRequired, null, choices);
6161
}
6262

6363
final class Choice<T> {

lib/src/api/common/commands/command_option.dart

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,57 +48,57 @@ final class Option<T> implements CommandOption {
4848
factory Option.string(
4949
{required String name,
5050
required String description,
51-
bool required = false}) =>
52-
Option._(name, description, CommandOptionType.string, null, required);
51+
bool isRequired = false}) =>
52+
Option._(name, description, CommandOptionType.string, null, isRequired);
5353

5454
factory Option.integer(
5555
{required String name,
5656
required String description,
57-
bool required = false}) =>
58-
Option._(name, description, CommandOptionType.integer, null, required);
57+
bool isRequired = false}) =>
58+
Option._(name, description, CommandOptionType.integer, null, isRequired);
5959

6060
factory Option.double(
6161
{required String name,
6262
required String description,
63-
bool required = false}) =>
64-
Option._(name, description, CommandOptionType.double, null, required);
63+
bool isRequired = false}) =>
64+
Option._(name, description, CommandOptionType.double, null, isRequired);
6565

6666
factory Option.boolean(
6767
{required String name,
6868
required String description,
69-
bool required = false}) =>
70-
Option._(name, description, CommandOptionType.boolean, null, required);
69+
bool isRequired = false}) =>
70+
Option._(name, description, CommandOptionType.boolean, null, isRequired);
7171

7272
factory Option.user(
7373
{required String name,
7474
required String description,
75-
bool required = false}) =>
76-
Option._(name, description, CommandOptionType.user, null, required);
75+
bool isRequired = false}) =>
76+
Option._(name, description, CommandOptionType.user, null, isRequired);
7777

7878
factory Option.channel(
7979
{required String name,
8080
required String description,
8181
List<ChannelType> channels = const [],
82-
bool required = false}) =>
82+
bool isRequired = false}) =>
8383
Option._(
84-
name, description, CommandOptionType.channel, channels, required);
84+
name, description, CommandOptionType.channel, channels, isRequired);
8585

8686
factory Option.role(
8787
{required String name,
8888
required String description,
89-
bool required = false}) =>
90-
Option._(name, description, CommandOptionType.role, null, required);
89+
bool isRequired = false}) =>
90+
Option._(name, description, CommandOptionType.role, null, isRequired);
9191

9292
factory Option.mentionable(
9393
{required String name,
9494
required String description,
95-
bool required = false}) =>
95+
bool isRequired = false}) =>
9696
Option._(
97-
name, description, CommandOptionType.mentionable, null, required);
97+
name, description, CommandOptionType.mentionable, null, isRequired);
9898

9999
factory Option.attachment(
100100
{required String name,
101101
required String description,
102-
bool required = false}) =>
103-
Option._(name, description, CommandOptionType.attachment, null, required);
102+
bool isRequired = false}) =>
103+
Option._(name, description, CommandOptionType.attachment, null, isRequired);
104104
}

lib/src/api/common/components/builder/message_builder.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,13 +393,13 @@ final class MessageBuilder {
393393
/// ```
394394
///
395395
/// Parameters:
396-
/// - [show]: Whether to display the separator line (default: true)
396+
/// - [isDividerVisible]: Whether to display the separator line (default: true)
397397
/// - [spacing]: The amount of vertical space (default: [SeparatorSize.small])
398398
void addSeparator({
399-
bool show = true,
399+
bool isDividerVisible = true,
400400
SeparatorSize spacing = SeparatorSize.small,
401401
}) {
402-
_components.add(Separator(show, spacing));
402+
_components.add(Separator(isDividerVisible, spacing));
403403
}
404404

405405
/// Adds text content to the message.

lib/src/api/common/components/button.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ final class Button implements MessageComponent {
2020
final String? _label;
2121
final String? _url;
2222
final PartialEmoji? _emoji;
23-
final bool _disabled;
23+
final bool _isDisabled;
2424

2525
Button(
2626
{required ButtonType type,
@@ -34,7 +34,7 @@ final class Button implements MessageComponent {
3434
_label = label,
3535
_url = url,
3636
_emoji = emoji,
37-
_disabled = disabled ?? false;
37+
_isDisabled = disabled ?? false;
3838

3939
factory Button.primary(String customId,
4040
{String? label, PartialEmoji? emoji, bool? disabled}) =>
@@ -98,12 +98,12 @@ final class Button implements MessageComponent {
9898
'style': _type.value,
9999
if (_url != null) 'url': _url,
100100
if (_label != null) 'label': _label,
101-
if (_disabled) 'disabled': _disabled,
101+
if (_isDisabled) 'disabled': _isDisabled,
102102
if (_emoji != null)
103103
'emoji': {
104104
'name': _emoji.name,
105105
'id': _emoji.id,
106-
'animated': _emoji.animated,
106+
'animated': _emoji.isAnimated,
107107
},
108108
};
109109
}

lib/src/api/common/components/select_menu.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ final class SelectMenu<T> implements MessageComponent, ModalComponent {
99
int? _maxLength;
1010
int? _minValues;
1111
int? _maxValues;
12-
bool? _disabled;
12+
bool? _isDisabled;
1313

1414
final List<SelectMenuOption<T>> _options;
1515
final List<Snowflake> _defaultValues;
@@ -30,7 +30,7 @@ final class SelectMenu<T> implements MessageComponent, ModalComponent {
3030
_maxLength = maxLength,
3131
_minValues = minValues,
3232
_maxValues = maxValues,
33-
_disabled = disabled,
33+
_isDisabled = disabled,
3434
_options = options ?? [],
3535
_defaultValues = defaultValues ?? [],
3636
_channelTypes = channelTypes ?? [];
@@ -118,7 +118,7 @@ final class SelectMenu<T> implements MessageComponent, ModalComponent {
118118
'type': _type.value,
119119
'custom_id': _customId,
120120
'placeholder': _placeholder,
121-
'disabled': _disabled,
121+
'disabled': _isDisabled,
122122
if (_minValues != null) 'min_values': _minValues,
123123
if (_maxValues != null) 'max_values': _maxValues,
124124
if (_minLength != null) 'min_length': _minLength,
@@ -166,7 +166,7 @@ final class SelectMenuOption<T> {
166166
'emoji': {
167167
'name': emoji?.name,
168168
'id': emoji?.id,
169-
'animated': emoji?.animated,
169+
'animated': emoji?.isAnimated,
170170
},
171171
'default': isDefault,
172172
};

lib/src/api/common/components/separator.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ enum SeparatorSize {
1111
final class Separator implements MessageComponent {
1212
ComponentType get type => ComponentType.separator;
1313

14-
final bool _show;
14+
final bool _isDividerVisible;
1515
final SeparatorSize _spacing;
1616

17-
Separator(this._show, this._spacing);
17+
Separator(this._isDividerVisible, this._spacing);
1818

1919
@override
2020
Map<String, dynamic> toJson() {
2121
return {
2222
'type': type.value,
23-
'divider': _show,
23+
'divider': _isDividerVisible,
2424
'spacing': _spacing.value,
2525
};
2626
}

0 commit comments

Comments
 (0)