drakongen 1.0.0

package/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/src/index.js",
+            "args": ["examples/tmp.drakon"]
+        }
+    ]
+}

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/README.md

@@ -0,0 +1,80 @@
+# drakongen
+
+**drakongen** generates pseudocode from drakon flowcharts built with [DrakonWidget](https://github.com/stepan-mitkin/drakonwidget) or [DrakonHub](https://github.com/stepan-mitkin/drakonhub_desktop).
+
+One can use the output pseudocode as a prompt for AI applications like ChatGPT or CodePilot.
+
+**drakongen** can also generate a generic AST from drakon flowcharts to generate source code in programming languages, for example, JavaScript.
+**drakongen**  turns a drakon flowchart into a tree in the JSON format that one can trivially transform into code in any programming language.
+
+## How to use drakongen in the browser
+
+Include the `drakongen.js` script on the web page.
+
+```html
+<script src="browser/drakongen.js"></script>
+```
+
+Call `toPseudocode` or `toTree` functions.
+
+```html
+<script>
+var drakon = ... // Get the drakon chart from DrakonWidget
+var name = "Diagram one"
+var filename = "Diagram one.drakon"
+
+var pseudo = toPseudocode(drakon, name, filename, "en")
+console.log(pseudo)
+
+var tree = toTree(drakon, name, filename, "en")
+console.log(tree)
+
+</script>
+```
+
+Available languages:
+
+- en English
+- no Norwegian
+- ru Russian
+
+## How to use drakongen in Node JS
+
+Add the **drakongen** package to dependencies.
+
+```
+npm i drakongen
+```
+
+- Require the **drakongen** module.
+- Call `toPseudocode` or `toTree` functions.
+
+```javascript
+const {toTree, toPseudocode} = require("drakongen")
+
+var drakon = ... // Get the drakon chart from DrakonWidget
+var name = "Diagram one"
+var filename = "Diagram one.drakon"
+
+var pseudo = toPseudocode(drakon, name, filename, "en")
+console.log(pseudo)
+
+var tree = toTree(drakon, name, filename, "en")
+console.log(tree)
+```
+
+## How to use drakongen as a command-line tool
+
+Install **drakongen** globally.
+
+```
+npm i --global drakongen
+```
+
+Run the **drakongen** utility.
+
+In this example, the language is Norwegian, the path to the output folder is **out**, the input file is **Hello.drakon**:
+
+```
+drakongen --language no --output out Hello.drakon
+```