Configuration
To support platter watch and platter build (see Command Line for more details), a platter configuration is generated in a project's package.json file where applicable. That configuration has the following shape by default:
...where resource is the kind of resource being created (e.g. postgres), and resource-unique-id is a unique ID for a resource generated by Platter. The remaining properties are specified at creation time through flags or through interactive prompts.
info
platter watch will support client-less, direct connections in the future. If this is a feature that you'd like, please email us at [email protected]
Client Options#
autoBranch#
Defaults to true. Specifies whether or not the resource can be watch-ed by platter watch, and whether it tracks the local git branch. If set to true, clients for the resource are compiled with a default branch of either $BRANCH from the environment (useful for continuous integration and other one-off builds) or a local git branch (useful for fast iteration on local feature branches).
directory#
Specifies the output directory for clients. If specified, this directory can be safely ignored in version control through e.g. .gitignore (much like node_modules is often ignored).