[ty] Add --config-file

217

Author: thejchap

crates/ty/src/args.rs

@@ -107,6 +107,15 @@ pub(crate) struct CheckCommand {
     #[clap(flatten)]
     pub(crate) config: ConfigsArg,
 
+    /// A path to a `ty.toml` configuration file
+    ///
+    /// `pyproject.toml` files are not accepted.
+    /// When provided, this file will be used in place of any discovered configuration (including user-level configuration).
+    /// ty will skip project discovery and default to the current working directory.
+    /// Paths are anchored at the current working directory.
+    #[arg(long)]
+    pub(crate) config_file: Option<SystemPathBuf>,
+
     /// The format to use for printing diagnostic messages.
     #[arg(long)]
     pub(crate) output_format: Option<OutputFormat>,

crates/ty/src/lib.rs

@@ -102,12 +102,16 @@ fn run_check(args: CheckCommand) -> anyhow::Result<ExitStatus> {
         .map(|path| SystemPath::absolute(path, &cwd))
         .collect();
 
-    let system = OsSystem::new(cwd);
+    let system = OsSystem::new(cwd.clone());
     let watch = args.watch;
     let exit_zero = args.exit_zero;
 
+    let mut project_metadata = match &args.config_file {
+        Some(config_file) => ProjectMetadata::from_config_file(config_file.clone(), cwd, &system)?,
+        None => ProjectMetadata::discover(&project_path, &system)?,
+    };
+
     let cli_options = args.into_options();
-    let mut project_metadata = ProjectMetadata::discover(&project_path, &system)?;
     project_metadata.apply_cli_options(cli_options.clone());
     project_metadata.apply_configuration_files(&system)?;
 

crates/ty/tests/cli.rs

@@ -1426,7 +1426,7 @@ fn cli_config_args_toml_string_basic() -> anyhow::Result<()> {
 fn cli_config_args_overrides_knot_toml() -> anyhow::Result<()> {
     let case = TestCase::with_files(vec![
         (
-            "knot.toml",
+            "ty.toml",
             r#"
             [terminal]
             error-on-warning = true

crates/ty_project/src/metadata.rs

@@ -27,6 +27,9 @@ pub struct ProjectMetadata {
     /// The raw options
     pub(super) options: Options,
 
+    /// Config file to override any discovered configuration
+    pub(super) config_file_override: Option<SystemPathBuf>,
+
     /// Paths of configurations other than the project's configuration that were combined into [`Self::options`].
     ///
     /// This field stores the paths of the configuration files, mainly for
@@ -45,9 +48,28 @@ impl ProjectMetadata {
             root,
             extra_configuration_paths: Vec::default(),
             options: Options::default(),
+            config_file_override: None,
         }
     }
 
+    pub fn from_config_file(
+        path: SystemPathBuf,
+        root: SystemPathBuf,
+        system: &dyn System,
+    ) -> Result<Self, ConfigurationFileError> {
+        tracing::debug!("Using overridden configuration file at '{path}'");
+
+        let config_file = ConfigurationFile::from_path(path.clone(), system)?;
+        let options = config_file.into_options();
+        Ok(Self {
+            name: Name::new(root.file_name().unwrap_or("root")),
+            root,
+            options,
+            extra_configuration_paths: Vec::new(),
+            config_file_override: Some(path),
+        })
+    }
+
     /// Loads a project from a `pyproject.toml` file.
     pub(crate) fn from_pyproject(
         pyproject: PyProject,
@@ -92,6 +114,7 @@ impl ProjectMetadata {
             root,
             options,
             extra_configuration_paths: Vec::new(),
+            config_file_override: None,
         })
     }
 

crates/ty_project/src/metadata/configuration_file.rs

@@ -14,6 +14,24 @@ pub(crate) struct ConfigurationFile {
 }
 
 impl ConfigurationFile {
+    pub(crate) fn from_path(
+        path: SystemPathBuf,
+        system: &dyn System,
+    ) -> Result<Self, ConfigurationFileError> {
+        let ty_toml_str = system.read_to_string(&path).map_err(|source| {
+            ConfigurationFileError::FileReadError {
+                source,
+                path: path.clone(),
+            }
+        })?;
+        match Options::from_toml_str(&ty_toml_str, ValueSource::File(Arc::new(path.clone()))) {
+            Ok(options) => Ok(Self { path, options }),
+            Err(error) => Err(ConfigurationFileError::InvalidTyToml {
+                source: Box::new(error),
+                path,
+            }),
+        }
+    }
     /// Loads the user-level configuration file if it exists.
     ///
     /// Returns `None` if the file does not exist or if the concept of user-level configurations
@@ -66,4 +84,10 @@ pub enum ConfigurationFileError {
         source: Box<TyTomlError>,
         path: SystemPathBuf,
     },
+    #[error("Failed to read `{path}`: {source}")]
+    FileReadError {
+        #[source]
+        source: std::io::Error,
+        path: SystemPathBuf,
+    },
 }