fix(prettier): honor .prettierignore during checks

qlty-check/src/cache.rs

@@ -243,6 +243,11 @@ impl InvocationCacheKey {
             &driver.copy_configs_into_tool_install.to_string(),
         );
 
+        digest.add(
+            "plugin.driver.ignore_files",
+            &serde_yaml::to_string(&driver.ignore_files).unwrap(),
+        );
+
         digest.add("qlty_version", &self.qlty_version);
         digest.add("tool", &self.tool.directory());
         digest.add("driver_name", &self.driver_name);

qlty-check/src/executor/invocation_script.rs

@@ -4,6 +4,7 @@ use itertools::Itertools;
 use qlty_analysis::utils::fs::path_to_string;
 use qlty_analysis::{join_path_string, utils::fs::path_to_native_string};
 use qlty_config::config::InvocationDirectoryType;
+use std::path::{Path, PathBuf};
 use tracing::{error, trace};
 
 #[cfg(unix)]
@@ -18,6 +19,7 @@ pub fn compute_invocation_script(plan: &InvocationPlan) -> Result<String> {
     // Autoload script first in case it has variables that need to be interpolated
     base_script = replace_autoload_script(plan, base_script);
     base_script = replace_config_script(plan, base_script);
+    base_script = replace_ignore_paths(plan, base_script);
     base_script = plan.tool.interpolate_variables(&base_script);
     base_script = replace_target_variable(plan, base_script);
     base_script = replace_tmpfile_variable(plan, base_script);
@@ -53,6 +55,22 @@ fn replace_config_script(plan: &InvocationPlan, script: String) -> String {
     }
 }
 
+fn replace_ignore_paths(plan: &InvocationPlan, script: String) -> String {
+    if !script.contains("${ignore_paths}") {
+        return script;
+    }
+
+    let ignore_paths = get_ignore_paths(plan)
+        .into_iter()
+        .map(|path| {
+            let escaped = escape(path_to_native_string(path).into()).into_owned();
+            format!("--ignore-path={escaped}")
+        })
+        .join(" ");
+
+    script.replace("${ignore_paths}", &ignore_paths)
+}
+
 fn replace_target_variable(plan: &InvocationPlan, script: String) -> String {
     if script.contains("${target}") {
         let targets_list = plan_target_list(plan);
@@ -108,6 +126,39 @@ fn get_config_file_paths(plan: &InvocationPlan) -> Vec<String> {
         .collect()
 }
 
+fn get_ignore_paths(plan: &InvocationPlan) -> Vec<PathBuf> {
+    let search_directory = ignore_search_directory(plan);
+
+    plan.driver
+        .ignore_files
+        .iter()
+        .map(|ignore_file| search_directory.join(ignore_file))
+        .filter(|ignore_path| ignore_path.exists())
+        .collect()
+}
+
+fn ignore_search_directory(plan: &InvocationPlan) -> PathBuf {
+    plan.plugin_configs
+        .first()
+        .and_then(|config| effective_config_directory(plan, &config.path))
+        .unwrap_or_else(|| plan.target_root.clone())
+}
+
+fn effective_config_directory(plan: &InvocationPlan, config_path: &Path) -> Option<PathBuf> {
+    if plan.target_root == plan.workspace.root {
+        return config_path.parent().map(Path::to_path_buf);
+    }
+
+    let relative_path = config_path.strip_prefix(&plan.workspace.root).ok()?;
+    Some(
+        plan.target_root
+            .join(relative_path)
+            .parent()
+            .unwrap()
+            .to_path_buf(),
+    )
+}
+
 pub fn plan_target_list(plan: &InvocationPlan) -> String {
     plan.targets
         .iter()
@@ -152,7 +203,8 @@ mod test {
         Workspace,
     };
     use qlty_types::analysis::v1::ExecutionVerb;
-    use std::{path::PathBuf, sync::Arc, time::SystemTime};
+    use std::{fs, path::PathBuf, sync::Arc, time::SystemTime};
+    use tempfile::tempdir;
 
     #[test]
     fn test_target_list() {
@@ -332,4 +384,114 @@ mod test {
 
         assert_eq!(script, "autoload_script: autoload.php");
     }
+
+    #[test]
+    fn test_replace_ignore_paths_uses_root_ignore_files_without_config() {
+        let temp_dir = tempdir().unwrap();
+        let workspace_root = temp_dir.path().to_path_buf();
+
+        fs::write(workspace_root.join(".prettierignore"), "ignored.js\n").unwrap();
+        fs::write(workspace_root.join(".gitignore"), "build/\n").unwrap();
+
+        let mut driver = build_driver(vec![], vec![]);
+        driver.ignore_files = vec![
+            PathBuf::from(".prettierignore"),
+            PathBuf::from(".gitignore"),
+        ];
+
+        let plan = InvocationPlan {
+            target_root: workspace_root.clone(),
+            workspace_entries: Arc::new(vec![]),
+            invocation_id: "".to_string(),
+            verb: ExecutionVerb::Check,
+            workspace: Workspace {
+                root: workspace_root.clone(),
+            },
+            settings: Default::default(),
+            runtime: None,
+            runtime_version: None,
+            plugin_name: "prettier".to_string(),
+            plugin: PluginDef::default(),
+            tool: Ruby::new_tool(""),
+            driver_name: "format".to_string(),
+            driver,
+            plugin_configs: vec![],
+            targets: vec![],
+            invocation_directory: PathBuf::from("/tool"),
+            invocation_directory_def: InvocationDirectoryDef {
+                kind: InvocationDirectoryType::ToolDir,
+                path: None,
+            },
+        };
+
+        let script = replace_ignore_paths(&plan, "prettier ${ignore_paths} ${target}".to_string());
+
+        assert!(script.contains("--ignore-path="));
+        assert!(script.contains(".prettierignore"));
+        assert!(script.contains(".gitignore"));
+    }
+
+    #[test]
+    fn test_replace_ignore_paths_uses_staged_config_directory() {
+        let workspace_dir = tempdir().unwrap();
+        let staging_dir = tempdir().unwrap();
+        let workspace_root = workspace_dir.path().to_path_buf();
+        let target_root = staging_dir.path().to_path_buf();
+        let config_path = workspace_root.join("packages/app/.prettierrc");
+
+        fs::create_dir_all(config_path.parent().unwrap()).unwrap();
+        fs::create_dir_all(target_root.join("packages/app")).unwrap();
+        fs::write(&config_path, "{}\n").unwrap();
+        fs::write(
+            target_root.join("packages/app/.prettierignore"),
+            "ignored.js\n",
+        )
+        .unwrap();
+        fs::write(target_root.join("packages/app/.gitignore"), "dist/\n").unwrap();
+        fs::write(target_root.join(".prettierignore"), "wrong.js\n").unwrap();
+
+        let mut driver = build_driver(vec![], vec![]);
+        driver.ignore_files = vec![
+            PathBuf::from(".prettierignore"),
+            PathBuf::from(".gitignore"),
+        ];
+
+        let plan = InvocationPlan {
+            target_root,
+            workspace_entries: Arc::new(vec![]),
+            invocation_id: "".to_string(),
+            verb: ExecutionVerb::Check,
+            workspace: Workspace {
+                root: workspace_root,
+            },
+            settings: Default::default(),
+            runtime: None,
+            runtime_version: None,
+            plugin_name: "prettier".to_string(),
+            plugin: PluginDef::default(),
+            tool: Ruby::new_tool(""),
+            driver_name: "format".to_string(),
+            driver,
+            plugin_configs: vec![crate::planner::config_files::PluginConfigFile {
+                path: config_path,
+                contents: "{}".to_string(),
+            }],
+            targets: vec![],
+            invocation_directory: PathBuf::from("/tool"),
+            invocation_directory_def: InvocationDirectoryDef {
+                kind: InvocationDirectoryType::ToolDir,
+                path: None,
+            },
+        };
+
+        let script = replace_ignore_paths(&plan, "prettier ${ignore_paths} ${target}".to_string());
+
+        assert!(script.contains(&path_to_native_string(
+            plan.target_root.join("packages/app/.prettierignore")
+        )));
+        assert!(script.contains(&path_to_native_string(
+            plan.target_root.join("packages/app/.gitignore")
+        )));
+        assert!(!script.contains("wrong.js"));
+    }
 }

qlty-cli/tests/cmd/network/check/prettier_ignore.in/.gitignore

@@ -0,0 +1 @@
+.qlty/

qlty-cli/tests/cmd/network/check/prettier_ignore.in/.prettierignore

@@ -0,0 +1 @@
+ignored

qlty-cli/tests/cmd/network/check/prettier_ignore.in/.qlty/qlty.toml

@@ -0,0 +1,8 @@
+config_version = "0"
+
+[[source]]
+name = "default"
+default = true
+
+[[plugin]]
+name = "prettier"

qlty-cli/tests/cmd/network/check/prettier_ignore.in/ignored/ignored.js

@@ -0,0 +1 @@
+const thing={answer:42}

qlty-cli/tests/cmd/network/check/prettier_ignore.in/included.js

@@ -0,0 +1 @@
+const thing={answer:42}

qlty-cli/tests/cmd/network/check/prettier_ignore.stderr

@@ -0,0 +1,2 @@
+✖ 1 issue
+✖ 1 unformatted file

qlty-cli/tests/cmd/network/check/prettier_ignore.stdout

@@ -0,0 +1,11 @@
+
+ UNFORMATTED FILES: 1 
+
+✖ included.js
+
+
+ ISSUES: 1 
+
+included.js:0:0
+    0:0  fmt     Incorrect formatting, autoformat by running `qlty fmt`.  prettier:fmt
+

qlty-cli/tests/cmd/network/check/prettier_ignore.toml

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

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.in/.gitignore

@@ -0,0 +1 @@
+tmp/

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.in/.qlty/qlty.toml

@@ -0,0 +1,8 @@
+config_version = "0"
+
+[[source]]
+name = "default"
+default = true
+
+[[plugin]]
+name = "prettier"

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.in/packages/app/.prettierignore

@@ -0,0 +1 @@
+ignored.js

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.in/packages/app/.prettierrc.json

@@ -0,0 +1 @@
+{}

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.in/packages/app/ignored.js

@@ -0,0 +1 @@
+const ignored = [1,2,3]

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.in/packages/app/included.js

@@ -0,0 +1 @@
+const included = [1,2,3]

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.stderr

@@ -0,0 +1,2 @@
+✖ 1 issue
+✖ 1 unformatted file

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.stdout

@@ -0,0 +1,11 @@
+
+ UNFORMATTED FILES: 1 
+
+✖ packages/app/included.js
+
+
+ ISSUES: 1 
+
+packages/app/included.js:0:0
+    0:0  fmt     Incorrect formatting, autoformat by running `qlty fmt`.  prettier:fmt
+

qlty-cli/tests/cmd/network/check/prettier_nested_ignore.toml

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

qlty-config/src/config/plugin.rs

@@ -102,6 +102,9 @@ pub struct DriverDef {
     #[serde(default)]
     pub config_files: Vec<PathBuf>,
 
+    #[serde(default)]
+    pub ignore_files: Vec<PathBuf>,
+
     #[serde(default)]
     pub suggested: SuggestionMode,
 

qlty-plugins/plugins/linters/prettier/plugin.toml

@@ -30,14 +30,15 @@ config_files = [
   "prettier.config.cjs",
   "prettier.config.js",
 ]
-affects_cache = ["package.json", ".editorconfig", ".prettierignore"]
+affects_cache = ["package.json", ".editorconfig", ".gitignore", ".prettierignore"]
 description = "JS, CSS, HTML, JSON, TS, GraphQL, MD and YML formatter"
 package_file_candidate = "package.json"
 package_file_candidate_filters = ["prettier"]
 
 [plugins.definitions.prettier.drivers.format]
-script = "prettier --config ${config_file} -w ${target}"
+script = "prettier ${ignore_paths} --config ${config_file} -w ${target}"
 runs_from = { type = "tool_directory" }
+ignore_files = [".prettierignore", ".gitignore"]
 batch_by = "config_file"
 success_codes = [0] # https://prettier.io/docs/cli#exit-codes
 cache_results = true