ADITO Code Completion

ADITO Code Completion brings the information from your ADITO YAML model into VS Code. It connects YAML model files with their JDito JavaScript/TypeScript process files and offers context-sensitive suggestions while you write code.

What the extension provides

The extension supports five workflows:

1. YAML model completion – while editing an ADITO YAML file, valid data-model names are suggested for supported schema fields.
2. JDito variable completion – in a linked JavaScript or TypeScript process file, variables such as $sys, $local and $this are suggested inside string literals.
3. Dynamic JDito completion – for schema properties that support it, $field.<name> and $param.<name> values are calculated from the current ADITO model.
4. Linked-file assistance – missing local process and documentation files can be created directly from their YAML references.
5. Configuration-value completion – fixed and custom values are suggested in the first argument of project.getInstanceConfigValue("") and project.getPreferenceValue("").

Suggestions are refreshed when relevant YAML, preference, or configuration files change, so the completion data stays up to date.

Quick start

1. Install ADITO Code Completion in VS Code.

2. Open an ADITO project as a trusted workspace.

3. Configure the ADITO schema catalog in the workspace settings:

   {
     "yaml.schemaStore.url": "https://releases.adito.cloud/2026/2026.1.2/schemas.json"
   }
   

4. Open a supported YAML, JavaScript, or TypeScript file.

5. Place the cursor at the desired position and press Ctrl+Space.

The extension walkthrough guides you through the required settings. If the TypeScript server was already running when the extension or its configuration changed, run TypeScript: Restart TS Server from the Command Palette.

YAML completion

The schema catalog defines which YAML files and properties are supported. It is used for model references and also to find the JDito process links that belong to a YAML file.

The extension includes YAML Language Support by Red Hat as an extension dependency for schema-driven YAML support.

JDito variable completion

JDito variables are offered when all of these conditions apply:

• The JavaScript or TypeScript file is linked from an ADITO YAML file.
• The corresponding schema property contains JDito variable metadata.
• The cursor is inside a string literal.

For example, you can get suggestions for the following $sys variable:

vars.get("$sys.");

Selecting $sys.clientcountry results in:

vars.get("$sys.clientcountry");

The available variables depend on the YAML link and its schema. This feature requires ADITO core version 2026.1.2 or later.

Dynamic $field and $param completion

Some schema properties provide dynamic model information. For these properties, the extension asks the transpile daemon for the parent model and its children when completion is requested. This means the suggestions reflect the current model and are queried on demand rather than stored as a permanent completion list.

This feature requires ADITO core version 2026.1.2 and ADITO Transpile version 1.2.0 or later.

The ADITO Standalone Tools extension

The transpile daemon is owned by the ADITO Standalone Tools extension. It is installed automatically together with ADITO Code Completion, downloads and updates the standalone tools itself, and starts one daemon per ADITO project folder (the folder that contains .aditoprj). If the extension or its daemon is unavailable, dynamic completion is skipped and normal schema-based completion remains available.

Tool failures are logged to the ADITO Standalone Tools output channel.

Creating linked files

For YAML files below a contexts/ directory, the extension recognizes safe local .js and .ts process paths. It also recognizes local .adoc documentation links in any YAML file.

When a referenced file is missing, place the cursor on the value and choose Create Missing Linked File from the Quick Fix menu. The extension creates parent directories, adds a type-appropriate TODO template, and opens the file. Ctrl-clicking on Windows/Linux or Cmd-clicking on macOS creates it while keeping the YAML document open.

Only paths inside the YAML file's directory are accepted. Absolute paths, URLs, unsupported extensions, and paths such as ../process.ts are rejected.

To create a missing process file when a YAML completion inserts its reference:

{
  "aditoCodeCompletion.createProcessFileOnReferenceInsertion": true
}

To create every missing supported reference when saving a YAML file:

{
  "aditoCodeCompletion.createProcessFileOnSave": true
}

Configuration overview

Configuration-value completion

The TypeScript server plugin suggests schema and custom values in the first argument of project.getPreferenceValue and project.getInstanceConfigValue.

Custom values are read from:

• preferences/preferences.yaml
• preferences/_____PREFERENCES_PROJECT/_____PREFERENCES_PROJECT.aod

The plugin searches the TypeScript project directory and all open VS Code workspace folders, including multi-root workspaces. It works with VS Code's bundled TypeScript version and with a workspace TypeScript version. No separate JDito language-server plugin needs to be added to tsconfig.json.

Requirements

• A trusted workspace. The extension needs access to workspace files and schemas.
• ADITO core 2026.1.2 or later for JDito variable completion.
• The ADITO Standalone Tools extension only for dynamic $field and $param completion.

Troubleshooting

No JDito variable suggestions appear

• Confirm that the current JS/TS file is linked from a YAML file.
• Confirm that the link property exists in the configured schema and contains JDito variable metadata.
• Make sure the cursor is inside a quoted string.
• Check that the file belongs to the currently opened workspace.
• Run TypeScript: Restart TS Server.

No dynamic $field or $param suggestions appear

• Confirm that the ADITO Standalone Tools extension is installed and enabled, and that the workspace root contains a .aditoprj folder.
• Confirm that yaml.schemaStore.url is configured and reachable.
• Check the ADITO Standalone Tools output channel for daemon or tool failures.

No YAML suggestions appear

• Confirm that the schema catalog is reachable.
• Check that the YAML filename matches one of the schema's file patterns.
• Ensure that the Red Hat YAML extension is installed and enabled.

Configuration-value suggestions are missing

• Use the first argument of project.getPreferenceValue or project.getInstanceConfigValue.
• Verify that the relevant schema or preference file can be read from the TypeScript project or workspace folder.
• Restart the TypeScript server after changing workspace configuration.