Workiva / Workiva/dependency_validator

Ensure Dart version is at least as high as dependencies

Open
#141 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dart
Stars
66
Forks
26
Avg merge
5d 7h
Merged PRs (30d)
7

Description

Say I have the following project:

environment:
  sdk: ^3.0.0

dependencies:
  pubspec_parse: ^1.5.0

This compiles, Pub doesn't complain, and this tool validates it with no issues. However, pubspec_parse version 1.5 requires Dart 3.6! Everything works because, coincidentally, I happen to have Dart 3.6 on my PC. But someone else might not, especially a CI workflow (this just happened in #138 but it happens to me all the time). I have a use case where I need to be entirely offline, so I'd like to know if I need to upgrade my Dart SDK as far in advance as possible.

To handle this, the tool should notice that pubspec_parse requires Dart 3.6 and flag that my environment.sdk is less than that. To handle the transitive case as well, the tool can look through .dart_tool/package_config.json and use the highest languageVersion it finds.


I filed https://github.com/dart-lang/pub/issues/4488 to see if the Dart team wants to integrate this into Pub directly as well

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the validator's existing SDK and dependency checks, then inspect .dart_tool/package_config.json to understand the available languageVersion data. Implement validation that compares the project's environment.sdk with the highest required Dart version, including transitive packages, and verify that incompatible constraints are reported.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.