commit | 92fa0c551267b38e4b27c9f74976ae4cd96d8b1e | [log] [tgz] |
---|---|---|
author | Moritz <mosum@google.com> | Fri Dec 20 16:19:58 2024 +0100 |
committer | GitHub <noreply@github.com> | Fri Dec 20 07:19:58 2024 -0800 |
tree | 495427649f29bba933532b124251490b7a96d03b | |
parent | 408526a84e74d7af0f9c8c3fbb49ce9178927ee0 [diff] |
Update README.md before archiving (#75)
[!IMPORTANT]
This repo has moved to https://github.com/dart-lang/test/tree/master/pkgs/test_descriptor
The test_descriptor
package provides a convenient, easy-to-read API for defining and verifying directory structures in tests.
We recommend that you import this library with the d
prefix. The d.dir()
and d.file()
functions are the main entrypoints. They define a filesystem structure that can be created using Descriptor.create()
and verified using Descriptor.validate()
. For example:
import 'dart:io'; import 'package:test/test.dart'; import 'package:test_descriptor/test_descriptor.dart' as d; void main() { test('Directory.rename', () async { await d.dir('parent', [ d.file('sibling', 'sibling-contents'), d.dir('old-name', [d.file('child', 'child-contents')]) ]).create(); await Directory('${d.sandbox}/parent/old-name') .rename('${d.sandbox}/parent/new-name'); await d.dir('parent', [ d.file('sibling', 'sibling-contents'), d.dir('new-name', [d.file('child', 'child-contents')]) ]).validate(); }); }
By default, descriptors create entries in a temporary sandbox directory, d.sandbox
. A new sandbox is automatically created the first time you create a descriptor in a given test, and automatically deleted once the test finishes running.
This package is term_glyph
aware. It will decide whether to use ASCII or Unicode glyphs based on the glyph.ascii
attribute.