Predefined variables/Magic vars (#117)

* basic idea

* generates docs

* hardcoded the gen script

* trying to hide magic vars

* eww-state is good now

* structure for cpu var is now there

* renamed cpu to diskstat, bc lib supports it after all

* not going to implement disk IO. go back to this commit, to see a rough idea

* removed it

* formatting

* stopped data race

* Update src/config/system_stats/ram.rs

Co-authored-by: ElKowar <[email protected]>

* Update src/config/system_stats/disk.rs

Co-authored-by: ElKowar <[email protected]>

* Explains macos better

* Update battery.rs

* Function for each OS when getting battery, a bit cleaner

* reworked battery a little

* all in one big file

* facepalm

* cleaner gen script and one huge file for the system stat stuff

* merge conflicts

* github interface for resolving merge conflicts sucks, this fixes it

* Apply suggestions from code review

Co-authored-by: ElKowar <[email protected]>

* Update src/config/inbuilt.rs

Co-authored-by: ElKowar <[email protected]>

* Apply suggestions from code review

Co-authored-by: ElKowar <[email protected]>

* code suggestions

* component temperature is a json struct

* newlines in magic vars descriptions

* disks is now json, numbers are not wrapped in strings, and more idiomatic code

* Update gen-docs.ts

Co-authored-by: mlvzk <[email protected]>

* removes a unneeded heading

* more doc updates and EWW_CPU_USAGE is now json

* calculates battery total avg and it's a json struct

Co-authored-by: ElKowar <[email protected]>
Co-authored-by: mlvzk <[email protected]>

.github/workflows/gh-pages.yml

@@ -21,7 +21,7 @@ jobs:
               uses: denoland/setup-deno@main
               with:
                   deno-version: "v1.x"
-            - run: deno run --allow-read gen-docs.ts ./src/widgets/widget_definitions.rs >> ./docs/content/main/widgets.md
+            - run: deno run --allow-read --allow-write gen-docs.ts ./src/widgets/widget_definitions.rs ./src/config/inbuilt.rs
 
             # Build & deploy
             - name: shalzz/zola-deploy-action

Cargo.toml

@@ -60,6 +60,7 @@ futures-core = "0.3"
 futures-util = "0.3"
 tokio-util = "0.6"
 
+sysinfo = "0.16.1"
 
 nom = "6.1"
 dyn-clone = "1.0"

docs/content/main/magic-vars.md

@@ -0,0 +1,13 @@
++++
+title = "Magic Variables"
+slug = "magic variables documenation"
+weight = 3
++++
+
+These are variables that are always there, without you having to import them.
+
+The delay between the updating variables is always 2s.
+
+
+## Updating magic variables
+

docs/content/main/widgets.md

@@ -3,3 +3,4 @@ title = "Widgets"
 slug = "widget documentation"
 weight = 3
 +++
+

gen-docs.ts

@@ -12,6 +12,18 @@ interface Widget {
     isVisible: boolean;
 }
 
+function parseMagicVariables(data: string) {
+    const pattern = /^.*\/\/\s*@desc\s*(\w+)\s*-\s*(.*)$/gm;
+    let output = [];
+    for (const [_, name, desc] of data.matchAll(pattern)) {
+        output.push(
+`### \`${name}\`
+${desc.replaceAll("\\n", "\n\n")}
+`);
+    }
+    return output.join("\n");
+}
+
 function parseVars(code: string): Record<string, string> {
     const VAR_PATTERN = /^.*\/\/+ *@var +(.*?) +- +(.*)$/;
     const vars: Record<string, string> = {};
@@ -121,7 +133,7 @@ function printDocs(vars: Record<string, string>, docs: Record<string, Widget>) {
         .map((x) => printWidget(x))
         .map((x) => x.replace(/\$\w+/g, (x) => vars[x.replace("$", "")]))
         .join("\n\n");
-    console.log(output);
+    return output;
 }
 
 function printWidget(widget: Widget) {
@@ -138,7 +150,13 @@ ${widget.props.map((prop) => `- **\`${prop.name}\`**: *\`${prop.type}\`* ${prop.
 // deno run --allow-read gen-docs.ts ./src/widgets/widget_definitions.ts 2> /dev/null
 Deno.readTextFile(Deno.args[0]).then(data => {
     const vars = parseVars(data);
-    printDocs(vars, parseDocs(data));
+    Deno.writeTextFile("docs/content/main/widgets.md", printDocs(vars, parseDocs(data)), {"append": true});
+}).catch(err => {
+    return console.error(err);
+})
+
+let magic = Deno.readTextFile(Deno.args[1]).then(data => {
+    Deno.writeTextFile("docs/content/main/magic-vars.md", parseMagicVariables(data), {"append": true});
 }).catch(err => {
     return console.error(err);
 })