fix ENH: Allow setting default output-format in pyproject.toml / pyrefly.toml #2688 by asukaminato0721 · Pull Request #2786 · facebook/pyrefly

asukaminato0721 · 2026-03-12T18:17:27Z

Summary

output-format is now a recognized project-level config option in both pyrefly.toml and [tool.pyrefly] in pyproject.toml, and pyrefly check will inherit it only when --output-format is not set on the CLI.

Test Plan

add test

Copilot

Pull request overview

Adds support for configuring output-format at the project level so pyrefly check uses it when the CLI --output-format flag is not provided.

Changes:

Document output-format as a project-level config option.
Add output_format to ConfigFile (TOML/pyproject parsing) with tests.
Update pyrefly check CLI handling to treat --output-format as optional and inherit from config.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File	Description
website/docs/configuration.mdx	Documents new `output-format` configuration option and precedence rules.
pyrefly/lib/commands/check.rs	Changes CLI arg to `Option`, inherits config defaults, and threads chosen format into output writing; adds tests.
crates/pyrefly_config/src/config.rs	Introduces `OutputFormat` in config schema and parses/serializes `output-format`; updates config parsing tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-12T19:06:24Z

pyrefly/lib/commands/check.rs

+impl OutputArgs {
+    fn inherit_defaults_from_config(&mut self, config: &ConfigFile) {
+        if self.baseline.is_none() {
+            self.baseline = config.baseline.clone();
+        }
+        if self.output_format.is_none() {
+            self.output_format = config.output_format.map(OutputFormat::from);
+        }
+    }
+
+    fn output_format(&self) -> OutputFormat {
+        self.output_format.clone().unwrap_or_default()
+    }
+}


inherit_defaults_from_config only fills fields when they are None, but the watch-mode loop comment says it should 'pick up config file changes'. After the first iteration, inherited values become Some(...) and will no longer update if the config changes (unless the CLI explicitly set them). To preserve hot-reload behavior, update the loop to overwrite baseline / output_format from config when !cli_provided_* (even if currently Some), or add a dedicated method (e.g. refresh_from_config_when_not_overridden(cli_provided_baseline, cli_provided_output_format, config)) that can overwrite existing values.

Copilot · 2026-03-12T19:06:24Z

pyrefly/lib/commands/check.rs

                    handle.path(),
                );
-                self.output.baseline = config.baseline.clone();
+                self.output.inherit_defaults_from_config(&config);


inherit_defaults_from_config only fills fields when they are None, but the watch-mode loop comment says it should 'pick up config file changes'. After the first iteration, inherited values become Some(...) and will no longer update if the config changes (unless the CLI explicitly set them). To preserve hot-reload behavior, update the loop to overwrite baseline / output_format from config when !cli_provided_* (even if currently Some), or add a dedicated method (e.g. refresh_from_config_when_not_overridden(cli_provided_baseline, cli_provided_output_format, config)) that can overwrite existing values.

Suggested change

self.output.inherit_defaults_from_config(&config);

self.output

.refresh_from_config_when_not_overridden(

cli_provided_baseline,

cli_provided_output_format,

&config,

);

Copilot · 2026-03-12T19:06:25Z

crates/pyrefly_config/src/config.rs

@@ -19,6 +19,7 @@ use std::time::Instant;
 use anyhow::Context;
 use anyhow::Result;
 use anyhow::anyhow;


This makes the config crate depend on clap just to derive ValueEnum. If pyrefly_config is intended to be a general-purpose library (used beyond the CLI), pulling clap into it increases coupling and can add compile-time overhead. Consider keeping the config enum purely serde-driven and performing string/enum mapping in the CLI crate (or feature-gating the ValueEnum derive behind a cli feature) to keep config parsing concerns separate from CLI concerns.

Suggested change

use anyhow::anyhow;

use anyhow::anyhow;

#[cfg(feature = "cli")]

Copilot · 2026-03-12T19:06:25Z

crates/pyrefly_config/src/config.rs

+#[derive(
+    Debug,
+    PartialEq,
+    Eq,
+    Deserialize,
+    Serialize,
+    Clone,
+    Copy,
+    Default,
+    ValueEnum
+)]
+#[serde(rename_all = "kebab-case")]
+pub enum OutputFormat {
+    /// Minimal text output, one line per error
+    MinText,
+    #[default]
+    /// Full, verbose text output
+    FullText,
+    /// JSON output
+    Json,
+    /// Emit GitHub Actions workflow commands
+    Github,
+    /// Only show error count, omitting individual errors
+    OmitErrors,
+}


This makes the config crate depend on clap just to derive ValueEnum. If pyrefly_config is intended to be a general-purpose library (used beyond the CLI), pulling clap into it increases coupling and can add compile-time overhead. Consider keeping the config enum purely serde-driven and performing string/enum mapping in the CLI crate (or feature-gating the ValueEnum derive behind a cli feature) to keep config parsing concerns separate from CLI concerns.

Copilot · 2026-03-12T19:06:25Z

pyrefly/lib/commands/check.rs

@@ -210,8 +223,8 @@ struct OutputArgs {
    #[arg(long, short = 'o', value_name = "OUTPUT_FILE")]
    output: Option<PathBuf>,
    /// Set the error output format.


Now that --output-format is optional (so config can supply it), the CLI help text no longer communicates the effective default (full-text) and precedence (CLI overrides config). Update the doc comment/arg help to explicitly state the default and that the config output-format is used only when the flag is absent, so behavior matches what’s documented in the website docs.

Suggested change

/// Set the error output format.

/// Set the error output format.

///

/// Defaults to `full-text` when neither this flag nor a config

/// `output-format` is provided. If both are set, this flag overrides

/// the config. The config `output-format` is only used when this

/// flag is omitted.

github-actions · 2026-03-18T03:17:30Z

According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅

meta-cla bot added the cla signed label Mar 12, 2026

This comment has been minimized.

Sign in to view

asukaminato0721 marked this pull request as ready for review March 12, 2026 18:59

Copilot AI review requested due to automatic review settings March 12, 2026 19:00

Copilot AI reviewed Mar 12, 2026

View reviewed changes

Copilot started reviewing on behalf of asukaminato0721 March 12, 2026 19:19 View session

asukaminato0721 force-pushed the 2688 branch from 1dfd92e to d1bd1ae Compare March 13, 2026 08:01

This comment has been minimized.

Sign in to view

fix

2ca3fd8

asukaminato0721 force-pushed the 2688 branch from d1bd1ae to 2ca3fd8 Compare March 18, 2026 02:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix ENH: Allow setting default output-format in pyproject.toml / pyrefly.toml #2688#2786

fix ENH: Allow setting default output-format in pyproject.toml / pyrefly.toml #2688#2786
asukaminato0721 wants to merge 1 commit intofacebook:mainfrom
asukaminato0721:2688

asukaminato0721 commented Mar 12, 2026

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Uh oh!

Copilot AI Mar 12, 2026

Uh oh!

Copilot AI Mar 12, 2026

Uh oh!

Copilot AI Mar 12, 2026

Uh oh!

Copilot AI Mar 12, 2026

Uh oh!

Copilot AI Mar 12, 2026

Uh oh!

This comment has been minimized.

github-actions bot commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-                self.output.inherit_defaults_from_config(&config);
+                self.output
+                    .refresh_from_config_when_not_overridden(
+                        cli_provided_baseline,
+                        cli_provided_output_format,
+                        &config,
+                    );

	use anyhow::anyhow;
	use anyhow::anyhow;
	#[cfg(feature = "cli")]

-    /// Set the error output format.
+    /// Set the error output format.
+    ///
+    /// Defaults to `full-text` when neither this flag nor a config
+    /// `output-format` is provided. If both are set, this flag overrides
+    /// the config. The config `output-format` is only used when this
+    /// flag is omitted.

Conversation

asukaminato0721 commented Mar 12, 2026

Summary

Test Plan

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

github-actions bot commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants