Dartdoc test -- full diff #249
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* 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
* add test * fix * add import * fix indent * move to getter * fix for ci * fix sdk version * fix
* 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
* 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
* 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
jonasfj
commented
Aug 19, 2024
| @@ -0,0 +1 @@ | |||
| ## v0.1.0 | |||
There was a problem hiding this comment.
We should write a proper changelog entry :D
jonasfj
commented
Aug 19, 2024
dartdoc_test/.gitignore
Outdated
| @@ -0,0 +1 @@ | |||
| .dartdoc_test | |||
There was a problem hiding this comment.
Do we still create this, or do we create things inside .dart_tool/dartdoc_test/
chinmoy12c
reviewed
Aug 25, 2024
Comment on lines
19
to
20
| /// code block without specified language | ||
| /// ``` |
There was a problem hiding this comment.
Should we specify here what the behaviour would be when language is not specified?
dartdoc_test/README.md
Outdated
Comment on lines
3
to
4
| This package provides an easy way to test code samples embedded in dartdoc | ||
| documentation comments. |
There was a problem hiding this comment.
Can we add what are the features it currently supports and what are some things that we would like to add in future? A list like "static analysis", "output comparison", ...
| return sanitized == sanitized.split('').reversed.join(''); | ||
| } | ||
|
|
||
| /// Should return: Local variable 'gcd' can't be referenced before it is declared. |
There was a problem hiding this comment.
Is there a mistake here? Why would this return an error and the isPalindrome example above won't?
chinmoy12c
reviewed
Aug 25, 2024
Comment on lines
+47
to
+57
| final reporter = Reporter.test(verbose: verbose); | ||
| for (final r in result) { | ||
| for (final e in r.errors) { | ||
| reporter.addIssue(Issue( | ||
| path: r.file.sample.comment.path, | ||
| message: e.error.message, | ||
| commentSpan: e.commentSpan, | ||
| generatedSpan: e.generatedSpan, | ||
| )); | ||
| } | ||
| } |
There was a problem hiding this comment.
Would it be good to add an example of how the reporter represents the result?
dartdoc_test/lib/src/analyzer.dart
Outdated
Comment on lines
61
to
62
| final FileSpan? commentSpan; | ||
| final FileSpan? generatedSpan; |
There was a problem hiding this comment.
Maybe add one-liner documentation for these properties?
* 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creating a PR with all dartdoc_test related changes for review.