CompilerInitializationOptions

Represents the Compiler InitializationOptions that the client sends in during the initialize process. If the the client doesn't doesn't explicity send in anything, we default everything to None to signify the client didn't set this. This will then default to what is currently set (more than likely the defaults) in the PresentationCompilerConfigImpl.

completionCommand: command identifier to trigger completion.
isCompletionItemDetailEnabled: whether the CompletionItem.detail field should be populated.
isCompletionItemDocumentationEnabled: whether the CompletionItem.documentation field should be populated.
isCompletionItemResolve: whether the client wants Metals to handle completionItem/resolve
isHoverDocumentationEnabled: whether to include docstrings in a textDocument/hover.
isSignatureHelpDocumentationEnabled: whether the SignatureHelp.documentation field should be populated.
overrideDefFormat: whether the override should include a unicode icon or only ascii.
parameterHintsCommand: command identifier to trigger parameter hints.
snippetAutoIndent: whether the client defaults to adding the indentation of the reference line that the operation started on.

Linear Supertypes

Serializable, java.io.Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new CompilerInitializationOptions(completionCommand: Option[String], isCompletionItemDetailEnabled: Option[Boolean], isCompletionItemDocumentationEnabled: Option[Boolean], isCompletionItemResolve: Option[Boolean], isHoverDocumentationEnabled: Option[Boolean], isSignatureHelpDocumentationEnabled: Option[Boolean], overrideDefFormat: Option[String], parameterHintsCommand: Option[String], snippetAutoIndent: Option[Boolean])

completionCommand
command identifier to trigger completion.
isCompletionItemDetailEnabled
whether the CompletionItem.detail field should be populated.
isCompletionItemDocumentationEnabled
whether the CompletionItem.documentation field should be populated.
isCompletionItemResolve
whether the client wants Metals to handle completionItem/resolve
isHoverDocumentationEnabled
whether to include docstrings in a textDocument/hover.
isSignatureHelpDocumentationEnabled
whether the SignatureHelp.documentation field should be populated.
overrideDefFormat
whether the override should include a unicode icon or only ascii.
parameterHintsCommand
command identifier to trigger parameter hints.
snippetAutoIndent
whether the client defaults to adding the indentation of the reference line that the operation started on.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val completionCommand: Option[String]

command identifier to trigger completion.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val isCompletionItemDetailEnabled: Option[Boolean]

whether the CompletionItem.detail field should be populated.
val isCompletionItemDocumentationEnabled: Option[Boolean]

whether the CompletionItem.documentation field should be populated.
val isCompletionItemResolve: Option[Boolean]

whether the client wants Metals to handle completionItem/resolve
val isHoverDocumentationEnabled: Option[Boolean]

whether to include docstrings in a textDocument/hover.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isSignatureHelpDocumentationEnabled: Option[Boolean]

whether the SignatureHelp.documentation field should be populated.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val overrideDefFormat: Option[String]

whether the override should include a unicode icon or only ascii.
val parameterHintsCommand: Option[String]

command identifier to trigger parameter hints.
val snippetAutoIndent: Option[Boolean]

whether the client defaults to adding the indentation of the reference line that the operation started on.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object CompilerInitializationOptions | package pc

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val completionCommand: Option[String]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val isCompletionItemDetailEnabled: Option[Boolean]

val isCompletionItemDocumentationEnabled: Option[Boolean]

val isCompletionItemResolve: Option[Boolean]

val isHoverDocumentationEnabled: Option[Boolean]

final def isInstanceOf[T0]: Boolean

val isSignatureHelpDocumentationEnabled: Option[Boolean]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val overrideDefFormat: Option[String]

val parameterHintsCommand: Option[String]

val snippetAutoIndent: Option[Boolean]

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped