An open API service indexing awesome lists of open source software.

https://github.com/simphotonics/merging_builder_example

Source code generation with Dart.
https://github.com/simphotonics/merging_builder_example

Last synced: 2 months ago
JSON representation

Source code generation with Dart.

Awesome Lists containing this project

README

        

# Merging Builder - Example

[![Dart](https://github.com/simphotonics/merging_builder/actions/workflows/dart.yml/badge.svg)](https://github.com/simphotonics/merging_builder/actions/workflows/dart.yml)

## Introduction

The package [`merging_builder`][merging_builder] provides a Dart builder that reads **several input files** and writes the merged output to **one output file**.

The example presented here contains two packages. The package [`researcher_builder`][researcher_builder] depends on [`merging_builder`][merging_builder] in order to define the builder [`add_names_builder`][add_names_builder] and the merging generator [`add_names_generator`][add_names_generator].

The package [`researcher`][researcher] depends on [`researcher_builder`][researcher_builder], specified as a *dev_dependency*, in order to access the builder [`add_names_builder`][add_names_builder] during the build process.

## Build Setup

Step by step instructions on how to set up and configure a [`MergingBuilder`][MergingBuilder] are provided in
the section [usage].

## Features and bugs
Please file feature requests and bugs at the [issue tracker].

[add_names_builder]: researcher_builder/lib/builder.dart

[add_names_generator]: researcher_builder/lib/src/generators/add_names_generator.dart

[builder]: https://github.com/dart-lang/build

[issue tracker]: https://github.com/simphotonics/merging_builder_example/issues

[merging_builder]: https://pub.dev/packages/merging_builder

[MergingBuilder]: https://pub.dev/documentation/merging_builder/latest/merging_builder/MergingBuilder-class.html

[researcher]: researcher

[researcher_builder]: researcher_builder

[usage]: https://github.com/simphotonics/merging_builder#usage