Settings in the editor

The Syside VS Code Extension adds these settings to the editor that hosts it: VS Code, or a compatible editor such as Cursor, Kiro or VSCodium. All sit under syside.* and work the same in every host. Where a setting mirrors a syside.toml option, the editor value takes priority when set. For where these settings fit among the configuration files, see how configuration is discovered and merged.

Tip

VS Code has two types of settings: User and Workspace. User settings are meant for personal settings that apply to all of your projects. If you work in a team or have settings that should only apply to one project, consider using Workspace settings instead. For more information, refer to the VS Code settings documentation.

General settings

  • syside.path – Overrides the path to the Syside language server executable. If this setting is not set, the extension uses the language server it ships with.

  • syside.include – Additional files and/or directories to analyze. Equivalent to the include configuration option. If set, this takes priority.

  • syside.exclude – Files and/or directories to omit from analysis. Equivalent to the exclude configuration option. If set, this takes priority.

  • syside.stdlib – Equivalent to the std configuration option. If set, this takes priority.

  • syside.completionLimit – Equivalent to the lsp.completion-limit configuration option. If set, this takes priority.

SysML settings

  • syside.lineLength – Equivalent to the format.line-width configuration option. If set, this takes priority. The formatter does not have automatic paragraph wrapping for long comments, docs and notes. To help with comment, docs, and notes line lengths, Sensmetry recommends also setting the Visual Studio Code’s in-built editor.rulers setting to the same value, which will show you a ruler at the given character limit, enabling you to manually break down your comments according to the limit.

  • syside.edit – Equivalent to the lsp.edit configuration option. If set, this takes priority.

Logging

  • syside.log – Overrides the path to the log file of the Syside language server. If this setting is not set, Syside will use the default log file created in a location designated by Visual Studio Code. The currently used active log file’s path can be found in Visual Studio Code’s Output > Syside pane. Syside attempts to rotate log files, however this may fail on certain configurations, e.g. Windows and VS Code when the log file is open in another process, in which case the log file will be overwritten.

  • syside.logLevel – Controls how much information Syside should record in the log file. Currently available options, listed from the most verbose to the least verbose:

    • trace – Should not be used day-to-day, only for troubleshooting. Contains all language server communication messages and their contents, leading to huge log files.

    • debug – Should not be used day-to-day, only for troubleshooting. Contains all language server communication messages, leading to huge log files.

    • info – The default. Good for day-to-day usage.

    • warning

    • error

    • critical

    • off – Completely disables any logging.

  • syside.telemetry.crashReports – Equivalent to the telemetry.crash-reports configuration option. If set, this takes priority. Additionally, crash reports can also be disabled by setting the VS Code-wide telemetry.telemetryLevel setting to off. For more information refer to What data we collect.

Diagram visualization

Syside draws the diagrams in diagram panels.

  • syside.visualization.defaultElementRendering – Layout used by the Syside: Visualize element command and the Ctrl/Cmd+Alt/Option+E shortcut, either asNestedDiagram (the default) or asTreeDiagram. The right-click menu always offers an explicit choice regardless of this setting.

  • syside.visualization.defaultDepth – How many levels of nested elements a diagram of an element or a whole file draws, 3 by default. A positive integer, or -1 for every level. A view keeps the depth it defines in the model. The Depth control in the panel changes it for one diagram.

  • syside.alwaysShowTitleBarMenu – Shows the Syside logo menu in the top right of every editor tab. On by default. Turn it off to hide the logo. Its commands stay available through the Command Palette.

The [viz] settings in syside.toml style and filter these diagrams. See Diagram settings for the full list.