Skip to content

Commit

Permalink
Remove deprecated update-check setting (#4313)
Browse files Browse the repository at this point in the history
  • Loading branch information
charliermarsh authored May 9, 2023
1 parent 48e1852 commit a435c0d
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 44 deletions.
11 changes: 11 additions & 0 deletions BREAKING_CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Breaking Changes

## 0.0.266

### `update-check` is no longer a valid configuration option ([#4313](https://github.com/charliermarsh/ruff/pull/4313))

The `update-check` functionality was deprecated in [#2530](https://github.com/charliermarsh/ruff/pull/2530),
in that the behavior itself was removed, and Ruff was changed to warn when that option was enabled.

Now, Ruff will throw an error when `update-check` is provided via a configuration file (e.g.,
`update-check = false`) or through the command-line, since it has no effect. Users should remove
this option from their configuration.

## 0.0.265

### `--fix-only` now exits with a zero exit code, unless `--exit-non-zero-on-fix` is specified ([#4146](https://github.com/charliermarsh/ruff/pull/4146))
Expand Down
3 changes: 0 additions & 3 deletions crates/ruff/src/settings/configuration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ pub struct Configuration {
pub target_version: Option<PythonVersion>,
pub task_tags: Option<Vec<String>>,
pub typing_modules: Option<Vec<String>>,
pub update_check: Option<bool>,
// Plugins
pub flake8_annotations: Option<flake8_annotations::settings::Options>,
pub flake8_bandit: Option<flake8_bandit::settings::Options>,
Expand Down Expand Up @@ -201,7 +200,6 @@ impl Configuration {
target_version: options.target_version,
task_tags: options.task_tags,
typing_modules: options.typing_modules,
update_check: options.update_check,
// Plugins
flake8_annotations: options.flake8_annotations,
flake8_bandit: options.flake8_bandit,
Expand Down Expand Up @@ -272,7 +270,6 @@ impl Configuration {
target_version: self.target_version.or(config.target_version),
task_tags: self.task_tags.or(config.task_tags),
typing_modules: self.typing_modules.or(config.typing_modules),
update_check: self.update_check.or(config.update_check),
// Plugins
flake8_annotations: self.flake8_annotations.or(config.flake8_annotations),
flake8_bandit: self.flake8_bandit.or(config.flake8_bandit),
Expand Down
2 changes: 0 additions & 2 deletions crates/ruff/src/settings/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ impl AllSettings {
fix_only: config.fix_only.unwrap_or(false),
format: config.format.unwrap_or_default(),
show_fixes: config.show_fixes.unwrap_or(false),
update_check: config.update_check.unwrap_or_default(),
},
lib: Settings::from_configuration(config, project_root)?,
})
Expand All @@ -74,7 +73,6 @@ pub struct CliSettings {
pub fix_only: bool,
pub format: SerializationFormat,
pub show_fixes: bool,
pub update_check: bool,
}

#[derive(Debug, CacheKey)]
Expand Down
8 changes: 0 additions & 8 deletions crates/ruff/src/settings/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -445,14 +445,6 @@ pub struct Options {
)]
/// A list of rule codes or prefixes to consider non-autofix-able.
pub unfixable: Option<Vec<RuleSelector>>,
#[option(
default = "false",
value_type = "bool",
example = "update-check = true"
)]
/// Enable or disable automatic update checks (overridden by the
/// `--update-check` and `--no-update-check` command-line flags).
pub update_check: Option<bool>,
#[option_group]
/// Options for the `flake8-annotations` plugin.
pub flake8_annotations: Option<flake8_annotations::settings::Options>,
Expand Down
15 changes: 0 additions & 15 deletions crates/ruff_cli/src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -240,16 +240,6 @@ pub struct CheckArgs {
/// autofix, even if no lint violations remain.
#[arg(long, help_heading = "Miscellaneous", conflicts_with = "exit_zero")]
pub exit_non_zero_on_fix: bool,
/// Does nothing and will be removed in the future.
#[arg(
long,
overrides_with("no_update_check"),
help_heading = "Miscellaneous",
hide = true
)]
update_check: bool,
#[clap(long, overrides_with("update_check"), hide = true)]
no_update_check: bool,
/// Show counts for every rule with at least one violation.
#[arg(
long,
Expand Down Expand Up @@ -402,7 +392,6 @@ impl CheckArgs {
force_exclude: resolve_bool_arg(self.force_exclude, self.no_force_exclude),
format: self.format,
show_fixes: resolve_bool_arg(self.show_fixes, self.no_show_fixes),
update_check: resolve_bool_arg(self.update_check, self.no_update_check),
},
)
}
Expand Down Expand Up @@ -467,7 +456,6 @@ pub struct Overrides {
pub force_exclude: Option<bool>,
pub format: Option<SerializationFormat>,
pub show_fixes: Option<bool>,
pub update_check: Option<bool>,
}

impl ConfigProcessor for &Overrides {
Expand Down Expand Up @@ -527,9 +515,6 @@ impl ConfigProcessor for &Overrides {
if let Some(target_version) = &self.target_version {
config.target_version = Some(*target_version);
}
if let Some(update_check) = &self.update_check {
config.update_check = Some(*update_check);
}
}
}

Expand Down
8 changes: 0 additions & 8 deletions crates/ruff_cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,6 @@ fn check(args: CheckArgs, log_level: LogLevel) -> Result<ExitStatus> {
fix_only,
format,
show_fixes,
update_check,
..
} = pyproject_config.settings.cli;

Expand Down Expand Up @@ -311,13 +310,6 @@ fn check(args: CheckArgs, log_level: LogLevel) -> Result<ExitStatus> {
}
}

if update_check {
warn_user_once!(
"update-check has been removed; setting it will cause an error in a future \
version."
);
}

if !cli.exit_zero {
if cli.diff {
// If we're printing a diff, we always want to exit non-zero if there are
Expand Down
1 change: 0 additions & 1 deletion crates/ruff_wasm/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ pub fn defaultSettings() -> Result<JsValue, JsValue> {
task_tags: None,
typing_modules: None,
unfixable: None,
update_check: None,
// Use default options for all plugins.
flake8_annotations: Some(flake8_annotations::settings::Settings::default().into()),
flake8_bandit: Some(flake8_bandit::settings::Settings::default().into()),
Expand Down
7 changes: 0 additions & 7 deletions ruff.schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a435c0d

Please sign in to comment.