OML Code

Professional VS Code extension for the Ontological Modeling Language (OML) with advanced semantic reasoning, SPARQL querying, interactive diagram visualization, and SHACL validation.

✨ Features

🎯 Language Support

• Syntax Highlighting - Rich syntax coloring for OML files
• IntelliSense - Code completion, hover information, and signature help
• Validation - Real-time semantic validation with detailed diagnostics
• Formatting - Automatic code formatting
• Rename Refactoring - Safe symbol renaming across files

🧠 Semantic Reasoning

• OWL/RDF Reasoning - Full semantic reasoning engine using N3 Store
• SPARQL Queries - Execute SPARQL queries against your ontologies using Comunica
• Knowledge Graph - Build and query semantic knowledge graphs

📊 Interactive Diagrams

• Visual Ontology Diagrams - Automatic diagram generation from OML models
• ELK Layout Engine - Professional graph layouts with Eclipse Layout Kernel
• Interactive Navigation - Click elements to navigate to source code
• Arrange Command - Re-layout diagrams on demand

📝 Markdown Integration

• OML Markdown Preview - Enhanced markdown preview with OML-specific features
• Embedded SPARQL - Execute SPARQL queries in markdown frontmatter
• Live Tables & Charts - Visualize query results with interactive tables and charts

✅ SHACL Validation

• Constraint Checking - Validate OML models against SHACL shapes
• Detailed Reports - Clear validation error messages

🌐 Works Everywhere

• Desktop Mode - Full-featured desktop VS Code support
• Browser Mode - Complete feature parity in vscode.dev and github.dev

🚀 Getting Started

Prerequisites

• VS Code version 1.67.0 or higher
• Authentication Required - GitHub or Microsoft account

Installation

1. Install from VS Code Marketplace
2. Sign in when prompted (GitHub or Microsoft)
3. Open any .oml file to activate the extension

First Time Setup

On first activation, OML Code will prompt you to authenticate with GitHub or Microsoft. This is required to use the extension.

If you skip authentication initially, you can sign in later via:

• Command Palette → OML Code: Sign In

To sign out:

• Command Palette → OML Code: Sign Out
• Then use the Accounts menu (bottom-left) to fully sign out from your authentication provider

📖 Usage

Working with OML Files

1. Create or open a .oml file
2. Start typing to experience IntelliSense
3. Hover over symbols for documentation
4. Use F2 to rename symbols

Generating Diagrams

1. Open an OML file
2. Right-click in editor → OML: Open Diagram
3. Use the Arrange button to re-layout
4. Click diagram elements to jump to code

Markdown with SPARQL

1. Create a .md file
2. Add OML code blocks with sparql queries or shacl shapes
3. Open with OML Markdown Preview
4. View query results as interactive tables or charts

⚙️ Configuration

Access settings via File → Preferences → Settings → search for "OML"

Language Server Mode

"oml.languageServer.mode": "node-ls"

Options: node-ls (desktop), browser-ls (web)

Authentication Provider

"oml.auth.provider": "github"

Options: github, microsoft

Authentication Scopes

"oml.auth.scopes": ["user:email"]

User Authorization

Contact info@modelware.io to sign up as a beta tester

🔒 Privacy & Authentication

OML Code uses VS Code's built-in authentication API with GitHub or Microsoft. Authentication is required to:

• Activate the extension
• Access all language features
• Generate diagrams
• Execute SPARQL queries

Your authentication tokens are managed securely by VS Code. No credentials are stored by the extension.

📦 What's Included

• Full OML Language Server with semantic analysis
• Reasoning Engine (N3 Store + OWL/RDFS)
• SPARQL Query Engine (Comunica)
• Diagram Generator (ELK + Sprotty)
• SHACL Validator
• Markdown Preview with query execution

📝 Feedback & Support

• Homepage: https://www.modelware.io/oml-code/
• Issues: GitHub Issues
• Documentation: OML Language Reference

📄 License

This extension is commercial software requiring a subscription. See LICENSE for details.

Copyright © 2026 Modelware. All rights reserved.

Enjoy semantic modeling with OML Code! ✨