feat(cli): rename cli commad from wot-servient to node-wot

Author: relu91

Dockerfile

@@ -35,4 +35,4 @@ STOPSIGNAL SIGINT
 ENTRYPOINT [ "node", "dist/cli.js" ]
 CMD [ "-h" ]
 
-##  docker build -t wot-servient ./docker/Dockerfile
+##  docker build -t node-wot ./docker/Dockerfile

README.md

@@ -119,16 +119,16 @@ Go into the repository:
 cd node-wot
 ```
 
-Build the Docker image named `wot-servient` from the `Dockerfile`:
+Build the Docker image named `node-wot` from the `Dockerfile`:
 
 ```
 npm run build:docker
 ```
 
-Run the wot-servient as a container:
+Run the `node-wot` as a container:
 
 ```
-docker run --rm wot-servient -h
+docker run --rm node-wot -h
 ```
 
 ## Examples
@@ -231,12 +231,12 @@ Can't find your preferred MediaType? More codecs can be easily added by implemen
 Run all the steps above including "Link Packages" and then run this:
 
 ```
-wot-servient -h
+node-wot -h
 cd examples/scripts
-wot-servient
+node-wot
 ```
 
-Without the "Link Packages" step, the `wot-servient` command is not available and `node` needs to be used (e.g., Windows CMD shell):
+Without the "Link Packages" step, the `node-wot` command is not available and `node` needs to be used (e.g., Windows CMD shell):
 
 ```
 # expose
@@ -256,9 +256,9 @@ First [build the docker image](#as-a-docker-image) and then run the counter exam
 
 ```
 # expose
-docker run -it --init -p 8080:8080/tcp -p 5683:5683/udp -v "$(pwd)"/examples:/srv/examples --rm wot-servient /srv/examples/scripts/counter.js
+docker run -it --init -p 8080:8080/tcp -p 5683:5683/udp -v "$(pwd)"/examples:/srv/examples --rm node-wot /srv/examples/scripts/counter.js
 # consume
-docker run -it --init -v "$(pwd)"/examples:/srv/examples --rm --net=host wot-servient /srv/examples/scripts/counter-client.js --client-only
+docker run -it --init -v "$(pwd)"/examples:/srv/examples --rm --net=host node-wot /srv/examples/scripts/counter-client.js --client-only
 ```
 
 -   The counter exposes the HTTP endpoint at 8080/tcp and the CoAP endpoint at 5683/udp and they are bound to the host machine (with `-p 8080:8080/tcp -p 5683:5683/udp`).

package-lock.json

@@ -31,8 +31,8 @@
         "prepare": "husky install",
         "publish": "npm publish --workspaces",
         "check:versions": "node utils/check_package_version_consistency.js",
-        "build:docker": "docker build -t wot-servient .",
-        "build:podman": "podman build -t wot-servient .",
+        "build:docker": "docker build -t node-wot .",
+        "build:podman": "podman build -t node-wot .",
         "clean:dist": "npm exec  --workspaces -- npx rimraf tsconfig.tsbuildinfo dist",
         "update:wot-typescript-definitions": "npx npm-check-updates  -u -f \"wot-typescript-definitions\" --deep",
         "link": "npm link -ws",

package.json

@@ -200,11 +200,11 @@ Please setup node-wot as described at the [node-wot main page](https://github.co
 
 ```
 
-Start the script by the command `wot-servient mqtt-publish.js` or `node ../../packages/cli/dist/cli.js mqtt-publish.js`.
+Start the script by the command `node-wot mqtt-publish.js` or `node ../../packages/cli/dist/cli.js mqtt-publish.js`.
 
 -   example-mqtt-subscription.js: Shows how node-wot consumes a Thing Description to do MQTT subscription on the provided event (=latest counter value) as well as initiate the action (reset counter).
 
-Start the script by the command `wot-servient -c mqtt-subscribe.js` or `node ../../packages/cli/dist/cli.js -c mqtt-subscribe.js`.
+Start the script by the command `node-wotù -c mqtt-subscribe.js` or `node ../../packages/cli/dist/cli.js -c mqtt-subscribe.js`.
 
 ### More Details
 

packages/binding-mqtt/README.md

@@ -27,36 +27,36 @@ If you do so, anyway, you can specify the entry point as follows:
 
 ```JavaScript
 "scripts":{
-   "start": "wot-servient main.js"
+   "start": "node-wot main.js"
 }
 ```
 
 There are several ways to start the application:
 
 a. Execute `npm start`.
-b. Execute `./node_modules/.bin/wot-servient main.js`.
+b. Execute `./node_modules/.bin/node-wot main.js`.
 c. Execute `node ./node_modules/@node-wot/cli/dist/cli.js main.js`.
 d. If you have installed `@node-wot/cli` globally you can even start the application right
-away using this command `wot-servient main.js`. However, in the current implementation, the
+away using this command `node-wot main.js`. However, in the current implementation, the
 import of local dependencies is not supported in this case.
 
-wot-servient can execute multiple files at once, for example as follows:
+node-wot can execute multiple files at once, for example as follows:
 
 ```
-wot-servient script1.js ./src/script2.js
+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`.
 
--   `wot-servient -h` _or_
--   `node packages\cli\dist\cli.js`
+-   `node-wot -h` _or_
+-   `node packages\cli\dist\cli.js -h`
 
 The `-h` help option shows the following output:
 
 ```
-Usage: wot-servient [options] [command] [files...]
+Usage: node-wot [options] [command] [files...]
 
 
 Run a WoT Servient in the current directory.
@@ -86,7 +86,7 @@ Settings can be applied through three methods, in order of precedence (highest t
 
 For the complete list of available configuration fields and their data types, run:
 
-wot-servient schema
+node-wot schema
 
 In your configuration files you can the following to enable IDE config validation:
 
@@ -113,7 +113,7 @@ ADDRESS=http://hello.com
 
 To debug, use the option `--inspect` or `--inspect-brk` if you want to hang until your debug client is connected. Then start [Chrome Dev Tools](chrome://inspect) or [vscode debugger](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_attaching-to-nodejs) or your preferred v8 inspector to debug your code.
 
-For further details check: `wot-servient --help`
+For further details check: `node-wot --help`
 
 ### Examples
 

packages/cli/README.md

@@ -14,7 +14,7 @@
     "main": "bin/index.js",
     "types": "dist/cli.d.ts",
     "bin": {
-        "wot-servient": "bin/index.js"
+        "node-wot": "bin/index.js"
     },
     "optionalDependencies": {
         "ts-node": "10.9.1"

packages/cli/package.json

@@ -41,7 +41,7 @@ const baseDir = ".";
 
 // General commands
 program
-    .name("wot-servient")
+    .name("node-wot")
     .description(
         `
 Run a WoT Servient in the current directory.
@@ -64,7 +64,7 @@ Settings can be applied through three methods, in order of precedence (highest t
 
 For the complete list of available configuration fields and their data types, run:
 
-wot-servient schema
+node-wot schema
 
 In your configuration files you can the following to enable IDE config validation:
 
@@ -136,11 +136,11 @@ program.action(async function (_, options, cmd) {
         servient = new DefaultServient(config);
     } catch (err) {
         if ((err as NodeJS.ErrnoException)?.code !== "ENOENT" || options.configFile != null) {
-            error("WoT-Servient configuration file error:\n%O\nClose.", err);
+            error("node-wot configuration file error:\n%O\nClose.", err);
             process.exit((err as NodeJS.ErrnoException).errno ?? 1);
         }
 
-        warn(`WoT-Servient using defaults as %s does not exist`, defaultFile);
+        warn(`node-wot using defaults as %s does not exist`, defaultFile);
 
         const config = await buildConfig(options, cloneDeep(defaultConfiguration), env, schemaValidator);
         config.servient.clientOnly = options.clientOnly ?? config.servient.clientOnly;
@@ -157,7 +157,7 @@ program.action(async function (_, options, cmd) {
     const files = await readdir(baseDir);
     const scripts = files.filter((file) => !file.startsWith(".") && file.slice(-3) === ".js");
 
-    info(`WoT-Servient using current directory with %d script${scripts.length > 1 ? "s" : ""}`, scripts.length);
+    info(`node-wot using current directory with %d script${scripts.length > 1 ? "s" : ""}`, scripts.length);
 
     return runScripts({ runtime, helpers }, scripts, options.inspect ?? options.inspectBrk);
 });

packages/cli/src/cli.ts

@@ -29,20 +29,20 @@ export async function runScripts(context: WoTContext, scripts: string[], debug?:
     const executor = new Executor();
     const launchScripts = (scripts: Array<string>) => {
         scripts.forEach(async (fname: string) => {
-            info(`WoT-Servient reading script ${fname}`);
+            info(`node-wot reading script ${fname}`);
             try {
                 const data = await readFile(fname, "utf-8");
                 // limit printout to first line
                 info(
-                    `WoT-Servient running script '${data.substr(0, data.indexOf("\n")).replace("\r", "")}'... (${
+                    `node-wot running script '${data.substr(0, data.indexOf("\n")).replace("\r", "")}'... (${
                         data.split(/\r\n|\r|\n/).length
                     } lines)`
                 );
 
                 fname = path.resolve(fname);
                 await executor.exec(fname, context);
             } catch (err) {
-                error(`WoT-Servient experienced error while reading script. %O`, err);
+                error(`node-wot experienced error while reading script. %O`, err);
             }
         });
     };