docs linting workflow

Author: Archmonger

.github/workflows/check.yml

@@ -67,4 +67,4 @@ jobs:
             - name: Check docs build
               run: hatch run docs:build
             - name: Check docs examples
-              run: hatch fmt docs --check
+              run: hatch run docs:check

docs/examples/passing_props_to_a_component/changing/app.py

@@ -1,5 +1,5 @@
 import asyncio
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from reactpy import component, html, use_async_effect, use_state
 
@@ -14,12 +14,12 @@ def clock(color, time):
 @component
 def app():
     color, set_color = use_state("lightcoral")
-    now, set_now = use_state(datetime.now(timezone.utc))
+    now, set_now = use_state(datetime.now(UTC))
 
     async def tick():
         while True:
             await asyncio.sleep(1)
-            set_now(datetime.now(timezone.utc))
+            set_now(datetime.now(UTC))
 
     use_async_effect(tick, dependencies=[])
 

docs/examples/reference_use_effect/async_clock/app.py

@@ -1,18 +1,18 @@
 # start
 import asyncio
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from reactpy import component, html, use_async_effect, use_state
 
 
 @component
 def clock():
-    now, set_now = use_state(datetime.now(timezone.utc))
+    now, set_now = use_state(datetime.now(UTC))
 
     async def effect():
         # Zero arguments. A long-running effect loops and honours cancellation.
         while True:
-            set_now(datetime.now(timezone.utc))
+            set_now(datetime.now(UTC))
             try:
                 await asyncio.sleep(1)
             except asyncio.CancelledError:

docs/examples/render_and_commit/re_render/app.py

@@ -1,18 +1,18 @@
 import asyncio
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from reactpy import component, html, use_async_effect, use_state
 
 
 # start
 @component
 def clock():
-    now, set_now = use_state(datetime.now(timezone.utc))
+    now, set_now = use_state(datetime.now(UTC))
 
     async def tick():
         while True:
             await asyncio.sleep(1)
-            set_now(datetime.now(timezone.utc))
+            set_now(datetime.now(UTC))
 
     use_async_effect(tick, dependencies=[])
 

docs/examples/reusing_logic_with_custom_hooks/hook_order_safe/app.py

@@ -9,7 +9,7 @@
 def use_profile(show_nickname):
     name, set_name = use_state("name")
     # the hook is called unconditionally; only the returned value is conditional
-    nickname, set_nickname = use_state("nickname")
+    nickname, _set_nickname = use_state("nickname")
     bio, set_bio = use_state("bio")
     return name, (nickname if show_nickname else "-"), bio, set_bio
 
@@ -19,7 +19,7 @@ def profile(show_nickname):
     name, nickname, bio, set_bio = use_profile(show_nickname)
 
     async def extend_bio(event):
-        set_bio(bio + "!")
+        set_bio(f"{bio}!")
 
     return html.div(
         html.button({"onClick": extend_bio}, f"bio={bio}"),

docs/examples/reusing_logic_with_custom_hooks/hook_order_violation/app.py

@@ -24,7 +24,7 @@ def profile(show_nickname):
     name, nickname, bio, set_bio = use_profile(show_nickname)
 
     async def extend_bio(event):
-        set_bio(bio + "!")
+        set_bio(f"{bio}!")
 
     return html.div(
         html.button({"onClick": extend_bio}, f"bio={bio}"),

docs/examples/thinking_in_react/use_state.py

@@ -4,5 +4,5 @@
 # start
 @component
 def filterable_product_table(products):
-    filter_text, set_filter_text = use_state("")
+    _filter_text, _set_filter_text = use_state("")
     in_stock_only, set_in_stock_only = use_state(False)

pyproject.toml

@@ -144,10 +144,17 @@ dependencies = [
   "mkdocs-minify-plugin",
   "mike",
   "linkcheckmd",
+  "pyright",
+  "starlette",
+  "orjson",
+  "asgi_tools",
+  "servestatic",
+  "websockets"
 ]
 
 [tool.hatch.envs.docs.scripts]
 serve = ["cd docs && mkdocs serve"]
+check = ["hatch check code docs/ && hatch check fmt docs/ && pyright docs/"]
 build = ["cd docs && mkdocs build --strict"]
 linkcheck = [
   "linkcheckMarkdown docs/ -v -r",
@@ -337,6 +344,17 @@ known-third-party = ["js"]
   "S102",
   # Allow print
   "T201",
+  # Docs render these files as teaching snippets, not importable modules.
+  # Relative imports (`from .my_button import my_button`) are what the docs
+  # deliberately teach, snippets unpack both halves of `use_state()` to show
+  # the full signature even when one half is unused, and each snippet file is
+  # standalone rather than part of a package.
+  "TID252",
+  "RUF059",
+  "INP001",
+  # "Keeping Components Pure" has to mutate a module-level variable with
+  # `global` in order to demonstrate why that is wrong.
+  "PLW0603",
 ]
 "scripts/**/*.py" = [
   # Allow print