[ty] Add --config-file

217

Author: thejchap

crates/ty/docs/cli.md

@@ -42,6 +42,8 @@ ty check [OPTIONS] [PATH]...
 <li><code>always</code>:  Always display colors</li>
 <li><code>never</code>:  Never display colors</li>
 </ul></dd><dt id="ty-check--config"><a href="#ty-check--config"><code>--config</code></a>, <code>-c</code> <i>config-option</i></dt><dd><p>A TOML <code>&lt;KEY&gt; = &lt;VALUE&gt;</code> pair</p>
+</dd><dt id="ty-check--config-file"><a href="#ty-check--config-file"><code>--config-file</code></a> <i>config-file</i></dt><dd><p>A path to a <code>ty.toml</code> configuration file</p>
+<p><code>pyproject.toml</code> 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.</p>
 </dd><dt id="ty-check--error"><a href="#ty-check--error"><code>--error</code></a> <i>rule</i></dt><dd><p>Treat the given rule as having severity 'error'. Can be specified multiple times.</p>
 </dd><dt id="ty-check--error-on-warning"><a href="#ty-check--error-on-warning"><code>--error-on-warning</code></a></dt><dd><p>Use exit code 1 if there are any warning-level diagnostics</p>
 </dd><dt id="ty-check--exit-zero"><a href="#ty-check--exit-zero"><code>--exit-zero</code></a></dt><dd><p>Always use exit code 0, even when there are error-level diagnostics</p>

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

@@ -23,7 +23,7 @@ use ruff_db::diagnostic::{Diagnostic, DisplayDiagnosticConfig, Severity};
 use ruff_db::max_parallelism;
 use ruff_db::system::{OsSystem, SystemPath, SystemPathBuf};
 use salsa::plumbing::ZalsaDatabase;
-use ty_project::metadata::options::Options;
+use ty_project::metadata::options::MetaOptions;
 use ty_project::watch::ProjectWatcher;
 use ty_project::{Db, DummyReporter, Reporter, watch};
 use ty_project::{ProjectDatabase, ProjectMetadata};
@@ -102,12 +102,17 @@ 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 config_file = args.config_file.clone();
+
+    let mut project_metadata = match &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)?;
 
@@ -117,7 +122,8 @@ fn run_check(args: CheckCommand) -> anyhow::Result<ExitStatus> {
         db.project().set_included_paths(&mut db, check_paths);
     }
 
-    let (main_loop, main_loop_cancellation_token) = MainLoop::new(cli_options);
+    let meta_options = MetaOptions::new(config_file, cli_options);
+    let (main_loop, main_loop_cancellation_token) = MainLoop::new(meta_options);
 
     // Listen to Ctrl+C and abort the watch mode.
     let main_loop_cancellation_token = Mutex::new(Some(main_loop_cancellation_token));
@@ -178,19 +184,19 @@ struct MainLoop {
     /// The file system watcher, if running in watch mode.
     watcher: Option<ProjectWatcher>,
 
-    cli_options: Options,
+    meta_options: MetaOptions,
 }
 
 impl MainLoop {
-    fn new(cli_options: Options) -> (Self, MainLoopCancellationToken) {
+    fn new(meta_options: MetaOptions) -> (Self, MainLoopCancellationToken) {
         let (sender, receiver) = crossbeam_channel::bounded(10);
 
         (
             Self {
                 sender: sender.clone(),
                 receiver,
                 watcher: None,
-                cli_options,
+                meta_options,
             },
             MainLoopCancellationToken { sender },
         )
@@ -338,7 +344,7 @@ impl MainLoop {
                 MainLoopMessage::ApplyChanges(changes) => {
                     revision += 1;
                     // Automatically cancels any pending queries and waits for them to complete.
-                    db.apply_changes(changes, Some(&self.cli_options));
+                    db.apply_changes(changes, Some(&self.meta_options));
                     if let Some(watcher) = self.watcher.as_mut() {
                         watcher.update(db);
                     }

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/db/changes.rs

@@ -1,5 +1,5 @@
 use crate::db::{Db, ProjectDatabase};
-use crate::metadata::options::Options;
+use crate::metadata::options::MetaOptions;
 use crate::watch::{ChangeEvent, CreatedKind, DeletedKind};
 use crate::{Project, ProjectMetadata};
 use std::collections::BTreeSet;
@@ -12,10 +12,13 @@ use rustc_hash::FxHashSet;
 use ty_python_semantic::Program;
 
 impl ProjectDatabase {
-    #[tracing::instrument(level = "debug", skip(self, changes, cli_options))]
-    pub fn apply_changes(&mut self, changes: Vec<ChangeEvent>, cli_options: Option<&Options>) {
+    #[tracing::instrument(level = "debug", skip(self, changes, meta_options))]
+    pub fn apply_changes(&mut self, changes: Vec<ChangeEvent>, meta_options: Option<&MetaOptions>) {
         let mut project = self.project();
         let project_root = project.root(self).to_path_buf();
+        let config_file_override =
+            meta_options.and_then(|options| options.config_file_override.clone());
+        let cli_options = meta_options.map(|options| options.cli_options.clone());
         let program = Program::get(self);
         let custom_stdlib_versions_path = program
             .custom_stdlib_search_path(self)
@@ -42,6 +45,14 @@ impl ProjectDatabase {
             tracing::trace!("Handle change: {:?}", change);
 
             if let Some(path) = change.system_path() {
+                if let Some(config_file) = &config_file_override {
+                    if path.eq(config_file.as_path()) {
+                        project_changed = true;
+
+                        continue;
+                    }
+                }
+
                 if matches!(
                     path.file_name(),
                     Some(".gitignore" | ".ignore" | "ty.toml" | "pyproject.toml")
@@ -170,10 +181,16 @@ impl ProjectDatabase {
         }
 
         if project_changed {
-            match ProjectMetadata::discover(&project_root, self.system()) {
+            let new_project_metadata = match config_file_override {
+                Some(config_file) => {
+                    ProjectMetadata::from_config_file(config_file, project_root, self.system())
+                }
+                None => ProjectMetadata::discover(&project_root, self.system()),
+            };
+            match new_project_metadata {
                 Ok(mut metadata) => {
                     if let Some(cli_options) = cli_options {
-                        metadata.apply_cli_options(cli_options.clone());
+                        metadata.apply_cli_options(cli_options);
                     }
 
                     if let Err(error) = metadata.apply_configuration_files(self.system()) {

crates/ty_project/src/lib.rs

@@ -5,7 +5,7 @@ use crate::walk::{ProjectFilesFilter, ProjectFilesWalker};
 pub use db::{Db, ProjectDatabase};
 use files::{Index, Indexed, IndexedFiles};
 use metadata::settings::Settings;
-pub use metadata::{ProjectDiscoveryError, ProjectMetadata};
+pub use metadata::{ProjectMetadata, ProjectMetadataError};
 use ruff_db::diagnostic::{
     Annotation, Diagnostic, DiagnosticId, Severity, Span, SubDiagnostic, create_parse_diagnostic,
     create_unsupported_syntax_diagnostic,

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,35 @@ 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, ProjectMetadataError> {
+        tracing::debug!("Using overridden configuration file at '{path}'");
+
+        let config_file = ConfigurationFile::from_path(path.clone(), system).map_err(|error| {
+            ProjectMetadataError::ConfigurationFileError {
+                source: Box::new(error),
+                path: path.clone(),
+            }
+        })?;
+
+        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 +121,7 @@ impl ProjectMetadata {
             root,
             options,
             extra_configuration_paths: Vec::new(),
+            config_file_override: None,
         })
     }
 
@@ -106,11 +136,11 @@ impl ProjectMetadata {
     pub fn discover(
         path: &SystemPath,
         system: &dyn System,
-    ) -> Result<ProjectMetadata, ProjectDiscoveryError> {
+    ) -> Result<ProjectMetadata, ProjectMetadataError> {
         tracing::debug!("Searching for a project in '{path}'");
 
         if !system.is_directory(path) {
-            return Err(ProjectDiscoveryError::NotADirectory(path.to_path_buf()));
+            return Err(ProjectMetadataError::NotADirectory(path.to_path_buf()));
         }
 
         let mut closest_project: Option<ProjectMetadata> = None;
@@ -125,7 +155,7 @@ impl ProjectMetadata {
                 ) {
                     Ok(pyproject) => Some(pyproject),
                     Err(error) => {
-                        return Err(ProjectDiscoveryError::InvalidPyProject {
+                        return Err(ProjectMetadataError::InvalidPyProject {
                             path: pyproject_path,
                             source: Box::new(error),
                         });
@@ -144,7 +174,7 @@ impl ProjectMetadata {
                 ) {
                     Ok(options) => options,
                     Err(error) => {
-                        return Err(ProjectDiscoveryError::InvalidTyToml {
+                        return Err(ProjectMetadataError::InvalidTyToml {
                             path: ty_toml_path,
                             source: Box::new(error),
                         });
@@ -171,7 +201,7 @@ impl ProjectMetadata {
                         .and_then(|pyproject| pyproject.project.as_ref()),
                 )
                 .map_err(|err| {
-                    ProjectDiscoveryError::InvalidRequiresPythonConstraint {
+                    ProjectMetadataError::InvalidRequiresPythonConstraint {
                         source: err,
                         path: pyproject_path,
                     }
@@ -185,7 +215,7 @@ impl ProjectMetadata {
                 let metadata =
                     ProjectMetadata::from_pyproject(pyproject, project_root.to_path_buf())
                         .map_err(
-                            |err| ProjectDiscoveryError::InvalidRequiresPythonConstraint {
+                            |err| ProjectMetadataError::InvalidRequiresPythonConstraint {
                                 source: err,
                                 path: pyproject_path,
                             },
@@ -281,7 +311,7 @@ impl ProjectMetadata {
 }
 
 #[derive(Debug, Error)]
-pub enum ProjectDiscoveryError {
+pub enum ProjectMetadataError {
     #[error("project path '{0}' is not a directory")]
     NotADirectory(SystemPathBuf),
 
@@ -302,6 +332,12 @@ pub enum ProjectDiscoveryError {
         source: ResolveRequiresPythonError,
         path: SystemPathBuf,
     },
+
+    #[error("Error loading configuration file at {path}: {source}")]
+    ConfigurationFileError {
+        source: Box<ConfigurationFileError>,
+        path: SystemPathBuf,
+    },
 }
 
 #[cfg(test)]
@@ -313,7 +349,7 @@ mod tests {
     use ruff_db::system::{SystemPathBuf, TestSystem};
     use ruff_python_ast::PythonVersion;
 
-    use crate::{ProjectDiscoveryError, ProjectMetadata};
+    use crate::{ProjectMetadata, ProjectMetadataError};
 
     #[test]
     fn project_without_pyproject() -> anyhow::Result<()> {
@@ -336,6 +372,7 @@ mod tests {
                   name: Name("app"),
                   root: "/app",
                   options: Options(),
+                  config_file_override: None,
                 )
             "#);
         });
@@ -374,6 +411,7 @@ mod tests {
                   name: Name("backend"),
                   root: "/app",
                   options: Options(),
+                  config_file_override: None,
                 )
             "#);
         });
@@ -471,6 +509,7 @@ expected `.`, `]`
                   root: Some("src"),
                 )),
               ),
+              config_file_override: None,
             )
             "#);
         });
@@ -521,6 +560,7 @@ expected `.`, `]`
                                     root: Some("src"),
                                   )),
                                 ),
+                                config_file_override: None,
                               )
                               "#);
         });
@@ -561,6 +601,7 @@ expected `.`, `]`
               name: Name("nested-project"),
               root: "/app/packages/a",
               options: Options(),
+              config_file_override: None,
             )
             "#);
         });
@@ -608,6 +649,7 @@ expected `.`, `]`
                   r#python-version: Some("3.10"),
                 )),
               ),
+              config_file_override: None,
             )
             "#);
         });
@@ -663,6 +705,7 @@ expected `.`, `]`
                   root: Some("src"),
                 )),
               ),
+              config_file_override: None,
             )
             "#);
         });
@@ -948,7 +991,7 @@ expected `.`, `]`
     }
 
     #[track_caller]
-    fn assert_error_eq(error: &ProjectDiscoveryError, message: &str) {
+    fn assert_error_eq(error: &ProjectMetadataError, message: &str) {
         assert_eq!(error.to_string().replace('\\', "/"), message);
     }