Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/dirty-beans-flash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@biomejs/biome": minor
---

Closes [#8024](https://github.com/biomejs/biome/issues/8024). Adds the `checkForEach` option to [useIterableCallbackReturn](https://biomejs.dev/linter/rules/use-iterable-callback-return/) allowing `forEach()` callbacks to be skipped from being checked for returning a value.
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,23 @@ declare_lint_rule! {
/// ```js
/// [].forEach(() => void null); // Void return value, which doesn't trigger the rule
/// ```
///
/// ## Options
///
/// ### `checkForEach`
///
/// Default: `true`
///
/// When set to `false`, rule will skip reporting `forEach` callbacks that return a value.
///
/// ```json,options
/// {
/// "options": {
/// "checkForEach": true
/// }
/// }
/// ```
///
pub UseIterableCallbackReturn {
version: "2.0.0",
name: "useIterableCallbackReturn",
Expand Down Expand Up @@ -128,6 +145,10 @@ impl Rule for UseIterableCallbackReturn {
.and_then(|member| member.as_js_name().cloned())
.and_then(|name| name.value_token().ok())?;

if !ctx.options().check_for_each() && member_name.text_trimmed() == "forEach" {
return None;
}

let method_config = ITERABLE_METHOD_INFOS.get(member_name.text_trimmed())?;

let arg_position = argument_list
Expand Down
16 changes: 15 additions & 1 deletion crates/biome_rule_options/src/use_iterable_callback_return.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,18 @@ use serde::{Deserialize, Serialize};
#[derive(Default, Clone, Debug, Deserialize, Deserializable, Merge, Eq, PartialEq, Serialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase", deny_unknown_fields, default)]
pub struct UseIterableCallbackReturnOptions {}
pub struct UseIterableCallbackReturnOptions {
/// When set to `false`, rule will skip reporting `forEach` callbacks that return a value.
#[serde(skip_serializing_if = "Option::<_>::is_none")]
pub check_for_each: Option<bool>,
}

impl UseIterableCallbackReturnOptions {
pub const DEFAULT_CHECK_FOR_EACH: bool = true;

/// Returns [`Self::check_for_each`] if it is set.
/// Otherwise, returns [`Self::DEFAULT_CHECK_FOR_EACH`].
pub fn check_for_each(&self) -> bool {
self.check_for_each.unwrap_or(Self::DEFAULT_CHECK_FOR_EACH)
}
}
7 changes: 6 additions & 1 deletion packages/@biomejs/backend-jsonrpc/src/workspace.ts

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

6 changes: 6 additions & 0 deletions packages/@biomejs/biome/configuration_schema.json

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