Merge pull request #877 from gjsjohnmurray/pre-sync-1.4.2

Add 1.4.2 changes to prerelease branch

Author: gjsjohnmurray

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [1.5.2022022301] 23-Feb-2022 pre-release
+Add 1.4.2 changes
+
 ## [1.5.2022020301] 03-Feb-2022 pre-release
 - Fixes
   - Allow `serverForUri` to return password for unnamed server (#837)
@@ -12,6 +15,21 @@ Add 1.4.1 changes
 ## [1.5.2022011401] 14-Jan-2022 pre-release
 Add 1.4.0 changes.
 
+## [1.4.2] 23-Feb-2022
+- Enhancements
+  - Generate content when a new local class or routine is created (#867)
+  - Add file icons (#822)
+  - Support file copying in Explorer, with some [limitations](https://github.com/intersystems-community/vscode-objectscript/issues/854#issuecomment-1036318435) (#857)
+  - Colorize text in Output channel when using VS Code 1.65 with proposed APIs enabled (#831)
+  - Improve server-side searching (requires proposed API enabled - see README) (#852)
+  - Add a distinct languageId (`objectscript-int`) for INT routines (#823)
+- Fixes
+  - Make `Open Terminal in Docker` command work with newer Docker versions (#734)
+  - Fix case where Quick Open (which requires proposed API) could open a file more than once (#861)
+  - Avoid unnecessary Language Server work when importing or compiling a folder (#858, #859)
+  - Activate extension correctly based on file-extensions present in workspace (#868)
+  - Upgrade vulnerable dependencies
+
 ## [1.4.1] 14-Jan-2022
 - Fixes
   - Version 1.4.0 is failing to activate (#827)

README.md

@@ -62,8 +62,8 @@ To unlock these features (optional):
 
 1. Download and install a beta version from GitHub. This is necessary because Marketplace does not allow publication of extensions that use proposed APIs.
 	- Go to https://github.com/intersystems-community/vscode-objectscript/releases
-	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.4.1`, look for `1.4.2-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
-	- Download the VSIX file (for example `vscode-objectscript-1.4.2-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
+	- Locate the beta immediately above the release you installed from Marketplace. For instance, if you installed `1.4.2`, look for `1.4.3-beta.1`. This will be functionally identical to the Marketplace version apart from being able to use proposed APIs.
+	- Download the VSIX file (for example `vscode-objectscript-1.4.3-beta.1.vsix`) and install it. One way to install a VSIX is to drag it from your download folder and drop it onto the list of extensions in the Extensions view of VS Code.
 
 2. From [Command Palette](https://code.visualstudio.com/docs/getstarted/tips-and-tricks#_command-palette) choose `Preferences: Configure Runtime Arguments`.
 3. In the argv.json file that opens, add this line (required for both Stable and Insiders versions of VS Code):

docs/Configuration.md

@@ -4,20 +4,109 @@ title: Configuration
 permalink: /configuration/
 nav_order: 4
 ---
-# Configuration 
 
-VS Code settings enable you to customize various aspects of its function. The InterSystems extensions provide settings used to configure VS Code for ObjectScript development.
+# Configuration
+
+VS Code settings enable you to customize various aspects of its behavior. The InterSystems extensions provide settings used to configure VS Code for ObjectScript development.
+
+{: #code-configuration-basic}
+
+## Basic Configuration
+
+VS Code has a concept of a [workspace](https://code.visualstudio.com/docs/editor/workspaces), which is a set of directories you want to use when you're working on a particular project. In the simplest setup when you are working within a single directory, a VS Code workspace is just the root folder of your project. In this case you keep workspace-specific settings in two files inside a `.vscode` directory located at the root of your project. Those two files are `settings.json`, which contains most configuration settings, and `launch.json`, which contains debugging configurations.
+
+Here is the simplest `settings.json` file content for an ObjectScript project:
+
+{: #code-workspace-simple}
+
+```json
+{
+    "objectscript.conn": {
+        "ns": "USER",
+        "active": true, 
+        "host": "localhost", 
+        "port": 52773, 
+        "username": "_SYSTEM" 
+    }
+}
+```
+
+However, a better strategy is to let the [InterSystems Server Manager](https://marketplace.visualstudio.com/items?itemName=intersystems-community.servermanager) handle the server connection information as described [later](#config-server). That extension also allows you to store your password securely, so please use it. Then in `settings.json` you only need to specify the server name, which you set up in Server Manager:
+
+```json
+{
+    "objectscript.conn": {
+        "server": "iris",
+        "ns": "USER",
+        "active": true
+    }
+}
+```
+
+If you need ObjectScript compilation flags other than the default ones, add an `"objectscript.compileFlags"` property to `settings.json` (more compileFlags information is [available here](/vscode-objectscript/settings#vscode-objectscript)):
+
+{: #code-workspace-compileFlags}
+
+```json
+{
+    "objectscript.conn": {
+        "server": "iris",
+        "ns": "USER",
+        "active": true, 
+    },
+    "objectscript.compileFlags": "cuk/compileembedded=1"
+}
+```
+
+Here is the simplest `launch.json` file content, with which you can debug the method `Test` in the class `Example.Service`, passing 2 parameters as input (see ["Running and Debugging"](/vscode-objectscript/rundebug/) for more information):
+
+{: #code-workspace-simple-debug}
+
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "objectscript",
+            "request": "launch",
+            "name": "Example.Service.Test", 
+            "program": "##class(Example.Service).Test(\"answer\",42)"
+        }
+    ]
+}
+```
+
+If you want to debug a running process, `launch.json` should have a section like this, which will present a dropdown menu of running processes:
+
+{: #code-workspace-simple-debug-process}
+
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "objectscript",
+            "request": "attach",
+            "name": "Example-attach-to-process", 
+            "processId": "${command:PickProcess}"
+        }
+    ]
+}
+```
+
+Note that `"configurations"` is an array, so you can define multiple configurations and choose the one to use from a dropdown menu in the Debug pane.
 
 {: #code-workspaces}
-## VS Code Workspaces 
 
-To work with VS Code, you need to open a workspace. In the simplest setup, a VS Code workspace is just the root folder of your project. Workspace settings and task configurations are stored in the root folder in the `settings.json` file in a folder called `.vscode`. Debugging launch configurations are stored in `launch.json`, also in `.vscode`.
+## VS Code Workspaces
+
+If your project requires more than a single root folder, you need to use a feature called multi-root workspaces. See [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) in the VS Code documentation.
 
-If you need to have more than one root folder in a VS Code workspace, use a feature called multi-root workspaces. See [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces) in the VS Code documentation.
+In this case settings are stored in a file with a `*.code-workspace` suffix. The filename's extension must be *.code-workspace*, for example `test.code-workspace`. This workspace file can be located anywhere. It defines what root folders the workspace consists of, and may also store other settings that would otherwise be stored in `settings.json` or `launch.json`. Settings in a root folder's `.vscode/settings.json` or `.vscode/launch.json` will override those in the workspace file, so be careful to use one or the other unless you truly need to leverage this flexibility.
 
-A multi-root workspace is defined by a `*.code-workspace` file. The file can have any name followed by *.code-workspace*, for example `test.code-workspace`. The `*.code-workspace` file stores information about what folders are in the workspace, and may also store other settings that would otherwise be stored in the settings.json or launch.json files. Settings in a folder's `.vscode/settings.json` or `.vscode/launch.json` will override those in the `*.code-workspace` file, so be careful to use one or the other unless you truly need to leverage this flexibility. You can have a workspace file even if you are only working with a single root folder. Indeed, if you are [working server-side](../serverside/) you will always be using a workspace file.
+You can have a workspace file even if you are only working with a single root folder. Indeed, if you are [working server-side](../serverside/) you will always be using a workspace file.
 
-To edit **InterSystems ObjectScript** extension settings in a `*.code-workspace` file in VS Code, open the workspace using **File > Open Workspace...**, select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) and select the Workspace tab. Search for **objectscript: conn**, and click on *Edit in settings.json*. VS Code opens the `*.code-workspace` file for that workspace.
+To edit **InterSystems ObjectScript** extension settings in a `*.code-workspace` file in VS Code, open the workspace using **File > Open Workspace from File...**, select **File > Preferences > Settings** (**Code > Preferences > Settings** on Mac) and select the Workspace tab. Search for **objectscript: conn**, and click on *Edit in settings.json*. VS Code opens the `*.code-workspace` file for that workspace.
 
 The **InterSystems ObjectScript** extension uses the multi-root workspaces feature to support ObjectScript development directly in namespaces on InterSystems servers.
 

docs/RunDebug.md

@@ -11,6 +11,8 @@ The InterSystems ObjectScript Extension provides support for ObjectScript debugg
 - [Debugging Intro Video](https://code.visualstudio.com/docs/introvideos/debugging)
 - [Debugging User Guide](https://code.visualstudio.com/docs/editor/debugging)
 
+Also, InterSystems Learning Services has produced [a short video](https://learning.intersystems.com/course/view.php?id=1795&ssoPass=1) which walks through the steps in this documentation page that you may find useful.
+
 ## Debug Configurations
 
 In order to run or debug an ObjectScript class or routine or attach to a running process, you must create a debug configuration. Some other languages default to running the currently active file, but to run ObjectScript, you must specify the routine or ClassMethod to use or the running process to attach to.

docs/ServerSide.md

@@ -138,7 +138,7 @@ The query string of the `uri` property accepts several parameters that control f
 - `isfs://myserver:user?type=cls`, shows only classes
 - `isfs://myserver:user?type=rtn`, shows only routines, mac, int and inc files
 - `isfs://myserver:user?generated=1`, shows generated files as well as not generated
-- `isfs://myserver:user?filter=%Z*.cls,%z*.cls,%Z*.mac`, comma-delimited list of search options, ignores `type`
+- `isfs://myserver:user?filter=%Z*.mac,%z*.mac`, comma-delimited list of search options, ignores `type`. The default is `*.cls,*.inc,*.mac,*.int`. To see all files, use `*`.
 - `isfs://myserver:user?flat=1`, a flat list of files does not split packages as folders.
 
 The options `flat` and `generated` can be combined with each other, and with `type` or `filter`. If `filter` is specified, `type` is ignored.

docs/_sass/color_schemes/isc.scss

@@ -1 +1,9 @@
-$link-color: #333695;
+$link-color: #333695;
+
+.side-bar {
+    max-width: 300px !important;
+}
+  
+.main {
+    max-width: 1200px !important;
+}