This section describes how to setup the configuration file, which is required for the ABL plugin in Windsurf to function correctly. The configuration file defines essential project attributes and must always reside in the root directory of the project. The following steps ensure a smooth development experience aligned with OpenEdge standards:
  1. Create a configuration file named openedge-project.json in the root directory of the project. This file defines key project settings such as project name, OpenEdge version, character set, and so on. As a JSON-formatted file, it is recommended to include openedge-project.json in your code repository for version control and team collaboration.
    Note: The configuration file must be named openedge-project.json. This specific filename is required by the Riverside plugin and cannot be changed.
  2. To configure the ABL plugin for Windsurf, modify the configuration file.

    The ABL plugin for Windsurf requires a configuration file to operate correctly. This plugin is not intended to replace the procedure editor, which allows direct file access and compilation. Instead, the plugin functions similar to Progress Developer Studio for OpenEdge, where .project and .propath files are required for project operations.

    To view or modify project attributes, open the openedge-project.json file that you created in step 1. Here is an example of openedge-project.json file for the myProject OpenEdge project: 
    {
  "name": "myProject",
  "version": "1.0",
  "oeversion": "12.8",
  "graphicalMode": true,
  "charset": "utf-8",
  "extraParameters": "-basekey ini",
  "numThreads": 1,
  "buildPath": [
    {
      "path": "src",
      "type": "source",
      "build": "rcode"
    }
  ]
}
    Note: These examples assume that your workspace contains an src directory for source code. Compiled code is placed in an rcode directory.
  3. Restart the ABL language server to apply changes made to the openedge-project.json file. The language server monitors source directories for changes. If no r-code exists in the build directory, procedures and classes are compiled at startup. During startup, the language server Output indicates which files are being compiled.

    You can restart the language server by either:

    • Restarting Windsurf.
    • Pressing Ctrl+Shift+P to execut the ABL: Restart Language Server command.

    With correct configuration, the language server should start without error. If issues occur, review the following diagnostic files located in the .builder directory:

    • builder.lock—This file is managed by the ABL language server and is used to track active instances of Windsurf within a project. If you attempt to open multiple Windsurf sessions for the same project, the language server detects the locked state and report an error indicating that the builder.lock file is in use.
    • clientlog0.log and stdout0.log—These log files capture diagnostic output from the AVM. The AVM is launched with the -clientlog clientlog0.log option, and its standard output is redirected to stdout0.log. Together, these logs provide valuable insights for troubleshooting issues and understanding the compilation process.

    The language server Output reports any invalid attributes in the JSON configuration.

  4. To test the configuration, create a new procedure file:

    1. In Windsurf, right-click the src directory and select New File.

    2. Save the file using a valid filename, for example test1.p. Ensure that the filename includes the .p extension to ensure it is recognized as an OpenEdge procedure file.

    3. Add the following code:
      message "hello, world!".
Here is a compilation error

      After saving the file (Ctrl+S), the second line is underlined in red, indicating a compilation error. The language server Output view confirms that the compilation failed.

      Compilation errors are also displayed in the Problems view, which can be filtered to show issues for the active file.

      Note: Windsurf does not include a Check Syntax button. Saving the file using Ctrl+S triggers background compilation and highlights errors inline. Alternatively, you can use ABL: Compile current buffer by pressing Ctrl+Shift+P to compile the current file.