Support dependency_validator running on analysis_options.yaml files
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
Research direction
Start by tracing how dependency_validator reads pubspec.yaml and identifies dependency usage, then locate where analysis_options.yaml files are excluded. Use the include entry in analysis_options.yaml and the dependency declarations in pubspec.yaml as the verification cases. Done means undeclared includes fail validation and dependencies used only by the include are required to be dev dependencies.
Written by the indexing model from the issue text.
Description
It is possible, and common practice to add a include: package:<somePackage>/<someEntrypoint>.yaml within an analysis_options.yaml file
For example, this is how pedantic and the newer lints package work
include: package:lints/recommended.yaml
Currently, dependency validator completely ignores this file, but it could, and probably should, audit the dependencies used within these files
I'm proposing the following rules regarding this file:
- if a dependency is used within the analysis_options.yaml
includestatement and is not declared within the pubspec.yaml file, the command should fail - if a dependency is only used within the analysis_options.yaml
includeAND is declared as a non-dev dependency, the command should fail
- Dominant language
- Dart
- Stars
- 66
- Forks
- 26
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 7
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.
More from Workiva/dependency_validator
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Workiva/dependency_validator#176 · 2 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
Workiva/dependency_validator#167 · 2 comments ·
-
Support Doc Imports Open
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Workiva/dependency_validator#153 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Workiva/dependency_validator#141 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
Workiva/dependency_validator#140 · 1 comment ·
All issues in Workiva/dependency_validator
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
code quality good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Suwayomi/Suwayomi-Tsumiru#479 ·
-
Build Failure: agora_rtc_engine compiled against android-31 while dependencies require android-34+ Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
conceptadev/noir#95 ·