Running with --dry-run masks warnings from --validate-links

[mkorbel1]

Running dart doc --validate-links --dry-run when warnings related to --validate-links are present will mask those warnings. They are only visible if --dry-run is omitted.

Additionally, I can't get any of the --validate-links warnings to print out, just the count of the number of warnings, which is pretty frustrating to debug. I'm not sure if the two are related.

Running on Dart version 2.19.2:

$ dart --version
Dart SDK version: 2.19.2 (stable) (Unknown timestamp) on "linux_x64"

[srawlins]

Good catch. That combo of flags should not be allowed.

[srawlins]

Additionally, I can't get any of the --validate-links warnings to print out

Would you mind filing a separate issue for this? Thanks!

[mkorbel1]

That combo of flags should not be allowed.

Why not? My use case is checking that there's no documentation issues as part of CI. I'd like to include warnings caught by --validate-links in my CI, but without actually needing to generate (and keep) all the documentation lying around.

Speaking of, these other issues are relevant for this use case as well:
#2846
#2907
#1959

Would you mind filing a separate issue for this? Thanks!

Sure, filed here: #3331

[srawlins]

The --validate-links feature is just a generic links checker on the generated output. If you like, we could keep this as a feature request that links can be validated in a dry run. But I'll prepare you I don't think we can implement that in the foreseeable future.

[mkorbel1]

Ah, ok, thanks for clarifying. I guess my real "feature request" is to make it really easy to use dartdoc in CI with as many quality checks as possible.

Ignoring/deleting the doc/api/ directory feels like an acceptable workaround for now, but yes some sort of indication that you can't run those two flags together would be helpful!

[jcollins-g]

https://dart-review.googlesource.com/c/sdk/+/282811 should prevent users from using both flags at once under this circumstance.

[mit-mit]

@jcollins-g given this is technically a small breaking change (CI jobs that used to pass both flags will break), I think we should mention this in the CHANGELOG.md file