Merge branch 'next-staging' into next

Author: jakobrosenberg

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,9 +1,18 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: "[BUG]"
+title: '[BUG]'
 labels: ''
 assignees: jakobrosenberg
+---
+
+**IMPORTANT**
+
+If possible, please consider creating the issue from within Pymakr. This will create a new issue template with relevant context information.
+
+To do so, click the device's context menu (`...`) -> `Debug` -> `Show Device Summary` -> `Create an issue on Github`
+
+If you prefer to use this form instead, you can delete the IMPORTANT section.
 
 ---
 
@@ -12,6 +21,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +34,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. Win 11 X64]
- - Device [e.g. Expansionboard v3.1]
- - Pymakr [e.g. v2.12.3]
+
+- OS: [e.g. Win 11 X64]
+- Device [e.g. Expansionboard v3.1]
+- Pymakr [e.g. v2.12.3]
 
 **Additional context**
 Add any other context about the problem here.

FAQ.md

@@ -26,6 +26,14 @@ There are a few ways to recover an unresponsive device.
 
 Node shouldn't be required, but there have been reports of issues being solved after installing Node.
 
+### What is Pymakr - Preview
+
+Pymakr Preview is the prerelease branch of Pymakr. Features and bugfixes that pass integration tests, but could require further feedback, are released to Pymakr Preview first. If there are no issues or proposals, Pymakr Preview will then be merged into Pymakr.
+
+### Can I change my version of Pymakr
+
+Yes, to install a specific version, go to the extensions tab, click the cogwheel next to `Pymakr` and select `Install Another Version`.
+
 ### I have an issue that's not described here
 
 Please open an issue on our [Github repo](https://github.com/pycom/pymakr-vsc). We usually respond within 24 hours.

src/providers/TextDocumentProvider.js

@@ -3,6 +3,7 @@ const vscode = require("vscode");
 const { timestamp } = require("../utils/createLogger");
 const { arraysToMarkdownTable, adapterHistoryTable } = require("../utils/formatters");
 const { serializeKeyValuePairs } = require("../utils/misc");
+const os = require("os");
 
 /**
  * @typedef {Object} subProvider
@@ -55,12 +56,22 @@ class TextDocumentProvider {
         const configTable = arraysToMarkdownTable([["Config", ""], ...Object.entries(config || {})]);
         const deviceTable = arraysToMarkdownTable([["Device", ""], ...Object.entries(device.raw || {})]);
         const systemTable = arraysToMarkdownTable([["System", ""], ...Object.entries(device.info || {})]);
+        const hostTable = arraysToMarkdownTable([
+          ["Host", ""],
+          ...Object.entries({
+            OS: process.platform + " - " + os.arch(),
+            Pymakr: vscode.extensions.getExtension("Pycom.pymakr")?.packageJSON.version,
+            "Pymakr-Preview": vscode.extensions.getExtension("Pycom.pymakr-preview")?.packageJSON.version,
+            VSCode: vscode.version,
+          }),
+        ]);
 
         const historyTable = arraysToMarkdownTable(adapterHistoryTable(device));
         const body = [
           configTable,
           deviceTable,
           systemTable,
+          hostTable,
           `## Device History at ${timestamp(new Date())}`,
           historyTable,
         ].join("\r\n\r\n");

src/utils/formatters.js

@@ -10,7 +10,7 @@
 const { timestamp } = require("./createLogger");
 
 const sanitize = (str) =>
-  (typeof str === "string" ? str : JSON.stringify(str, null, 2))
+  (typeof str === "string" ? str : typeof str === "undefined" ? "undefined" : JSON.stringify(str, null, 2))
     .replace(/\|/gm, "|")
     .replace(/\r?\n/gm, "<br />")
     .replace(/"username": ".+?"/, '"username": "&#42;&#42;&#42;"')