fix!: avoid false negatives when the current version is a pre-release and there is a prior stable release on pub

[renancaraujo]

Description

fix!: avoid false negatives when the current version is a pre-release and there is a prior stable release on pub

This is a breaking change, in the following case, that returned false, will return true after this change.

// latest version on pub: 0.2.0
await pubUpdater.isUpToDate(
  packageName: 'my_package',
  currentVersion: '0.3.0-dev.1',
),

closes: #41

Type of Change

• ✨ New feature (non-breaking change which adds functionality)
• 🛠️ Bug fix (non-breaking change which fixes an issue)
• ❌ Breaking change (fix or feature that would cause existing functionality to change)
• 🧹 Code refactor
• ✅ Build configuration change
• 📝 Documentation
• 🗑️ Chore

[felangel]

So just to clarify if the current version was 0.1.0-dev.48 and the latest version was 1.0.0, isUpToDate would return true?

[renancaraujo]

I would say, in short, I think we shouldn't track how "up to date" a pre-release is when compared to a stable release because it is a rabbit hole (#41 (comment))

[alestiago]

I also had the same doubt that @felangel had here.

Can we add some documentation in the README.md that explains why this behaviour is intended? Similar to what you explained here but giving it more visibility by including it in the README.md

Maybe a FAQ similar to how mocktail or very_good_coverage have?