Workiva / Workiva/dependency_validator
Support Doc Imports
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 66
- Forks
- 26
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 7
Description
Dart 3.8.0 added Doc Imports which:
enables external elements to be referenced in documentation comments without actually importing them
Currently, dependency_validator doesn't appear to consider these doc imports as usages. So, if a package is imported only in Doc Imports and not in regular imports, dependency_validator will detect it as unused. I think these only need to be declared as a dev_dependency, despite being in lib/.
In practice, it might be rare for packages to have doc comment references to packages that they don't actually depend on.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named in the issue. Start by finding the dependency-usage analysis for Dart imports and reproduce the case with a Dart 3.8 doc import that references an otherwise unused package. Done means the package is no longer reported as unused when referenced only by a doc import, with regression coverage added.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100