Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.Generator.WriteSystem

Synopsis

Documentation

These are the default file-writing WriteOptions required for Drasil (the main Makefile will not play well otherwise).

Options:

overwritePolicy: Always allow file-overwriting.
dirName: The example's abbreviation.
textEncoding: UTF-8.
debugDataPolicy: Dependant on DEBUG_ENV environment variable being set, writing to a nested `.drasil` folder.

Arguments

:: ToFiles sys concOpts
=> sys	The system.
-> concOpts	The concretization options.
-> WriteOptions	The file-writing options.
-> IO ()	Files will be written to a local directory named after the abbreviation of the system.

Concretize a system into a concrete set of files and write them to disk.

Note: Writes files to a subdirectory of the current working directory.

Deprecated: Use concretizeAndWrite instead of directly setting system locale before file-writing.

Internal: Set system locale encoding to UTF-8.

Configuration options for writing a repository of software artifacts.

Constructors

WO
Fields overwritePolicy :: OverwritePolicy Are we allowed to overwrite files or not? localDirName :: forall sys. HasSystemMeta sys => sys -> PathSegment What is the name of the subfolder to be created? textEncoding :: TextEncoding What is the expected text encoding scheme? debugDataPolicy :: DebugDataPolicy Should debugging data be written?

When should debugging data be written?

Constructors

AlwaysWrite	Always.
Fields PathSegment The name of the directory to carry all debugging data files.
CheckEnvVar	Only write debugging data if the following environment variable (`String`) is non-empty.
Fields String The environment variable name. PathSegment The name of the directory to carry all debugging data files.
NeverWrite	Never.