meta 1.1.8

  • Readme
  • Changelog
  • Installing
  • 93

Annotations for Static Analysis #

This package defines annotations that can be used by the tools that are shipped with the Dart SDK.

Library Structure #

The annotations in this package are defined in two libraries.

The library in meta.dart defines annotations that can be used by static analysis tools to provide a more complete analysis of the code that uses them. Within the SDK, these tools include the command-line analyzer (dartanalyzer) and the analysis server that is used to power many of the Dart-enabled development tools.

The library in dart2js.dart defines annotations that provide hints to dart2js to improve the quality of the JavaScript code that it produces. These annotations are currently experimental and might be removed in a future version of this package.

Support #

Post issues and feature requests on the GitHub issue tracker.

Questions and discussions are welcome at the Dart Analyzer Discussion Group.

License #

See the LICENSE file.

1.1.8 #

  • Introduce @nonVirtual to annotate instance members that should not be overridden in subclasses or when mixed in.

1.1.7 #

  • Introduce @sealed to declare that a class or mixin is not allowed as a super-type.

    Only classes in the same package as a class or mixin annotated with @sealed may extend, implement or mix-in the annotated class or mixin. (SDK issue 27372).

1.1.6 #

  • Set max SDK version to <3.0.0.

1.1.5 #

  • Introduce @isTest and @isTestGroup to declare a function that is a test, or a test group.

1.1.4 #

  • Added dart2js.dart.

1.1.2 #

  • Rollback SDK constraint update for 2.0.0. No longer needed.

1.1.1 #

  • Update SDK constraint to be 2.0.0 dev friendly.

1.1.0 #

  • Introduce @alwaysThrows to declare that a function always throws (SDK issue 17999). This is first available in Dart SDK 1.25.0-dev.1.0.

      import 'package:meta/meta.dart';
      // Without knowing that [failBigTime] always throws, it looks like this
      // function might return without returning a bool.
      bool fn(expected, actual) {
        if (expected != actual)
          failBigTime(expected, actual);
          return True;
      void failBigTime(expected, actual) {
        throw new StateError('Expected $expected, but was $actual.');

1.0.5 #

  • Introduce @experimental to annotate a library, or any declaration that is part of the public interface of a library (such as top-level members, class members, and function parameters) to indicate that the annotated API is experimental and may be removed or changed at any-time without updating the version of the containing package, despite the fact that it would otherwise be a breaking change.

1.0.4 #

  • Introduce @virtual to allow field overrides in strong mode (SDK issue 27384).

      import 'package:meta/meta.dart' show virtual;
      class Base {
        @virtual int x;
      class Derived extends Base {
        int x;
        // Expose the hidden storage slot:
        int get superX => super.x;
        set superX(int v) { super.x = v; }

1.0.3 #

  • Introduce @checked to override a method and tighten a parameter type (SDK issue 25578).

      import 'package:meta/meta.dart' show checked;
      class View {
        addChild(View v) {}
      class MyView extends View {
        // this override is legal, it will check at runtime if we actually
        // got a MyView.
        addChild(@checked MyView v) {}
      main() {
        dynamic mv = new MyView();
        mv.addChild(new View()); // runtime error

1.0.2 #

  • Introduce @visibleForTesting annotation for declarations that may be referenced only in the library or in a test.

1.0.1 #

  • Updated @factory to allow statics and methods returning null.

1.0.0 #

  • First stable API release.

0.12.2 #

  • Updated @protected to include implemented interfaces (linter#252).

0.12.1 #

  • Fixed markdown in dartdocs.

0.12.0 #

  • Introduce @optionalTypeArgs annotation for classes whose type arguments are to be treated as optional.

0.11.0 #

  • Added new Required constructor with a means to specify a reason to explain why a parameter is required.

0.10.0 #

  • Introduce @factory annotation for methods that must either be abstract or must return a newly allocated object.
  • Introduce @literal annotation that indicates that any invocation of a constructor must use the keyword const unless one or more of the arguments to the constructor is not a compile-time constant.

0.9.0 #

  • Introduce @protected annotation for members that must only be called from instance members of subclasses.
  • Introduce @required annotation for optional parameters that should be treated as required.
  • Introduce @mustCallSuper annotation for methods that must be invoked by all overriding methods.

Use this package as a library

1. Depend on it

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

  meta: ^1.1.8

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:meta/meta.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 28, 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 suggestions

Fix lib/meta.dart. (-8.17 points)

Analysis of lib/meta.dart reported 17 hints, including:

line 49 col 36: Avoid const keyword.

line 60 col 26: Avoid const keyword.

line 82 col 36: Avoid const keyword.

line 94 col 26: Avoid const keyword.

line 106 col 29: Avoid const keyword.

Fix lib/dart2js.dart. (-1 points)

Analysis of lib/dart2js.dart reported 2 hints:

line 20 col 28: Avoid const keyword.

line 37 col 30: Avoid const keyword.

Maintenance suggestions

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 meta.dart. Packages with multiple examples should provide example/

For more information see the pub package layout conventions.

The description is too long. (-10 points)

Search engines display only the first part of the description. Try to keep the value of the description field in your package's pubspec.yaml file between 60 and 180 characters.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.12.0 <3.0.0