Skip to main content

Updates to Dart style guide

Posted by Bob Nystrom

Just a quick note that I've updated the Dart style guide on The changes mostly reflect practices we've already adopted internally, but it's good to write them down so we can try to be as consistent as possible. While coding style is an eternal holy war, I think most of us agree that having a single style that the community uses makes it easier for all of us to share, reuse, and extend code.

Use ";" for empty constructors. This is required for const constructors. So, to be consistent, we use this for all empty constructors (which are pretty common thanks to initializing formals).

Place the super() call last in initialization lists. Dart lets you put it anywhere, but it always gets invoked after the other fields are initialized. Placing it last makes that visually consistent.

Prefer type annotating public APIs. Most of us seem to naturally do this anyway, so this just codifies that. You don't *have* to type annotate all over the place in Dart, but it seems like many of us feel you get the most value out of the language by using types at your API boundaries.

Do not type annotate locals. Conversely, we don't see a lot of value in annotating local variables. Methods tend to be pretty short in modern code and the type of a local is almost always obvious from the initializer. Also, the editor will now do type inference of locals variables declared using var, so you still get the auto-complete you know and love.

Don't use "double" as a type annotation. It doesn't mean what you think. Use "num". If it was up to me, I would just get rid of the "double" type completely, but avoiding it is the next best thing.

Don't type annotate initializing formals. "Initializing formals" are the "this." thing you can do with constructor parameters to initialize a field. Since the field already likely has a type annotation, it's redundant to have it here too.

Don't annotate function expressions. Function expressions are usually short and their terseness is what's nice about it. Adding unnecessary type annotations just clutters it up. This seems to be what we do in practice anyway.

Name libraries and source files using lowercase_with_underscores. This ensures that they are valid identifiers, which may come in handy if we move to an identifier-based #import syntax.

Clarify spacing of "is !". Our repo has a mixture of "is! Foo" and "is !Foo". The latter wins by about a factor of two, and is also consistent with the other spacing rules.

Constructor initialization list formatting. Existing code is all over the place here and no style seems to make initialization lists particularly beautiful, but at least picking one style makes them consistent.

Spacing for "{", "}" and named arguments (":" and "="). The style guide didn't say how things like empty maps should appear ("{}" or "{ }"). Now it does.

Not exactly a super exciting development in the world of Dart, but I think little stuff like this can help make Dart code easier to work with, and that in turn makes it easier for our community to grow.


Popular posts from this blog

A stronger Dart for everyone

We are constantly asking ourselves:
How do we make developers even more productive when writing Dart apps? We believe that a critical part of the answer to this question is to make strongmode – a sound static type system for Dart – the standard for all Dart developers.

Teams that use Dart to build apps like Soundtrap, AdWords, AdSense, and Greentea say they really enjoy using strong mode features, such as early error detection. In fact, teams that have switched completely to strong mode cite not only early error detection but also better code readability and maintainability as major benefits. We hear this both from small teams and Рeven more so Рfrom large teams with hundreds of developers writing and maintaining millions of lines of Dart code. As Björn Sperber from Soundtrap says,
Strong mode and the smooth integration with IntelliJ is a joy to use and a huge improvement. If you’ve tried out Flutter, you’ve already used strong mode checks from the Dart analyzer.

Given the benefits …

AngularDart 3.0: Easy upgrade, better performance

AngularDart 3.0 is now available. It brings better performance and smaller generated code, while also making you more productive.

Version 3.0 is an evolution: although it has some breaking changes (detailed below), it is a smooth upgrade due to minimal public API adjustments. Most of the progress is under the hood—in code quality, stability, generated code size, performance, and developer experience.

Code quality:
2731 instances of making the framework code more type safe (using sound Dart).The AngularDart framework code size is down by 12%.Many additional style updates to the codebase:Changed to use idiomatic <T> for generic methods.Removed NgZoneImpl, all the code exists in NgZone now.Stability:
Many CSS encapsulation fixes due to update with csslib package.Fixed bugs with IE11.

For the Mail sample app, we see 30% faster time-to-interactive (currently 3812 ms on a simulated 3G connection, measured via Lighthouse).Our large app benchmark shows 2x faster render times of…

AngularDart 4

AngularDart v4 is now available. We've been busy since the release angular2 v3.1.0 in May. Not only did we "drop the 2", but we also improved the compiler and tightened up the framework to give you smaller code, we updated the package structure to improve usability, and we added several new features. Check out the updated documentation to get started.
Just angular Upgrading to v4 will require more than updating your version constraint. The package has changed names (back) to angular – dropping the 2. You'll need to update your pubspec.yaml and the corresponding imports in your code. In most instances, find-and-replace should do the trick. Going forward, the package will be called package:angular. We'll just update the version number.
Smaller code The updated compiler in 4.0 allows type-based optimizations that not only improve runtime performance but generate better code because we are able to strongly type templates. A big result of the update is that many ap…