refactor(dependencies): use enum (CheckMajorVersions) instead of boolean ♻️

Author: andho

compiler-cli/src/add.rs

@@ -8,7 +8,7 @@ use gleam_core::{
 
 use crate::{
     cli,
-    dependencies::{UseManifest, parse_gleam_add_specifier},
+    dependencies::{self, UseManifest, parse_gleam_add_specifier},
     fs,
 };
 
@@ -27,13 +27,13 @@ pub fn command(paths: &ProjectPaths, packages_to_add: Vec<String>, dev: bool) ->
 
     // Insert the new packages into the manifest and perform dependency
     // resolution to determine suitable versions
-    let manifest = crate::dependencies::download(
+    let manifest = dependencies::download(
         paths,
         cli::Reporter::new(),
         Some((new_package_requirements.clone(), dev)),
         Vec::new(),
-        UseManifest::Yes,
-        false,
+        dependencies::UseManifest::Yes,
+        dependencies::CheckMajorVersions::No,
     )?;
 
     // Read gleam.toml and manifest.toml so we can insert new deps into it

compiler-cli/src/build.rs

@@ -10,13 +10,19 @@ use gleam_core::{
 
 use crate::{
     build_lock::BuildLock,
-    cli,
-    dependencies::UseManifest,
+    cli, dependencies,
     fs::{self, ConsoleWarningEmitter},
 };
 
 pub fn download_dependencies(paths: &ProjectPaths, telemetry: impl Telemetry) -> Result<Manifest> {
-    crate::dependencies::download(paths, telemetry, None, Vec::new(), UseManifest::Yes)
+    crate::dependencies::download(
+        paths,
+        telemetry,
+        None,
+        Vec::new(),
+        dependencies::UseManifest::Yes,
+        dependencies::CheckMajorVersions::No,
+    )
 }
 
 pub fn main(paths: &ProjectPaths, options: Options, manifest: Manifest) -> Result<Built> {

compiler-cli/src/dependencies.rs

@@ -52,6 +52,14 @@ static UTF8_SYMBOLS: Symbols = Symbols {
     right: "─",
 };
 
+/// When set to `Yes`, the cli will check for major version updates of direct dependencies and
+/// print them to the console if the major versions are not upgradeable due to constraints.
+#[derive(Debug, Clone, Copy)]
+pub enum CheckMajorVersions {
+    Yes,
+    No,
+}
+
 pub fn list(paths: &ProjectPaths) -> Result<()> {
     let (_, manifest) = get_manifest_details(paths)?;
     list_manifest_packages(std::io::stdout(), manifest)
@@ -217,7 +225,7 @@ pub fn update(paths: &ProjectPaths, packages: Vec<String>) -> Result<()> {
         None,
         packages.into_iter().map(EcoString::from).collect(),
         use_manifest,
-        true,
+        CheckMajorVersions::Yes,
     )?;
 
     Ok(())
@@ -355,7 +363,7 @@ pub fn download<Telem: Telemetry>(
     // packages being resolved (not the locked ones).
     use_manifest: UseManifest,
     // If true we check for major version updates and print them to the console.
-    check_major_versions: bool,
+    check_major_versions: CheckMajorVersions,
 ) -> Result<Manifest> {
     let mode = Mode::Dev;
 
@@ -646,7 +654,7 @@ struct DependencyManager<Telem: Telemetry, P: dependency::PackageFetcher> {
     mode: Mode,
     use_manifest: UseManifest,
     telemetry: Telem,
-    check_major_versions: bool,
+    check_major_versions: CheckMajorVersions,
 }
 
 impl<Telem: Telemetry, P> DependencyManager<Telem, P>
@@ -660,7 +668,7 @@ where
             mode: Mode::Dev,
             use_manifest: UseManifest::No,
             telemetry,
-            check_major_versions: false,
+            check_major_versions: CheckMajorVersions::No,
         }
     }
 
@@ -674,7 +682,7 @@ where
         self
     }
 
-    fn with_check_major_versions(mut self, check_major_versions: bool) -> Self {
+    fn with_check_major_versions(mut self, check_major_versions: CheckMajorVersions) -> Self {
         self.check_major_versions = check_major_versions;
         self
     }
@@ -788,7 +796,7 @@ where
         }
         LocalPackages::from_manifest(&manifest).write_to_disc(paths)?;
 
-        if self.check_major_versions {
+        if let CheckMajorVersions::Yes = self.check_major_versions {
             let major_versions_available =
                 dependency::check_for_major_version_updates(&manifest, &self.package_fetcher);
             if !major_versions_available.is_empty() {

compiler-cli/src/fs.rs

@@ -22,7 +22,7 @@ use std::{
 
 use camino::{ReadDirUtf8, Utf8Path, Utf8PathBuf};
 
-use crate::{dependencies::UseManifest, lsp::LspLocker};
+use crate::{dependencies, lsp::LspLocker};
 
 #[cfg(test)]
 mod tests;
@@ -246,13 +246,13 @@ impl MakeLocker for ProjectIO {
 
 impl DownloadDependencies for ProjectIO {
     fn download_dependencies(&self, paths: &ProjectPaths) -> Result<Manifest> {
-        crate::dependencies::download(
+        dependencies::download(
             paths,
             NullTelemetry,
             None,
             Vec::new(),
-            UseManifest::Yes,
-            false,
+            dependencies::UseManifest::Yes,
+            dependencies::CheckMajorVersions::No,
         )
     }
 }

compiler-cli/src/lib.rs

@@ -782,7 +782,7 @@ fn download_dependencies(paths: &ProjectPaths) -> Result<()> {
         None,
         Vec::new(),
         UseManifest::Yes,
-        true,
+        dependencies::CheckMajorVersions::Yes,
     )?;
     Ok(())
 }