conf

 Index

 Classes 

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

 Functions 

load_config

Load Config from the given path.

 Enumerations 

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

---

󰊕 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 CrashTelemAction

Action to take on crash in regard to crash reports.

Ignore 
Upload 

class DiagnosticSeverity

Severity of a lint rule.

Error 
Warning 
Information 
Hint 
Off 

class Edit

LSP editing scope.

All 
External 
Project 

class FloatFormat

Synthetic float format

none 
Exp 
Prec 

class KwToken

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

Token 
Keyword 

class MultiOrder

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

Ordered 
Nonunique 

class MultiPlacement

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

First 
FirstSpecialization 
Last 

class MultiplicityBoundType

Type to check multiplicity range bounds expression result against.

Integer 
Natural 

class NameHintPreference

Hinted name preference

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

class NullFormat

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

Null 
Brackets 

class OperatorBreak

Whether to place operators before line break, or after.

Before 
After 

class OptionalKw

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

Always 
AsNeeded 

class OptionalKwToken

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

Token 
Keyword 
none 

class OptionalToken

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

Never 
Always 
OnBreak 

class Toggle

Toggle option

On 
Off 
Explicit 