feat(js/lint): implement rule useDisposables

Author: siketyan

.changeset/fast-glasses-ask.md

@@ -0,0 +1,33 @@
+---
+"@biomejs/biome": patch
+---
+
+Add a new lint rule `useDisposables` for JavaScript, which detects a disposable object assigned to a variable without `using` or `await using` syntax. Disposable objects, which implements `Disposable` or `AsyncDisposable` interface, are intended to dispose after use. Not disposing them can lead some resource or memory leak depending on the implementation.
+
+**Invalid:**
+
+```js
+function createDisposable(): Disposable {
+  return {
+    [Symbol.dispose]() {
+      // do something
+    },
+  };
+}
+
+const disposable = createDisposable();
+```
+
+**Valid:**
+
+```js
+function createDisposable(): Disposable {
+  return {
+    [Symbol.dispose]() {
+      // do something
+    },
+  };
+}
+
+using disposable = createDisposable();
+```

crates/biome_configuration/src/analyzer/linter/rules.rs

@@ -45,6 +45,7 @@ pub mod use_array_sort_compare;
 pub mod use_await_thenable;
 pub mod use_consistent_arrow_return;
 pub mod use_destructuring;
+pub mod use_disposables;
 pub mod use_exhaustive_switch_cases;
 pub mod use_explicit_type;
 pub mod use_find;
@@ -57,4 +58,4 @@ pub mod use_spread;
 pub mod use_vue_consistent_define_props_declaration;
 pub mod use_vue_define_macros_order;
 pub mod use_vue_multi_word_component_names;
-declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: no_ambiguous_anchor_text :: NoAmbiguousAnchorText , self :: no_before_interactive_script_outside_document :: NoBeforeInteractiveScriptOutsideDocument , self :: no_continue :: NoContinue , self :: no_deprecated_imports :: NoDeprecatedImports , self :: no_duplicated_spread_props :: NoDuplicatedSpreadProps , self :: no_empty_source :: NoEmptySource , self :: no_equals_to_null :: NoEqualsToNull , self :: no_floating_promises :: NoFloatingPromises , self :: no_for_in :: NoForIn , self :: no_import_cycles :: NoImportCycles , self :: no_increment_decrement :: NoIncrementDecrement , self :: no_jsx_literals :: NoJsxLiterals , self :: no_jsx_props_bind :: NoJsxPropsBind , self :: no_leaked_render :: NoLeakedRender , self :: no_misused_promises :: NoMisusedPromises , self :: no_multi_assign :: NoMultiAssign , self :: no_multi_str :: NoMultiStr , self :: no_next_async_client_component :: NoNextAsyncClientComponent , self :: no_parameters_only_used_in_recursion :: NoParametersOnlyUsedInRecursion , self :: no_proto :: NoProto , self :: no_react_forward_ref :: NoReactForwardRef , self :: no_return_assign :: NoReturnAssign , self :: no_script_url :: NoScriptUrl , self :: no_shadow :: NoShadow , self :: no_sync_scripts :: NoSyncScripts , self :: no_ternary :: NoTernary , self :: no_undeclared_env_vars :: NoUndeclaredEnvVars , self :: no_unknown_attribute :: NoUnknownAttribute , self :: no_unnecessary_conditions :: NoUnnecessaryConditions , self :: no_unresolved_imports :: NoUnresolvedImports , self :: no_unused_expressions :: NoUnusedExpressions , self :: no_useless_catch_binding :: NoUselessCatchBinding , self :: no_useless_undefined :: NoUselessUndefined , self :: no_vue_data_object_declaration :: NoVueDataObjectDeclaration , self :: no_vue_duplicate_keys :: NoVueDuplicateKeys , self :: no_vue_reserved_keys :: NoVueReservedKeys , self :: no_vue_reserved_props :: NoVueReservedProps , self :: no_vue_setup_props_reactivity_loss :: NoVueSetupPropsReactivityLoss , self :: use_array_sort_compare :: UseArraySortCompare , self :: use_await_thenable :: UseAwaitThenable , self :: use_consistent_arrow_return :: UseConsistentArrowReturn , self :: use_destructuring :: UseDestructuring , self :: use_exhaustive_switch_cases :: UseExhaustiveSwitchCases , self :: use_explicit_type :: UseExplicitType , self :: use_find :: UseFind , self :: use_max_params :: UseMaxParams , self :: use_qwik_method_usage :: UseQwikMethodUsage , self :: use_qwik_valid_lexical_scope :: UseQwikValidLexicalScope , self :: use_regexp_exec :: UseRegexpExec , self :: use_sorted_classes :: UseSortedClasses , self :: use_spread :: UseSpread , self :: use_vue_consistent_define_props_declaration :: UseVueConsistentDefinePropsDeclaration , self :: use_vue_define_macros_order :: UseVueDefineMacrosOrder , self :: use_vue_multi_word_component_names :: UseVueMultiWordComponentNames ,] } }
+declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: no_ambiguous_anchor_text :: NoAmbiguousAnchorText , self :: no_before_interactive_script_outside_document :: NoBeforeInteractiveScriptOutsideDocument , self :: no_continue :: NoContinue , self :: no_deprecated_imports :: NoDeprecatedImports , self :: no_duplicated_spread_props :: NoDuplicatedSpreadProps , self :: no_empty_source :: NoEmptySource , self :: no_equals_to_null :: NoEqualsToNull , self :: no_floating_promises :: NoFloatingPromises , self :: no_for_in :: NoForIn , self :: no_import_cycles :: NoImportCycles , self :: no_increment_decrement :: NoIncrementDecrement , self :: no_jsx_literals :: NoJsxLiterals , self :: no_jsx_props_bind :: NoJsxPropsBind , self :: no_leaked_render :: NoLeakedRender , self :: no_misused_promises :: NoMisusedPromises , self :: no_multi_assign :: NoMultiAssign , self :: no_multi_str :: NoMultiStr , self :: no_next_async_client_component :: NoNextAsyncClientComponent , self :: no_parameters_only_used_in_recursion :: NoParametersOnlyUsedInRecursion , self :: no_proto :: NoProto , self :: no_react_forward_ref :: NoReactForwardRef , self :: no_return_assign :: NoReturnAssign , self :: no_script_url :: NoScriptUrl , self :: no_shadow :: NoShadow , self :: no_sync_scripts :: NoSyncScripts , self :: no_ternary :: NoTernary , self :: no_undeclared_env_vars :: NoUndeclaredEnvVars , self :: no_unknown_attribute :: NoUnknownAttribute , self :: no_unnecessary_conditions :: NoUnnecessaryConditions , self :: no_unresolved_imports :: NoUnresolvedImports , self :: no_unused_expressions :: NoUnusedExpressions , self :: no_useless_catch_binding :: NoUselessCatchBinding , self :: no_useless_undefined :: NoUselessUndefined , self :: no_vue_data_object_declaration :: NoVueDataObjectDeclaration , self :: no_vue_duplicate_keys :: NoVueDuplicateKeys , self :: no_vue_reserved_keys :: NoVueReservedKeys , self :: no_vue_reserved_props :: NoVueReservedProps , self :: no_vue_setup_props_reactivity_loss :: NoVueSetupPropsReactivityLoss , self :: use_array_sort_compare :: UseArraySortCompare , self :: use_await_thenable :: UseAwaitThenable , self :: use_consistent_arrow_return :: UseConsistentArrowReturn , self :: use_destructuring :: UseDestructuring , self :: use_disposables :: UseDisposables , self :: use_exhaustive_switch_cases :: UseExhaustiveSwitchCases , self :: use_explicit_type :: UseExplicitType , self :: use_find :: UseFind , self :: use_max_params :: UseMaxParams , self :: use_qwik_method_usage :: UseQwikMethodUsage , self :: use_qwik_valid_lexical_scope :: UseQwikValidLexicalScope , self :: use_regexp_exec :: UseRegexpExec , self :: use_sorted_classes :: UseSortedClasses , self :: use_spread :: UseSpread , self :: use_vue_consistent_define_props_declaration :: UseVueConsistentDefinePropsDeclaration , self :: use_vue_define_macros_order :: UseVueDefineMacrosOrder , self :: use_vue_multi_word_component_names :: UseVueMultiWordComponentNames ,] } }

crates/biome_configuration/src/generated/domain_selector.rs

@@ -0,0 +1,162 @@
+use crate::JsRuleAction;
+use crate::services::typed::Typed;
+use biome_analyze::{
+    FixKind, Rule, RuleDiagnostic, RuleDomain, context::RuleContext, declare_lint_rule,
+};
+use biome_console::markup;
+use biome_js_factory::make;
+use biome_js_syntax::{JsVariableDeclaration, JsVariableDeclarator, JsVariableDeclaratorList, T};
+use biome_rowan::{AstNode, BatchMutationExt};
+use biome_rule_options::use_disposables::UseDisposablesOptions;
+
+declare_lint_rule! {
+    /// Detects a disposable object assigned to a variable without using or await using syntax.
+    ///
+    /// Disposable objects, which implements Disposable or AsyncDisposable interface, are intended
+    /// to dispose after use. Not disposing them can lead some resource or memory leak depending on
+    /// the implementation.
+    ///
+    /// ## Examples
+    ///
+    /// ### Invalid
+    ///
+    /// ```ts,expect_diagnostic
+    /// function createDisposable(): Disposable {
+    ///   return {
+    ///     [Symbol.dispose]() {
+    ///       // do something
+    ///     },
+    ///   };
+    /// }
+    ///
+    /// const disposable = createDisposable();
+    /// ```
+    ///
+    /// ```js,expect_diagnostic
+    /// class MyClass implements AsyncDisposable {
+    ///   async [Symbol.asyncDispose]() {
+    ///     // do something
+    ///   },
+    /// }
+    ///
+    /// const instance = new MyClass();
+    /// ```
+    ///
+    /// ### Valid
+    ///
+    /// ```ts
+    /// function createDisposable(): Disposable {
+    ///   return {
+    ///     [Symbol.dispose]() {
+    ///       // do something
+    ///     },
+    ///   };
+    /// }
+    ///
+    /// using disposable = createDisposable();
+    /// ```
+    ///
+    /// ```js
+    /// class MyClass implements AsyncDisposable {
+    ///   async [Symbol.asyncDispose]() {
+    ///     // do something
+    ///   },
+    /// }
+    ///
+    /// await using instance = new MyClass();
+    /// ```
+    ///
+    pub UseDisposables {
+        version: "next",
+        name: "useDisposables",
+        language: "js",
+        recommended: false,
+        fix_kind: FixKind::Unsafe,
+        domains: &[RuleDomain::Project],
+    }
+}
+
+impl Rule for UseDisposables {
+    type Query = Typed<JsVariableDeclarator>;
+    type State = DisposableKind;
+    type Signals = Option<Self::State>;
+    type Options = UseDisposablesOptions;
+
+    fn run(ctx: &RuleContext<Self>) -> Self::Signals {
+        let decl = ctx.query();
+        let initializer = decl.initializer()?;
+        let expression = initializer.expression().ok()?;
+        let ty = ctx.type_of_expression(&expression);
+
+        // Lookup the parent declaration which possibly has `await` and/or `using` tokens.
+        let parent = decl
+            .parent::<JsVariableDeclaratorList>()?
+            .parent::<JsVariableDeclaration>()?;
+
+        let is_disposed = parent.kind().ok()?.kind() == T![using];
+        if ty.is_disposable() && !is_disposed {
+            return Some(DisposableKind::Disposable);
+        }
+
+        let is_async_disposed = is_disposed && parent.await_token().is_some();
+        if ty.is_async_disposable() && !is_async_disposed {
+            return Some(DisposableKind::AsyncDisposable);
+        }
+
+        None
+    }
+
+    fn diagnostic(ctx: &RuleContext<Self>, state: &Self::State) -> Option<RuleDiagnostic> {
+        let node = ctx.query();
+
+        Some(
+            RuleDiagnostic::new(
+                rule_category!(),
+                node.range(),
+                markup! { "Disposable object is assigned here but never disposed." },
+            )
+            .note(match state {
+                DisposableKind::Disposable => markup! {
+                    "The object implements the "<Emphasis>"Disposable"</Emphasis>"interface, which is intended to be disposed after use with "<Emphasis>"using"</Emphasis>" syntax."
+                },
+                DisposableKind::AsyncDisposable => markup! {
+                    "The object implements the "<Emphasis>"AsyncDisposable"</Emphasis>"interface, which is intended to be disposed after use with "<Emphasis>"await using"</Emphasis>" syntax."
+                },
+            })
+            .note(markup! {
+                "Not disposing the object properly can lead some resource or memory leak."
+            })
+        )
+    }
+
+    fn action(ctx: &RuleContext<Self>, state: &Self::State) -> Option<JsRuleAction> {
+        let mut mutation = ctx.root().begin();
+
+        let decl = ctx
+            .query()
+            .parent::<JsVariableDeclaratorList>()?
+            .parent::<JsVariableDeclaration>()?;
+
+        let mut new_decl = decl
+            .clone()
+            .with_kind_token(make::token_with_trailing_space(T![using]));
+
+        if let DisposableKind::AsyncDisposable = state {
+            new_decl = new_decl.with_await_token(Some(make::token_with_trailing_space(T![await])));
+        }
+
+        mutation.replace_node(decl, new_decl);
+
+        Some(JsRuleAction::new(
+            ctx.metadata().action_category(ctx.category(), ctx.group()),
+            ctx.metadata().applicability(),
+            markup! { "Add the "<Emphasis>"using"</Emphasis>" keyword to dispose the object when leaving the scope." },
+            mutation,
+        ))
+    }
+}
+
+pub enum DisposableKind {
+    Disposable,
+    AsyncDisposable,
+}

crates/biome_diagnostics_categories/src/categories.rs

@@ -0,0 +1,48 @@
+/* should generate diagnostics */
+const disposable = {
+  [Symbol.dispose]() {
+    // do something
+  }
+};
+
+const asyncDisposable = {
+  async [Symbol.asyncDispose]() {
+    // do something
+  }
+};
+
+function createDisposable(): Disposable {
+  return {
+    [Symbol.dispose]() {
+      // do something
+    },
+  };
+}
+
+const createdDisposable = createDisposable();
+
+function createAsyncDisposable(): AsyncDisposable {
+  return {
+    async [Symbol.asyncDispose](): Promise<void> {
+      // do something
+    },
+  };
+}
+
+const createdAsyncDisposable = createAsyncDisposable();
+
+class DisposableClass implements Disposable {
+	[Symbol.dispose](): void {
+		// do something
+	}
+}
+
+const disposableInstance = new DisposableClass();
+
+class AsyncDisposableClass implements AsyncDisposable {
+	async [Symbol.asyncDispose](): Promise<void> {
+		// do something
+	}
+}
+
+const asyncDisposableInstance = new AsyncDisposableClass();