Syside Editor

Essential and performant SysML v2 language support in VS Code

Syside Editor is a free and powerful SysML v2 textual editing and analysis tool, providing essential and performant functionality to work with SysML v2 and KerML languages.

Table of Contents

• Getting Started
• Syside Tools: Editor vs Pro Suite
• Features
  • Model validation
  • Semantic highlighting
  • Model navigation
  • Documentation on hover
  • Renaming
  • Document outline
  • References
  • Folding
  • Auto-completion
  • Auto-formatting
• Configuration
  • Configuring VS Code
    • Override the path to the Syside executable
    • Override the path to the standard library
    • Control the internal log level
    • Override the path to the log file
    • Include additional files and directories as external libraries
    • Exclude files and directories from analysis
    • Configure line length for automatic formatting
  • Available commands
• Troubleshooting

Getting Started

1. Install Syside Editor from the VS Code marketplace
2. Open any SysML v2 file (.sysml) and the extension will activate
3. Explore features (see Editor documentation)

Got questions, concerns or ideas? Talk to us directly at our Community Forum or reach out to syside.support@sensmetry.com.

Syside Tools: Editor vs Pro Suite

Syside Editor delivers essential SysML v2 language textual editing support. Syside Pro Suite is a comprehensive SysML v2 tool suite for professionals. The Pro Suite tools include:

• Syside Modeler providing powerful SysML v2 modeling & productivity features, including SysML v2 diagram visualization, command line interface, and more.
• Syside Automator - Industry-leading SysML v2 processing engine with Python API unlocking unlimited scripting and automation possibilities, incl. code & documentation generation, model validation, simulation, tool integration, and custom application development.

Learn about Pro Suite →

Features

The extension provides core features to support SysML v2 document editing:

Model validation

Catch errors early with real-time diagnostics for syntax errors, type mismatches, and constraint violations.

Semantic highlighting

Quickly identify element types and model structure through visual styling based on semantic meaning.

Model navigation

Navigate your model efficiently by jumping to definitions, finding references, and traversing specialization hierarchies across files.

Documentation on hover

Access element documentation, type information, and metadata instantly without leaving your current context.

Renaming

Rename elements safely across your entire workspace with automatic updates to all references.

Document outline

Navigate quickly to any element using a hierarchical tree view that provides structural overview of the currently opened document.

References

Understand the impact of changes by finding all locations where an element is referenced.

Folding

Improve readability by collapsing and expanding sections based on syntactic structure.

Auto-completion

Write SysML v2 code faster with context-aware suggestions for keywords, element names, and qualified references.

Auto-formatting

Maintain consistent code style with automatic indentation, spacing, and alignment.

Configuration

You can customize Syside Editor to fit your workflow by utilising configuration options. Refer to the Syside Editor documentation for a full list of settings available in the extension.

Configuring VS Code

Override the path to the Syside executable

{
  "syside.path": "/path/to/syside"
}

Note: This extension does not bundle the Syside executable, but instead downloads it automatically, if this setting is not set.

Override the path to the standard library:

{
  "syside.stdlib": "/path/to/sysml.library"
}

Control the internal log level:

{
  "syside.logLevel": "trace"
}

Override the path to the log file:

{
  "syside.log": "/path/to/syside.log"
}

Include additional files and directories as external libraries:

{
  "syside.include": ["/path/to/external/lib", "/another/path/**/*.sysml"]
}

Supports glob patterns.

Note: Syside does not include files and directories starting with . character (hidden files on Unix) by default, they must be provided explicitly.

Exclude files and directories from analysis:

{
  "syside.exclude": ["build/**", "temp/**", "*.tmp"]
}

Supports glob patterns.

Configure line length for automatic formatting:

{
  "syside.lineLength": 100
}

Available commands

Syside Editor provides the following commands through the Command Palette:

• Syside: Restart Language Server - Restarts the language server without the need to restart the whole Visual Studio Code window.
• Syside: Show log file - Opens the log file containing Syside logs for troubleshooting

Troubleshooting

Having issues with Syside Editor? Here's how to get help:

Problems installing or activating:

• Check your internet connection. Syside Editor does not bundle the language server executable, but rather downloads it on first activation (unless the syside.path setting is set).
• Check whether the syside.path setting is empty or correct. Syside Editor does not check whether the set path is correct. If the extension does not activate, consider resetting the syside.path setting and allowing Editor to download a new executable automatically.

Note for Windows users: archive extraction uses tar.exe which is provided by Windows 10+ since 2018-07. If this fails for any reason, download and extract binaries manually, and set syside.path configuration option to the extracted syside.exe.

For general problems:

• Check the Syside output panel for error messages
• Use the Syside: Show log file command to access logs
• Review our troubleshooting guide for common solutions

If Syside crashes:

• Check the Syside output panel for crash details
• Use the Syside: Show log file command to access logs
• Additionally, Developer Tools (Help > Toggle Developer Tools > Console) may contain additional error information that can be useful to us
• Include log files when reporting issues to our support team

Need more help? Reach out to us at syside.support@sensmetry.com or visit our Community Forum.

Developed by Sensmetry - Enabling Systems Integrated Digital Engineering to build superior systems much faster.