refactor: completely remove references to wot-servient and rename it to node-wot

relu91 · relu91 · commit f63f2f756d40 · 2026-03-03T12:48:23.000+01:00
diff --git a/README.md b/README.md
@@ -118,7 +118,7 @@ You can alternatively use node-wot via its command line interface (CLI). Please
 
 #### As global tool
 
-To make the `wot-servient` command available on your machine, install the CLI tool in the global scope:
+To make the `node-wot` command available on your machine, install the CLI tool in the global scope:
 
 ```
 npm i @node-wot/cli -g
diff --git a/packages/binding-mqtt/README.md b/packages/binding-mqtt/README.md
@@ -300,7 +300,7 @@ Please setup node-wot as described at the [node-wot main page](https://github.co
 -   example-mqtt-publish.js: Shows when node-wot acts as a MQTT Client that publishes data (latest counter value) to a broker.
     At the same time, another client can invoke an action, such as `resetCounter`, by sending a publication message to the topic of this action.
     This other client does not have to be node-wot, any MQTT client can interact with this Thing.
-    For node-wot clients, make sure to provide MQTT broker details (`host`, `port`, `username`, `password`, `clientId`) in the wot-servient.conf.json:
+    For node-wot clients, make sure to provide MQTT broker details (`host`, `port`, `username`, `password`, `clientId`) in the `node-wot.conf.json`:
 
 ```js
 {
diff --git a/packages/binding-netconf/README.md b/packages/binding-netconf/README.md
@@ -44,7 +44,7 @@ The Binding example in the `./examples` directory provides a TD (`netconf-thing.
 Depending on which NETCONF server is used, the following might have to be changed:
 
 -   IP address and port in `examples/netconf-thing.jsonld`
--   credentials for the NETCONF Thing (id `urn:dev:wot:org:eclipse:netconf-example`) have to be changed in `wot-servient.conf.json`.
+-   credentials for the NETCONF Thing (id `urn:dev:wot:org:eclipse:netconf-example`) have to be changed in `node-wot.conf.json`.
 
 ## New Form Fields for the NETCONF Binding
 
@@ -53,7 +53,7 @@ Depending on which NETCONF server is used, the following might have to be change
 The href contains: URI schema + IP address + port + XPath
 
 -   URI schema: the schema for NETCONF is not registered with IANA; the Binding is using `netconf`.
--   IP address and port: IP address and port of the NETCONF server. The credentials for the SSH connection to the server can be added into the `wot-servient.configuration.json`.
+-   IP address and port: IP address and port of the NETCONF server. The credentials for the SSH connection to the server can be added into the `node-wot.configuration.json`.
 -   XPath: the XPath of the YANG model node addressed by the given InteractionAffordance. The XPath is automatically converted into the corresponding XML needed by the RPC. If an attribute refers to a particular namespace, an alias can be used. The complete URN for the alias should be added to the **nc:NSs** field.
 
 ### nc:target
diff --git a/packages/browser-bundle/web-test-runner.config.mjs b/packages/browser-bundle/web-test-runner.config.mjs
@@ -169,7 +169,7 @@ async function cleanup() {
 
 function controlTestServient() {
     return {
-        name: "wot-servient",
+        name: "node-wot",
 
         async executeCommand({ command }) {
             switch (command) {
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -48,7 +48,7 @@ node-wot script1.js ./src/script2.js
 
 ### Configuration
 
-The `-h` option explains the functionality and also how node-wot can be configured based on `wot-servient.conf.json`.
+The `-h` option explains the functionality and also how node-wot can be configured based on `node-wot.conf.json`.
 
 -   `node-wot -h` _or_
 -   `node packages\cli\dist\cli.js -h`
@@ -69,7 +69,7 @@ Options:
   -v, --version                   display node-wot version
   -c, --client-only               do not start any servers (enables multiple instances without port conflicts)
   -ll, --logLevel <string>        choose the desired log level. WARNING: if DEBUG env variable is specified this option gets overridden. (choices: "debug", "info", "warn", "error")
-  -f, --config-file <file>        load configuration from specified file (default: $(pwd)/wot-servient.conf.json)
+  -f, --config-file <file>        load configuration from specified file (default: $(pwd)/node-wot.conf.json)
   -p, --config-params <param...>  override configuration parameters [key1:=value1 key2:=value2 ...] (e.g. http.port:=8080)
   -h, --help                      show this help
 
@@ -91,12 +91,12 @@ node-wot schema
 In your configuration files you can the following to enable IDE config validation:
 
 {
-    "$schema": "./node_modules/@node-wot/cli/dist/wot-servient-schema.conf.json"
+    "$schema": "./node_modules/@node-wot/cli/dist/node-wot-schema.conf.json"
     ...
 }
 ```
 
-Additionally, you can look at [the JSON Schema](https://github.com/eclipse-thingweb/node-wot/blob/master/packages/cli/src/wot-servient-schema.conf.json) to understand possible values for each field.
+Additionally, you can look at [the JSON Schema](https://github.com/eclipse-thingweb/node-wot/blob/master/packages/cli/src/node-wot-schema.conf.json) to understand possible values for each field.
 
 > In the current implementation, the **middleware** option (that you can use to handle raw HTTP requests _before_ they hit the Servient) is only available when using the `@node-wot/binding-http` package as a library. See [Adding a middleware](../binding-http/README.md#adding-a-middleware) for more information.
 
diff --git a/packages/cli/import-json-to-ts.js b/packages/cli/import-json-to-ts.js
@@ -1,7 +1,7 @@
 const { readFileSync, writeFileSync } = require("fs");
 const { existsSync, mkdirSync } = require("fs");
 
-const schema = readFileSync("./src/wot-servient-schema.conf.json", "utf8");
+const schema = readFileSync("./src/node-wot-schema.conf.json", "utf8");
 const package = readFileSync("./package.json", "utf8");
 const { version } = JSON.parse(package);
 
@@ -11,7 +11,7 @@ if (!existsSync(generatedDir)) {
 }
 
 writeFileSync(
-    "./src/generated/wot-servient-schema.conf.ts",
+    "./src/generated/node-wot-schema.conf.ts",
     `const schema = ${schema.trimEnd()} as const \nexport default schema;`
 );
 writeFileSync("./src/generated/version.ts", `const version = "${version}" as const \nexport default version;`);
diff --git a/packages/cli/src/cli.ts b/packages/cli/src/cli.ts
@@ -20,7 +20,7 @@ import DefaultServient from "./cli-default-servient";
 import * as path from "path";
 import { Command, Argument, Option } from "commander";
 import Ajv, { ValidateFunction } from "ajv";
-import ConfigSchema from "./generated/wot-servient-schema.conf";
+import ConfigSchema from "./generated/node-wot-schema.conf";
 import version from "./generated/version";
 import { createLoggers, Helpers } from "@node-wot/core";
 import { loadEnvVariables } from "./utils";
@@ -36,7 +36,7 @@ const { error, info, warn, debug } = createLoggers("cli", "cli");
 const program = new Command();
 const ajv = new Ajv({ strict: true, allErrors: true });
 const schemaValidator = ajv.compile(ConfigSchema) as ValidateFunction<Configuration>;
-const defaultFile = "wot-servient.conf.json";
+const defaultFile = "node-wot.conf.json";
 const baseDir = ".";
 
 // General commands
@@ -69,7 +69,7 @@ node-wot schema
 In your configuration files you can the following to enable IDE config validation:
 
 {
-    "$schema": "./node_modules/@node-wot/cli/dist/wot-servient-schema.conf.json"
+    "$schema": "./node_modules/@node-wot/cli/dist/node-wot-schema.conf.json"
     ...
 }
     `
@@ -86,7 +86,7 @@ program
     )
     .option(
         "-f, --config-file <file>",
-        "load configuration from specified file (default: $(pwd)/wot-servient.conf.json)",
+        "load configuration from specified file (default: $(pwd)/node-wot.conf.json)",
         (value, previous) => parseConfigFile(value, previous)
     )
     .option(
diff --git a/packages/cli/src/configuration.ts b/packages/cli/src/configuration.ts
@@ -14,7 +14,7 @@
  ********************************************************************************/
 
 import { FromSchema } from "json-schema-to-ts";
-import schema from "./generated/wot-servient-schema.conf";
+import schema from "./generated/node-wot-schema.conf";
 import { DotenvParseOutput } from "dotenv";
 import _ from "lodash";
 import { readFile } from "fs/promises";
diff --git a/packages/cli/src/node-wot-schema.conf.json b/packages/cli/src/node-wot-schema.conf.json
diff --git a/packages/cli/src/utils/load-env-variables.ts b/packages/cli/src/utils/load-env-variables.ts
@@ -15,7 +15,7 @@
 import * as dotenv from "dotenv";
 import ErrnoException = NodeJS.ErrnoException;
 
-export function loadEnvVariables(prefix: string = "WOT_SERVIENT_"): { [key: string]: string } {
+export function loadEnvVariables(prefix: string = "NODE_WOT_"): { [key: string]: string } {
     const env: dotenv.DotenvConfigOutput = dotenv.config();
     const errornoException: ErrnoException | undefined = env.error;
     // ignore file not found but throw otherwise
diff --git a/packages/cli/test/configuration.ts b/packages/cli/test/configuration.ts
@@ -17,7 +17,7 @@ import { suite, test } from "@testdeck/mocha";
 import { should, expect, use as chaiUse } from "chai";
 import { buildConfig, buildConfigFromFile, defaultConfiguration, Configuration } from "../src/configuration";
 import Ajv, { ValidateFunction } from "ajv";
-import ConfigSchema from "../src/generated/wot-servient-schema.conf";
+import ConfigSchema from "../src/generated/node-wot-schema.conf";
 import chaiAsPromised from "chai-as-promised";
 import { writeFileSync, unlinkSync } from "fs";
 import { ValidationError } from "ajv";
diff --git a/packages/cli/test/parsers/config-params-parser.ts b/packages/cli/test/parsers/config-params-parser.ts
@@ -19,7 +19,7 @@ import { should, expect } from "chai";
 import { parseConfigParams } from "../../src/parsers/config-params-parser";
 import { InvalidArgumentError } from "commander";
 import Ajv, { ValidateFunction } from "ajv";
-import ConfigSchema from "../../src/generated/wot-servient-schema.conf";
+import ConfigSchema from "../../src/generated/node-wot-schema.conf";
 import { Configuration } from "../../src/configuration";
 
 should();
diff --git a/packages/cli/test/utils/load-env-variables.ts b/packages/cli/test/utils/load-env-variables.ts
@@ -32,8 +32,8 @@ class LoadEnvVariablesTest {
     }
 
     @test "should filter environment variables by prefix"() {
-        process.env.WOT_SERVIENT_HTTP_PORT = "8080";
-        process.env.WOT_SERVIENT_COAP_PORT = "5683";
+        process.env.NODE_WOT_HTTP_PORT = "8080";
+        process.env.NODE_WOT_COAP_PORT = "5683";
         process.env.OTHER_VAR = "value";
 
         const result = loadEnvVariables();
@@ -44,8 +44,8 @@ class LoadEnvVariablesTest {
     }
 
     @test "should return empty object when no matching variables are found"() {
-        delete process.env.WOT_SERVIENT_HTTP_PORT;
-        delete process.env.WOT_SERVIENT_COAP_PORT;
+        delete process.env.NODE_WOT_HTTP_PORT;
+        delete process.env.NODE_WOT_COAP_PORT;
 
         const result = loadEnvVariables();
 
@@ -56,7 +56,7 @@ class LoadEnvVariablesTest {
     @test "should use custom prefix"() {
         process.env.CUSTOM_PREFIX_VAR1 = "value1";
         process.env.CUSTOM_PREFIX_VAR2 = "value2";
-        process.env.WOT_SERVIENT_VAR3 = "value3";
+        process.env.NODE_WOT_VAR3 = "value3";
 
         const result = loadEnvVariables("CUSTOM_PREFIX_");
 
@@ -66,11 +66,11 @@ class LoadEnvVariablesTest {
     }
 
     @test "should remove prefix from keys"() {
-        process.env.WOT_SERVIENT_MYKEY = "myvalue";
+        process.env.NODE_WOT_MYKEY = "myvalue";
 
         const result = loadEnvVariables();
 
         expect(result).to.have.property("MYKEY", "myvalue");
-        expect(Object.keys(result)).to.not.include("WOT_SERVIENT_MYKEY");
+        expect(Object.keys(result)).to.not.include("NODE_WOT_MYKEY");
     }
 }
diff --git a/packages/cli/wot-servient.conf.json.md b/packages/cli/wot-servient.conf.json.md

Original file line number	Diff line number	Diff line change
`@@ -300,7 +300,7 @@ Please setup node-wot as described at the [node-wot main page](https://github.co`
`300`	`300`	`- example-mqtt-publish.js: Shows when node-wot acts as a MQTT Client that publishes data (latest counter value) to a broker.`
`301`	`301`	At the same time, another client can invoke an action, such as `resetCounter`, by sending a publication message to the topic of this action.
`302`	`302`	`This other client does not have to be node-wot, any MQTT client can interact with this Thing.`
`303`		- For node-wot clients, make sure to provide MQTT broker details (`host`, `port`, `username`, `password`, `clientId`) in the wot-servient.conf.json:
	`303`	+ For node-wot clients, make sure to provide MQTT broker details (`host`, `port`, `username`, `password`, `clientId`) in the `node-wot.conf.json`:
`304`	`304`
`305`	`305`	```js
`306`	`306`	`{`