exhaustive deps are off by default

idom has an upcoming change that will allow it to
infer hook dependencies automatically

Author: rmorshea

README.md

@@ -22,3 +22,44 @@ Run the tests
 ```bash
 tox
 ```
+
+# Errors
+
+`ROH2**` errors can be enabled with the `--exhaustive-hook-deps` flag or setting
+`exhaustive_hook_deps = True` in your  `flake8` config.
+
+<table>
+    <tr>
+        <th>Code</th>
+        <th>Message</th>
+    </tr>
+    <tr>
+        <td>ROH100</td>
+        <td>Hook is defined as a closure</td>
+    </tr>
+    <tr>
+        <td>ROH101</td>
+        <td>Hook was used outside component or hook definition</td>
+    </tr>
+    <tr>
+        <td>ROH102</td>
+        <td>Hook was used inside a conditional or loop statement</td>
+    </tr>
+    <tr>
+        <td>ROH200</td>
+        <td>
+            A hook's dependency is not destructured - dependencies should be refered to
+            directly, not via an attribute or key of an object
+        </td>
+    </tr>
+    <tr>
+        <td>ROH201</td>
+        <td>Hook dependency args should be a literal list, tuple or None</td>
+    </tr>
+    <tr>
+        <td>ROH202</td>
+        <td>
+            Hook dependency is not specified
+        </td>
+    </tr>
+</table>

flake8_idom_hooks/__init__.py

@@ -10,5 +10,6 @@
     __version__ = "0.0.0"
 
 from .flake8_plugin import Plugin
+from .run import run_checks
 
-__all__ = ["Plugin"]
+__all__ = ["Plugin", "run_checks"]

flake8_idom_hooks/exhaustive_deps.py

@@ -131,7 +131,7 @@ def _get_dependency_names_from_expression(
                     # own linter doesn't do this we'll just take the easy route for now:
                     # https://github.com/facebook/react/issues/16265
                     self._save_error(
-                        201,
+                        200,
                         elt,
                         (
                             f"dependency arg of {hook_name!r} is not destructured - "
@@ -144,14 +144,16 @@ def _get_dependency_names_from_expression(
             isinstance(dependency_expr, ast.Constant) and dependency_expr.value is None
         ):
             self._save_error(
-                202,
+                201,
                 dependency_expr,
                 (
                     f"dependency args of {hook_name!r} should be a literal list, tuple, "
                     f"or None - not expression type {type(dependency_expr).__name__!r}"
                 ),
             )
             return None
+        else:
+            return set()
 
 
 class _MissingNameFinder(ErrorVisitor):
@@ -178,7 +180,7 @@ def visit_Name(self, node: ast.Name) -> None:
                 self.used_deps.add(node_id)
             else:
                 self._save_error(
-                    203,
+                    202,
                     node,
                     (
                         f"dependency {node_id!r} of function {self._func_name!r} "

flake8_idom_hooks/flake8_plugin.py

@@ -1,31 +1,38 @@
+from __future__ import annotations
+
 import ast
+from argparse import Namespace
 
-from typing import List, Tuple, Type
+from flake8.options.manager import OptionManager
 
 from flake8_idom_hooks import __version__
-
-from .utils import ErrorVisitor
-from .rules_of_hooks import RulesOfHooksVisitor
-from .exhaustive_deps import ExhaustiveDepsVisitor
+from flake8_idom_hooks.run import run_checks
 
 
 class Plugin:
 
     name = __name__
     version = __version__
 
-    _visitor_types: List[Type[ErrorVisitor]] = [
-        RulesOfHooksVisitor,
-        ExhaustiveDepsVisitor,
-    ]
+    @classmethod
+    def add_options(cls, option_manager: OptionManager) -> None:
+        option_manager.add_option(
+            "--exhaustive-hook-deps",
+            action="store_true",
+            default=False,
+            dest="exhaustive_hook_deps",
+            parse_from_config=True,
+        )
+
+    @classmethod
+    def parse_options(cls, options: Namespace) -> None:
+        cls.options = options
 
     def __init__(self, tree: ast.Module) -> None:
         self._tree = tree
 
-    def run(self) -> List[Tuple[int, int, str, Type["Plugin"]]]:
-        errors = []
-        for vtype in self._visitor_types:
-            visitor = vtype()
-            visitor.visit(self._tree)
-            errors.extend(visitor.errors)
-        return [(line, col, msg, self.__class__) for line, col, msg in errors]
+    def run(self) -> list[tuple[int, int, str, type[Plugin]]]:
+        return [
+            error + (self.__class__,)
+            for error in run_checks(self._tree, self.options.exhaustive_hook_deps)
+        ]

flake8_idom_hooks/run.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+import ast
+
+from .exhaustive_deps import ExhaustiveDepsVisitor
+from .rules_of_hooks import RulesOfHooksVisitor
+
+
+def run_checks(
+    tree: ast.Module,
+    exhaustive_hook_deps: bool,
+) -> list[tuple[int, int, str]]:
+    visitor_types = [RulesOfHooksVisitor]
+    if exhaustive_hook_deps:
+        visitor_types.append(ExhaustiveDepsVisitor)
+
+    errors: list[tuple[int, int, str]] = []
+    for vtype in visitor_types:
+        visitor = vtype()
+        visitor.visit(tree)
+        errors.extend(visitor.errors)
+
+    return errors

tests/hook_usage_test_cases.py

@@ -116,7 +116,7 @@ def CheckEffects():
 
     use_effect(
         lambda: (
-            # error: ROH203 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
+            # error: ROH202 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
             x
             + y
         ),
@@ -125,41 +125,41 @@ def CheckEffects():
 
     use_effect(
         lambda: (
-            # error: ROH203 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
+            # error: ROH202 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
             x
         )
     )
 
     use_effect(
         lambda: (
-            # error: ROH203 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
+            # error: ROH202 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
             x.y
         ),
         [
-            # error: ROH201 dependency arg of 'use_effect' is not destructured - dependencies should be refered to directly, not via an attribute or key of an object
+            # error: ROH200 dependency arg of 'use_effect' is not destructured - dependencies should be refered to directly, not via an attribute or key of an object
             x.y
         ],
     )
 
     module.use_effect(
         lambda: (
-            # error: ROH203 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
+            # error: ROH202 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
             x
         ),
         [],
     )
 
     use_effect(
         lambda: (
-            # error: ROH203 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
+            # error: ROH202 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
             x
         ),
         args=[],
     )
 
     use_effect(
         function=lambda: (
-            # error: ROH203 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
+            # error: ROH202 dependency 'x' of function 'lambda' is not specified in declaration of 'use_effect'
             x
         ),
         args=[],
@@ -171,7 +171,7 @@ def my_effect():
 
     @use_effect(args=[])
     def my_effect():
-        # error: ROH203 dependency 'x' of function 'my_effect' is not specified in declaration of 'use_effect'
+        # error: ROH202 dependency 'x' of function 'my_effect' is not specified in declaration of 'use_effect'
         x
 
     @use_effect(args=[])
@@ -182,7 +182,7 @@ def my_effect(*args, **kwargs):
 
     @module.use_effect(args=[])
     def my_effect():
-        # error: ROH203 dependency 'x' of function 'my_effect' is not specified in declaration of 'use_effect'
+        # error: ROH202 dependency 'x' of function 'my_effect' is not specified in declaration of 'use_effect'
         x
 
     @not_a_decorator_we_care_about
@@ -200,7 +200,7 @@ def impropper_usage_of_effect_as_decorator():
 
     use_effect(
         lambda: None,
-        # error: ROH202 dependency args of 'use_effect' should be a literal list, tuple, or None - not expression type 'Name'
+        # error: ROH201 dependency args of 'use_effect' should be a literal list, tuple, or None - not expression type 'Name'
         not_a_list_or_tuple,
     )
 

tests/test_flake8_idom_hooks.py

@@ -1,7 +1,7 @@
 import ast
 from pathlib import Path
 
-from flake8_idom_hooks import Plugin
+from flake8_idom_hooks import run_checks
 
 
 def test_flake8_idom_hooks():
@@ -20,5 +20,4 @@ def test_flake8_idom_hooks():
                 col_offset = len(line) - len(lstrip_line)
                 message = line.replace("# error:", "", 1).strip()
                 expected_errors.add((lineno, col_offset, message))
-    actual_errors = Plugin(tree).run()
-    assert {(ln, col, msg) for ln, col, msg, p_type in actual_errors} == expected_errors
+    assert set(run_checks(tree, exhaustive_hook_deps=True)) == expected_errors