Skip to content

Commit

Permalink
Updates for Wazi for VS Code 4.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
phaumer committed Jun 14, 2024
1 parent 1f65b6c commit 66ffe34
Show file tree
Hide file tree
Showing 8 changed files with 548 additions and 72 deletions.
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

# IBM Z® Open Editor

**IBM Z Open Editor is an extension for Visual Studio Code that provides language support for the IBM® Enterprise COBOL, PL/I, HLASM, REXX, and JCL languages.**
**IBM Z Open Editor is an extension for Visual Studio Code that provides language support for the IBM® Enterprise COBOL, PL/I, HLASM, REXX, and (all new!) JCL languages.**

> Go here for the full [Documentation](https://ibm.github.io/zopeneditor-about/Docs/introduction.html?utm_source=vscode&utm_medium=referral&utm_campaign=vscode_marketplace) online.
**New**: IBM Z Open Editor v4.0.0 introduced advanced capabilities that go beyond program editing. These are at the moment local preprocessor support for COBOL, a new Web view built on top of Zowe Explorer that displays z/OS resources such as data sets and jobs in a sortable table, and a new DBB user build VS Code Problems view integration. All users get a 60-day evaluation trial for these advanced capabilities. After that they are licensed via the IBM Developer for z/OS Enterprise Edition offering. The language editing capabilities are still free and will be maintained and enhanced as always. See the [IBM Documentation](https://ibm.biz/code-whatsnew) with details.
**New**: IBM Z Open Editor v4.0.0 introduced advanced capabilities that go beyond program editing. These are at the moment preprocessor support for COBOL, a new Web view built on top of Zowe Explorer that displays z/OS resources such as data sets and jobs in a sortable table, a new DBB user build VS Code Problems view integration, HLASM custom macros support. All users get a 60-day evaluation trial for these advanced capabilities. After that they are licensed via the IBM Developer for z/OS Enterprise Edition offering. The language editing capabilities are still free and will be maintained and enhanced as always. See the [IBM Documentation](https://ibm.biz/code-whatsnew) with details.

**New**: IBM Z Open Editor v3.3.0 introduced AI assistance for Java developers with [IBM watsonx Code Assistant for Z](https://www.ibm.com/products/watsonx-code-assistant-z), which supports AI-assisted transformation of COBOL to Java for modernizing applications.
**Note**: Import update for the release of version 4.3.0 of IBM Z Open Editor: [IBM watsonx Code Assistant for Z](https://www.ibm.com/products/watsonx-code-assistant-z), which supports AI-assisted transformation of COBOL to Java for modernizing applications, has now been moved into it's own VS Code extension IBM watsonx Code Assistant for Z version 2.0.0. All functionality has been migrated into this dedicated extension. Receive your copy of the Z Code Assistant via your Passport Advantage Online. See the [Documentation](https://www.ibm.com/docs/en/watsonx-code-assistant-4z) for more details.

The core extension provides language support for the IBM Enterprise programming languages for z/OS®. It supports COBOL v6.4, PL/I v6.1, and High Level Assembler for z/OS 3.1 and TSO/E REXX. This also includes capabilities for embedded statements in COBOL and PL/I for CICS 6.1 (6.2 Beta), IMS 15.1.0 and SQL DB2 for z/OS 12.1. Earlier versions of any of these components will also work. IBM Z Open Editor realizes its language support by implementing fully functional [language servers](https://langserver.org/) together with additional editor enhancements that enable IBM Z developers to utilize features such as:
The core extension provides language support for the IBM Enterprise programming languages for z/OS®. It supports COBOL v6.4, PL/I v6.1, High Level Assembler for z/OS 3.1, TSO/E REXX, and z/OS MVS Job Control Language (JCL). This also includes capabilities for embedded statements in COBOL and PL/I for CICS 6.1 (6.2 Beta), IMS 15.1.0 and SQL DB2 for z/OS 12.1. Earlier versions of any of these components will also work. IBM Z Open Editor realizes its language support by implementing fully functional [language servers](https://langserver.org/) together with additional editor enhancements that enable IBM Z developers to utilize features such as:

- Real-time syntax checking and highlighting while you type
- Problems view with all syntax errors and (in COBOL) unreachable code
Expand All @@ -31,7 +31,12 @@ The core extension provides language support for the IBM Enterprise programming
- Custom code snippet support and more than 200 high value code snippets for COBOL, PL/I, and JCL out of the box
- Search and replace refactoring across multiple program files

Note, that for Job Control Language (JCL), the extension only provides syntax highlighting.
Note, that for Job Control Language (JCL), the extension only provides below mentioned features:

- Real-time syntax checking and highlighting while you type
- Problems view with all syntax errors
- Outline view and outline search
- Code and variable completion

To learn more about the IBM Z Open Editor extension's capabilities, we suggest that you walk through our [documentation](https://ibm.github.io/zopeneditor-about/Docs/introduction.html) and try it with the [example repository](https://github.com/IBM/zopeneditor-sample) provided on GitHub.

Expand All @@ -42,7 +47,6 @@ To interact with z/OS, this extension also automatically co-installs the [Zowe E
- [Privacy notice](#privacy-notice-for-feedback)
- [Prerequisites](#prerequisites)
- [Configuring Java](#configuring-java)
- [IBM watsonx Code Assistant for Z](#generate-java-from-cobol-using-ibm-watsonx-code-assistant-for-z)
- [COBOL and PL/I Language Server Protocol capability examples](#language-server-protocol-capability-examples)
- [Advanced Capabilities](#advanced-capabilities)

Expand All @@ -61,7 +65,6 @@ This current release of IBM Z Open Editor will collect anonymous data for the fo
- Using common language server operations such as code completion, references, definition, rename
- Starting a user build
- Responding to the feedback dialog
- Using IBM watsonx Code Assistant for Z operations
- Activating trial or full unlock licenses

Such events are logged with the following information:
Expand Down Expand Up @@ -89,9 +92,9 @@ Here are the prerequisites for installing this extension in Visual Studio Code:
- You can use versions 11, or 17 of [IBM's Semeru Runtime](https://developer.ibm.com/languages/java/semeru-runtimes/) that can be [downloaded here](https://developer.ibm.com/languages/java/semeru-runtimes/downloads).
- You can use [Oracle Java 11](https://www.oracle.com/java/technologies/downloads/#java11) or the LTS versions 17 of Oracle Java.
- You can also use version 11, or 17 of the [OpenJDK](https://adoptium.net/index.html).
- Newer versions of Java should also work, but are not as rigorously tested for Z Open Editor as Java 11.
- Newer versions of Java should also work, but are not as rigorously tested for Z Open Editor as Java 11 and 17.
- Various settings are provided to configure how the extension uses Java. See the [Configuring Java](#configuring-java) section below for more details.
- Zowe CLI 7.21.3 or newer and the Zowe Explorer VS Code extension v2.14.1 or newer: To make use of [Zowe](https://zowe.org) to open and edit files directly from z/OS MVS or USS, you need Zowe client software and either IBM RSE API or z/OSMF configured. For more information, see [Installing Zowe CLI](https://docs.zowe.org/stable/user-guide/cli-installcli) and [VS Code Extension for Zowe](https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe#user-content-prerequisites). Once installed, you must [create a Zowe CLI team configuration file](https://ibm.github.io/zopeneditor-about/Docs/interact_zos_overview.html) so that data sets can be found and accessed.
- Zowe CLI 7.24.1 or newer (optional, but recommended) and the Zowe Explorer VS Code extension v2.16.0 or newer (required): To make use of [Zowe](https://zowe.org) to open and edit files directly from z/OS MVS or USS, you need Zowe client software and either IBM RSE API or z/OSMF configured. For more information, see [Installing Zowe CLI](https://docs.zowe.org/stable/user-guide/cli-installcli) and [VS Code Extension for Zowe](https://marketplace.visualstudio.com/items?itemName=Zowe.vscode-extension-for-zowe#user-content-prerequisites). Once installed, you must [create a Zowe CLI team configuration file](https://ibm.github.io/zopeneditor-about/Docs/interact_zos_overview.html) so that data sets can be found and accessed.

- (Optional) Git: To use the features that involve Git, you must install Git and have it available in your system path so that VS Code can display it. On Macs, Git comes out of the box. On Linux, you can install Git with your distribution's package manager. On Windows, you can get Git from <https://git-scm.com>.

Expand Down Expand Up @@ -126,13 +129,13 @@ To define a user setting use the Preferences > Settings menu and either locate t
On Mac:

```json
"zopeneditor.JAVA_HOME": "/Library/Java/JavaVirtualMachines/jdk11.0.15+10.jdk/Contents/Home"
"zopeneditor.JAVA_HOME": "/Library/Java/JavaVirtualMachines/jdk11.0.23+9.jdk/Contents/Home"
```

On Windows:

```json
"zopeneditor.JAVA_HOME": "C:\\Program Files\\Java\\jdk11.0.15+10"
"zopeneditor.JAVA_HOME": "C:\\Program Files\\Java\\jdk11.0.23+9"
```

### Configuring the Java memory allocation
Expand All @@ -143,13 +146,9 @@ By default, the language server clients that start the language servers for COBO
"zopeneditor.server.memoryAllocation": 640
```

## Generate Java from COBOL using IBM watsonx Code Assistant for Z

Enable IBM watsonx Code Assistant and upload a COBOL service that is prepared for transformation. Use AI-assistance to generate Java classes and object-oriented Java business logic that is semantically equivalent to existing COBOL to help you quickly get started modernizing your applications. To learn more, visit the [IBM watsonx Code Assistant Product guide](https://www.ibm.com/products/watsonx-code-assistant-z).

## Language Server Protocol capability examples

The following animations just give you glimpse of the capabilities available in IBM Z Open Editor. We are showing you different examples using different programming languages, but most of the features shown here are available for all four languages: COBOL, PL/I, HLASM, as well as REXX.
The following animations just give you glimpse of the capabilities available in IBM Z Open Editor. We are showing you different examples using different programming languages, but most of the features shown here are available for all four languages: COBOL, PL/I, HLASM, JCL, as well as REXX.

### Outline view explorer

Expand Down
9 changes: 4 additions & 5 deletions product-licenses/LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ LICENSE INFORMATION
The Programs listed below are licensed under the following License Information terms and conditions in addition to the Program license terms previously agreed to by Client and IBM. If Client does not have previously agreed to license terms in effect for the Program, the International License Agreement for Non-Warranted Programs (i125-5589-06) applies.

Program Name (Program Number):
IBM Z Open Editor V4.1 (Plug-in)
IBM Z Open Editor V4.3 (Plug-in)

The following standard terms apply to Licensee's use of the Program.

Expand All @@ -12,9 +12,9 @@ Modifiable Third Party Code
To the extent, if any, in the NOTICES file IBM identifies third party code as "Modifiable Third Party Code," IBM authorizes Licensee to 1) modify the Modifiable Third Party Code and 2) reverse engineer the Program modules that directly interface with the Modifiable Third Party Code provided that it is only for the purpose of debugging Licensee's modifications to such third party code. IBM's service and support obligations, if any, apply only to the unmodified Program.


L/N: L-LEYT-2LK79N
D/N: L-LEYT-2LK79N
P/N: L-LEYT-2LK79N
L/N: L-MZTN-W7GQBK
D/N: L-MZTN-W7GQBK
P/N: L-MZTN-W7GQBK

International License Agreement for Non-Warranted Programs

Expand Down Expand Up @@ -503,4 +503,3 @@ In Czech Republic: Licensee expressly accepts the terms of this agreement which
In Romania: The Licensee expressly accepts, the following standard clauses that may be deemed 'unusual clauses' as per the provisions of article 1203 Romanian Civil Code: clauses 2, 4, 5, 8j. The Licensee hereby acknowledges that it was sufficiently informed of all the provisions of this Agreement, including the clauses mentioned above, it properly analyzed and understood such provisions and had the opportunity to negotiate the terms of each clause.

i125-5589-06 (10-2021)

40 changes: 3 additions & 37 deletions product-licenses/NOTICES.txt
Original file line number Diff line number Diff line change
@@ -1,33 +1,6 @@
NOTICES AND INFORMATION

IBM Z Open Editor V4.1

The IBM license agreement and any applicable information on the web
download page for IBM products refers Licensee to this file for details
concerning notices applicable to code included in the products listed
above ("the Program").

Notwithstanding the terms and conditions of any other agreement Licensee
may have with IBM or any of its related or affiliated entities
(collectively "IBM"), the third party code identified below is subject
to the terms and conditions of the IBM license agreement for the Program
and not the license terms that may be contained in the notices below.
The notices are provided for informational purposes.

Please note: This Notices file may identify information that is not used
by, or that was not shipped with, the Program as Licensee installed it.

IMPORTANT: IBM does not represent or warrant that the information in this
NOTICES file is accurate. Third party websites are independent of IBM and
IBM does not represent or warrant that the information on any third party
website referenced in this NOTICES file is accurate. IBM disclaims any
and all liability for errors and omissions or for any damages accruing
from the use of this NOTICES file or its contents, including without
limitation URLs or references to any third party websites.

NOTICES AND INFORMATION

IBM Z Open Editor V4.1
IBM Z Open Editor V4.3

The IBM license agreement and any applicable information on the web
download page for IBM products refers Licensee to this file for details
Expand Down Expand Up @@ -55,7 +28,7 @@ limitation URLs or references to any third party websites.

=====================================================================

The following are Notices for Z Open Editor V4.1
The following are Notices for Z Open Editor V4.3

=====================================================================
START OF APACHE LICENSE 2.0 NOTICES AND INFORMATION
Expand Down Expand Up @@ -3300,13 +3273,6 @@ END OF UNLICENSE NOTICES AND INFORMATION

=====================================================================

End of Notices for IBM Z Open Editor 4.1
End of Notices for IBM Z Open Editor 4.3

=====================================================================




L/N: L-LEYT-2LK79N
D/N: L-LEYT-2LK79N
P/N: L-LEYT-2LK79N
8 changes: 4 additions & 4 deletions product-licenses/rse-api-for-zowe-cli/LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ LICENSE INFORMATION
The Programs listed below are licensed under the following License Information terms and conditions in addition to the Program license terms previously agreed to by Client and IBM. If Client does not have previously agreed to license terms in effect for the Program, the International License Agreement for Non-Warranted Programs (i125-5589-06) applies.

Program Name (Program Number):
IBM RSE API Plug-in for Zowe CLI V4.1 (Plug-in)
IBM RSE API Plug-in for Zowe CLI V4.3 (Plug-in)

The following standard terms apply to Licensee's use of the Program.

Expand All @@ -12,9 +12,9 @@ Modifiable Third Party Code
To the extent, if any, in the NOTICES file IBM identifies third party code as "Modifiable Third Party Code," IBM authorizes Licensee to 1) modify the Modifiable Third Party Code and 2) reverse engineer the Program modules that directly interface with the Modifiable Third Party Code provided that it is only for the purpose of debugging Licensee's modifications to such third party code. IBM's service and support obligations, if any, apply only to the unmodified Program.


L/N: L-MJHW-2B5AZ3
D/N: L-MJHW-2B5AZ3
P/N: L-MJHW-2B5AZ3
L/N: L-KVNQ-DWB7BX
D/N: L-KVNQ-DWB7BX
P/N: L-KVNQ-DWB7BX

International License Agreement for Non-Warranted Programs

Expand Down
12 changes: 6 additions & 6 deletions product-licenses/rse-api-for-zowe-cli/NOTICES.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
NOTICES AND INFORMATION

IBM RSE API Plug-in for Zowe CLI V4.1
IBM RSE API Plug-in for Zowe CLI V4.3

The IBM license agreement and any applicable information on the web
download page for IBM products refers Licensee to this file for details
Expand All @@ -26,7 +26,7 @@ from the use of this NOTICES file or its contents, including without
limitation URLs or references to any third party websites.

=====================================================================
Start of Notices for IBM RSE API Plug-in for Zowe CLI 4.1.x
Start of Notices for IBM RSE API Plug-in for Zowe CLI 4.3.x
=====================================================================

=====================================================================
Expand Down Expand Up @@ -785,14 +785,14 @@ END OF UNLICENSE NOTICES AND INFORMATION


=====================================================================
End of Notices for IBM RSE API Plug-in for Zowe CLI 4.1.x
End of Notices for IBM RSE API Plug-in for Zowe CLI 4.3.x
=====================================================================






L/N: L-MJHW-2B5AZ3
D/N: L-MJHW-2B5AZ3
P/N: L-MJHW-2B5AZ3
L/N: L-KVNQ-DWB7BX
D/N: L-KVNQ-DWB7BX
P/N: L-KVNQ-DWB7BX
2 changes: 1 addition & 1 deletion product-licenses/zapp/LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ LICENSE INFORMATION
The Programs listed below are licensed under the following License Information terms and conditions in addition to the Program license terms previously agreed to by Client and IBM. If Client does not have previously agreed to license terms in effect for the Program, the International License Agreement for Non-Warranted Programs (i125-5589-06) applies.

Program Name (Program Number):
IBM Zapp Core Library V1.1 (Plug-in)
IBM Zapp Core Library V1.2 (Plug-in)

The following standard terms apply to Licensee's use of the Program.

Expand Down
6 changes: 3 additions & 3 deletions product-licenses/zapp/NOTICES.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
NOTICES AND INFORMATION

IBM Zapp Core Library V1.1
IBM Zapp Core Library V1.2

The IBM license agreement and any applicable information on the web
download page for IBM products refers Licensee to this file for details
Expand All @@ -25,7 +25,7 @@ and all liability for errors and omissions or for any damages accruing
from the use of this NOTICES file or its contents, including without
limitation URLs or references to any third party websites.

Start of Notices for IBM Zapp Core Library 1.1.0
Start of Notices for IBM Zapp Core Library 1.2.0
=====================================================================

=====================================================================
Expand Down Expand Up @@ -663,7 +663,7 @@ For more information, please refer to <http://unlicense.org/>
END OF UNLICENSE NOTICES AND INFORMATION
=====================================================================

End of Notices for IBM Zapp Core Library 1.1.0
End of Notices for IBM Zapp Core Library 1.2.0


L/N: L-KTSR-8RJLXL
Expand Down
Loading

0 comments on commit 66ffe34

Please sign in to comment.