Warn user is using deprecated default source (repository reference instead of default = true)

qlty-cli/tests/cmd/check/using_deprecated_default_source.in/.gitignore

@@ -0,0 +1,4 @@
+.qlty/results
+.qlty/logs
+.qlty/out
+.qlty/sources

qlty-cli/tests/cmd/check/using_deprecated_default_source.in/.qlty/qlty.toml

@@ -0,0 +1,6 @@
+config_version = "0"
+
+[[source]]
+name = "default"
+repository = "https://github.com/qltysh/qlty.git"
+tag = "v0.463.0"

qlty-cli/tests/cmd/check/using_deprecated_default_source.stderr

@@ -0,0 +1,10 @@
+
+⚠ Warning: qlty.toml is using a deprecated, repository-based, default source.
+
+Please change the default source in your qlty.toml to:
+
+[[source]]
+name = "default"
+default = true
+
+✔ No issues

qlty-cli/tests/cmd/check/using_deprecated_default_source.toml

@@ -0,0 +1,2 @@
+bin.name = "qlty"
+args = ["check", "--all", "--no-cache"]

qlty-config/src/config.rs

@@ -15,6 +15,7 @@ pub use self::ignore::{Ignore, ALL_WILDCARD};
 pub use self::overrides::Override;
 use self::smells::Smells;
 pub use builder::Builder;
+use console::style;
 pub use coverage::Coverage;
 pub use download::{Cpu, DownloadDef, DownloadFileType, OperatingSystem, System};
 pub use file_type::FileType;
@@ -37,7 +38,7 @@ use anyhow::{bail, Result};
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
-use tracing::debug;
+use tracing::{debug, warn};
 
 #[derive(Debug, Serialize, Deserialize, Clone, Default)]
 pub struct QltyConfig {
@@ -86,6 +87,8 @@ pub struct QltyConfig {
     pub source: Vec<SourceDef>,
 }
 
+const OLD_DEFAULT_SOURCE_REPOSITORY: &str = "https://github.com/qltysh/qlty";
+
 impl QltyConfig {
     pub fn validate_cli_version(&self) -> Result<()> {
         if self.cli_version.is_none() {
@@ -136,6 +139,43 @@ impl QltyConfig {
             .map(|(name, settings)| (name.clone(), f(settings)))
             .collect::<HashMap<_, _>>()
     }
+
+    pub fn default_source(&self) -> Option<&SourceDef> {
+        self.source
+            .iter()
+            .find(|s| s.name.as_deref() == Some("default"))
+    }
+
+    pub fn print_deprecation_warnings(&self) {
+        match self.default_source() {
+            Some(source) => {
+                if source.repository.is_some()
+                    && source
+                        .repository
+                        .as_ref()
+                        .unwrap()
+                        .starts_with(OLD_DEFAULT_SOURCE_REPOSITORY)
+                {
+                    warn!("qlty.toml default source is a repository-style reference to qltysh.");
+                    eprintln!(
+                        r#"
+{} Warning: qlty.toml is using a deprecated, repository-based, default source.
+
+Please change the default source in your qlty.toml to:
+
+[[source]]
+name = "default"
+default = true
+"#,
+                        style("⚠").yellow()
+                    );
+                }
+            }
+            None => {
+                warn!("No default source defined in qlty.toml.");
+            }
+        }
+    }
 }
 
 #[cfg(test)]

qlty-config/src/config/source.rs

@@ -40,11 +40,11 @@ impl SourceDef {
             }))
         } else if self.repository.is_some() {
             if self.tag.is_some() && self.branch.is_some() {
-                bail!("Source defines both a tag and branch");
+                bail!("Repository source defines both a tag and branch");
             }
 
             if self.tag.is_none() && self.branch.is_none() {
-                bail!("Source defines neither a tag nor branch");
+                bail!("Repository source defines neither a tag nor branch");
             }
 
             let reference = if self.tag.is_some() {

qlty-config/src/workspace.rs

@@ -58,7 +58,13 @@ impl Workspace {
     }
 
     pub fn config(&self) -> Result<QltyConfig> {
-        Builder::full_config_for_workspace(self)
+        let config = Builder::full_config_for_workspace(self);
+
+        if let Ok(config) = &config {
+            config.print_deprecation_warnings();
+        }
+
+        config
     }
 
     pub fn sources_list(&self) -> Result<SourcesList> {