Configs for Code Scrawl
To know:
- Configs go in
PROJECT_ROOT/.scrawl.jsonorPROJECT_ROOT/.config/scrawl.json - In cli
scrawl --boolAttributeorscrawl -strAttribute strValueto override yourjsonconfigurations.-
--boolAttributepresence means "setboolAttributeto true"
-
- Your
.jsonfile is loaded byTlf\Cli(when you use thescrawlcommand). If you instantiateTlf\Scrawl($projectDir, $configs)in PHP, you'd have to load up configs yourself. -
--deleteExistingDocsis a DANGEROUS feature. Iftruein your.jsonor provided in yourscrawlcall, your entiredocsfolder will be deleted when runningscrawl. - Configs in the PHP array provided to
Tlf\Scrawldo NOT use-or--. This is purely for predictable cli input parsing. -
--markdown.preserveNewLinesAdds 2 spaces at the end of every line to ensure Markdown parsers separate those lines in output.- Defaults
true... thus MUST be disabled through.json
- Defaults
- There's also a
-scrawl.extconfig option to load additional extensions. See the config file for this package for an example.- @TODO properly document
-scrawl.extconfig.
- @TODO properly document
Available configs & their default values:
All default values are determined/picked in the Tlf\Cli class
- dir.docs:
docsordocordoc - dir.template:
docs-srcordoc-srcordocs-src - dir.code:
srcorcodeorsrc - file.conf:
.config/scrawl.jsonor.scrawl.jsonor.config/scrawl.json - file.code.ext:
* - file.template.ext:
.src.md - deleteExistingDocs:
false - markdown.preserveNewLines:
true - markdown.prependGenNotice:
true - scrawl.ext:
[] - readme.copyFromDocs:
true