mdoc.internal.cli
package mdoc.internal.cli
Type members
Classlikes
case class Context(settings: Settings, reporter: Reporter, compiler: MarkdownCompiler, compilers: Map[(Set[Dependency], List[String]), MarkdownCompiler])
- Companion
- object
case class InputFile(relpath: RelativePath, inputFile: AbsolutePath, outputFile: AbsolutePath, inputDirectory: AbsolutePath, outputDirectory: AbsolutePath)
- Value Params
- inputDirectory
-
directory enclosing the input file.
- inputFile
-
the input file to read from.
- outputDirectory
-
directory enclosing the output file.
- outputFile
-
the output file to write to.
- relpath
-
the input filename relativized by its input directory.
- Companion
- object
case class MdocProperties(scalacOptions: String, classpath: String, site: Map[String, String], in: Option[List[AbsolutePath]], out: Option[List[AbsolutePath]])
- Companion
- object
case class Settings(@Section("Common options") @Description("The input directory or regular file containing markdown and other documentation sources that should be processed. ".+("Markdown files are processed by mdoc while non-markdown files are copied verbatim to the output directory. ").+("Can be repeated to process multiple input directories/files.")) @ExtraName("i") in: List[AbsolutePath], @Description("The output directory or regular file where you\'d like to generate your markdown or other documentation sources. ".+("Must be repeated to match the number of `--in` arguments and must be a directory when the matching `--in` argument is a directory.")) @ExtraName("o") out: List[AbsolutePath], @Description("Key/value pairs of variables to replace through @VAR@. ".+("For example, the flag \'--site.VERSION 1.0.0\' will replace appearances of \'@VERSION@\' in ").+("markdown files with the string 1.0.0")) site: Map[String, String], @Section("Compiler options") @Description("Classpath to use when compiling Scala code examples. ".+("Defaults to the current thread\'s classpath.").+("You can use Coursier\'s fetch command to generate the classpath for you:").+("`--classpath $(cs fetch --classpath org::artifact:version)`")) classpath: String, @Description("Space separated list of compiler flags such as \'-Xplugin:kind-projector.jar -deprecation -Yrangepos\'. ".+("Defaults to the value of \'scalacOptions\' in the \'mdoc.properties\' resource file, if any. ").+("When using sbt-mdoc, update the `scalacOptions` sbt setting instead of passing --scalac-options to `mdocExtraArguments`.")) scalacOptions: String, @Description("Use relative filenames when reporting error messages. ".+("Useful for producing consistent docs on a local machine and CI. ")) reportRelativePaths: Boolean, @Description("The encoding to use when reading and writing files.") charset: Charset, @Description("The working directory to use for making relative paths absolute.") cwd: AbsolutePath, @Hidden @Description("The width of the screen, used to line wrap pretty-printed objects.") screenWidth: Int, @Hidden @Description("The height of the screen, used to truncate large pretty-printed objects.") screenHeight: Int, @Hidden @Description("The Coursier logger used to report progress bars when downloading dependencies") coursierLogger: Logger)
- Companion
- object