Data extraction from dartdoc internals. #1353
Merged
+1,082
−0
Conversation
This file contains hidden or 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
|
@jcollins-g: please take a quick look on our use of the dartdoc API. |
sortie
approved these changes
Jun 15, 2018
| final outputFile = new File(p.join(outputDirectoryPath, fileName)); | ||
| await outputFile.writeAsString(convert.json.encode(extract.toJson())); | ||
| _onFileCreated.add(outputFile); | ||
| _writtenFiles.add(fileName); |
There was a problem hiding this comment.
I wasn't sure about that either, the API documentation didn't specify it exactly, but package:dartdoc uses the same relative path pattern, and I'd go with that.
|
Sorry, missed this while I was out last week. Use of API looks good to me at a glance. |
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.
I think it is the best if we keep the
package:dartdocdependency and our specific overrides in separate package (calling itpub_dartdoc), one which we run as an external process (same as if we were runningdartdoc). This would allow the dependencies to have separate upgrade paths and schedules.Added a test that is running on this small package and tests the output of the doc generation and our data extraction too.
The data contains:
Related issues: dart-lang/pana#269, dart-lang/dartdoc#1667, #1179
The package is not yet used as part of the pub site, it will be integrated in a subsequent PR.