Refactor DartDocConfig object usage, part 1 #1661
Merged
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
…rtdoc tests for travis
pq
approved these changes
Apr 9, 2018
lib/src/model.dart
Outdated
|
|
||
| @override | ||
| String get name => _name; | ||
| // Order by which this container should be sorted. |
kevmoo
reviewed
Apr 10, 2018
|
|
||
| DartDoc dartdoc = new DartDoc(inputDir, excludeLibraries, sdkDir, generators, | ||
| outputDir, packageMeta, includeLibraries, includeExternals); | ||
| DartDocConfig config = new DartDocConfig.fromParameters( |
There was a problem hiding this comment.
There was a problem hiding this comment.
@kevmoo Hmmm. What I'm really looking for is a non-throwing, tolerant version of safe_config thrown in a blender with build_cli and a sprinkle of the analyzer's directory-specific configuration semantics. I have something like that a few PRs out on this line of development.
This was referenced Apr 10, 2018
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.
A first step toward making dartdoc_options.yaml play nicely with command line options. The way dartdoc handles configuration right now is very confusing -- some things are referenced in a global configuration object, some things are referenced via an object that's passed around, some things are referenced directly from parameters that are also in the config object... On top of that, Dartdoc's internal caching often had to be bypassed for testing because cached values were dependent on configuration objects.
Unfortunately, adding the dartdoc options file added Yet Another Way of configuring things and didn't tie it in to the old ways. To integrate that, we first need to get the rest of dartdoc's configuration under control.
This does that. There's only one way to look at each of the major flags now -- via a config object that is passed in to DartDoc objects at construction time. This makes it safe to, among other things, have multiple DartDoc objects with different configuration objects generate docs inside the same program (a pretty basic prerequisite for #1609).
Also:
Some of the command line options (those that involve setting up the generators) aren't moved in this PR, but will be in a followup as that's a fairly large change too.