questmark-webrenderer 1.0.0 → 1.0.4

package/README.md

@@ -0,0 +1,56 @@
+# Questmark-Webrenderer
+
+This is a simple "inline web renderer and interpreter" for Questmark.
+
+It allows you to create "live" Questmark documents that you can easily work on and test in your browser!
+
+## Usage
+
+1. Save your Questmark document (in Markdown source code form!) as a `.html` file
+2. Add the following lines to the bottom of the file, exactly as shown:
+    ~~~
+    ```comment
+        <script src="https://unpkg.com/questmark-webrenderer@1.0.4/dist/webRender-basic.js"></script>
+        <script src="https://unpkg.com/questmark-webrenderer@1.0.4/dist/main.js" type="module"></script>
+    ```
+    ~~~
+3. Open the .html file on your browser!
+
+(see [space-alien.md.html](https://github.com/jorisvddonk/questmark-webrenderer/blob/master/examples/space-alien.md.html) ([demo](https://raw.githack.com/jorisvddonk/questmark-webrenderer/main/examples/space-alien.md.html)) for an example)
+
+You can also save your Questmark documents as `.md` files, but then you need to open them using a webserver that forces the `text/html` Content-Type header. [local-web-server](https://github.com/lwsjs/local-web-server) can do this using the following config file, for example:
+
+```js
+module.exports = {
+  mime: {
+    'text/html': ['html', 'md']
+  }
+}
+```
+
+and then run
+
+```bash
+npx local-web-server --config-file ws_config.js
+```
+
+## alternative usage
+
+Alternatively, you could load a .md file in your browser, open the browser console, and then paste and execute the following:
+
+```javascript
+const qm_wr1 = document.createElement('script'); qm_wr1.setAttribute('src', 'https://unpkg.com/questmark-webrenderer@1.0.4/dist/webRender-basic.js');
+const qm_wr2 = document.createElement('script'); qm_wr2.setAttribute('type', 'module'); qm_wr2.setAttribute('src', 'https://unpkg.com/questmark-webrenderer@1.0.4/dist/main.js');
+document.body.appendChild(qm_wr1);
+document.body.appendChild(qm_wr2);
+```
+
+try it out [here](https://ghcdn.rawgit.org/jorisvddonk/questmark/master/examples/self-describing.md), for example!
+
+## Customization
+
+You can currently customize the following things:
+
+* Extra foreign functions can be supplied to the VM by setting the global variable `extraForeignFunctions` to a JavaScript object, with the keys mapping to foreign functions passed to the VM. See [foreign-function.md.html](https://github.com/jorisvddonk/questmark-webrenderer/blob/master/examples/foreign-function.md.html) ([demo](https://raw.githack.com/jorisvddonk/questmark-webrenderer/main/examples/foreign-function.md.html)) for an example.
+* The VM can be modified prior to it starting, and can be prevented from auto-starting, by setting the global variable `preRun` to a function that receives the `vm` instance. Return `false` from this function to prevent the VM from auto-starting. See [prerun.md.html](https://github.com/jorisvddonk/questmark-webrenderer/blob/master/examples/prerun.md.html) ([demo](https://raw.githack.com/jorisvddonk/questmark-webrenderer/main/examples/prerun.md.html)).
+

package/dist/main.js

@@ -15904,6 +15904,7 @@
       const root = unistBuilder('questmarkDocument', { options: {} }, []);
       let last_once_directive_nr = 0;
       let noLinkBehaviour = NoLinkBehaviour.LOOPBACK_TO_OPTIONS;
+      let retainWhitespace = false;
       unistUtilVisitParents$1(tree, 'heading', (x, ancestors) => {
           if (ancestors.length > 1) {
               return;
@@ -16044,6 +16045,23 @@
           qvmState.programList.push(a);
       };
       const visitorFunc = (node, index, parent) => {
+          let fixText = (n) => {
+              let text = "";
+              if (retainWhitespace) {
+                  text = file_contents.substring(n.position.start.offset, n.position.end.offset);
+              }
+              else {
+                  text = n.value;
+              }
+              if (parent.type === "paragraph" && parent.children.indexOf(n) === parent.children.length - 1) {
+                  text = text + '\n\n';
+              }
+              text = text.replaceAll('\\*', '*').replaceAll('\\[', '[').replaceAll('\\]', ']').replaceAll('\\#', '#').replaceAll('\\`', '`').replaceAll('\\(', '(').replaceAll('\\)', ')');
+              if (parent.type === "emphasis" || parent.type === "strong") {
+                  text = `*${text}*`;
+              }
+              return text;
+          };
           if (parent === undefined && node.type !== "questmarkDocument") {
               return;
           }
@@ -16078,6 +16096,11 @@
                                   throw new Error(`Unknown 'options.no_link_behaviour': ${node.options["options"]["no_link_behaviour"]}`);
                               }
                           }
+                          if (node.options["options"]["whitespace"]) {
+                              if (node.options["options"]["whitespace"] === "retain") {
+                                  retainWhitespace = true;
+                              }
+                          }
                       }
                   }
                   break;
@@ -16120,7 +16143,7 @@
                       if (option.text !== null) {
                           if (option.text.includes("`")) {
                               // TODO: support inlineCode in options. Can do via `concat`.
-                              console.warn("Option text contains a backtick. Inline code elements in option blocks is currently not supported!");
+                              console.warn("WARN: Option text contains a backtick. Inline code elements in option blocks is currently not supported!");
                           }
                           q(pushString(option.text));
                       }
@@ -16148,7 +16171,7 @@
                                   instructions.forEach(i => q(i));
                               }
                               else {
-                                  q(pushString(child.value));
+                                  q(pushString(fixText(child)));
                                   q(invokeFunction("emit"));
                               }
                           });
@@ -16188,7 +16211,7 @@
                   instructions.forEach(i => q(i));
                   break;
               case "text":
-                  q(pushString(node.value));
+                  q(pushString(fixText(node)));
                   q(invokeFunction("emit"));
                   break;
           }
@@ -16210,7 +16233,16 @@
   const vmState = parseMarkdown(document.body.textContent).qvmState;
   console.log(vmState);
   vm.loadVMState(vmState);
-  vm.run();
+  let run = true;
+  if (globalThis.preRun) {
+    let result = globalThis.preRun(vm);
+    if (result === false) {
+      run = false;
+    }
+  }
+  if (run) {
+    vm.run();
+  }
 
   globalThis.vm = vm;
 

package/dist/webRender-basic.js

@@ -22,6 +22,7 @@ window.choices = (choices) => {
     choices.forEach(element => {
       const button = document.createElement('button');
       button.textContent = element.title;
+      button.classList.add('questmark');
       button.onclick = () => {
         clear();
         console.log(`Picked #${element.id}: "${element.title}" `);
@@ -35,12 +36,20 @@ window.emit = (body) => {
   if (firstTime === false) {
     document.body.textContent = '';
     firstTime = true;
+
+    const style = document.createElement('style');
+    style.textContent = `span.questmark {
+      white-space: pre-line;
+    }`;
+    document.head.appendChild(style);
+
     window.logElement = document.createElement('div');
     document.body.appendChild(window.logElement);
     log = (body) => {
       console.log(body);
       const span = document.createElement('span');
       span.textContent = body;
+      span.classList.add('questmark');
       window.logElement.appendChild(span);
     }
     clear = () => {

package/main.mjs

@@ -9,6 +9,15 @@ const vm = new QuestVM(body => {
 const vmState = parseMarkdown(document.body.textContent).qvmState;
 console.log(vmState);
 vm.loadVMState(vmState);
-vm.run();
+let run = true;
+if (globalThis.preRun) {
+  let result = globalThis.preRun(vm);
+  if (result === false) {
+    run = false;
+  }
+}
+if (run) {
+  vm.run();
+}
 
 globalThis.vm = vm;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "questmark-webrenderer",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "A simple inline parser and renderer for Questmark, to create live testable Questmark documents easily",
   "main": "dist/main.js",
   "scripts": {
@@ -20,7 +20,7 @@
     "rollup-plugin-shim": "^1.0.0"
   },
   "dependencies": {
-    "questmark": "^0.0.9",
+    "questmark": "^0.0.11",
     "tzo": "^1.0.10"
   }
 }

package/webRender-basic.js

@@ -22,6 +22,7 @@ window.choices = (choices) => {
     choices.forEach(element => {
       const button = document.createElement('button');
       button.textContent = element.title;
+      button.classList.add('questmark');
       button.onclick = () => {
         clear();
         console.log(`Picked #${element.id}: "${element.title}" `);
@@ -35,12 +36,20 @@ window.emit = (body) => {
   if (firstTime === false) {
     document.body.textContent = '';
     firstTime = true;
+
+    const style = document.createElement('style');
+    style.textContent = `span.questmark {
+      white-space: pre-line;
+    }`;
+    document.head.appendChild(style);
+
     window.logElement = document.createElement('div');
     document.body.appendChild(window.logElement);
     log = (body) => {
       console.log(body);
       const span = document.createElement('span');
       span.textContent = body;
+      span.classList.add('questmark');
       window.logElement.appendChild(span);
     }
     clear = () => {

package/examples/space-alien.html

@@ -1,173 +0,0 @@
-# QUESTMARK-OPTIONS-HEADER
-
-    {
-      "questmark-spec": "1.0",
-      "initial-state": "init",
-      "initial-context": {
-        "asked_about_glowy_bits": 0,
-        "cars_not_spaceships": 0,
-        "know_about_cheese": 0,
-        "know_alien_name": 0,
-        "details_about_hamsters": 0,
-        "bad_details_about_hamsters": 0
-      },
-      "options": {
-        "no_link_behaviour": "loopback_to_options"
-      }
-    }
-
-# init
-
-Greetings, Human! Glad you've finally woken up! You banged your head quite badly there and we were worried that your central processing unit was severely damaged, but it seems that you're fine enough to open your eyes! Wonderful. How do you feel?
-
-* `@once` Uuuuh... "central processing unit"?
-
-Oh! Right, sorry. "brain" you call it, I think. Funny word. Sounds almost fake, if you ask me.
-
-* `@once` Hey! What are those glowy bits inside you? `1 "asked_about_glowy_bits" setContext`
-
-Ah, those are a private matter to us. Please don't ask about our glowy bits ever again, thanks.
-
-* [What happened?](#what_happen)
-
-# what_happen
-
-Well, we were zipping around space in our awesome spaceship, when we randomly stumbled upon your nice planet.
-Our pilot figured it'd be great to land on your world, and we did!
-Or, well, we tried to.
-See, the thing is, our spaceship is rather difficult to control in atmospheres as thick as around your world.
-..and... well...
-We happened to accidentally veer widely off course and land RIGHT on top of your parked spaceship.
-Sorry about that!
-
-* `0 "cars_not_spaceships" getContext eq` Err... Spaceship? I don't have a spaceship. You mean my car? `1 "cars_not_spaceships" setContext`
-
-"Car"? Is that what you call spaceships?
-
-* `1 "cars_not_spaceships" getContext eq` No; cars are something different entirely. They're on wheels. We don't have spaceships; not really at least. `2 "cars_not_spaceships" setContext`
-
-You don't have spaceships!? Wow! How do you people even get to space?
-
-* `2 "cars_not_spaceships" getContext eq` [We don't go to space. Well, not really. Most of us don't. Some do. It's complicated.](#now_what)
-
-Oh, I see this bothers you.
-`"asked_about_glowy_bits" getContext jgz {`
-Just like our glowy bits bother us when you ask about it.
-`}`
-We won't mention cars again. Sorry.
-
-# now_what
-
-* `@once` So, who are you? `1 "know_alien_name" setContext`
-
-We are the Humsters. We're intergalactical space travellers! Awesome, huh?
-
-* `@once` `"know_alien_name" getContext 1 eq "know_about_cheese" getContext 0 eq and` "Humsters"? That's a bit of a weird name. Sounds familiar.
-
-Yeah, some other humanoid-like creature gave it to us. We don't really know why.
-
-* `@once` `"know_alien_name" getContext 1 eq "know_about_cheese" getContext 1 eq and` [Oh, no. You're called "Humsters" because you're like Hamsters and like cheese!?](#about_hamsters)
-
-```comment
-If you know both their name AND about cheese, you can connect the dots.
-```
-
-Huh? "Hamsters"? That name sounds just like ours... What are "Hamsters"? Are they also intergalactical space travellers!? We'd love to get to meet more advanced species that also travel across space!
-
-* `@once` What are you doing in our solar system? `1 "know_about_cheese" setContext`
-
-We're just travelling and looking for cheese.
-
-* `@once` `"know_about_cheese" getContext` Cheese?
-
-Yeah, we love cheese!
-
-* I have had enough. Goodbye!
-
-Goodbye, human!
-
-`exit`
-
-# about_hamsters
-
-* [Hamsters are AWESOME](#awesome_hamsters)
-
-Wow, they sound amazing!
-
-* [Hamsters aren't particularly awesome](#bad_hamsters)
-* Oh, look at my watch, it's time to go. Goodbye!
-
-What is a watch?
-Oh... You are already gone.
-Well, goodbye then.
-
-`exit`
-
-# awesome_hamsters
-
-Can you tell us more about hamsters please?
-
-* `@once` Hamsters have soft hair `"details_about_hamsters" getContext 1 + "details_about_hamsters" setContext`
-
-We have soft hair!
-
-* `@once` Hamsters have cute eyes `"details_about_hamsters" getContext 1 + "details_about_hamsters" setContext`
-
-We have cute eyes!
-
-* `@once` Hamsters have a fuzzy tail `"details_about_hamsters" getContext 1 + "details_about_hamsters" setContext`
-
-We have a fuzzy tail!
-
-* `@once` `"details_about_hamsters" getContext 3 eq` [Hamsters are great at running in wheels](#humsters_are_hamsters)
-
-WE ARE GREAT AT RUNNING IN WHEELS!
-
-Wow, Human! It seems that we just discovered something AWESOME.
-
-WE.
-ARE.
-HAMSTERS!
-Not Humsters!
-
-Wow!
-
-# bad_hamsters
-
-* `@once` Hamsters smell `"bad_details_about_hamsters" getContext 1 + "bad_details_about_hamsters" setContext`
-
-Are you sure about this?
-
-* `@once` Hamsters poop `"bad_details_about_hamsters" getContext 1 + "bad_details_about_hamsters" setContext`
-
-Are you sure about this?
-
-* `@once` Hamsters make lots of noise `"bad_details_about_hamsters" getContext 1 + "bad_details_about_hamsters" setContext`
-
-Are you sure about this?
-
-* `@once` `"bad_details_about_hamsters" getContext 3 eq` [Hmm, you're right, I might be wrong about hamsters. Now they actually sound pretty awesome](#awesome_hamsters)
-
-Wow, I'm sure!
-
-# humsters_are_hamsters
-
-* Wow, that's amazing.
-
-Sure is! I'm glad we managed to figure that out, Human!
-
-Now, it seems that it is time for us to run around in a hamster wheel.
-
-Goodbye, human!
-
-`"goodbye" goto`
-
-# goodbye
-
-* Goodbye, humsters! `exit`
-
-
-```comment
-  <script src="webRender-basic.js"></script>
-  <script src="./dist/main.js" type="module"></script>
-```