Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ezequielgandolfi/openedge-zext

OpenEdge ABL Extension for VSCode
https://github.com/ezequielgandolfi/openedge-zext

4gl abl openedge progress vscode-extension

Last synced: about 1 month ago
JSON representation

OpenEdge ABL Extension for VSCode

Host: GitHub
URL: https://github.com/ezequielgandolfi/openedge-zext
Owner: ezequielgandolfi
License: apache-2.0
Created: 2018-12-12T11:54:18.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2022-04-09T22:50:13.000Z (over 2 years ago)
Last Synced: 2024-08-03T22:16:49.890Z (5 months ago)
Topics: 4gl, abl, openedge, progress, vscode-extension
Language: TypeScript
Size: 1.38 MB
Stars: 22
Watchers: 7
Forks: 10
Open Issues: 19
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-openedge-abl - ezequielgandolfi/openedge-zext - Another Openedge plugin **[😴 inactive]** (IDE / Visual Studio Code)

README

# OpenEdge-ZExt - Visual Studio Code extension for OpenEdge ABL

OpenEdge ABL Extension for Visual Studio Code

## Features

- Syntax highlighting
- Auto-complete (tables, fields, methods, variables, parameters)
- Source navigation (ctrl+click)
- Check syntax, compile, run
- Deploy (source / r-code)
- Source formatting
- Hover information
- Include files suggestion
- Code snippets

### Auto-complete
> *Supports database table/fields, temp-tables, buffers, methods*
![autocomplete](resources/readme/autocomplete.gif)

### Source navigation
> *Navigate throught includes, declarations*
![navigation](resources/readme/navigation.gif)

### Check syntax, Compile, Run, Deploy
- OpenEdge integration for check syntax, compile and run commands
- Configurable deployment options

> Check **Shortcut Keys** section

> Deployment options are located in configuration file

### Source formatting
- Available commands:
- `ABL: Format - Keywords - Upper Case`
- `ABL: Format - Keywords - Lower Case`
- `ABL: Format - Trim Right`

### Hover information
- Provides information when mouse hovers an element (table, field, variable, etc)

### Shortcut Keys
- `Alt+F1` Compile + deploy
- `Alt+F3` Compile with options (xref, debug-list, xcode, etc) + deploy
- `Alt+F2` Deploy without compile (only source file)
- `Shift+F2` Check syntax
- `F2` Run

### Other features

#### Code folding
- Uses `//#region` and `//#endregion` code folding - same as TypeScript

## What's new

### 1.0.0
- Better code completion details
- Includes file sugestion on typing `{`
- Brand new source code (seriously... almost everything...)

### 0.6.0
- New commands for source formatting

See [CHANGELOG](CHANGELOG.md) for more information.

## Requirements

- OpenEdge Progress 11+

## Usage
- Extension is activated for extensions: .i .p .w .cls

### Starting
- Create a configuration file (see Extension Settings below)
- Execute command "ABL: Read Dictionary Structure" for auto-complete feature
- Enjoy...

### Commands

#### ABL: Read Dictionary Structure
> Create a database auto-complete file

#### ABL: Check Syntax (Shift+F2)
> Check syntax for current file and highlights errors

#### ABL: Compile & Deploy (Alt+F1)
> Compile the current file and deploy the RCode when configured

#### ABL: Deploy Source (Alt+F2)
> Deploy the current file when configured (without compile)

#### ABL: Compile with Options (Alt+F3)
> Compile the current file with additional options (Preprocess, X-Ref, etc)

## Extension Settings

Create a file named ".openedge-zext.json" in root path of the workspace.
> Download base configuration file [here](resources/examples/.openedge-zext.json).

```JSON
{
"workingDirectory": "${workspaceFolder}\\Temp",
"proPath": [
"c:\\src",
"${workspaceFolder}"
],
"proPathMode": "overwrite", // append, prepend
"dlcPath": "c:\\dlc116",
"parameterFiles": [
"default.pf"
],
"dbDictionary": [
"myDatabaseForAutoComplete"
],
"deployment": [
{
"taskType": "current.r-code", // current.source
"path": "c:\\out",
"postAction": [
{
"actionType": "URL",
"command": "http://localhost:8080/postAction"
}
]
}
]
}
```

- `dlcPath` is optional, and overwrite DLC enviorenment variable
- `dbDictionary` are the logical names of database files for the auto-complete option (command: ABL Read Dictionary Structure)
- `deployment` are actions from compile/deploy commands (Alt+F1, Alt+F2 and Alt+F3)
- Default values:
- `proPath`: workspaceRoot
- `workingDirectory`: folder of active source file

## Known Issues & Enhancements

Visit [Issues page on GitHub](https://github.com/ezequielgandolfi/openedge-zext/issues) to report any problem or submit an enhancement.

## Greetings
Grammar file based on Christophe Camicas' project (https://github.com/chriscamicas/abl-tmlanguage.git)

## License
Licensed under the [Apache-2.0](LICENSE) License.