package topkg-care
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=4b632b60137852bb72ff9c8cdc2e16ac5ece6473569e50963fef9c1e800a0933a516bea1107b04011645afa4a1e78893c82dbce0aa8de2970d4d6c6d0dd2fe02
doc/topkg_care/Topkg_care/Text/index.html
Module Topkg_care.Text
Text processing helpers.
Marked-up text files
Warning. Some of the following functions are not serious and can break on certain valid inputs in all sorts of fashion. To understand breakage bear in mind that they operate line-wise.
val flavour_of_fpath : Fpath.t -> flavour option
flavour_of_fpath p
determines a flavour according to the extension of p
as follows:
Some `Markdown
for.md
Some `Asciidoc
for.asciidoc
or.adoc
None
otherwise
val head : ?flavour:flavour -> string -> (string * string) option
head ~flavour text
extracts the head of the document text
of flavour flavour
(defaults to `Markdown
).
The head is defined as follows:
- Anything before the first header is discarded.
- The first header is kept in the first component
- Everything that follows until the next header of the same or greater level is kept discarding trailing blank lines.
val header_title : ?flavour:flavour -> string -> string
header_title ~flavour text
extract the title of a header text
of flavour flavour
(defaults to `Markdown
).
Toy change log parsing
val change_log_last_entry :
?flavour:flavour ->
string ->
(string * (string * string)) option
val change_log_file_last_entry :
Fpath.t ->
(string * (string * string), Bos_setup.R.msg) Bos_setup.result
change_log_file_last_entry file
tries to parse the last change log entry of the file file
using flavour_of_fpath
and and change_log_last_entry
.
Toy URI parsing
split_uri uri
splits uri
into a triple (scheme, host, path)
. If rel
is true
(defaults to false
), a leading "/"
in path
is removed.
Edit and page text
edit_file f
invokes the tool mentioned in the EDITOR
environment variable with f
and returns the exit code of the program.
find ~no_pager
is an optional pager command. If don't
is true
returns None
. Otherwise first consults the PAGER
environment variable, then tries less
or more
in that order. If the TERM
environment variable is "dumb"
or undefined unconditionaly returns None
.