RDF/Turtle and SAMM Aspect Models

VS Code extension for the ESMF SDK Turtle language server. The extension supports prefix Go to Definition, fast syntax feedback while typing, and server-driven heavy Aspect validation for SAMM-style Turtle models.

Configuration

• turtle.languageServerSettings.activateEmbeddedLanguageServer (boolean, default: true)
  • When enabled, the extension starts the SAMM CLI language server process. When disabled, an external language server must be started manually.
• turtle.languageServerSettings.automaticUpdateCheck (boolean, default: true)
  • Automatically check for updates of the SAMM CLI language server and notify when a new version is available.
• turtle.languageServerSettings.sammCliPath (string)
  • Path to the SAMM CLI executable or jar file to use as the language server. Can be downloaded / set via the 'Select SAMM CLI Executable' command.
• turtle.languageServerSettings.serverPort (number, default: 1846)
  • TCP port used to connect to the Turtle/SAMM language server.
• turtle.languageServerSettings.traceLevel (string, default: off)
  • Controls the verbosity of language client protocol tracing. Options: off, messages, verbose.

Use the command Turtle: Select SAMM CLI Executable to choose either:

• one of the latest SAMM CLI GitHub releases, or
• a custom executable path from your local file system.

Features

• Prefix Go to Definition inside Turtle files.
• Two-level validation:
  • Fast feedback on type from the regular Turtle parser diagnostics provided by the server (appear in the editor and Problems).
  • Heavy Aspect validation from the server for model-level issues (results shown in notifications and status bar).
• Manual validation command:
  • Turtle: Validate document now

Run The Server And Extension Together

1. In this extension project, install dependencies with npm install.
2. Compile the extension with npm run build.
3. Press F5 in VS Code to open an Extension Development Host.
4. Open a Turtle file such as samples/valid.ttl or your Aspect model file.

If the server cannot be downloaded or started, the extension shows an error and leaves a detailed message in the Turtle LSP output channel.

Validation Behavior

Fast feedback on type:

• Driven by the server's regular Turtle parsing diagnostics.
• Results appear in the editor and Problems panel.
• Intended for quick editor feedback while you type.

Heavy Aspect validation:

• Runs on the server, not in the extension.
• Results are displayed in notification messages (for manual validation) or status bar (for save-triggered validation).
• Always uses detailed server validation messaging when the server returns report text.
• Always shows visible progress for long-running validation.
• Runs automatically on save and can also be triggered manually.

When each validation runs:

• On type: fast syntax feedback only.
• On save: heavy Aspect validation for Turtle documents.
• Manual: Turtle: Validate document now for the active Turtle document.

Commands

• Turtle: Validate document now
  • Sends a server request for the active Turtle document.
• Turtle: Select SAMM CLI Executable
  • Opens a quick pick with the latest 10 GitHub releases and a custom-path option.
• Turtle: Restart and reconnect to Language Server
  • Restarts the language server and reconnects the client.

UX During Long-Running Validation

• Manual validation shows a progress notification while the request is running.
• Save-triggered validation always uses a short status-bar progress indicator instead of repeated popups.
• After completion, the user gets a summary message with validation results.
• Automatic save validation keeps progress and completion feedback in the status bar.

Verify Go To Definition

Use samples/valid.ttl:

1. Open samples/valid.ttl.
2. Place the cursor on foaf:Person, foaf:name, or another prefixed name.
3. Run Go to Definition.
4. Confirm that VS Code jumps to the matching @prefix declaration.

Expected behavior:

• foaf:* resolves to @prefix foaf: ....
• ex:* resolves to @prefix ex: ....

Verify Aspect Validation

Use samples/org.eclipse.esmf.test/1.0.0/Aspect.ttl or samples/invalid.ttl.

Manual check:

1. Open an Aspect model file.
2. Run Turtle: Validate document now.
3. Wait for the progress indicator to finish.
4. Confirm that validation results appear in a notification message.

On-save check:

1. Save the model file.
2. Confirm that the status bar shows validation progress.
3. Confirm that a summary message appears in the status bar after completion.