code_builder 4.1.0
code_builder: ^4.1.0 copied to clipboard

A fluent, builder-based library for generating valid Dart code

Pub package Build Status Gitter chat

A fluent, builder-based library for generating valid Dart code.

Usage #

code_builder has a narrow and user-friendly API.

See the example and test folders for additional examples.

For example creating a class with a method:

import 'package:code_builder/code_builder.dart';
import 'package:dart_style/dart_style.dart';

void main() {
  final animal = Class((b) => b = 'Animal'
    ..extend = refer('Organism')
    ..methods.add(Method.returnsVoid((b) => b = 'eat'
      ..body = const Code("print('Yum');"))));
  final emitter = DartEmitter();


class Animal extends Organism {
  void eat() => print('Yum!');

Have a complicated set of dependencies for your generated code? code_builder supports automatic scoping of your ASTs to automatically use prefixes to avoid symbol conflicts:

import 'package:code_builder/code_builder.dart';
import 'package:dart_style/dart_style.dart';

void main() {
  final library = Library((b) => b.body.addAll([
        Method((b) => b
          ..body = const Code('')
 = 'doThing'
          ..returns = refer('Thing', 'package:a/a.dart')),
        Method((b) => b
          ..body = const Code('')
 = 'doOther'
          ..returns = refer('Other', 'package:b/b.dart')),
  final emitter = DartEmitter.scoped();


import 'package:a/a.dart' as _i1;
import 'package:b/b.dart' as _i2;

_i1.Thing doThing() {}
_i2.Other doOther() {}

Contributing #

If a feature is missing (the Dart language is always evolving) or you'd like an easier or better way to do something, consider opening a pull request. You can always file an issue, but generally speaking feature requests will be on a best-effort basis.

NOTE: Due to the evolving Dart SDK the local dartfmt must be used to format this repository. You can run it simply from the command-line:

$ pub run dart_style:format -w .

Updating generated (.g.dart) files #

NOTE: There is currently a limitation in build_runner that requires a workaround for developing this package. We expect this to be unnecessary in the future.

Use build_runner:

$ pub global activate build_runner
$ mv build.disabled.yaml build.yaml
$ pub global run build_runner build --delete-conflicting-outputs
$ mv build.yaml build.disabled.yaml
pub points


A fluent, builder-based library for generating valid Dart code

Repository (GitHub)
View/report issues


API reference


BSD-3-Clause (LICENSE)


built_collection, built_value, collection, matcher, meta


Packages that depend on code_builder