You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Configuration.md
+18-7Lines changed: 18 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,26 +6,27 @@ nav_order: 3
6
6
---
7
7
# Configuration
8
8
9
-
VS Code settings enable you to customize various aspects of its function. The InterSystems-provided extensions enable you to define InterSystems IRIS servers and the connections to those servers.
9
+
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.
10
10
11
11
## Settings
12
12
13
-
Many available settings are general to VS Code, and you can learn about them in the [Visual Studio Code Documentation](https://code.visualstudio.com/docs). The InterSystems Server Manager and InterSystems ObjectScript extensions supply specific settings used to configure VS Code for ObjectScript development.
13
+
Many available settings are general to VS Code, and you can learn about them in the [Visual Studio Code Documentation](https://code.visualstudio.com/docs). The InterSystems Server Manager and InterSystems ObjectScript extensions supply additional settings you can use to define InterSystems IRIS servers and connections to those servers.
14
+
14
15
There are several levels on which settings are stored and used:
15
16
16
17
-**User** - User settings are stored in a file location specific to you and apply globally to any instance of VS Code or any VS Code workspace that you open.
17
18
-**Workspace** - Workspace settings are stored in a file inside the workspace and apply to anyone who opens the workspace.
18
19
-**Folder** - If more than one folder is present in the workspace, you can select the folder where the settings file is stored by selecting from the Folder drop down list.
19
20
20
-
For example, the following screen shot shows Workspace selected:
21
+
For example, the following screen shot shows the Workspace level selected:
See the VS Code documentation section [User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings).
25
26
26
27
## Configuring a Server
27
28
28
-
First, configure one or more servers. Select **View > Command Palette > InterSystems Server Manager: Store Password in Keychain**. This command lets you define a new server, as well as storing a password. Click the plus sign in the upper right corner of the dialog, as shown:
29
+
First, configure one or more servers. Select **View > Command Palette > InterSystems Server Manager: Store Password in Keychain**. This command lets you define a new server and securely store a password in the system keychain. Click the plus sign in the upper right corner of the dialog, as shown:
29
30
30
31

31
32
@@ -37,7 +38,9 @@ Provide the following values when prompted:
37
38
-**Username** - the username to use in logging in to this server.
38
39
-**Confirm connection type** - the protocol used for connections, possible values are **http** and **https**.
39
40
40
-
Once you have entered these values, the server definition is stored in your user settings. At that point another prompt appears, asking for a password to store in the system Keychain. Enter the password for the username supplied earlier to complete the process.
41
+
Once you have entered these values, the server definition is stored in your user settings. At that point another prompt appears, asking for a password to store in the system keychain. Enter the password for the username supplied earlier to complete the process. Storing a password is optional. You can terminate the process and store the server configuration by pressing either **Escape** or **Return**. If you do not store a password, users are prompted for a password each time they connect to the server.
42
+
43
+
You can create a configuration for a server that is not currently running.
41
44
42
45
## Editing a Server Configuration
43
46
@@ -80,7 +83,15 @@ If you do not store the password securely in the system Keychain or add it to th
80
83
81
84
## Configuring a Server Connection
82
85
83
-
Open the folder where you want client-side files to be located. Select the **ObjectScript Explorer** button which has been added to the Activity Bar. Select the **Choose Server and Namespace** button. This action opens a dialog that lets you select a server, or create a new one. Once you have selected a server and namespace, connection configuration is complete.
86
+
Open the folder where you want client-side files to be located. Select the **ObjectScript Explorer** button on the Activity Bar. Select the **Choose Server and Namespace** button. This action opens a dialog that lets you select a server, or create a new one. Once you have selected a server and namespace, connection configuration is complete. VS Code adds the server and namespace to the status bar, as shown in the following screen shot.
87
+
88
+

89
+
90
+
You cannot create a connection to a server that is not running.
91
+
92
+
Click on the server and namespace in the status bar to open a list of actions you can take for this server:
93
+
94
+

84
95
85
96
## Editing a Server Connection
86
97
@@ -92,7 +103,7 @@ The connection configuration looks like this:
Copy file name to clipboardExpand all lines: docs/RunDebug.md
+29-5Lines changed: 29 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,28 @@ nav_order: 4
6
6
---
7
7
# Running and Debugging
8
8
9
-
In order to run or debug an ObjectScript class or routine, you must create a launch configuration. Click the run button in the Activity Bar:
9
+
The InterSystems ObjectScript Extension provides support for ObjectScript debugging. It takes advantage of the debugging capabilities built into VS Code, so you may find these VS Code documentation resources useful:
10
+
11
+
-[Node.js debugging in VS Code](https://code.visualstudio.com/docs/editor/debugging)
In order to run or debug an ObjectScript class or routine, you must create a launch configuration. Some other languages default to running the currently active file, but to run ObjectScript, you must specify the routine or ClassMethod to use.
Once you have chosen a debug environment, VS Code creates and opens a `launch.json` file containing the following default content:
16
31
17
32
```json
18
33
{
@@ -33,7 +48,7 @@ These attributes are mandatory for any launch configuration:
33
48
-**request** - Identifies the type of action for this launch configuration. Possible values are `launch` and `attach`.
34
49
-**name** - An arbitrary name to identify the configuration. This name appears in the Start Debugging drop down list.
35
50
36
-
In addition, for an **objectscript** configuration, you need to supply the attribute **program**, which specifies the executable or file to run when launching the debugger, as shown in the following example:
51
+
In addition, for an **objectscript** configuration, you need to supply the attribute **program**, which specifies the routine or ClassMethod to run when launching the debugger, as shown in the following example:
37
52
38
53
```json
39
54
"launch": {
@@ -49,10 +64,19 @@ In addition, for an **objectscript** configuration, you need to supply the attri
Clicking on the green arrow runs the currently selected launch configuration.
81
+
82
+
Debugging commands and items on the **Run** menu function much as they do for other languages supported by VS Code. For information on VS Code debugging, see the documentation resources listed at the start of this section.
0 commit comments