Documentation

This is most likely the function you want to use. It takes a file type template as an argument, along with what you want displayed when the user opens the editor. It then runs the editor, and returns the version of the text that the user modified.

Examples:

>>> :set -XOverloadedStrings
>>> runUserEditorDWIM jsonTemplate "{\n\n}\n"

This will open up the user's $EDITOR configured to edit JSON, and with the initial text:

{
}

There are a bunch of templates. See the "File-type extensions" section. It's also trivially easy to make your own templates. Say you want one for, I dunno, Python:

pythonTemplate = mkTemplate "py"

The argument to mkTemplate should be the file extension you want. In that case, I used "py", because Python's file extension is .py.

This is the same as above, it just takes a file as an argument instead of the ByteString

runUserEditorDWIMFile templ fp = B.readFile fp >>=  runUserEditorDWIM templ

Open up the user's editor with no initial contents.

This is probably the second-simplest function.

Make a template

mkTemplate ext = _ftempl <> "." <> ext

>>> mkTemplate "blah"
tmp.blah

File-type template for HTML

htmlTemplate = mkTemplate "html"

File-type template for JSON

jsonTemplate = mkTemplate "json"

File-type template for Markdown

markdownTemplate = mkTemplate "md"

Older file-type template for Markdown

markdownTemplate = mkTemplate "markdown"

File-type template for plain text

plainTemplate = mkTemplate "txt"

File-type template for XML

xmlTemplate = mkTemplate "xml"

Same as plainTemplate

File-type template for YAML

yamlTemplate = mkTemplate "yaml"

Open an editor. You probably don't want to use this function.

This uses getEnv from System.Posix to attempt to get the user's $EDITOR variable. Failing that, try the $VISUAL variable.

Wrapper around userEditor that includes a fallback option if the $EDITOR variable doesn't exist. userEditorDefault def = userEditor >>= case Just e -> return e Nothing -> return def

The default editor if no other editor is found

_default_editor = "vi"

The list of variables we should search when finding the user's editor.

_editor = ["EDITOR", "VISUAL"]

Since: 0.6.0.0

The standard filename template

_ftempl = "tmp"

If you don't want to use ByteString, use this function.

>>> :type runUserEditorDWIM plainTemplate mempty
IO ByteString
>>> :type fmap wrapStr (runUserEditorDWIM plainTemplate mempty)
IO String