mdoc
.
internal
.
cli
Settings
Related Docs:
object Settings
|
package cli
case class
Settings
(
in:
List
[
AbsolutePath
]
,
out:
List
[
AbsolutePath
]
,
watch:
Boolean
=
false
,
check:
Boolean
=
false
,
noLinkHygiene:
Boolean
=
false
,
verbose:
Boolean
=
false
,
site:
Map
[
String
,
String
] =
Map.empty
,
classpath:
String
=
""
,
scalacOptions:
String
=
""
,
cleanTarget:
Boolean
=
false
,
noLivereload:
Boolean
=
false
,
port:
Int
=
4000
,
host:
String
=
"localhost"
,
help:
Boolean
=
false
,
usage:
Boolean
=
false
,
version:
Boolean
=
false
,
markdownExtensions:
List
[
String
] =
List("md", "html")
,
include:
List
[
PathMatcher
] =
Nil
,
exclude:
List
[
PathMatcher
] =
Nil
,
reportRelativePaths:
Boolean
=
false
,
charset:
Charset
=
StandardCharsets.UTF_8
,
cwd:
AbsolutePath
,
stringModifiers:
List
[
StringModifier
] =
StringModifier.default()
,
postModifiers:
List
[
PostModifier
] =
PostModifier.default()
,
preModifiers:
List
[
PreModifier
] =
PreModifier.default()
,
inputStream:
InputStream
=
System.in
,
screenWidth:
Int
=
120
,
screenHeight:
Int
=
50
,
headerIdGenerator: (
String
) ⇒
String
=
GitHubIdGenerator
,
variablePrinter: (
Variable
) ⇒
String
=
ReplVariablePrinter
,
coursierLogger:
Logger
=
coursierapi.Logger.progressBars()
)
extends
Product
with
Serializable
Linear Supertypes
Serializable
,
Serializable
,
Product
,
Equals
,
AnyRef
,
Any
Ordering
Alphabetic
By Inheritance
Inherited
Settings
Serializable
Serializable
Product
Equals
AnyRef
Any
Hide All
Show All
Visibility
Public
All
Instance Constructors
new
Settings
(
in:
List
[
AbsolutePath
]
,
out:
List
[
AbsolutePath
]
,
watch:
Boolean
=
false
,
check:
Boolean
=
false
,
noLinkHygiene:
Boolean
=
false
,
verbose:
Boolean
=
false
,
site:
Map
[
String
,
String
] =
Map.empty
,
classpath:
String
=
""
,
scalacOptions:
String
=
""
,
cleanTarget:
Boolean
=
false
,
noLivereload:
Boolean
=
false
,
port:
Int
=
4000
,
host:
String
=
"localhost"
,
help:
Boolean
=
false
,
usage:
Boolean
=
false
,
version:
Boolean
=
false
,
markdownExtensions:
List
[
String
] =
List("md", "html")
,
include:
List
[
PathMatcher
] =
Nil
,
exclude:
List
[
PathMatcher
] =
Nil
,
reportRelativePaths:
Boolean
=
false
,
charset:
Charset
=
StandardCharsets.UTF_8
,
cwd:
AbsolutePath
,
stringModifiers:
List
[
StringModifier
] =
StringModifier.default()
,
postModifiers:
List
[
PostModifier
] =
PostModifier.default()
,
preModifiers:
List
[
PreModifier
] =
PreModifier.default()
,
inputStream:
InputStream
=
System.in
,
screenWidth:
Int
=
120
,
screenHeight:
Int
=
50
,
headerIdGenerator: (
String
) ⇒
String
=
GitHubIdGenerator
,
variablePrinter: (
Variable
) ⇒
String
=
ReplVariablePrinter
,
coursierLogger:
Logger
=
coursierapi.Logger.progressBars()
)
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
def
addSite
(
extraVariables:
Map
[
String
,
String
]
)
:
Settings
final
def
asInstanceOf
[
T0
]
:
T0
Definition Classes
Any
val
charset
:
Charset
val
check
:
Boolean
val
classpath
:
String
val
cleanTarget
:
Boolean
def
clone
()
:
AnyRef
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
...
)
val
coursierLogger
:
Logger
val
cwd
:
AbsolutePath
final
def
eq
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
val
exclude
:
List
[
PathMatcher
]
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
headerIdGenerator
: (
String
) ⇒
String
val
help
:
Boolean
val
host
:
String
val
in
:
List
[
AbsolutePath
]
val
include
:
List
[
PathMatcher
]
val
inputStream
:
InputStream
def
isExplicitlyExcluded
(
path:
RelativePath
)
:
Boolean
def
isFileWatching
:
Boolean
def
isIncluded
(
path:
RelativePath
)
:
Boolean
final
def
isInstanceOf
[
T0
]
:
Boolean
Definition Classes
Any
val
isMarkdownFileExtension
:
Set
[
String
]
val
markdownExtensions
:
List
[
String
]
final
def
ne
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
val
noLinkHygiene
:
Boolean
val
noLivereload
:
Boolean
final
def
notify
()
:
Unit
Definition Classes
AnyRef
final
def
notifyAll
()
:
Unit
Definition Classes
AnyRef
def
onLoad
(
reporter:
Reporter
)
:
Unit
val
out
:
List
[
AbsolutePath
]
lazy val
outputByInput
:
Map
[
AbsolutePath
,
AbsolutePath
]
val
port
:
Int
val
postModifiers
:
List
[
PostModifier
]
val
preModifiers
:
List
[
PreModifier
]
val
reportRelativePaths
:
Boolean
val
scalacOptions
:
String
val
screenHeight
:
Int
val
screenWidth
:
Int
val
site
:
Map
[
String
,
String
]
val
stringModifiers
:
List
[
StringModifier
]
final
def
synchronized
[
T0
]
(
arg0: ⇒
T0
)
:
T0
Definition Classes
AnyRef
def
toInputFile
(
infile:
AbsolutePath
)
:
Option
[
InputFile
]
def
toString
()
:
String
Definition Classes
Settings
→ AnyRef → Any
val
usage
:
Boolean
def
validate
(
logger:
Reporter
)
:
Configured
[
Context
]
val
variablePrinter
: (
Variable
) ⇒
String
val
verbose
:
Boolean
val
version
:
Boolean
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
(
...
)
val
watch
:
Boolean
def
withProperties
(
props:
MdocProperties
)
:
Settings
def
withWorkingDirectory
(
dir:
AbsolutePath
)
:
Settings
Inherited from
Serializable
Inherited from
Serializable
Inherited from
Product
Inherited from
Equals
Inherited from
AnyRef
Inherited from
Any
Ungrouped