rename element to component

Author: rmorshea

flake8_idom_hooks/exhaustive_deps.py

@@ -1,7 +1,7 @@
 import ast
 from typing import Optional, Union, Set
 
-from .utils import is_hook_def, is_element_def, ErrorVisitor, set_current
+from .utils import is_hook_def, is_component_def, ErrorVisitor, set_current
 
 
 HOOKS_WITH_DEPS = ("use_effect", "use_callback", "use_memo")
@@ -11,13 +11,13 @@ class ExhaustiveDepsVisitor(ErrorVisitor):
     def __init__(self) -> None:
         super().__init__()
         self._current_function: Optional[ast.FunctionDef] = None
-        self._current_hook_or_element: Optional[ast.FunctionDef] = None
+        self._current_hook_or_component: Optional[ast.FunctionDef] = None
 
     def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
-        if is_hook_def(node) or is_element_def(node):
-            with set_current(self, hook_or_element=node):
+        if is_hook_def(node) or is_component_def(node):
+            with set_current(self, hook_or_component=node):
                 self.generic_visit(node)
-        elif self._current_hook_or_element is not None:
+        elif self._current_hook_or_component is not None:
             for deco in node.decorator_list:
                 if not isinstance(deco, ast.Call):
                     continue
@@ -36,15 +36,15 @@ def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
                 for kw in deco.keywords:
                     if kw.arg == "args":
                         self._check_hook_dependency_list_is_exhaustive(
-                            self._current_hook_or_element,
+                            self._current_hook_or_component,
                             called_func_name,
                             node,
                             kw.value,
                         )
                         break
 
     def visit_Call(self, node: ast.Call) -> None:
-        if self._current_hook_or_element is None:
+        if self._current_hook_or_component is None:
             return
 
         called_func = node.func
@@ -75,15 +75,15 @@ def visit_Call(self, node: ast.Call) -> None:
 
         if isinstance(func, ast.Lambda):
             self._check_hook_dependency_list_is_exhaustive(
-                self._current_hook_or_element,
+                self._current_hook_or_component,
                 called_func_name,
                 func,
                 args,
             )
 
     def _check_hook_dependency_list_is_exhaustive(
         self,
-        current_hook_or_element: ast.FunctionDef,
+        current_hook_or_component: ast.FunctionDef,
         hook_name: str,
         func: Union[ast.FunctionDef, ast.Lambda],
         dependency_expr: Optional[ast.expr],
@@ -98,7 +98,7 @@ def _check_hook_dependency_list_is_exhaustive(
         func_name = "lambda" if isinstance(func, ast.Lambda) else func.name
 
         top_level_variable_finder = _TopLevelVariableFinder()
-        top_level_variable_finder.visit(current_hook_or_element)
+        top_level_variable_finder.visit(current_hook_or_component)
         variables_defined_in_scope = top_level_variable_finder.variable_names
 
         missing_name_finder = _MissingNameFinder(

flake8_idom_hooks/rules_of_hooks.py

@@ -3,7 +3,7 @@
 
 from .utils import (
     is_hook_def,
-    is_element_def,
+    is_component_def,
     ErrorVisitor,
     is_hook_function_name,
     set_current,
@@ -14,7 +14,7 @@ class RulesOfHooksVisitor(ErrorVisitor):
     def __init__(self) -> None:
         super().__init__()
         self._current_hook: Optional[ast.FunctionDef] = None
-        self._current_element: Optional[ast.FunctionDef] = None
+        self._current_component: Optional[ast.FunctionDef] = None
         self._current_function: Optional[ast.FunctionDef] = None
         self._current_call: Optional[ast.Call] = None
         self._current_conditional: Union[None, ast.If, ast.IfExp, ast.Try] = None
@@ -32,12 +32,12 @@ def visit_FunctionDef(self, node: ast.FunctionDef) -> None:
                 loop=None,
             ):
                 self.generic_visit(node)
-        elif is_element_def(node):
+        elif is_component_def(node):
             with set_current(
                 self,
-                element=node,
+                component=node,
                 function=node,
-                # we need to reset these before enter new element
+                # we need to reset these before visiting a new component
                 conditional=None,
                 loop=None,
             ):
@@ -83,8 +83,8 @@ def _check_if_propper_hook_usage(
         if not is_hook_function_name(name):
             return None
 
-        if self._current_hook is None and self._current_element is None:
-            msg = f"hook {name!r} used outside element or hook definition"
+        if self._current_hook is None and self._current_component is None:
+            msg = f"hook {name!r} used outside component or hook definition"
             self._save_error(101, node, msg)
 
         loop_or_conditional = self._current_conditional or self._current_loop

flake8_idom_hooks/utils.py

@@ -27,11 +27,11 @@ def is_hook_def(node: ast.FunctionDef) -> bool:
     return is_hook_function_name(node.name)
 
 
-def is_element_def(node: ast.FunctionDef) -> bool:
-    return is_element_function_name(node.name)
+def is_component_def(node: ast.FunctionDef) -> bool:
+    return is_component_function_name(node.name)
 
 
-def is_element_function_name(name: str) -> bool:
+def is_component_function_name(name: str) -> bool:
     return name[0].upper() == name[0] and "_" not in name
 
 

tests/hook_usage_test_cases.py

@@ -82,15 +82,15 @@ def use_state():
 
 
 def generic_function():
-    # error: ROH101 hook 'use_state' used outside element or hook definition
+    # error: ROH101 hook 'use_state' used outside component or hook definition
     use_state
 
 
 def use_state():
     use_other
 
 
-def Element():
+def Component():
     use_state
 
 
@@ -101,12 +101,12 @@ def use_custom_hook():
 # ok since 'use_state' is not the last attribute
 module.use_state.other
 
-# error: ROH101 hook 'use_effect' used outside element or hook definition
+# error: ROH101 hook 'use_effect' used outside component or hook definition
 module.use_effect()
 
 
-def not_hook_or_element():
-    # error: ROH101 hook 'use_state' used outside element or hook definition
+def not_hook_or_component():
+    # error: ROH101 hook 'use_state' used outside component or hook definition
     use_state
 
 
@@ -205,24 +205,24 @@ def impropper_usage_of_effect_as_decorator():
     )
 
 
-def make_element():
-    # nested element definitions are ok.
-    def NestedElement():
+def make_component():
+    # nested component definitions are ok.
+    def NestedComponent():
         use_state
 
 
 some_global_variable
 
 
-def Element():
+def Component():
     # referencing a global variable is OK
     use_effect(lambda: some_global_variable, [])
 
 
 if True:
 
-    def Element():
-        # this is ok since the conditional is outside the element
+    def Component():
+        # this is ok since the conditional is outside the component
         use_state
 
     def use_other():