Skip to content

Commit d0ef60b

Browse files
authored
Fix build_test README and improve a comment. (#4090)
1 parent 3577e4c commit d0ef60b

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

build_test/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,16 @@ write individual sources to it from a `PackageAssetReader`, or write all sources
8484
to it with `loadIsolateSources`:
8585

8686
```dart
87-
final readerWriter = TestReaderWriter();
88-
await readerWriter.loadIsolateSources();
87+
final readerWriter = TestReaderWriter(rootPackage: 'test_package');
88+
await readerWriter.testing.loadIsolateSources();
8989
testBuilder(
9090
yourBuilder,
91-
{} /* test assets here */,
91+
{'test_package|lib/a.dart': '''
92+
import 'package:real_package/annotations.dart';
93+
94+
@RealAnnotation()
95+
class TestClass {}
96+
'''},
9297
readerWriter: readerWriter,
9398
);
9499
```

build_test/lib/src/test_reader_writer.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ import 'in_memory_reader_writer.dart';
1616
/// files.
1717
///
1818
/// Writes and deletes are notified to [FakeWatcher].
19+
///
20+
/// You must pass a `rootPackage` if the `TestReaderWriter` will be used in
21+
/// a build. This specifies which package `build_runner` is running in.
1922
abstract interface class TestReaderWriter
2023
implements AssetReader, RunnerAssetWriter {
2124
factory TestReaderWriter({String? rootPackage}) =>

0 commit comments

Comments
 (0)