doc: show release notes

Author: jakobrosenberg

RELEASE_NOTES_2.22.0.md

@@ -0,0 +1,68 @@
+# Release notes for Pymakr v2.22.0
+
+It's been a long time coming but we're delighted to finally announce the next release of our Pymakr 2. We've packed this release with tons of new features and bugfixes to make Pymakr 2 even faster, easier and more reliable than ever.
+
+We aim to make your experience with Pymakr as pleasant as possible Should you have any problems with our new release, please [open an issue](https://github.com/pycom/pymakr-vsc/issues/new/choose) on Github so that we can help.
+
+# <br>
+
+## Feature Highlights
+
+[Get Started Guide](#get-started-guide)
+
+[Developer Mode](#developer-mode)
+
+[Device Configuration](#device-configuration)
+
+[Better Notifications](#better-notifications)
+
+[Device Hover](#device-hover)
+
+[Open File on Device](#open-file-on-device)
+
+# <br>
+
+## Get Started Guide
+
+Clicking `ctrl/cmd + shift + p`, typing `walkthrough` and selecting `Get Started: Open Walkthrough...` will show a list of walkthroughs.
+
+Here's you can click `Pymakr 2 - Getting Started` for a brief rundown.
+
+# <br>
+
+## Developer Mode
+
+Dev mode keeps your connected devices running and synchronized to your project folder in realtime.
+
+In dev mode, whenever a file in a project is saved, the changes are synced to the project's devices and the devices then restarted.
+
+Clicking the upload button while in dev mode will stop the current running script and upload files that are different from those on the device. Kinda like patching. _This is different from the regular upload functionality, which erases all content on the device before uploading the entire project._
+
+_Note: Dev mode is limited to to the capabilities of the connected devices. Eg. it's not possible for Pymakr to communicate with a device in `machine.deepsleep` since the device's USB is disabled in this state. (A workaround for this may be possible - see `dev.simulateDeepSleep` in `pymakr.conf`)_
+
+# <br>
+
+## Device Configuration
+
+It's now possible to configure individual devices in `settings->pymakr->devices->configs`. Here you can customize settings like `device.rootPath` and `device.adapterOptions` in case your device doesn't work with the defaults / auto detected values.
+
+# <br>
+
+## Better Notifications
+
+We've added more notifications to help explain the different events and actions in Pymakr.
+Power users who are ready to kick the support wheels can click `Don't show again` or save their choices when a popup is no longer wanted.
+
+_Popup choices can be undone in `Settings->Pymakr->Misc->Notifications_
+
+# <br>
+
+## Device hover
+
+Hovering over a device now shows information about the device.
+
+# <br>
+
+## Open File on Device
+
+Right clicking a project file and selecting `Pymakr->Open file on device` will open the corresponding file on the device. Here you can verify the content and save changes as required.

src/PyMakr.js

@@ -30,6 +30,8 @@ class PyMakr {
    * @param {vscode.ExtensionContext} context
    */
   constructor(context) {
+    this.context = context;
+
     /**
      * Actions to be run at the launch of the plugin
      * @example
@@ -47,7 +49,7 @@ class PyMakr {
     this.vscodeHelpers = createVSCodeHelpers(this);
 
     /** Handles all info, warn and error notifications */
-    this.notifier = new Notifier(this)
+    this.notifier = new Notifier(this);
 
     /** Extendable logger. */
     this.log = createLogger("[Pymakr]");
@@ -57,7 +59,6 @@ class PyMakr {
     this.terminalPort = 5364 + ((Math.random() * 10240) | 0);
 
     this.onUpdatedConfig("silent");
-    this.context = context;
 
     /** The package.json manifest */
     this.manifest = manifest;
@@ -88,6 +89,8 @@ class PyMakr {
     this.registerWithIde();
     this.setup();
     this.handlePendingActions();
+
+    this.notifier.notifications.showReleaseNotes();
   }
 
   handlePendingActions() {
@@ -165,8 +168,7 @@ class PyMakr {
    */
   onUpdatedConfig(mode) {
     this.log.level = this.log.levels[this.config.get().debug.logLevel];
-    if (this.log.level >= 5)
-    process.env.debug = this.log.level === 5 ? 'true' : 'silly'
+    if (this.log.level >= 5) process.env.debug = this.log.level === 5 ? "true" : "silly";
 
     this.log.filter = this.config.get().debug.logFilter !== "" ? new RegExp(this.config.get().debug.logFilter) : "";
     if (mode !== "silent") this.log.info("updated config:", this.config.get());

src/utils/Notifier.js

@@ -1,4 +1,5 @@
 const vscode = require("vscode");
+const { createStateObject } = require("./storageObj");
 
 /**
  * @typedef {string} btnText selecting this option will not hide the notification in the future
@@ -21,6 +22,9 @@ class Notifier {
       warning: vscode.window.showWarningMessage,
       error: vscode.window.showErrorMessage,
     };
+    this.state = {
+      lastReadReleaseNotes: createStateObject(this.pymakr.context.globalState, "lastReadReleaseNotes"),
+    };
   }
 
   /**
@@ -251,6 +255,13 @@ class Notifier {
           "": [null, this.DONT_SHOW_AGAIN],
         });
     },
+    showReleaseNotes: async () => {
+      const uri = vscode.Uri.file(`${__dirname}/../../RELEASE_NOTES_2.22.0.md`);
+      if (this.state.lastReadReleaseNotes.get() !== uri.fsPath) {
+        this.state.lastReadReleaseNotes.set(uri.fsPath);
+        vscode.commands.executeCommand("markdown.showPreview", uri);
+      }
+    },
   };
 }