test_html_builder 1.0.1 
test_html_builder: ^1.0.1 copied to clipboard
workiva.comBuilder that generates HTML files from templates for dart tests.
test_html_builder #
A Dart builder that uses templates to generate HTML files for dart tests. Useful for projects with many tests that require custom HTML. Instead of having to replicate the custom HTML file for every test file that requires it, this builder can apply a template to any number of test files.
Usage #
Add this package as a dev_dependency:
dev_dependencies:
test_html_builder: ^1.0.0
Create as many HTML test templates in the test/ directory as needed, e.g.:
<!-- test/example_template.html -->
<html>
<head>
<!-- Load custom assets needed by the test. -->
<script src="custom.js"></script>
<!--
Every template must include this `{test}` token.
It will be replaced by the builder with the required tags:
<link rel="x-dart-test" href="...">
<script src="packages/test/dart.js"></script>
-->
{test}
</head>
</html>
Tell the builder which templates should be applied to which files, e.g.:
targets:
$default:
builders:
test_html_builder:
options:
templates:
"test/react_template.html":
- "test/components/**_test.dart"
- "test/react/**_test.dart"
"test/default_template.html":
- "test/**_test.dart"
Notes:
-
If there is overlap between the globs defined for multiple templates, the builder will choose the first template that matches.
-
If none of the templates match for a given test file, no html file will be generated.
-
One-off custom html files for individual tests are still supported, but they must use the
.custom.htmlextension:- test/example_test.dart
- test/example_test.custom.html
Contributing #
dartanalyzer .dartfmt -w .pub run test
If you make changes to lib/src/config.dart and need to regenerate
lib/src/config.g.dart:
- Uncomment the
json_serializable: ^3.0.0dev dependency inpubspec.yaml - Comment out the entirety of
build.yaml pub get && pub run build_runner build
This is necessary because a builder cannot depend on code that is generated by
another builder in the same package. An alternative solution would be to define
the TestHtmlBuilderConfig in a separate package, but this is simpler for now.
Metadata
Publisher
Metadata
Builder that generates HTML files from templates for dart tests.
Repository (GitHub)
View/report issues
License
unknown (license)
Dependencies
build, build_config, glob, json_annotation, logging, path
