Class/Object

org.scalafmt.cli

CliOptions

Related Docs: object CliOptions | package cli

Permalink

case class CliOptions(config: Option[Path] = None, configStr: Option[String] = None, range: Set[Range] = Set.empty[Range], customFiles: Seq[AbsoluteFile] = Nil, customExcludes: Seq[String] = Nil, writeMode: WriteMode = Override, testing: Boolean = false, stdIn: Boolean = false, quiet: Boolean = false, debug: Boolean = false, git: Option[Boolean] = None, nonInteractive: Boolean = false, diff: Option[String] = None, assumeFilename: String = "stdin.scala", migrate: Option[AbsoluteFile] = None, common: CommonOptions = CommonOptions(), gitOpsConstructor: (AbsoluteFile) ⇒ GitOps = x => new GitOpsImpl(x), noStdErr: Boolean = false) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CliOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CliOptions(config: Option[Path] = None, configStr: Option[String] = None, range: Set[Range] = Set.empty[Range], customFiles: Seq[AbsoluteFile] = Nil, customExcludes: Seq[String] = Nil, writeMode: WriteMode = Override, testing: Boolean = false, stdIn: Boolean = false, quiet: Boolean = false, debug: Boolean = false, git: Option[Boolean] = None, nonInteractive: Boolean = false, diff: Option[String] = None, assumeFilename: String = "stdin.scala", migrate: Option[AbsoluteFile] = None, common: CommonOptions = CommonOptions(), gitOpsConstructor: (AbsoluteFile) ⇒ GitOps = x => new GitOpsImpl(x), noStdErr: Boolean = false)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. val assumeFilename: String

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val common: CommonOptions

    Permalink
  8. val config: Option[Path]

    Permalink
  9. def configPath: Path

    Permalink

    - If --config-str is specified (and tempConfigPath is defined), this returns the path to a temporary file.

    - If --config-str is specified (and tempConfigPath is defined), this returns the path to a temporary file. - If both tempConfigPath and config are None, this return the path to .scalafmt.conf on the working directory.

    returns

    A path to a configuration file

  10. val configStr: Option[String]

    Permalink
  11. val customExcludes: Seq[String]

    Permalink
  12. val customFiles: Seq[AbsoluteFile]

    Permalink
  13. val debug: Boolean

    Permalink
  14. val diff: Option[String]

    Permalink
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def excludeFilterRegexp: Regex

    Permalink
  17. val fileFetchMode: FileFetchMode

    Permalink
  18. val files: Seq[AbsoluteFile]

    Permalink
  19. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  21. val git: Option[Boolean]

    Permalink
  22. val gitOps: GitOps

    Permalink
  23. val gitOpsConstructor: (AbsoluteFile) ⇒ GitOps

    Permalink
  24. val inPlace: Boolean

    Permalink
  25. def info: PrintStream

    Permalink
  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. val migrate: Option[AbsoluteFile]

    Permalink
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. val noStdErr: Boolean

    Permalink
  30. val nonInteractive: Boolean

    Permalink
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. val quiet: Boolean

    Permalink
  34. val range: Set[Range]

    Permalink
  35. def scalafmtConfig: Configured[ScalafmtConfig]

    Permalink

    Parse the scalafmt configuration and try to encode it to ScalafmtConfig.

    Parse the scalafmt configuration and try to encode it to ScalafmtConfig. If --config-str is specified, this will parse the configuration string specified by --config-str. Otherwise, a contents of configuration file specified by configPath will be parsed.

    If --config-str is not specified and configuration file is missing, this will return the default configuration

  36. val stdIn: Boolean

    Permalink
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. val testing: Boolean

    Permalink
  39. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def withFiles(files: Seq[AbsoluteFile]): CliOptions

    Permalink
  43. val writeMode: WriteMode

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped