protod 0.0.4

  • Readme
  • Changelog
  • Installing
  • new34

Protocol Buffer Deltas #


Go / Dart package to describe a change to a GeneratedMessage.

See groupshare for reference implementation.

v0.0.1 #

First release. Experimental code!

v0.0.2 #


v0.0.3 #


v0.0.4 #

Types for map keys, generating all scalar type variations.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  protod: ^0.0.4

2. Install it

You can install packages from the command line:

with pub:

$ pub get

with Flutter:

$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:protod/any.pb.dart';
import 'package:protod/any.pbenum.dart';
import 'package:protod/any.pbjson.dart';
import 'package:protod/any.pbserver.dart';
import 'package:protod/delta.dart';
import 'package:protod/delta.pb.dart';
import 'package:protod/delta.pbenum.dart';
import 'package:protod/delta.pbjson.dart';
import 'package:protod/delta.pbserver.dart';
import 'package:protod/delta.types.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on May 30, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.2
  • pana: 0.13.8-dev

Health issues and suggestions

Document public APIs. (-0.05 points)

647 out of 669 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/delta.pbjson.dart. (-23.33 points)

Analysis of lib/delta.pbjson.dart reported 53 hints, including:

line 8 col 20: Avoid const keyword.

line 10 col 8: Avoid const keyword.

line 11 col 5: Avoid const keyword.

line 12 col 5: Avoid const keyword.

line 13 col 5: Avoid const keyword.

Fix lib/any.pbjson.dart. (-1.99 points)

Analysis of lib/any.pbjson.dart reported 4 hints:

line 8 col 18: Avoid const keyword.

line 10 col 8: Avoid const keyword.

line 11 col 5: Avoid const keyword.

line 12 col 5: Avoid const keyword.

Fix lib/delta.dart. (-0.50 points)

Analysis of lib/delta.dart reported 1 hint:

line 200 col 11: Unnecessary new keyword.

Fix additional 7 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/any.pb.dart (Run dartfmt to format lib/any.pb.dart.)
  • lib/any.pbenum.dart (Run dartfmt to format lib/any.pbenum.dart.)
  • lib/any.pbserver.dart (Run dartfmt to format lib/any.pbserver.dart.)
  • lib/delta.pb.dart (Run dartfmt to format lib/delta.pb.dart.)
  • lib/delta.pbenum.dart (Run dartfmt to format lib/delta.pbenum.dart.)
  • lib/delta.pbserver.dart (Run dartfmt to format lib/delta.pbserver.dart.)
  • lib/delta.types.dart (Run dartfmt to format lib/delta.types.dart.)

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and protod.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.0 <3.0.0
fixnum ^0.10.11 0.10.11
protobuf ^1.0.1 1.0.1
Dev dependencies
test ^1.14.3