conf

 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.
InlayHints		Options for inlay hints.
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 token, 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.
NameHintPreference		Hinted name preference
Toggle		Toggle option
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 
Never 

class OptionalKw

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

Always 
AsNeeded 

class OptionalToken

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

Never 
Always 
OnBreak 

class MultiOrder

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

Ordered 
Nonunique 

class OptionalKwToken

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

Token 
Keyword 
none 

class KwToken

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

Token 
Keyword 

class MultiPlacement

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

First 
FirstSpecialization 
Last 

class OperatorBreak

Whether to place operators before line break, or after.

Before 
After 

class FloatFormat

Synthetic float format

none 
Exp 
Prec 

class NullFormat

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

Null 
Brackets 

class MultiplicityBoundType

Type to check multiplicity range bounds expression result against.

Integer 
Natural 

class DiagnosticSeverity

Severity of a lint rule.

Error 
Warning 
Information 
Hint 
Off 

class NameHintPreference

Hinted name preference

Both 
PreferRegular 
PreferShort 
Shortest 
Longest 
Off 

class Toggle

Toggle option

On 
Off 
Explicit 

class CrashTelemAction

Action to take on crash in regard to crash reports.

Ignore 
Upload 

class Edit

LSP editing scope.

All 
External 
Project 