Merge pull request #1286 from danielpeintner/fix-comments-text-2024-05-22

docs: fix typos in comments/text/descriptions/variable-names

Author: relu91

packages/binding-coap/src/coap-server.ts

@@ -367,7 +367,7 @@ export default class CoapServer implements ProtocolServer {
                 this.coreResources.delete(name);
                 this.mdnsIntroducer?.delete(name);
 
-                info(`CoapServer succesfully destroyed '${exposedThing.title}'`);
+                info(`CoapServer successfully destroyed '${exposedThing.title}'`);
                 return true;
             }
         }

packages/binding-coap/test/coap-client-test.ts

@@ -31,7 +31,7 @@ const port2 = 31834;
 /**
  * Helper function for waiting during tests.
  *
- * @param ms The time to wait in miliseconds.
+ * @param ms The time to wait in milliseconds.
  * @returns A Promise that is resolved after the given time period.
  */
 function sleep(ms: number) {

packages/binding-coap/test/coap-server-test.ts

@@ -636,7 +636,7 @@ class CoapServerTest {
         await coapServer.stop();
     }
 
-    @test async "should add the cov:observe subprotocol value to obervable properties and events "() {
+    @test async "should add the cov:observe subprotocol value to observable properties and events "() {
         const coapServer = new CoapServer({ port: 5683 });
         const servient = new Servient();
         servient.addServer(coapServer);

packages/binding-mbus/src/mbus.ts

@@ -30,7 +30,7 @@ export class MBusForm extends Form {
      */
     public "mbus:offset"?: number;
     /**
-     * Timeout in milliseconds of the modbus request. Default to 1000 milliseconds
+     * Timeout in milliseconds of the mbus request. Default to 1000 milliseconds
      */
     public "mbus:timeout"?: number;
 }

packages/binding-modbus/test/modbus-client-test.ts

@@ -343,7 +343,7 @@ describe("Modbus client test", () => {
         it("should write a resource with big endian ordering", async () => {
             const form: ModbusForm = {
                 href: "modbus+tcp://127.0.0.1:8502/1/0",
-                contentType: "application/octet-stream;length=2;byteSeq=BIG_ENDIAN", // FIXME: Use mostsignficant etc.
+                contentType: "application/octet-stream;length=2;byteSeq=BIG_ENDIAN", // FIXME: Use most significant etc.
                 "modv:function": 16,
             };
 

packages/binding-mqtt/src/mqtt-broker-server.ts

@@ -351,7 +351,7 @@ export default class MqttBrokerServer implements ProtocolServer {
         }
 
         if (removedThing != null) {
-            info(`MqttBrokerServer succesfully destroyed '${removedThing.title}'`);
+            info(`MqttBrokerServer successfully destroyed '${removedThing.title}'`);
         } else {
             info(`MqttBrokerServer failed to destroy thing with thingId '${thingId}'`);
         }

packages/binding-opcua/test/full-opcua-thing-test.ts

@@ -51,7 +51,7 @@ const thingDescription: WoT.ThingDescription = {
             unit: "°C",
             type: "number",
             "opcua:nodeId": { root: "i=84", path: "/Objects/1:MySensor/2:ParameterSet/1:Temperature" },
-            // Don't specifu type here as it could be multi form: type: [ "object", "number" ],
+            // Don't specify type here as it could be multi form: type: [ "object", "number" ],
             forms: [
                 // 0 -> standard Node WoT form => Raw value
                 {
@@ -113,7 +113,7 @@ const thingDescription: WoT.ThingDescription = {
             observable: true,
             unit: "°C",
             type: "number",
-            // dont't
+            // don't
             forms: [
                 {
                     href: "/",
@@ -209,7 +209,7 @@ const thingDescription: WoT.ThingDescription = {
                 type: "object",
                 properties: {
                     PreviousSetPoint: {
-                        type: "object", // << Note here this is an object reprensenting a JSON OPCUA Variant
+                        type: "object", // << Note here this is an object representing a JSON OPCUA Variant
                         title: "the previous temperature set point",
                         // minimum: 0,
                         // maximum: 100,

packages/binding-websockets/src/ws-server.ts

@@ -84,7 +84,7 @@ export default class WebSocketServer implements ProtocolServer {
     public start(servient: Servient): Promise<void> {
         debug(`WebSocketServer starting on ${this.address !== undefined ? this.address + " " : ""}port ${this.port}`);
         return new Promise<void>((resolve, reject) => {
-            // handle incoming WebScoket connections
+            // handle incoming WebSocket connections
             this.httpServer.on("upgrade", (request, socket, head) => {
                 const pathname = new url.URL(request.url ?? "", `${this.scheme}://${request.headers.host}`).pathname;
 
@@ -309,7 +309,7 @@ export default class WebSocketServer implements ProtocolServer {
                 removedThing = this.thingNames.delete(thingPath);
             }
             if (removedThing) {
-                info(`WebSocketServer succesfully destroyed '${thingId}'`);
+                info(`WebSocketServer successfully destroyed '${thingId}'`);
             } else {
                 info(`WebSocketServer failed to destroy thing with thingId '${thingId}'`);
             }

packages/cli/src/cli-default-servient.ts

@@ -328,7 +328,7 @@ export default class DefaultServient extends Servient {
                                 return undefined;
                             });
                             thing.setPropertyReadHandler("things", async () => {
-                                debug("returnings things");
+                                debug("returning things");
                                 return this.getThings();
                             });
                             thing

packages/cli/src/cli.ts

@@ -38,7 +38,7 @@ const schemaValidator = ajv.compile(ConfigSchema) as ValidateFunction;
 const defaultFile = "wot-servient.conf.json";
 const baseDir = ".";
 
-const dotEnvConfigParamters: DotEnvConfigParameter = {};
+const dotEnvConfigParameters: DotEnvConfigParameter = {};
 
 // General commands
 program
@@ -175,7 +175,7 @@ function parseConfigParams(param: string, previous: unknown) {
                 .join("\n")}`
         );
     }
-    // Concatenate validated paramters
+    // Concatenate validated parameters
     let result = previous ?? {};
     result = _.merge(result, obj);
     return result;
@@ -220,7 +220,7 @@ if (errorNoException?.code !== "ENOENT") {
     for (const [key, value] of Object.entries(env.parsed)) {
         // Parse and validate on configfile-related entries
         if (key.startsWith("config.")) {
-            dotEnvConfigParamters[key.replace("config.", "")] = value;
+            dotEnvConfigParameters[key.replace("config.", "")] = value;
         }
     }
 }
@@ -238,7 +238,7 @@ async function buildConfig(): Promise<unknown> {
     }
 
     // .env file
-    for (const [key, value] of Object.entries(dotEnvConfigParamters)) {
+    for (const [key, value] of Object.entries(dotEnvConfigParameters)) {
         const obj = _.set({}, key, value);
         configFileData = _.merge(configFileData, obj);
     }