formulaic/NOTES.md

26 lines
764 B
Markdown

As this is my third Go project and remarkably like my git-linter project, I've
decided to try and keep the same sort of documentation path I chose for that
project.
# Strategies
formulaic uses a variety of strategies that it passes through to understand
what to do.
1. Parse the command line.
2. Read in the configuration file, in the following order (so later
keys override earlier keys):
a. From formulaic.[toml|json|yaml]
b. From $HOME/.formulaic/config.[toml|json|yaml]
c. As specified as a filename on the command line
d. As specified as key-value pairs on the command line.
3. Find or pull down the requested template.
4. Unless otherwise specified, make queries as specified in the formulaic
configuration.
5. Generate the project