feat(oxfmt): Support ignorePatterns in oxfmtrc

Author: leaysgur

apps/oxfmt/src/format.rs

@@ -7,7 +7,7 @@ use std::{
 };
 
 use oxc_diagnostics::DiagnosticService;
-use oxc_formatter::{FormatOptions, Oxfmtrc};
+use oxc_formatter::Oxfmtrc;
 
 use crate::{
     cli::{CliRunResult, FormatCommand},
@@ -49,8 +49,8 @@ impl FormatRunner {
         // NOTE: Currently, we only load single config file.
         // - from `--config` if specified
         // - else, search nearest for the nearest `.oxfmtrc.json` from cwd upwards
-        let format_options = match load_config(&cwd, basic_options.config.as_ref()) {
-            Ok(options) => options,
+        let config = match load_config(&cwd, basic_options.config.as_ref()) {
+            Ok(config) => config,
             Err(err) => {
                 print_and_flush_stdout(
                     stdout,
@@ -60,11 +60,21 @@ impl FormatRunner {
             }
         };
 
+        let ignore_patterns = config.ignore_patterns.clone().unwrap_or_default();
+        let format_options = match config.into_format_options() {
+            Ok(options) => options,
+            Err(err) => {
+                print_and_flush_stdout(stdout, &format!("Failed to parse configuration.\n{err}\n"));
+                return CliRunResult::InvalidOptionConfig;
+            }
+        };
+
         let walker = match Walk::build(
             &cwd,
             &paths,
             &ignore_options.ignore_path,
             ignore_options.with_node_modules,
+            &ignore_patterns,
         ) {
             Ok(walker) => walker,
             Err(err) => {
@@ -171,7 +181,7 @@ impl FormatRunner {
 /// Returns error if:
 /// - Config file is specified but not found or invalid
 /// - Config file parsing fails
-fn load_config(cwd: &Path, config_path: Option<&PathBuf>) -> Result<FormatOptions, String> {
+fn load_config(cwd: &Path, config_path: Option<&PathBuf>) -> Result<Oxfmtrc, String> {
     let config_path = if let Some(config_path) = config_path {
         // If `--config` is explicitly specified, use that path
         Some(if config_path.is_absolute() {
@@ -194,9 +204,9 @@ fn load_config(cwd: &Path, config_path: Option<&PathBuf>) -> Result<FormatOption
     };
 
     match config_path {
-        Some(ref path) => Oxfmtrc::from_file(path)?.into_format_options(),
+        Some(ref path) => Oxfmtrc::from_file(path),
         // Default if not specified and not found
-        None => Ok(FormatOptions::default()),
+        None => Ok(Oxfmtrc::default()),
     }
 }
 

apps/oxfmt/src/walk.rs

@@ -18,6 +18,7 @@ impl Walk {
         paths: &[PathBuf],
         ignore_paths: &[PathBuf],
         with_node_modules: bool,
+        ignore_patterns: &[String],
     ) -> Result<Self, String> {
         let (target_paths, exclude_patterns) = normalize_paths(cwd, paths);
 
@@ -55,8 +56,12 @@ impl Walk {
                 return Err(format!("Failed to add ignore file: {}", ignore_path.display()));
             }
         }
-        // TODO: Support config.ignorePatterns
-        // Use `builder.add_line(None, pattern_str)` here
+        // Handle `config.ignorePatterns`
+        for pattern in ignore_patterns {
+            if builder.add_line(None, pattern).is_err() {
+                return Err(format!("Failed to add ignore pattern `{pattern}`"));
+            }
+        }
         let ignores = builder.build().map_err(|_| "Failed to build ignores".to_string())?;
 
         // NOTE: If return `false` here, it will not be `visit()`ed at all

apps/oxfmt/tests/fixtures/config_ignore_patterns/.oxfmtrc.json

@@ -0,0 +1,3 @@
+{
+  "ignorePatterns": ["not-formatted/"]
+}

apps/oxfmt/tests/fixtures/config_ignore_patterns/fmtrc.jsonc

@@ -0,0 +1,3 @@
+{
+    "ignorePatterns": ["*.js"],
+}

apps/oxfmt/tests/fixtures/config_ignore_patterns/not-formatted/bad.js

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

apps/oxfmt/tests/fixtures/config_ignore_patterns/not-formatted/err.js

@@ -0,0 +1 @@
+class

apps/oxfmt/tests/mod.rs

@@ -183,6 +183,22 @@ fn ignore_patterns() {
         );
 }
 
+#[test]
+fn config_ignore_patterns() {
+    Tester::new()
+        .with_cwd(PathBuf::from("tests/fixtures/config_ignore_patterns"))
+        .test_and_snapshot_multiple(
+            "config_ignore_patterns",
+            &[
+                // .oxfmtrc.json contains: ignorePatterns: ["not-formatted/"]
+                // Should not find any files
+                &["--check"],
+                // fmtrc.jsonc also ignores every .js files
+                &["--check", "--config", "fmtrc.jsonc"],
+            ],
+        );
+}
+
 #[test]
 fn ignore_and_override() {
     Tester::new()

apps/oxfmt/tests/snapshots/config_ignore_patterns@oxfmt.snap

@@ -0,0 +1,24 @@
+---
+source: apps/oxfmt/tests/tester.rs
+---
+########## 
+arguments: --check
+working directory: tests/fixtures/config_ignore_patterns
+----------
+Checking formatting...
+
+Expected at least one target file
+----------
+CLI result: NoFilesFound
+----------
+
+########## 
+arguments: --check --config fmtrc.jsonc
+working directory: tests/fixtures/config_ignore_patterns
+----------
+Checking formatting...
+
+Expected at least one target file
+----------
+CLI result: NoFilesFound
+----------

crates/oxc_formatter/src/service/oxfmtrc.rs

@@ -48,6 +48,8 @@ pub struct Oxfmtrc {
     // TODO: experimental_ternaries
     #[serde(skip_serializing_if = "Option::is_none")]
     pub experimental_sort_imports: Option<SortImportsConfig>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ignore_patterns: Option<Vec<String>>,
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize, JsonSchema)]

crates/oxc_formatter/tests/snapshots/schema_json.snap

@@ -48,6 +48,15 @@ expression: json
         }
       ]
     },
+    "ignorePatterns": {
+      "type": [
+        "array",
+        "null"
+      ],
+      "items": {
+        "type": "string"
+      }
+    },
     "jsxSingleQuote": {
       "type": [
         "boolean",