Skip to content

Commit e3c76a5

Browse files
authored
Dart lints (google#6808)
* Dart - add analysis options with the recommended lints * Dart - generate code without linter issues * Dart - remove linter issues in example and test code * Dart - remove linter issues in lib code * Dart - update generate code in /tests/
1 parent 4b9123b commit e3c76a5

20 files changed

+560
-581
lines changed

dart/analysis_options.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include: package:lints/recommended.yaml

dart/example/example.dart

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
*/
1616

1717
import 'package:flat_buffers/flat_buffers.dart' as fb;
18-
import './monster_my_game.sample_generated.dart' as myGame;
18+
import './monster_my_game.sample_generated.dart' as my_game;
1919

2020
// Example how to use FlatBuffers to create and read binary buffers.
2121

@@ -25,20 +25,20 @@ void main() {
2525
}
2626

2727
void builderTest() {
28-
final builder = new fb.Builder(initialSize: 1024);
28+
final builder = fb.Builder(initialSize: 1024);
2929
final int? weaponOneName = builder.writeString("Sword");
3030
final int weaponOneDamage = 3;
3131

3232
final int? weaponTwoName = builder.writeString("Axe");
3333
final int weaponTwoDamage = 5;
3434

35-
final swordBuilder = new myGame.WeaponBuilder(builder)
35+
final swordBuilder = my_game.WeaponBuilder(builder)
3636
..begin()
3737
..addNameOffset(weaponOneName)
3838
..addDamage(weaponOneDamage);
3939
final int sword = swordBuilder.finish();
4040

41-
final axeBuilder = new myGame.WeaponBuilder(builder)
41+
final axeBuilder = my_game.WeaponBuilder(builder)
4242
..begin()
4343
..addNameOffset(weaponTwoName)
4444
..addDamage(weaponTwoDamage);
@@ -54,25 +54,25 @@ void builderTest() {
5454
final weapons = builder.writeList([sword, axe]);
5555

5656
// Struct builders are very easy to reuse.
57-
final vec3Builder = new myGame.Vec3Builder(builder);
57+
final vec3Builder = my_game.Vec3Builder(builder);
5858

5959
vec3Builder.finish(4.0, 5.0, 6.0);
6060
vec3Builder.finish(1.0, 2.0, 3.0);
6161
// Set his hit points to 300 and his mana to 150.
6262
final int hp = 300;
6363
final int mana = 150;
6464

65-
final monster = new myGame.MonsterBuilder(builder)
65+
final monster = my_game.MonsterBuilder(builder)
6666
..begin()
6767
..addNameOffset(name)
6868
..addInventoryOffset(inventory)
6969
..addWeaponsOffset(weapons)
70-
..addEquippedType(myGame.EquipmentTypeId.Weapon)
70+
..addEquippedType(my_game.EquipmentTypeId.Weapon)
7171
..addEquippedOffset(axe)
7272
..addHp(hp)
7373
..addMana(mana)
7474
..addPos(vec3Builder.finish(1.0, 2.0, 3.0))
75-
..addColor(myGame.Color.Red);
75+
..addColor(my_game.Color.Red);
7676

7777
final int monsteroff = monster.finish();
7878
builder.finish(monsteroff);
@@ -85,17 +85,17 @@ void builderTest() {
8585
void objectBuilderTest() {
8686
// Create the builder here so we can use it for both weapons and equipped
8787
// the actual data will only be written to the buffer once.
88-
var axe = new myGame.WeaponObjectBuilder(name: 'Axe', damage: 5);
88+
var axe = my_game.WeaponObjectBuilder(name: 'Axe', damage: 5);
8989

90-
var monsterBuilder = new myGame.MonsterObjectBuilder(
91-
pos: new myGame.Vec3ObjectBuilder(x: 1.0, y: 2.0, z: 3.0),
90+
var monsterBuilder = my_game.MonsterObjectBuilder(
91+
pos: my_game.Vec3ObjectBuilder(x: 1.0, y: 2.0, z: 3.0),
9292
mana: 150,
9393
hp: 300,
9494
name: 'Orc',
9595
inventory: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
96-
color: myGame.Color.Red,
97-
weapons: [new myGame.WeaponObjectBuilder(name: 'Sword', damage: 3), axe],
98-
equippedType: myGame.EquipmentTypeId.Weapon,
96+
color: my_game.Color.Red,
97+
weapons: [my_game.WeaponObjectBuilder(name: 'Sword', damage: 3), axe],
98+
equippedType: my_game.EquipmentTypeId.Weapon,
9999
equipped: axe,
100100
);
101101

@@ -114,7 +114,7 @@ void objectBuilderTest() {
114114

115115
bool verify(List<int> buffer) {
116116
// Get access to the root:
117-
var monster = new myGame.Monster(buffer);
117+
var monster = my_game.Monster(buffer);
118118

119119
// Get and test some scalar types from the FlatBuffer.
120120
assert(monster.hp == 80);
@@ -131,20 +131,20 @@ bool verify(List<int> buffer) {
131131
assert(inv[9] == 9);
132132

133133
// Get and test the `weapons` FlatBuffers's `vector`.
134-
var expected_weapon_names = ["Sword", "Axe"];
135-
var expected_weapon_damages = [3, 5];
134+
var expectedWeaponNames = ["Sword", "Axe"];
135+
var expectedWeaponDamages = [3, 5];
136136
var weps = monster.weapons!;
137137
for (int i = 0; i < weps.length; i++) {
138-
assert(weps[i].name == expected_weapon_names[i]);
139-
assert(weps[i].damage == expected_weapon_damages[i]);
138+
assert(weps[i].name == expectedWeaponNames[i]);
139+
assert(weps[i].damage == expectedWeaponDamages[i]);
140140
}
141141

142142
// Get and test the `Equipment` union (`equipped` field).
143-
assert(monster.equippedType!.value == myGame.EquipmentTypeId.Weapon.value);
144-
assert(monster.equippedType == myGame.EquipmentTypeId.Weapon);
143+
assert(monster.equippedType!.value == my_game.EquipmentTypeId.Weapon.value);
144+
assert(monster.equippedType == my_game.EquipmentTypeId.Weapon);
145145

146-
assert(monster.equipped is myGame.Weapon);
147-
var equipped = monster.equipped as myGame.Weapon;
146+
assert(monster.equipped is my_game.Weapon);
147+
var equipped = monster.equipped as my_game.Weapon;
148148
assert(equipped.name == "Axe");
149149
assert(equipped.damage == 5);
150150

dart/example/monster_my_game.sample_generated.dart

Lines changed: 32 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class Color {
1414
factory Color.fromValue(int value) {
1515
final result = values[value];
1616
if (result == null) {
17-
throw new StateError('Invalid value $value for bit flag enum Color');
17+
throw StateError('Invalid value $value for bit flag enum Color');
1818
}
1919
return result;
2020
}
@@ -26,15 +26,15 @@ class Color {
2626
static const int maxValue = 2;
2727
static bool containsValue(int value) => values.containsKey(value);
2828

29-
static const Color Red = const Color._(0);
30-
static const Color Green = const Color._(1);
31-
static const Color Blue = const Color._(2);
29+
static const Color Red = Color._(0);
30+
static const Color Green = Color._(1);
31+
static const Color Blue = Color._(2);
3232
static const Map<int, Color> values = {
3333
0: Red,
3434
1: Green,
3535
2: Blue};
3636

37-
static const fb.Reader<Color> reader = const _ColorReader();
37+
static const fb.Reader<Color> reader = _ColorReader();
3838

3939
@override
4040
String toString() {
@@ -50,7 +50,7 @@ class _ColorReader extends fb.Reader<Color> {
5050

5151
@override
5252
Color read(fb.BufferContext bc, int offset) =>
53-
new Color.fromValue(const fb.Int8Reader().read(bc, offset));
53+
Color.fromValue(const fb.Int8Reader().read(bc, offset));
5454
}
5555

5656
class EquipmentTypeId {
@@ -60,7 +60,7 @@ class EquipmentTypeId {
6060
factory EquipmentTypeId.fromValue(int value) {
6161
final result = values[value];
6262
if (result == null) {
63-
throw new StateError('Invalid value $value for bit flag enum EquipmentTypeId');
63+
throw StateError('Invalid value $value for bit flag enum EquipmentTypeId');
6464
}
6565
return result;
6666
}
@@ -72,13 +72,13 @@ class EquipmentTypeId {
7272
static const int maxValue = 1;
7373
static bool containsValue(int value) => values.containsKey(value);
7474

75-
static const EquipmentTypeId NONE = const EquipmentTypeId._(0);
76-
static const EquipmentTypeId Weapon = const EquipmentTypeId._(1);
75+
static const EquipmentTypeId NONE = EquipmentTypeId._(0);
76+
static const EquipmentTypeId Weapon = EquipmentTypeId._(1);
7777
static const Map<int, EquipmentTypeId> values = {
7878
0: NONE,
7979
1: Weapon};
8080

81-
static const fb.Reader<EquipmentTypeId> reader = const _EquipmentTypeIdReader();
81+
static const fb.Reader<EquipmentTypeId> reader = _EquipmentTypeIdReader();
8282

8383
@override
8484
String toString() {
@@ -94,13 +94,13 @@ class _EquipmentTypeIdReader extends fb.Reader<EquipmentTypeId> {
9494

9595
@override
9696
EquipmentTypeId read(fb.BufferContext bc, int offset) =>
97-
new EquipmentTypeId.fromValue(const fb.Uint8Reader().read(bc, offset));
97+
EquipmentTypeId.fromValue(const fb.Uint8Reader().read(bc, offset));
9898
}
9999

100100
class Vec3 {
101101
Vec3._(this._bc, this._bcOffset);
102102

103-
static const fb.Reader<Vec3> reader = const _Vec3Reader();
103+
static const fb.Reader<Vec3> reader = _Vec3Reader();
104104

105105
final fb.BufferContext _bc;
106106
final int _bcOffset;
@@ -123,11 +123,11 @@ class _Vec3Reader extends fb.StructReader<Vec3> {
123123

124124
@override
125125
Vec3 createObject(fb.BufferContext bc, int offset) =>
126-
new Vec3._(bc, offset);
126+
Vec3._(bc, offset);
127127
}
128128

129129
class Vec3Builder {
130-
Vec3Builder(this.fbBuilder) {}
130+
Vec3Builder(this.fbBuilder);
131131

132132
final fb.Builder fbBuilder;
133133

@@ -166,20 +166,19 @@ class Vec3ObjectBuilder extends fb.ObjectBuilder {
166166
/// Convenience method to serialize to byte list.
167167
@override
168168
Uint8List toBytes([String? fileIdentifier]) {
169-
fb.Builder fbBuilder = new fb.Builder(deduplicateTables: false);
170-
int offset = finish(fbBuilder);
171-
fbBuilder.finish(offset, fileIdentifier);
169+
final fbBuilder = fb.Builder(deduplicateTables: false);
170+
fbBuilder.finish(finish(fbBuilder), fileIdentifier);
172171
return fbBuilder.buffer;
173172
}
174173
}
175174
class Monster {
176175
Monster._(this._bc, this._bcOffset);
177176
factory Monster(List<int> bytes) {
178-
fb.BufferContext rootRef = new fb.BufferContext.fromBytes(bytes);
177+
final rootRef = fb.BufferContext.fromBytes(bytes);
179178
return reader.read(rootRef, 0);
180179
}
181180

182-
static const fb.Reader<Monster> reader = const _MonsterReader();
181+
static const fb.Reader<Monster> reader = _MonsterReader();
183182

184183
final fb.BufferContext _bc;
185184
final int _bcOffset;
@@ -188,11 +187,11 @@ class Monster {
188187
int get mana => const fb.Int16Reader().vTableGet(_bc, _bcOffset, 6, 150);
189188
int get hp => const fb.Int16Reader().vTableGet(_bc, _bcOffset, 8, 100);
190189
String? get name => const fb.StringReader().vTableGetNullable(_bc, _bcOffset, 10);
191-
List<int>? get inventory => const fb.ListReader<int>(const fb.Uint8Reader()).vTableGetNullable(_bc, _bcOffset, 14);
190+
List<int>? get inventory => const fb.ListReader<int>(fb.Uint8Reader()).vTableGetNullable(_bc, _bcOffset, 14);
192191
Color get color => Color.fromValue(const fb.Int8Reader().vTableGet(_bc, _bcOffset, 16, 2));
193192
List<Weapon>? get weapons => const fb.ListReader<Weapon>(Weapon.reader).vTableGetNullable(_bc, _bcOffset, 18);
194193
EquipmentTypeId? get equippedType => EquipmentTypeId._createOrNull(const fb.Uint8Reader().vTableGetNullable(_bc, _bcOffset, 20));
195-
dynamic? get equipped {
194+
dynamic get equipped {
196195
switch (equippedType?.value) {
197196
case 1: return Weapon.reader.vTableGetNullable(_bc, _bcOffset, 22);
198197
default: return null;
@@ -211,11 +210,11 @@ class _MonsterReader extends fb.TableReader<Monster> {
211210

212211
@override
213212
Monster createObject(fb.BufferContext bc, int offset) =>
214-
new Monster._(bc, offset);
213+
Monster._(bc, offset);
215214
}
216215

217216
class MonsterBuilder {
218-
MonsterBuilder(this.fbBuilder) {}
217+
MonsterBuilder(this.fbBuilder);
219218

220219
final fb.Builder fbBuilder;
221220

@@ -278,7 +277,7 @@ class MonsterObjectBuilder extends fb.ObjectBuilder {
278277
final Color? _color;
279278
final List<WeaponObjectBuilder>? _weapons;
280279
final EquipmentTypeId? _equippedType;
281-
final dynamic? _equipped;
280+
final dynamic _equipped;
282281
final List<Vec3ObjectBuilder>? _path;
283282

284283
MonsterObjectBuilder({
@@ -290,7 +289,7 @@ class MonsterObjectBuilder extends fb.ObjectBuilder {
290289
Color? color,
291290
List<WeaponObjectBuilder>? weapons,
292291
EquipmentTypeId? equippedType,
293-
dynamic? equipped,
292+
dynamic equipped,
294293
List<Vec3ObjectBuilder>? path,
295294
})
296295
: _pos = pos,
@@ -335,20 +334,19 @@ class MonsterObjectBuilder extends fb.ObjectBuilder {
335334
/// Convenience method to serialize to byte list.
336335
@override
337336
Uint8List toBytes([String? fileIdentifier]) {
338-
fb.Builder fbBuilder = new fb.Builder(deduplicateTables: false);
339-
int offset = finish(fbBuilder);
340-
fbBuilder.finish(offset, fileIdentifier);
337+
final fbBuilder = fb.Builder(deduplicateTables: false);
338+
fbBuilder.finish(finish(fbBuilder), fileIdentifier);
341339
return fbBuilder.buffer;
342340
}
343341
}
344342
class Weapon {
345343
Weapon._(this._bc, this._bcOffset);
346344
factory Weapon(List<int> bytes) {
347-
fb.BufferContext rootRef = new fb.BufferContext.fromBytes(bytes);
345+
final rootRef = fb.BufferContext.fromBytes(bytes);
348346
return reader.read(rootRef, 0);
349347
}
350348

351-
static const fb.Reader<Weapon> reader = const _WeaponReader();
349+
static const fb.Reader<Weapon> reader = _WeaponReader();
352350

353351
final fb.BufferContext _bc;
354352
final int _bcOffset;
@@ -367,11 +365,11 @@ class _WeaponReader extends fb.TableReader<Weapon> {
367365

368366
@override
369367
Weapon createObject(fb.BufferContext bc, int offset) =>
370-
new Weapon._(bc, offset);
368+
Weapon._(bc, offset);
371369
}
372370

373371
class WeaponBuilder {
374-
WeaponBuilder(this.fbBuilder) {}
372+
WeaponBuilder(this.fbBuilder);
375373

376374
final fb.Builder fbBuilder;
377375

@@ -418,9 +416,8 @@ class WeaponObjectBuilder extends fb.ObjectBuilder {
418416
/// Convenience method to serialize to byte list.
419417
@override
420418
Uint8List toBytes([String? fileIdentifier]) {
421-
fb.Builder fbBuilder = new fb.Builder(deduplicateTables: false);
422-
int offset = finish(fbBuilder);
423-
fbBuilder.finish(offset, fileIdentifier);
419+
final fbBuilder = fb.Builder(deduplicateTables: false);
420+
fbBuilder.finish(finish(fbBuilder), fileIdentifier);
424421
return fbBuilder.buffer;
425422
}
426423
}

0 commit comments

Comments
 (0)