conf

Configuration related types and functionality.

Index

Classes ¶

FormatPreserved		Formatting option that can either be preserved from source, or overridden.
SynthOptions		Options for printing synthetic elements.
BreakOptions		Options for inserting line breaks.
WhileLoopParentheses		Options for parenthesizing expressions in while loops.
MergeOptions		Options for merging consecutive declaration relationships.
BinaryEndsFormat		Options for binary ends formatting:
RedefinesKeyword		Options for redefines keyword formatting.
ActionKeyword		Options for action keyword formatting:
OccurrenceKeyword		Options for occurrence keyword formatting:
FirstKeyword		Options for first keyword formatting:
OfKeyword		Options for of keyword formatting:
RefKeyword		Options for ref keyword formatting:
FromKeyword		Options for from keyword formatting.
FeatureKeyword		Options for feature keyword formatting (KerML).
SpecializationKeyword		Options for specialization keyword formatting in member relationships (KerML).
CommaOptions		Options for trailing comma placement.
ParenthesesFormat		Options for expression parentheses formatting:
DeclFormat		Format options for declarations
KeywordOptions		Options for keyword formatting
FormatOptions		Formatter options for Syside
Lint		Configuration for validations and lints.
ImpliedRedefinitionHints		Options for implicit redefinitions.
ConstantHint		Whether to show the constant keyword on implicitly constant features in SysML.
RefHint		Whether to show the ref keyword on non-composite features in SysML.
EffectiveNameHints		Inlay hint options for effective names.
ImpliedHeritageHints		Options for implicit specialization hints.
SuccessionSourceHints		Whether to show the implicitly computed succession and transition sources.
InlayHints		Options for inlay hints.
Hover		Options for LSP hover provider that displays documentation of elements under the cursor.
Telemetry		Telemetry options.
Lsp		Syside LSP options.
Format		Formatter options for Syside
Config		Syside configuration using TOML 1.0. See TOML page for more details.

Functions ¶

load_config

Load Config from the given path.

Enumerations ¶

AlwaysNever		An option to always print some token, or never.
OptionalKw		An option to always print some keyword, or as-needed.
OptionalToken		An option to always print some token, never print, or print on-break due to line width limits.
MultiOrder		Whether to place ordered, or nonunique, first when printing multiplicity ranges.
OptionalKwToken		An option to print a non-word token, word keyword, or none.
KwToken		An option to print a non-word token, or word keyword.
MultiPlacement		An option to control multiplicity range placement relative to declaration specializations.
OperatorBreak		Whether to place operators before line break, or after.
FloatFormat		Synthetic float format
NullFormat		Whether to print null expressions as null, or ().
MultiplicityBoundType		Type to check multiplicity range bounds expression result against.
DiagnosticSeverity		Severity of a lint rule.
RedefinitionEndConformance		The scope of redefinition-end-conformance diagnostic.
NameHintPreference		Hinted name preference
Toggle		Toggle option
PathResolution		Kind of paths to resolve in hover contents.
CrashTelemAction		Action to take on crash in regard to crash reports.
Edit		LSP editing scope.

---

Functions

load_config(arg: str | os.PathLike[AnyStr], /) → syside.conf.Config

Load Config from the given path.

Raises FileNotFoundError if there is no such file. Raises RuntimeError if parsing fails otherwise.

Enumerations

class AlwaysNever

An option to always print some token, or never.

Always ¶	Always print a token.
Never ¶	Never print a token.

class OptionalKw

An option to always print some keyword, or as-needed.

Always ¶	Always print a keyword.
AsNeeded ¶	Only print a keyword if required by the grammar.

class OptionalToken

An option to always print some token, never print, or print on-break due to line width limits.

Never ¶	Never print a token.
Always ¶	Always print a token.
OnBreak ¶	Only print a token if the line breaks.

class MultiOrder

Whether to place ordered, or nonunique, first when printing multiplicity ranges.

Ordered ¶	Print ordered before nonunique.
Nonunique ¶	Print nonunique before ordered.

class OptionalKwToken

An option to print a non-word token, word keyword, or none.

Token ¶	Print a non-word token.
Keyword ¶	Print a keyword.
none ¶	Print nothing.

class KwToken

An option to print a non-word token, or word keyword.

Token ¶	Print a non-word token.
Keyword ¶	Print a keyword.

class MultiPlacement

An option to control multiplicity range placement relative to declaration specializations.

First ¶	Print multiplicity before any other specializations.
FirstSpecialization ¶	Print multiplicity after the first specialization.
Last ¶	Print multiplicity after all other specializations.

class OperatorBreak

Whether to place operators before line break, or after.

Before ¶	Print an operator before a line break.
After ¶	Print an operator after a line break.

class FloatFormat

Synthetic float format

none ¶	Use default formatting.
Exp ¶	Use exponential notation.
Prec ¶	Use general format.

class NullFormat

Whether to print null expressions as null, or ().

Null ¶	Print null expressions as null.
Brackets ¶	Print null expressions as ().

class MultiplicityBoundType

Type to check multiplicity range bounds expression result against.

Integer ¶	Test multiplicity bound type against Integer (specification).
Natural ¶	Test multiplicity bound type against Natural.

class DiagnosticSeverity

Severity of a lint rule.

Error ¶	Reports an error.
Warning ¶	Reports a warning.
Information ¶	Reports an information.
Hint ¶	Reports a hint.
Off ¶	Disables the lint entirely.

class RedefinitionEndConformance

The scope of redefinition-end-conformance diagnostic.

Standard ¶	Standard behaviour that only diagnoses end conformance on associations and connectors.
All ¶	Old behaviour that diagnoses end conformance on all types.

class NameHintPreference

Hinted name preference

Both ¶	Hint both names.
PreferRegular ¶	Hint only regular name, or short name otherwise.
PreferShort ¶	Hint only short name, or regular name otherwise.
Shortest ¶	Hint only the shortest name.
Longest ¶	Hint only the longest name.
Off ¶	Disable name hints.

class Toggle

Toggle option

On ¶	Default behaviour is enabled.
Off ¶	Default behaviour and all nested options are disabled.
Explicit ¶	Default behaviour is disabled. Same as on if there is no default behaviour not covered by nested options.

class PathResolution

Kind of paths to resolve in hover contents.

Off ¶	Disable path resolution
Relative ¶	Enable path resolution for relative paths that match given extensions

class CrashTelemAction

Action to take on crash in regard to crash reports.

Ignore ¶	Crash reports are not uploaded and remain completely local.
Upload ¶	Crash reports are uploaded, local report remains.

class Edit

LSP editing scope.

All ¶	Allows renaming all symbols.
External ¶	Allows renaming project and external symbols, but not standard library.
Project ¶	Allows renaming only project symbols.