-
Notifications
You must be signed in to change notification settings - Fork 87
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[dartdoc_test] add some ways to ignore analysis #248
Conversation
52c7b13
to
61983ba
Compare
# Create test file for code samples to "test/dartdoc_test.dart" | ||
dart run dartdoc_test add | ||
|
||
# Run test command | ||
dart test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Create test file for code samples to "test/dartdoc_test.dart" | |
dart run dartdoc_test add | |
# Run test command | |
dart test | |
# Add dartdoc_test as dev dependency | |
dart pub add dev:dartdoc_test | |
# Create test file for code samples to "test/dartdoc_test.dart" | |
dart run dartdoc_test add | |
# Run test command | |
dart test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we can make dart format
ignore these files.
We can either disable dart format
check in mono_pkg.yaml
(which is a bit sad), or we can use a different extension here 🤣
Like .dart-example
instead of .dart
🙈
I'm not sure I have any good ideas :/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found this and, as a temporary solution, I rewrote the example so that it would not be subject to format checks.
/// 1 positional argument expected by 'factorial', but 0 found.
/// ```dart
/// final fact = factorial();
/// print(fact); // 120
/// ```
* Initial dartdoc_test packages with some hacks * Update CI configuration * update dartdoc_test (#239) * add more examples and fix extracting * code splitting and print code samples and it's location. * set overlay of sample code and update dart sdk * [dartdoc_test] add extractor tests and wrap code with imports (#241) * add test * fix * add import * fix indent * move to getter * fix for ci * fix sdk version * fix * [dartdoc_test] add documentation samples analyzer (#242) * implement analyze and output samples to .dartdoc_test directory * add CRLF/LF line breaks tests * add license headers to all files * add documentation and some modified * fix extractor test and add TestContext * update to make analyzer work * translate original span from sample file span * make DartDocTestContext to singleton no longer * add example dart project * add write options to write sample code to file (for debug) * updated README. minor fixes * add new analyzer test * update example README * update README, add .gitignore for .dartdoc_test, and create add subcommand to generate test file * fix * rename DartDoc -> Dartdoc * fix extractor and add tests * fix span translation and add test * add CommandRunner and make some commands to subCommand * fix * fix analyzer and ignore warning * fix print of analyze results * create integration test * [dartdoc_test] implement good logging! (#245) * move some codes to src/ * set analyze to default command, and print usage when -h flag is set * remove extract command and fix integration_test * add logger and varbose option * add test for verbose * fix log * move log to Command * [dartdoc_test] implement Reporter (#247) * create logger class * add summary log * move command * create reporter * fix * add ansi and fix extractor to allow code blocks with no specified language * add output directory option * add extractor test * import and print relative path * fix format * apply review suggestions and update Reporter * update reporter * use stdout reporter * allow analyze command options in default command * add integration test for runDartdocTest() * update report to print relative path * fix to work test reporter in example directory * fix * [dartdoc_test] add some ways to ignore analysis (#248) * implement code sample ignoring * add comments * fix ignoring and test * update documentations * add exclude option * fix summary and make ReporterForTest use verbose flag * move models to model.dart * only run integration test on ./example * do not wrap code samples with main() when code sample includes main() * fix * rename code sample output directory * add doc comments * update ignoring to use code block tagging (dart#no-test) * add public member documentations * fix * switch default output directory to * update CHANGELOG * fix to make some class to final * remove Reporter constructor, add some comments, and some fixes * add missing doc comment * fix output code * fix for ci * fix readme --------- Co-authored-by: takumma <[email protected]>
add 2 ways to ignore code sample analysis.
#no-test
dart#no-test
is specified as the language of code block.exclude
option to cli and test function. so we can ignore files or directories.and I add public documentation and do some work to get it published!