Merge pull request #192 from pycom/develop

Jakob Rosenberg · web-flow · commit 3a33f12b3dde · 2022-01-04T12:08:28.000Z
New release
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+## [1.1.17](https://github.com/pycom/pymakr-vsc/compare/v1.1.16...v1.1.17) (2022-01-04)
+- better handling for unavailable bindings (3b4a57e)
+- github action error for deploy script (1e2b9c5)
+- reduce requirements for fallback builds (6b05f12)
+
+## [1.1.16](https://github.com/pycom/pymakr-vsc/compare/v1.1.15...v1.1.16) (2021-10-27)
+- binding: updated serialport to 9.2.4 (d4a8934)
 
 ## [1.1.15](https://github.com/pycom/pymakr-vsc/compare/v1.1.14...v1.1.15) (2021-10-15)
 - better handling for unavailable bindings ([3b4a57e](https://github.com/pycom/pymakr-vsc/commit/3b4a57ec7ae85695ac1a830eb2b4737b16fbeab5))
diff --git a/README.md b/README.md
@@ -113,18 +113,22 @@ This may be the case if your board is a generic micropython board.
 3) re-run 'pymakr > Extra > List Serial ports'
 4) is the board is not detected as the first , you may need to move it to the front of the list.
 
+### Binding errors for `serialport`
+`serialport` relies on a native module which needs to be downloaded or built at runtime. Sometimes this fails.
+
+**Solutions:**
+- Install VSCode [manually](https://code.visualstudio.com/docs/setup/setup-overview) (we've had [issues](https://github.com/pycom/pymakr-vsc/issues/184#issuecomment-959293789) with package managers like Snap)
+- If a working binding can't be downloaded, PyMakr will try to build them locally with `node-gyp`. Please see requirements for your OS [here](https://github.com/nodejs/node-gyp#installation)
+
 ## Developing
 If you want to contribute to this project you can test the app the following way:
 
 - Download the code or clone the repo
-- Install Babel by running `npm install --save-dev babel-core`
 - Open the folder in VSC
-- Press F1 and execute `Tasks: Run build task` to run the babel builder
 - Press F5 to run the plugin (opens a new VSC window)
  
 Note: make sure you have the 'code' terminal command installed. See [code setup for Mac(https://code.visualstudio.com/docs/setup/mac)
 
 ## Create a local package
-- Install the vscode publishing tool by running `npm install -g vsce`
-- Create a .vsix package by running `vsce package`
+- Create a .vsix package by running `npm run package`
 - you can then install the .vsix package by running `code --install-extension pymakr-1.x.y.vsix`
diff --git a/lib/config.js b/lib/config.js
@@ -159,7 +159,7 @@ module.exports = class Config {
             items: {
               type: 'string'
             },
-            default: ['Pycom','Pycom Ltd.','FTDI','Microsoft','Microchip Technology, Inc.'],
+            default: ['Pycom','Pycom Ltd.','FTDI','Microsoft','Microchip Technology, Inc.', '1a86'],
             order: 13
         },
     }
diff --git a/lib/main/settings-wrapper.js b/lib/main/settings-wrapper.js
@@ -33,13 +33,6 @@ module.exports = class SettingsWrapper extends EventEmitter {
     var _this = this
     
 
-
-    // this.refresh(function(){
-    //   _this.watchConfigFile()
-    //   _this.watchProjectChange()
-    //   cb(_this)
-    // })
-    
     this.readConfigFile(this.global_config_file,true,function(contents){
       _this.global_config = contents
       _this.readConfigFile(_this.config_file,false,function(contents){
diff --git a/pymakr.js b/pymakr.js
@@ -1,145 +1,118 @@
-var vscode = require('vscode');
-var { execSync } = require('child_process');
+const vscode = require('vscode');
+const { execSync } = require('child_process');
 const { prepareSerialPort } = require('./lib/serialport')
-var PanelView, Pymakr, Pyboard, SettingsWrapper, pb, v, sw, pymakr
-
+const destroyHandles = []
+
+/**
+ * same as vscode.commands.registerCommand but automatically pushes disposables to context subscriptions     
+ * @param {vscode.ExtensionContext} context 
+ * @param {Object.<string, (...args: any[]) => any>} commands
+ */
+const batchRegisterCommands = (context, commands) => {
+    Object.entries(commands).forEach(([command, callback]) => {
+        const disposable = vscode.commands.registerCommand(command, callback)
+        context.subscriptions.push(disposable)
+    })
+}
 
+/**
+ * this method activates the extension
+ * @param {vscode.ExtensionContext} context 
+ */
 async function activate(context) {
     await prepareSerialPort()
-    SettingsWrapper = require('./lib/main/settings-wrapper');
 
-    sw = new SettingsWrapper(function () {
+    /**
+     * we have to import SettingsWrapper after prepareSerialPort
+     * since SettingsWrapper imports serialport
+     */
+    const SettingsWrapper = require('./lib/main/settings-wrapper');
+
+    const settingsWrapper = new SettingsWrapper(function () {
         const nodejs_installed = execSync('node -v', { encoding: 'utf8' }).substr(0, 1) === "v"
 
         if (!nodejs_installed) {
-            vscode.window.showErrorMessage("NodeJS not detected on this machine, which is required for Pymakr to work. See the Pymakr readme for dependancies.")
+            vscode.window.showErrorMessage("NodeJS not detected on this machine, which is required for Pymakr to work. See the Pymakr readme for dependencies.")
         } else {
+            const PanelView = require('./lib/main/panel-view');
+            const Pymakr = require('./lib/pymakr');
+            const Pyboard = require('./lib/board/pyboard');
 
 
-            PanelView = require('./lib/main/panel-view');
-            Pymakr = require('./lib/pymakr');
-            Pyboard = require('./lib/board/pyboard');
-
-
-            pb = new Pyboard(sw)
-            v = new PanelView(pb, sw)
-            pymakr = new Pymakr({}, pb, v, sw)
-
+            const pyboard = new Pyboard(settingsWrapper)
+            const panelView = new PanelView(pyboard, settingsWrapper)
+            const pymakr = new Pymakr({}, pyboard, panelView, settingsWrapper)
+            const { terminal } = panelView
 
-            var terminal = v.terminal
-
-            var disposable = vscode.commands.registerCommand('pymakr.help', function () {
-                terminal.show()
-                pymakr.writeHelpText()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.listCommands', function () {
-                v.showQuickPick()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.connect', function () {
-                terminal.show()
-                pymakr.connect()
-            })
-
-            var disposable = vscode.commands.registerCommand('pymakr.run', function () {
-                terminal.show()
-                pymakr.run()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.runselection', function () {
-                terminal.show()
-                pymakr.runselection()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.upload', function () {
-                terminal.show()
-                pymakr.upload()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.uploadFile', function () {
-                terminal.show()
-                pymakr.uploadFile()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.download', function () {
-                terminal.show()
-                pymakr.download()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.globalSettings', function () {
-                pymakr.openGlobalSettings()
-            })
-            context.subscriptions.push(disposable);
+            destroyHandles.push(() => panelView.destroy())
 
-            var disposable = vscode.commands.registerCommand('pymakr.projectSettings', function () {
-                pymakr.openProjectSettings()
-            })
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.disconnect', function () {
-                pymakr.disconnect()
-            });
-            context.subscriptions.push(disposable);
-
-            // // not used. open/close terminal command is already available. 
-            // // not used. open/close terminal command is already available. 
-            // // not used. open/close terminal command is already available. 
-            // // Terminal opens automatically when doing a connect, run or sync action.
-            // var disposable = vscode.commands.registerCommand('pymakr.toggleREPL', function () {
-            //     pymakr.toggleVisibility()
-            // });
-            // context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.toggleConnect', function () {
-                if (!pymakr.pyboard.connected) {
+            batchRegisterCommands(context, {
+                'pymakr.help': () => {
+                    terminal.show()
+                    pymakr.writeHelpText()
+                },
+                'pymakr.listCommands': () => {
+                    panelView.showQuickPick()
+                },
+                'pymakr.connect': () => {
+                    terminal.show()
+                    pymakr.connect()
+                },
+                'pymakr.run': () => {
+                    terminal.show()
+                    pymakr.run()
+                },
+                'pymakr.runselection': () => {
+                    terminal.show()
+                    pymakr.runselection()
+                },
+                'pymakr.upload': () => {
+                    terminal.show()
+                    pymakr.upload()
+                },
+                'pymakr.uploadFile': () => {
+                    terminal.show()
+                    pymakr.uploadFile()
+                },
+                'pymakr.download': () => {
+                    terminal.show()
+                    pymakr.download()
+                },
+                'pymakr.globalSettings': () => {
+                    pymakr.openGlobalSettings()
+                },
+                'pymakr.projectSettings': () => {
+                    pymakr.openProjectSettings()
+                },
+                'pymakr.disconnect': () => {
+                    pymakr.disconnect()
+                },
+                'pymakr.toggleConnect': () => {
+                    if (!pymakr.pyboard.connected)
+                        terminal.show()
+                    pymakr.toggleConnect()
+                },
+                'pymakr.extra.getVersion': () => {
+                    terminal.show()
+                    pymakr.getVersion()
+                },
+                'pymakr.extra.getWifiMac': () => {
                     terminal.show()
+                    pymakr.getWifiMac()
+                },
+                'pymakr.extra.getSerial': () => {
+                    terminal.show()
+                    pymakr.getSerial()
                 }
-                pymakr.toggleConnect()
-            });
-            context.subscriptions.push(disposable);
-
-
-            var disposable = vscode.commands.registerCommand('pymakr.extra.getVersion', function () {
-                terminal.show()
-                pymakr.getVersion()
-            });
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.extra.getWifiMac', function () {
-                terminal.show()
-                pymakr.getWifiMac()
-            });
-            context.subscriptions.push(disposable);
-
-            var disposable = vscode.commands.registerCommand('pymakr.extra.getSerial', function () {
-                terminal.show()
-                pymakr.getSerial()
-            });
-            context.subscriptions.push(disposable);
+            })
 
         }
 
     })
-
-}
-
-
-
-function deactivate() {
-    v.destroy()
 }
 
-
 module.exports = {
     activate,
-    deactivate
+    deactivate: () => destroyHandles.map(destroy => destroy())
 }
 
diff --git a/settings.md b/settings.md
@@ -10,7 +10,7 @@ The majority of the sessing can be specified in both the global config file as w
 | ctrl_c_on_connect| yes     | yes    | false                 | If true, executes a ctrl-c on connect to stop running programs
 ||||
 | auto_connect     | no       | yes    | true | Autoconnect on USB. Ignores any \'address\' setting and automatically connects to the top item in the serialport list
-| autoconnect_comport_manufacturers| no | yes | 'Pycom','Pycom Ltd.','FTDI', 'Microsoft','Microchip Technology, Inc.'| Comma separated list of all the  comport manufacturers supported for the autoconnect feature. Defaults to all possible manufacturers that pycom boards can return.
+| autoconnect_comport_manufacturers| no | yes | 'Pycom','Pycom Ltd.','FTDI', 'Microsoft','Microchip Technology, Inc.', '1a86'| Comma separated list of all the  comport manufacturers supported for the autoconnect feature. Defaults to all possible manufacturers that pycom boards can return.
 ||||
 | sync_folder      | yes     | yes    | ""                    | Folder to synchronize. Empty to sync projects main folder
 | sync_file_types  | yes     | yes    | "py,txt,log,json,xml,html,js, css,mpy" | Types of files to be synchronized

Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ module.exports = class Config {`
`159`	`159`	`items: {`
`160`	`160`	`type: 'string'`
`161`	`161`	`},`
`162`		`- default: ['Pycom','Pycom Ltd.','FTDI','Microsoft','Microchip Technology, Inc.'],`
	`162`	`+ default: ['Pycom','Pycom Ltd.','FTDI','Microsoft','Microchip Technology, Inc.', '1a86'],`
`163`	`163`	`order: 13`
`164`	`164`	`},`
`165`	`165`	`}`