minor fixes

add in error code to messages and rename error code base to ROH (rules of hooks)
instead of vague IDML (no idea what that meant). fix tests following these changes
too

Author: rmorshea

flake8_idom_hooks.py

@@ -4,7 +4,7 @@
     get_distribution as _get_distribution,
     DistributionNotFound as _DistributionNotFound,
 )
-from typing import List, Tuple, Iterator, Union, Optional
+from typing import List, Tuple, Iterator, Union, Optional, Type
 
 
 try:
@@ -23,7 +23,7 @@ class Plugin:
     def __init__(self, tree: ast.Module):
         self._tree = tree
 
-    def run(self):
+    def run(self) -> List[Tuple[int, int, str, Type["Plugin"]]]:
         visitor = HookRulesVisitor()
         visitor.visit(self._tree)
         cls = type(self)
@@ -66,8 +66,8 @@ def _visit_loop(self, node: ast.AST) -> None:
 
     def _check_if_hook_defined_in_function(self, node: ast.FunctionDef) -> None:
         if self._current_function is not None and _is_hook_or_element_def(node):
-            msg = f"Hook {node.name!r} defined inside another function."
-            self.errors.append((node.lineno, node.col_offset, msg))
+            msg = f"hook {node.name!r} defined as closure in function {self._current_function.name!r}"
+            self._save_error(100, node, msg)
 
     def _check_if_propper_hook_usage(self, node: Union[ast.Name, ast.Attribute]):
         if isinstance(node, ast.Name):
@@ -79,8 +79,8 @@ def _check_if_propper_hook_usage(self, node: Union[ast.Name, ast.Attribute]):
             return
 
         if not _is_hook_or_element_def(self._current_function):
-            msg = f"Hook {name!r} used outside element or hook definition."
-            self.errors.append((node.lineno, node.col_offset, msg))
+            msg = f"hook {name!r} used outside element or hook definition"
+            self._save_error(101, node, msg)
             return
 
         _loop_or_conditional = self._current_conditional or self._current_loop
@@ -94,10 +94,13 @@ def _check_if_propper_hook_usage(self, node: Union[ast.Name, ast.Attribute]):
                 ast.While: "while loop",
             }
             node_name = node_type_to_name[node_type]
-            msg = f"Hook {name!r} used inside {node_name}."
-            self.errors.append((node.lineno, node.col_offset, msg))
+            msg = f"hook {name!r} used inside {node_name}"
+            self._save_error(102, node, msg)
             return
 
+    def _save_error(self, error_code: int, node: ast.AST, message: str):
+        self.errors.append((node.lineno, node.col_offset, f"ROH{error_code} {message}"))
+
     @contextmanager
     def _set_current(self, **attrs) -> Iterator[None]:
         old_attrs = {k: getattr(self, f"_current_{k}") for k in attrs}

requirements.txt

@@ -1,3 +1,4 @@
 -r requirements/dev.txt
 -r requirements/prod.txt
 -r requirements/test.txt
+-r requirements/lint.txt

requirements/lint.txt

@@ -1,2 +1 @@
-flake8
 black

requirements/prod.txt

@@ -0,0 +1 @@
+flake8 >=3.7

setup.cfg

@@ -2,7 +2,6 @@
 ignore = E203, E266, E501, W503, F811, N802
 max-line-length = 88
 max-complexity = 18
-select = B,C,E,F,W,T4,B9,N
 exclude =
     .eggs/*
     .tox/*

setup.py

@@ -17,7 +17,7 @@
 package = {
     "name": name,
     "py_modules": ["flake8_idom_hooks"],
-    "entry_points": {"flake8.extension": ["IDML = flake8_idom_hooks:Plugin"]},
+    "entry_points": {"flake8.extension": ["ROH=flake8_idom_hooks:Plugin"]},
     "python_requires": ">=3.6",
     "description": "Flake8 plugin to enforce the rules of hooks for IDOM",
     "author": "Ryan Morshead",

tests/hook_usage_cases.py

@@ -1,28 +1,28 @@
 def HookInIf():
     if True:
-        # error: Hook 'use_state' used inside if statement.
+        # error: ROH102 hook 'use_state' used inside if statement
         use_state
 
 
 def HookInElif():
     if False:
         pass
     elif True:
-        # error: Hook 'use_state' used inside if statement.
+        # error: ROH102 hook 'use_state' used inside if statement
         use_state
 
 
 def HookInElse():
     if False:
         pass
     else:
-        # error: Hook 'use_state' used inside if statement.
+        # error: ROH102 hook 'use_state' used inside if statement
         use_state
 
 
 def HookInIfExp():
     (
-        # error: Hook 'use_state' used inside inline if expression.
+        # error: ROH102 hook 'use_state' used inside inline if expression
         use_state
         if True
         else None
@@ -34,14 +34,14 @@ def HookInElseOfIfExp():
         None
         if True
         else
-        # error: Hook 'use_state' used inside inline if expression.
+        # error: ROH102 hook 'use_state' used inside inline if expression
         use_state
     )
 
 
 def HookInTry():
     try:
-        # error: Hook 'use_state' used inside try statement.
+        # error: ROH102 hook 'use_state' used inside try statement
         use_state
     except:
         pass
@@ -51,38 +51,38 @@ def HookInExcept():
     try:
         raise ValueError()
     except:
-        # error: Hook 'use_state' used inside try statement.
+        # error: ROH102 hook 'use_state' used inside try statement
         use_state
 
 
 def HookInFinally():
     try:
         pass
     finally:
-        # error: Hook 'use_state' used inside try statement.
+        # error: ROH102 hook 'use_state' used inside try statement
         use_state
 
 
 def HookInForLoop():
     for i in range(3):
-        # error: Hook 'use_state' used inside for loop.
+        # error: ROH102 hook 'use_state' used inside for loop
         use_state
 
 
 def HookInWhileLoop():
     while True:
-        # error: Hook 'use_state' used inside while loop.
+        # error: ROH102 hook 'use_state' used inside while loop
         use_state
 
 
 def outer_function():
-    # error: Hook 'use_state' defined inside another function.
+    # error: ROH100 hook 'use_state' defined as closure in function 'outer_function'
     def use_state():
         ...
 
 
 def generic_function():
-    # error: Hook 'use_state' used outside element or hook definition.
+    # error: ROH101 hook 'use_state' used outside element or hook definition
     use_state
 
 
@@ -97,5 +97,5 @@ def Element():
 # ok since 'use_state' is not the last attribute
 module.use_state.other
 
-# error: Hook 'use_state' used outside element or hook definition.
+# error: ROH101 hook 'use_state' used outside element or hook definition
 module.use_state