This is a utility that aims to standardise the way we consume configurations when interacting with the Lagoon API via various tools.

The goal is to make it so that configuration for one tool can be used by another tool seamlessly as long as the configuration is in the expected location.

This utility is designed ONLY for the Lagoon API/UI/Auth interactions. If building a tool that has its own configurations, then a similar method of interacting with that tools configuration should leverage XDG in a similar manner but store the information in different files to remain independent of the core configuration.

Considerations

• This is only for core configuration for tools, additional configurations should write their own configuration management that leverages concepts from this package without touching the core config files it generates.
• Migrations from existing configurations to this new format should be handled within those tools
  • the lagoon-cli will have a migration hook that can prompt a user to migrate their configuration if an old one is detected.
  • lagoon-sync should probably have something similar for the core configuration.
• lagoon-sync has additional configurations for handling syncs of different components (rsync/dbs, etc), these should be handled separately to the core configuration, either within lagoon-syncs own configuration utility, or an extension of this utility.