fix(noVoidTypeReturn): accept void expression in returns

biomejs · Oct 7, 2024 · b9186c2 · b9186c2
1 parent 48affbb
commit b9186c2
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 33 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -62,6 +62,18 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b
 
   Contributed by @Conaclos
 
+- [noVoidTypeReturn](https://biomejs.dev/linter/rules/no-void-type-return/) now accept `void` expressions in return position ([#4173](https://github.com/biomejs/biome/issues/4173)).
+
+  The following code is now accepted:
+
+  ```ts
+  function f(): void {
+    return void 0;
+  }
+  ```
+
+  Contributed by @Conaclos
+
 ### Parser
 
 #### Bug Fixes

diff --git a/crates/biome_js_analyze/src/lint/correctness/no_void_type_return.rs b/crates/biome_js_analyze/src/lint/correctness/no_void_type_return.rs
@@ -2,9 +2,10 @@ use biome_analyze::context::RuleContext;
 use biome_analyze::{declare_lint_rule, Ast, Rule, RuleDiagnostic};
 use biome_console::markup;
 use biome_js_syntax::{
-    AnyTsReturnType, JsArrowFunctionExpression, JsFunctionDeclaration,
+    AnyJsExpression, AnyTsReturnType, JsArrowFunctionExpression, JsFunctionDeclaration,
     JsFunctionExportDefaultDeclaration, JsFunctionExpression, JsGetterClassMember,
     JsGetterObjectMember, JsMethodClassMember, JsMethodObjectMember, JsReturnStatement,
+    JsSyntaxKind,
 };
 use biome_rowan::{declare_node_union, AstNode};
 
@@ -92,47 +93,28 @@ declare_lint_rule! {
     }
 }
 
-declare_node_union! {
-    pub JsFunctionMethod = JsArrowFunctionExpression | JsFunctionDeclaration | JsFunctionExportDefaultDeclaration | JsFunctionExpression | JsGetterClassMember | JsGetterObjectMember | JsMethodClassMember | JsMethodObjectMember
-}
-
-pub(crate) fn return_type(func: &JsFunctionMethod) -> Option<AnyTsReturnType> {
-    match func {
-        JsFunctionMethod::JsArrowFunctionExpression(func) => {
-            func.return_type_annotation()?.ty().ok()
-        }
-        JsFunctionMethod::JsFunctionDeclaration(func) => func.return_type_annotation()?.ty().ok(),
-        JsFunctionMethod::JsFunctionExportDefaultDeclaration(func) => {
-            func.return_type_annotation()?.ty().ok()
-        }
-        JsFunctionMethod::JsFunctionExpression(func) => func.return_type_annotation()?.ty().ok(),
-        JsFunctionMethod::JsGetterClassMember(func) => {
-            Some(AnyTsReturnType::AnyTsType(func.return_type()?.ty().ok()?))
-        }
-        JsFunctionMethod::JsGetterObjectMember(func) => {
-            Some(AnyTsReturnType::AnyTsType(func.return_type()?.ty().ok()?))
-        }
-        JsFunctionMethod::JsMethodClassMember(func) => func.return_type_annotation()?.ty().ok(),
-        JsFunctionMethod::JsMethodObjectMember(func) => func.return_type_annotation()?.ty().ok(),
-    }
-}
-
 impl Rule for NoVoidTypeReturn {
     type Query = Ast<JsReturnStatement>;
-    type State = JsFunctionMethod;
+    type State = AnyJsFunctionMethodWithReturnType;
     type Signals = Option<Self::State>;
     type Options = ();
 
     fn run(ctx: &RuleContext<Self>) -> Self::Signals {
         let ret = ctx.query();
-        // Do not take arg-less returns into account
-        let _arg = ret.argument()?;
+        // Ignore arg-less returns such as `return;`
+        let arg = ret.argument()?;
+        if let AnyJsExpression::JsUnaryExpression(expr) = arg {
+            if expr.operator_token().ok()?.kind() == JsSyntaxKind::VOID_KW {
+                // Ignore `return void <foo>;`
+                return None;
+            }
+        }
         let func = ret
             .syntax()
             .ancestors()
             .find(|x| AnyJsControlFlowRoot::can_cast(x.kind()))
-            .and_then(JsFunctionMethod::cast)?;
-        let ret_type = return_type(&func)?;
+            .and_then(AnyJsFunctionMethodWithReturnType::cast)?;
+        let ret_type = func.return_type()?;
         ret_type.as_any_ts_type()?.as_ts_void_type().and(Some(func))
     }
 
@@ -149,3 +131,28 @@ impl Rule for NoVoidTypeReturn {
         ))
     }
 }
+
+declare_node_union! {
+    pub AnyJsFunctionMethodWithReturnType = JsArrowFunctionExpression | JsFunctionDeclaration | JsFunctionExportDefaultDeclaration | JsFunctionExpression | JsGetterClassMember | JsGetterObjectMember | JsMethodClassMember | JsMethodObjectMember
+}
+
+impl AnyJsFunctionMethodWithReturnType {
+    pub fn return_type(&self) -> Option<AnyTsReturnType> {
+        match self {
+            Self::JsArrowFunctionExpression(func) => func.return_type_annotation()?.ty().ok(),
+            Self::JsFunctionDeclaration(func) => func.return_type_annotation()?.ty().ok(),
+            Self::JsFunctionExportDefaultDeclaration(func) => {
+                func.return_type_annotation()?.ty().ok()
+            }
+            Self::JsFunctionExpression(func) => func.return_type_annotation()?.ty().ok(),
+            Self::JsGetterClassMember(func) => {
+                Some(AnyTsReturnType::AnyTsType(func.return_type()?.ty().ok()?))
+            }
+            Self::JsGetterObjectMember(func) => {
+                Some(AnyTsReturnType::AnyTsType(func.return_type()?.ty().ok()?))
+            }
+            Self::JsMethodClassMember(func) => func.return_type_annotation()?.ty().ok(),
+            Self::JsMethodObjectMember(func) => func.return_type_annotation()?.ty().ok(),
+        }
+    }
+}
diff --git a/crates/biome_js_analyze/tests/specs/correctness/noVoidTypeReturn/valid.ts b/crates/biome_js_analyze/tests/specs/correctness/noVoidTypeReturn/valid.ts
@@ -13,3 +13,7 @@ class B {
 function f(): void {
 	return;
 }
+
+function g(): void {
+	return void 0;
+}
diff --git a/crates/biome_js_analyze/tests/specs/correctness/noVoidTypeReturn/valid.ts.snap b/crates/biome_js_analyze/tests/specs/correctness/noVoidTypeReturn/valid.ts.snap
@@ -20,6 +20,8 @@ function f(): void {
 	return;
 }
 
-```
-
+function g(): void {
+	return void 0;
+}
 
+```