Merge pull request #11373 from thalesmg/fix-spellcheck-master-20230731

fix(spellcheck): fix several spellcheck issues not caught in CI

apps/emqx_bridge_azure_event_hub/src/emqx_bridge_azure_event_hub.erl

@@ -68,8 +68,25 @@ fields(Method) ->
     Fields = emqx_bridge_kafka:fields(Method),
     override_documentations(Fields).
 
-desc(_) ->
-    undefined.
+desc("config_producer") ->
+    ?DESC("desc_config");
+desc("ssl_client_opts") ->
+    emqx_schema:desc("ssl_client_opts");
+desc("get_producer") ->
+    ["Configuration for Azure Event Hub using `GET` method."];
+desc("put_producer") ->
+    ["Configuration for Azure Event Hub using `PUT` method."];
+desc("post_producer") ->
+    ["Configuration for Azure Event Hub using `POST` method."];
+desc(Name) ->
+    lists:member(Name, struct_names()) orelse throw({missing_desc, Name}),
+    ?DESC(Name).
+
+struct_names() ->
+    [
+        auth_username_password,
+        producer_kafka_opts
+    ].
 
 conn_bridge_examples(Method) ->
     [
@@ -162,7 +179,15 @@ ref(Name) ->
 
 producer_overrides() ->
     #{
-        authentication => mk(ref(auth_username_password), #{default => #{}, required => true}),
+        authentication =>
+            mk(
+                ref(auth_username_password),
+                #{
+                    default => #{},
+                    required => true,
+                    desc => ?DESC("authentication")
+                }
+            ),
         bootstrap_hosts =>
             mk(
                 binary(),

rel/i18n/emqx_bridge_azure_event_hub.hocon

@@ -105,7 +105,7 @@ partition_count_refresh_interval.label:
 """Partition Count Refresh Interval"""
 
 max_batch_bytes.desc:
-"""Maximum bytes to collect in a Azure Event Hub message batch. Most of the Kafka brokers default to a limit of 1 MB batch size. EMQX's default value is less than 1 MB in order to compensate Kafka message encoding overheads (especially when each individual message is very small). When a single message is over the limit, it is still sent (as a single element batch)."""
+"""Maximum bytes to collect in an Azure Event Hub message batch. Most of the Kafka brokers default to a limit of 1 MB batch size. EMQX's default value is less than 1 MB in order to compensate Kafka message encoding overheads (especially when each individual message is very small). When a single message is over the limit, it is still sent (as a single element batch)."""
 
 max_batch_bytes.label:
 """Max Batch Bytes"""
@@ -284,4 +284,28 @@ sync_query_timeout.desc:
 sync_query_timeout.label:
 """Synchronous Query Timeout"""
 
+auth_username_password.desc:
+"""Username/password based authentication."""
+
+auth_username_password.label:
+"""Username/password Auth"""
+
+auth_sasl_password.desc:
+"""The password for connecting to Azure Event Hub.  Should be the "connection string-primary key" of a Namespace shared access policy."""
+
+auth_sasl_password.label:
+"""Password"""
+
+producer_kafka_opts.desc:
+"""Azure Event Hub producer configs."""
+
+producer_kafka_opts.label:
+"""Azure Event Hub Producer"""
+
+desc_config.desc:
+"""Configuration for an Azure Event Hub bridge."""
+
+desc_config.label:
+"""Azure Event Hub Bridge Configuration"""
+
 }

rel/i18n/emqx_bridge_dynamo.hocon

@@ -36,8 +36,9 @@ local_topic.label:
 
 template.desc:
 """Template, the default value is empty. When this value is empty the whole message will be stored in the database.<br>
-The template can be any valid json with placeholders and make sure all keys for table are here, example:<br>
-  {"id" : "${id}", "clientid" : "${clientid}", "data" : "${payload.data}"}"""
+The template can be any valid JSON with placeholders and make sure all keys for table are here, example:<br>
+  <code>{"id" : "${id}", "clientid" : "${clientid}", "data" : "${payload.data}"}</code>
+"""
 
 template.label:
 """Template"""

rel/i18n/emqx_bridge_greptimedb.hocon

@@ -35,7 +35,7 @@ local_topic.label:
 """Local Topic"""
 
 write_syntax.desc:
-"""Conf of GreptimeDB gRPC protocol to write data points.The write syntax is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point, and placeholder supported, which is the same as InfluxDB line protocol.
+"""Conf of GreptimeDB gRPC protocol to write data points. Write syntax is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point, and placeholder supported, which is the same as InfluxDB line protocol.
 See also [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) and
 [GreptimeDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) </br>
 TLDR:</br>

scripts/spellcheck/spellcheck.sh

@@ -17,8 +17,16 @@ if ! [ -f "$SCHEMA" ]; then
   exit 1
 fi
 
+if [[ -t 1 ]];
+then
+  DOCKER_TERMINAL_OPT="-t"
+else
+  DOCKER_TERMINAL_OPT=""
+fi
+
 set +e
-docker run --rm -i --name spellcheck \
+# shellcheck disable=SC2086
+docker run --rm -i ${DOCKER_TERMINAL_OPT} --name spellcheck \
     -v "${PROJ_ROOT}"/scripts/spellcheck/dicts:/dicts \
     -v "$SCHEMA":/schema.json \
     ghcr.io/emqx/emqx-schema-validate:0.4.0 /schema.json