Dart pub
This repository provides a plugin for the protoc compiler. It generates Dart files for working with data in protocol buffers format.
We only support the full proto2 schema. Proto3 should work due to backwards compatibility. See this issue list for proto3 schema features which are currently missing.
To compile a .proto file, you must use the 'protoc' command which is installed separately. Protobuf 3.0.0 or above is required.
The generated files are pure Dart code that run in either in the Dart VM or in a browser (using dart2js). They depend the protobuf Dart package. A Dart project that includes generated files should add "protobuf" to its pubspec.yaml file.
Note: currently the workflow is POSIX-oriented.
To build standalone protoc plugin:
pub install to install all dependenciesbin directory to your PATH,
or passing it directly with protoc's --plugin option.Please, remember that the plugin is pure Dart script and requires the presence
of dart executable in your PATH.
When both the dart executable and bin/protoc-gen-dart are in the
PATH the protocol buffer compiler can be invoked to generate like this:
$ protoc --dart_out=. test.proto
pub global$ pub global activate protoc_plugin
And then add .pub-cache/bin in your home dir to your PATH if you haven't already.
This will activate the latest published version of the plugin. If you wish to use a local working copy, use
$ pub global activate -s path <path/to/your/dart-protoc-plugin>
The protocol buffer compiler accepts options for each plugin. For the
Dart plugin, these options are passed together with the --dart_out
option. The individial options are separated using comma, and the
final output directive is separated from the options using colon. Pass
options <option 1> and <option 2> like this:
--dart_out="<option 1>,<option 2>:."
The protocol buffer compiler produces several files for each .proto file
it compiles. In some cases this is not exactly what is needed, e.g one
would like to create new libraries which exposes the objects in these
libraries or create new librares combining object definitions from
several .proto libraries into one.
The best way to aproach this is to create the new libraries needed and re-export the relevant protocol buffer classes.
Say we have the file m1.proto with the following content
message M1 {
optional string a;
}
and m2.proto containing
message M2 {
optional string b;
}
Compiling these to Dart will produce two libraries in m1.pb.dart and
m2.pb.dart. The following code shows a library M which combines
these two protocol buffer libraries, exposes the classes M1 and M2 and
adds som additional methods.
library M;
import "m1.pb.dart";
import "m2.pb.dart";
export "m1.pb.dart" show M1;
export "m2.pb.dart" show M2;
M1 createM1() => new M1();
M2 createM2() => new M2();
Here are some ways to get protoc:
apt-get install protobuf-compilerbrew install protobufIf the version installed this way doesn't work, an alternative is to compile protoc from source.
Remember to run the tests. That is as easy as make run-tests.
Breaking change: Handle identifiers starting with a leading underscore. This covers message names, enum names, enum value identifiers and file names.
Before, these would appear in the generated Dart code as private identifiers. Now the underscore is moved to the end.
Field names and extension field names already had all underscores removed, and these are not affected by this change.
If there is a conflicting name with a trailing underscore defined later in the same scope, a disambiguation will happen that can potentially lead to existing identifiers getting a new name in the generated Dart.
For example:
message _Foo {}
message Foo_ {}
_Foo will get the name Foo_ and Foo_ will now end up being called Foo__.
Breaking change: Support for map fields Generated files require package:protobuf version 0.10.5 or newer. Protobuf map fields such as:
message Foo { map<int32, string> map_field = 1; } are now no longer represented as List<Foo_MapFieldEntry> but as Map<int, String>.
All code handling these fields needs to be updated.
dart:async with a prefix to prevent name
collisions.BuilderInfo.qualifiedMessageName.
Requires package:protobuf version 0.10.4 or newer.as check of enum valueOf by using correctly typed Map of
values.
Generated files must require package:protobuf version 0.10.3 or newer.BuilderInfo.messageName will now be the fully qualified name for generated messages.copyWith() to message classes and update getDefault() to use freeze().
Requires package:protobuf version 0.10.0 or newer.pub global usage. Protoc plugin can now be installed by running pub global activate protoc_plugin.Function will soon be a reserved keyword, so don't generate classes with that name.dart_name option.This release requires 0.5.0 of the protobuf library.
This release changes how getters work for message fields, to detect a common mistake.
Previously, the protobuf API didn't report any error for an incorrect usage of setters. For example, if field "foo" is a message field of type Foo, this code would silently have no effect:
var msg = new SomeMessage(); msg.foo.bar = 123; This is because "msg.foo" would call "new Foo()" and return it without saving it.
The example can be fixed like this:
var msg = new SomeMessage(); msg.foo = new Foo(); msg.foo.bar = 123; Or equivalently:
var msg = new SomeMessage() ..foo = (new Foo()..bar = 123); Starting in 0.4.0, the default value of "msg.foo" is an immutable instance of Foo. You can read the default value of a field the same as before, but writes will throw UnsupportedError.
For now, new mixins can only be added using a patch:
This new API is subject to change without notice, but if you want to try it out anyway, see the unit test.
The 0.3.6 version of the dart-protobuf library added two new functions, so this release changes the protobuf compiler to avoid using them.
Protobuf changes for smaller dart2js code, Int64 fixes
This change is paired with https://chromiumcodereview.appspot.com/814213003
Reduces code size for one app by 0.9%
Parameterize uri resolution and parsing of options, use package:path.
This helps make the compiler more configurable to embed it in other systems (like pub transformers)
Update the version number
You can install the package from the command line:
$ pub global activate protoc_plugin
The package has the following executables:
$ protoc-gen-dart
Add this to your package's pubspec.yaml file:
dependencies:
protoc_plugin: ^12.0.0
You can install packages from the command line:
with pub:
$ pub get
with Flutter:
$ flutter packages get
Alternatively, your editor might support pub get or flutter packages get.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:protoc_plugin/base_type.dart';
import 'package:protoc_plugin/bazel.dart';
import 'package:protoc_plugin/client_generator.dart';
import 'package:protoc_plugin/code_generator.dart';
import 'package:protoc_plugin/const_generator.dart';
import 'package:protoc_plugin/enum_generator.dart';
import 'package:protoc_plugin/extension_generator.dart';
import 'package:protoc_plugin/file_generator.dart';
import 'package:protoc_plugin/grpc_generator.dart';
import 'package:protoc_plugin/indenting_writer.dart';
import 'package:protoc_plugin/linker.dart';
import 'package:protoc_plugin/message_generator.dart';
import 'package:protoc_plugin/names.dart';
import 'package:protoc_plugin/options.dart';
import 'package:protoc_plugin/output_config.dart';
import 'package:protoc_plugin/protobuf_field.dart';
import 'package:protoc_plugin/protoc.dart';
import 'package:protoc_plugin/service_generator.dart';
import 'package:protoc_plugin/testing/mixins.dart';
| Version | Uploaded | Documentation | Archive |
|---|---|---|---|
| 12.0.0 | Dec 6, 2018 |
|
|
| 11.0.0 | Dec 4, 2018 |
|
|
| 0.10.5 | Oct 11, 2018 |
|
|
| 0.10.4 | Oct 2, 2018 |
|
|
| 0.10.3 | Sep 25, 2018 |
|
|
| 0.10.2 | Sep 7, 2018 |
|
|
| 0.10.1 | Sep 6, 2018 |
|
|
| 0.10.0 | Aug 31, 2018 |
|
|
| 0.9.0 | Aug 30, 2018 |
|
|
| 0.8.2 | Aug 28, 2018 |
|
|
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
77
|
|
Health:
Code health derived from static analysis.
[more]
|
94
|
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
70
|
|
Overall:
Weighted score of the above.
[more]
|
81
|
We analyzed this package on Dec 6, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: Flutter, other
Platform components identified in package:
io.
Fix lib/src/descriptor.pbenum.dart. (-2.96 points)
Analysis of lib/src/descriptor.pbenum.dart reported 6 hints, including:
line 11 col 7: Name types using UpperCamelCase.
line 82 col 7: Name types using UpperCamelCase.
line 108 col 7: Name types using UpperCamelCase.
line 134 col 7: Name types using UpperCamelCase.
line 157 col 7: Name types using UpperCamelCase.
Fix lib/src/descriptor.pb.dart. (-2.48 points)
Analysis of lib/src/descriptor.pb.dart reported 5 hints:
line 148 col 7: Name types using UpperCamelCase.
line 199 col 7: Name types using UpperCamelCase.
line 1320 col 7: Name types using UpperCamelCase.
line 1460 col 7: Name types using UpperCamelCase.
line 1548 col 7: Name types using UpperCamelCase.
Fix lib/src/dart_options.pb.dart. (-0.50 points)
Analysis of lib/src/dart_options.pb.dart reported 1 hint:
line 93 col 7: Name types using UpperCamelCase.
Fix lib/src/plugin.pb.dart. (-0.50 points)
Analysis of lib/src/plugin.pb.dart reported 1 hint:
line 129 col 7: Name types using UpperCamelCase.
The description is too short. (-20 points)
Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.
Maintain an example. (-10 points)
Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use protoc_plugin.dart.
| Package | Constraint | Resolved | Available |
|---|---|---|---|
| Direct dependencies | |||
| Dart SDK | >=2.0.0 <3.0.0 | ||
| dart_style | ^1.0.6 | 1.2.1 | |
| fixnum | ^0.10.5 | 0.10.9 | |
| path | ^1.0.0 | 1.6.2 | |
| protobuf | ^0.10.5 | 0.10.5 | |
| Transitive dependencies | |||
| analyzer | 0.34.0 | ||
| args | 1.5.1 | ||
| async | 2.0.8 | ||
| charcode | 1.1.2 | ||
| collection | 1.14.11 | ||
| convert | 2.0.2 | ||
| crypto | 2.0.6 | ||
| csslib | 0.14.6 | ||
| front_end | 0.1.7 | ||
| html | 0.13.3+3 | ||
| kernel | 0.3.7 | ||
| logging | 0.11.3+2 | ||
| meta | 1.1.6 | ||
| package_config | 1.0.5 | ||
| plugin | 0.2.0+3 | ||
| pub_semver | 1.4.2 | ||
| source_span | 1.4.1 | ||
| string_scanner | 1.0.4 | ||
| typed_data | 1.1.6 | ||
| utf | 0.9.0+5 | ||
| watcher | 0.9.7+10 | ||
| Dev dependencies | |||
| build | ^1.0.0 | ||
| build_runner | ^1.0.0 | ||
| build_web_compilers | ^0.4.0 | ||
| glob | ^1.1.7 | 1.1.7 | |
| test | ^1.3.0 | ||
| yaml | ^2.1.15 | 2.1.15 | |