]> git.basschouten.com Git - openhab-addons.git/commitdiff
[jsscripting] Update docs and refactor path (#11827)
authorDan Cunningham <dan@digitaldan.com>
Tue, 21 Dec 2021 22:36:22 +0000 (14:36 -0800)
committerGitHub <noreply@github.com>
Tue, 21 Dec 2021 22:36:22 +0000 (23:36 +0100)
This adds a minor refactoring of loading local resource paths that i didn't have time to get into 3.2  and moves the docs directory to doc.

Signed-off-by: Dan Cunningham <dan@digitaldan.com>
bundles/org.openhab.automation.jsscripting/README.md
bundles/org.openhab.automation.jsscripting/doc/rule-config.png [new file with mode: 0644]
bundles/org.openhab.automation.jsscripting/doc/rule-engines.png [new file with mode: 0644]
bundles/org.openhab.automation.jsscripting/doc/rule-script.png [new file with mode: 0644]
bundles/org.openhab.automation.jsscripting/doc/settings.png [new file with mode: 0644]
bundles/org.openhab.automation.jsscripting/docs/rule-config.png [deleted file]
bundles/org.openhab.automation.jsscripting/docs/rule-engines.png [deleted file]
bundles/org.openhab.automation.jsscripting/docs/rule-script.png [deleted file]
bundles/org.openhab.automation.jsscripting/docs/settings.png [deleted file]
bundles/org.openhab.automation.jsscripting/src/main/java/org/openhab/automation/jsscripting/internal/OpenhabGraalJSScriptEngine.java

index 6ce4b4f2f1a7ed5d49b11af23e024d2554e38b2b..7d1b2fcc8d2ca2cb87beffb1c7211b3747a08079 100644 (file)
@@ -30,7 +30,7 @@ to common openHAB functionality within rules including items, things, actions, l
 
 This add-on includes by default the [openhab-js](https://github.com/openhab/openhab-js/) NPM library and exports it's namespaces onto the global namespace. This allows the use of `items`, `actions`, `cache` and other objects without the need to explicitly import using `require()`.  This functionality can be disabled for users who prefer to manage their own imports via the add-on configuration options. 
 
-![OpenHAB Rule Configuration](./docs/settings.png)
+![openHAB Rule Configuration](./doc/settings.png)
 
 ## UI Based Rules
 
@@ -42,17 +42,17 @@ Advanced users, or users migrating scripts from existing systems may want to use
 
 Using the openHAB UI, first create a new rule and set a trigger condition
 
-![OpenHAB Rule Configuration](./docs/rule-config.png)
+![openHAB Rule Configuration](./doc/rule-config.png)
 
 ### Adding Actions
 
 Select "Add Action" and then select "ECMAScript 262 Edition 11".  Its important this is "Edition 11" or higher, earlier versions will not work. This will bring up a empty script editor where you can enter your javascript.
 
-![OpenHAB Rule Engines](./docs/rule-engines.png)
+![openHAB Rule Engines](./doc/rule-engines.png)
 
 You can now write rules using standard ES6 Javascript along with the included openHAB [standard library](#standard-library).
 
-![OpenHAB Rule Script](./docs/rule-script.png)
+![openHAB Rule Script](./doc/rule-script.png)
 
 For example, turning a light on:
 ```javascript
diff --git a/bundles/org.openhab.automation.jsscripting/doc/rule-config.png b/bundles/org.openhab.automation.jsscripting/doc/rule-config.png
new file mode 100644 (file)
index 0000000..e26c6a0
Binary files /dev/null and b/bundles/org.openhab.automation.jsscripting/doc/rule-config.png differ
diff --git a/bundles/org.openhab.automation.jsscripting/doc/rule-engines.png b/bundles/org.openhab.automation.jsscripting/doc/rule-engines.png
new file mode 100644 (file)
index 0000000..6faa0fb
Binary files /dev/null and b/bundles/org.openhab.automation.jsscripting/doc/rule-engines.png differ
diff --git a/bundles/org.openhab.automation.jsscripting/doc/rule-script.png b/bundles/org.openhab.automation.jsscripting/doc/rule-script.png
new file mode 100644 (file)
index 0000000..585d16e
Binary files /dev/null and b/bundles/org.openhab.automation.jsscripting/doc/rule-script.png differ
diff --git a/bundles/org.openhab.automation.jsscripting/doc/settings.png b/bundles/org.openhab.automation.jsscripting/doc/settings.png
new file mode 100644 (file)
index 0000000..a342844
Binary files /dev/null and b/bundles/org.openhab.automation.jsscripting/doc/settings.png differ
diff --git a/bundles/org.openhab.automation.jsscripting/docs/rule-config.png b/bundles/org.openhab.automation.jsscripting/docs/rule-config.png
deleted file mode 100644 (file)
index e26c6a0..0000000
Binary files a/bundles/org.openhab.automation.jsscripting/docs/rule-config.png and /dev/null differ
diff --git a/bundles/org.openhab.automation.jsscripting/docs/rule-engines.png b/bundles/org.openhab.automation.jsscripting/docs/rule-engines.png
deleted file mode 100644 (file)
index 6faa0fb..0000000
Binary files a/bundles/org.openhab.automation.jsscripting/docs/rule-engines.png and /dev/null differ
diff --git a/bundles/org.openhab.automation.jsscripting/docs/rule-script.png b/bundles/org.openhab.automation.jsscripting/docs/rule-script.png
deleted file mode 100644 (file)
index 585d16e..0000000
Binary files a/bundles/org.openhab.automation.jsscripting/docs/rule-script.png and /dev/null differ
diff --git a/bundles/org.openhab.automation.jsscripting/docs/settings.png b/bundles/org.openhab.automation.jsscripting/docs/settings.png
deleted file mode 100644 (file)
index a342844..0000000
Binary files a/bundles/org.openhab.automation.jsscripting/docs/settings.png and /dev/null differ
index 7f0d4b15a9fb8488ebae1e7411083a46f25478c0..93a69ab60d2b6aaf434d56ccefafb206e68f3ec2 100644 (file)
@@ -223,11 +223,12 @@ public class OpenhabGraalJSScriptEngine extends InvocationInterceptingScriptEngi
 
     /**
      * Converts a root node path to a class resource path for loading local modules
+     * Ex: C:\node_modules\foo.js -> /node_modules/foo.js
      *
      * @param path
      * @return
      */
     private String nodeFileToResource(Path path) {
-        return "/" + NODE_DIR + "/" + path.getFileName();
+        return "/" + path.subpath(0, path.getNameCount()).toString().replace('\\', '/');
     }
 }