Fix hassfest validation: move URLs from translations to placeholders (#249)

danieldotnl · claude · web-flow · commit 669c24dfa863 · 2026-01-31T15:39:29.000+01:00
* Fix hassfest validation: move URLs from translations to placeholders

Home Assistant PR #154224 (merged Jan 27, 2026) introduced validation
that prevents URLs from being directly embedded in translation strings.

This commit implements the proper solution using description placeholders:
- Created strings.json with URL placeholders for form steps
- Added URL constants and placeholder functions in config_flow.py
- Updated SchemaFlowFormStep instances to inject URLs via description_placeholders
- Removed URLs from menu step descriptions (SchemaFlowMenuStep doesn't support placeholders)

This keeps the URLs maintainable in code while allowing translators to
work with clean, locale-agnostic strings.

Fixes hassfest validation failures reported in issue #154226

Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;

* Fix unit tests: pass hass parameter to Template constructor

Home Assistant now requires the hass parameter when creating Template
objects (will be mandatory in 2025.10). Updated three failing tests to
pass coordinator.hass to Template constructor.

Fixes test_start_with_counter, test_start_with_source, and test_start_with_time.

All 126 tests now passing.

Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;

* Remove translations/en.json in favor of strings.json

Home Assistant now uses strings.json as the primary translation file.
The old translations/en.json with embedded URLs is no longer needed.

Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;

* Use translations/en.json for custom integration (remove strings.json)

strings.json is for core HA integrations. Custom integrations use
translations/en.json at runtime. URLs are removed from translations
and injected via description_placeholders in config_flow.py.

Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;

* Add URL placeholders to translations

The placeholders {buymeacoffee_url}, {device_class_url}, and
{state_class_url} are now in the translation strings and will be
replaced with actual URLs by the description_placeholders functions
at runtime.

Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;

---------

Co-authored-by: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/.devcontainer.json b/.devcontainer.json
@@ -1,7 +1,17 @@
 {
   "name": "danieldotnl/measureit",
   "image": "mcr.microsoft.com/vscode/devcontainers/python:3.13",
-  "postCreateCommand": "scripts/setup",
+  "postCreateCommand": "scripts/setup && gh auth setup-git",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {
+      "version": "24"
+    },
+    "ghcr.io/devcontainers/features/github-cli:1.0.15": {},
+    "ghcr.io/anthropics/devcontainer-features/claude-code:1": {}
+  },
+  "mounts": [
+    "source=${env:HOME}/.config/gh,target=/home/vscode/.config/gh,type=bind,consistency=cached"
+  ],
   "forwardPorts": [8123],
   "portsAttributes": {
     "8123": {
@@ -43,6 +53,5 @@
       }
     }
   },
-  "remoteUser": "vscode",
-  "features": {}
+  "remoteUser": "vscode"
 }
diff --git a/custom_components/measureit/config_flow.py b/custom_components/measureit/config_flow.py
@@ -60,6 +60,11 @@
 if TYPE_CHECKING:
     from collections.abc import Mapping
 
+# URL constants for description placeholders
+_DEVICE_CLASS_URL = "https://www.home-assistant.io/integrations/sensor/#device-class"
+_STATE_CLASS_URL = "https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes"
+_BUYMEACOFFEE_URL = "https://www.buymeacoffee.com/danieldotnl"
+
 PERIOD_OPTIONS = [
     selector.SelectOptionDict(value="hour", label="hour"),
     selector.SelectOptionDict(value="day", label="day"),
@@ -388,6 +393,35 @@ async def validate_sensor_edit(
 DATA_SCHEMA_THANK_YOU = vol.Schema({})
 
 
+async def get_sensors_step_placeholders(
+    handler: SchemaCommonFlowHandler,  # noqa: ARG001
+) -> dict[str, str]:
+    """Return description placeholders for sensors step."""
+    return {
+        "device_class_url": _DEVICE_CLASS_URL,
+        "state_class_url": _STATE_CLASS_URL,
+    }
+
+
+async def get_thank_you_placeholders(
+    handler: SchemaCommonFlowHandler,  # noqa: ARG001
+) -> dict[str, str]:
+    """Return description placeholders for thank you step."""
+    return {
+        "buymeacoffee_url": _BUYMEACOFFEE_URL,
+    }
+
+
+async def get_add_sensors_placeholders(
+    handler: SchemaCommonFlowHandler,  # noqa: ARG001
+) -> dict[str, str]:
+    """Return description placeholders for add sensors step."""
+    return {
+        "device_class_url": _DEVICE_CLASS_URL,
+        "state_class_url": _STATE_CLASS_URL,
+    }
+
+
 CONFIG_FLOW = {
     "user": SchemaFlowMenuStep(["time", "source", "count"]),
     "time": SchemaFlowFormStep(
@@ -415,9 +449,11 @@ async def validate_sensor_edit(
         validate_user_input=validate_sensor_setup,
         suggested_values=get_add_sensor_suggested_values,
         next_step="thank_you",
+        description_placeholders=get_sensors_step_placeholders,
     ),
     "thank_you": SchemaFlowFormStep(
         DATA_SCHEMA_THANK_YOU,
+        description_placeholders=get_thank_you_placeholders,
     ),
 }
 
@@ -434,6 +470,7 @@ async def validate_sensor_edit(
         suggested_values=get_add_sensor_suggested_values,
         validate_user_input=validate_sensor_setup,
         next_step="thank_you",
+        description_placeholders=get_add_sensors_placeholders,
     ),
     "select_edit_sensor": SchemaFlowFormStep(
         get_select_sensor_schema,
@@ -455,6 +492,7 @@ async def validate_sensor_edit(
     ),
     "thank_you": SchemaFlowFormStep(
         DATA_SCHEMA_THANK_YOU,
+        description_placeholders=get_thank_you_placeholders,
     ),
 }
 
diff --git a/custom_components/measureit/translations/en.json b/custom_components/measureit/translations/en.json
@@ -3,7 +3,7 @@
     "step": {
       "user": {
         "title": "Choose what you want to measure (what)",
-        "description": "Thank you for setting up MeasureIt!\nIf you need help with the configuration have a look at the [readme](https://github.com/danieldotnl/ha-measureit) or ask a question on the [community forum](https://community.home-assistant.io/t/measureit-measure-all-you-need-based-on-time-and-templates/660614).\n\nChoose what you want to measure:\n**Time:** Measure the elapsed time while conditions are met.\n**Source:** Measure the state changes of a source entity, while conditions are met.\n**Counter:** Measure the number of times something (described in a template) occurs, while conditions are met.",
+        "description": "Thank you for setting up MeasureIt!\nIf you need help with the configuration, have a look at the readme or ask a question on the community forum.\n\nChoose what you want to measure:\n**Time:** Measure the elapsed time while conditions are met.\n**Source:** Measure the state changes of a source entity, while conditions are met.\n**Counter:** Measure the number of times something (described in a template) occurs, while conditions are met.",
         "menu_options": {
           "time": "Time",
           "source": "Source",
@@ -45,7 +45,7 @@
       },
       "sensors": {
         "title": "Configure the sensors (how)",
-        "description": "Configure the sensors. When in doubt, stick to the defaults. Individual sensor settings can be adjusted after this setup via 'configure'.\n\n**Reset periods:** Select a predefined period to measure (when the meter will reset). Alternatively, provide a custom cron expression. Each period becomes a separate sensor.\n**Value template:** A template that is applied on the output of the sensor. Use `value` to refer to the sensor state.\n**Unit of measurement:** The unit of what your are measuring. E.g.: m3\n**Device class:** Find more about device classes [here](https://www.home-assistant.io/integrations/sensor/#device-class).\n**State class**: Find more about state classes [here](https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes).",
+        "description": "Configure the sensors. When in doubt, stick to the defaults. Individual sensor settings can be adjusted after this setup via 'configure'.\n\n**Reset periods:** Select a predefined period to measure (when the meter will reset). Alternatively, provide a custom cron expression. Each period becomes a separate sensor.\n**Value template:** A template that is applied on the output of the sensor. Use `value` to refer to the sensor state.\n**Unit of measurement:** The unit of what your are measuring. E.g.: m3\n**Device class:** Find more about device classes [{device_class_url}].\n**State class**: Find more about state classes [{state_class_url}].",
         "data": {
           "periods": "Reset periods:",
           "unit_of_measurement": "Unit of measurement",
@@ -56,7 +56,7 @@
       },
       "thank_you": {
         "title": "Thank you for setting up MeasureIt!",
-        "description": "Did you know that I'm incredibly motivated by coffee? ☕\nIf you like using MeasureIt, please consider buying me a coffee!\nhttps://www.buymeacoffee.com/danieldotnl 🙏"
+        "description": "Did you know that I'm incredibly motivated by coffee? ☕\nIf you like using MeasureIt, please consider buying me a coffee!\n{buymeacoffee_url} 🙏"
       }
     },
     "error": {
@@ -77,7 +77,7 @@
       },
       "add_sensors": {
         "title": "Add sensor(s)",
-        "description": "Add and configure one or more sensors. When in doubt, stick to the defaults.\n\n**Reset periods:** Select the periods you want to measure (when the meter will reset). Each period becomes a separate sensor.\n**Value template:** A template that is applied on the output of the sensor. Use `value` to refer to the sensor state.\n**Unit of measurement:** The unit of what your are measuring. E.g.: m3\n**Device class:** Find more about device classes [here](https://www.home-assistant.io/integrations/sensor/#device-class).\n**State class**: Find more about state classes [here](https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes).",
+        "description": "Add and configure one or more sensors. When in doubt, stick to the defaults.\n\n**Reset periods:** Select the periods you want to measure (when the meter will reset). Each period becomes a separate sensor.\n**Value template:** A template that is applied on the output of the sensor. Use `value` to refer to the sensor state.\n**Unit of measurement:** The unit of what your are measuring. E.g.: m3\n**Device class:** Find more about device classes [{device_class_url}].\n**State class**: Find more about state classes [{state_class_url}].",
         "data": {
           "period": "Reset periods:",
           "unit_of_measurement": "Unit of measurement",
@@ -97,7 +97,7 @@
       },
       "thank_you": {
         "title": "Thank you for setting up MeasureIt!",
-        "description": "Did you know that I'm incredibly motivated by coffee? ☕\nIf you like using MeasureIt, please consider buying me a coffee!\nhttps://www.buymeacoffee.com/danieldotnl 🙏"
+        "description": "Did you know that I'm incredibly motivated by coffee? ☕\nIf you like using MeasureIt, please consider buying me a coffee!\n{buymeacoffee_url} 🙏"
       },
       "edit_sensor": {
         "title": "Edit sensor",
diff --git a/tests/unit/test_coordinator.py b/tests/unit/test_coordinator.py
@@ -186,8 +186,8 @@ def test_async_on_heartbeat(coordinator: MeasureItCoordinator) -> None:
 
 def test_start_with_counter(coordinator: MeasureItCoordinator) -> None:
     """Test start."""
-    coordinator._condition_template = Template("{{ True }}")
-    coordinator._counter_template = Template("{{ True }}")
+    coordinator._condition_template = Template("{{ True }}", coordinator.hass)
+    coordinator._counter_template = Template("{{ True }}", coordinator.hass)
     assert coordinator._condition_template_listener is None
     assert coordinator._time_window_listener is None
     assert coordinator._condition_template_listener is None
@@ -200,7 +200,7 @@ def test_start_with_counter(coordinator: MeasureItCoordinator) -> None:
 def test_start_with_source(coordinator: MeasureItCoordinator) -> None:
     """Test start."""
     coordinator._meter_type = MeterType.SOURCE
-    coordinator._condition_template = Template("{{ True }}")
+    coordinator._condition_template = Template("{{ True }}", coordinator.hass)
     coordinator._source_entity = "sensor.test"
     coordinator._get_sensor_state = MagicMock(return_value=123)
     entity = MeasureItCoordinatorEntity()
@@ -221,7 +221,7 @@ def test_start_with_source(coordinator: MeasureItCoordinator) -> None:
 def test_start_with_time(coordinator: MeasureItCoordinator) -> None:
     """Test start."""
     coordinator._meter_type = MeterType.TIME
-    coordinator._condition_template = Template("{{ True }}")
+    coordinator._condition_template = Template("{{ True }}", coordinator.hass)
     assert coordinator._condition_template_listener is None
     assert coordinator._time_window_listener is None
     assert coordinator._heartbeat_listener is None
