🎉 new feature: save the output from the poly deps, info and libs commands

[DavidVujic]

The poly deps, poly info and poly libs commands have a new option available: --save. You'll find the new feature in the CLI v1.35.0 and in the Poetry plugin v1.42.0.

This will - in addition to printing the output as before - save the output to file. The file output has the emojis replaced with standard characters.

Saving the result from the deps, info and libs commands is useful during Pull Requests, and when reviewing code. Besides the actual code diff, the changes in the saved commands will give the reviewer an overview of what has changed from an architecture point of view. You will be able to get an overview of changes in coupling between bricks, and dependencies.

The poly deps command is probably the most useful command for this kind of scenario, having the details about how the bricks are related to each other.

The idea comes from the discussion #365

Example usage

This view shows that the brick usages has been changed. The stored command output is a versioned file, and (when updating it from the feature branch) you will get an overview over the deps.

Configurable output location

By default, the command output will be saved to development/poly/<the command>.txt, but you can configure where to save it.
Example configuration:

[tool.polylith.commands]
output = "somewhere/else"

Or, configure output location by command:

[tool.polylith.commands.deps]
output = "somewhere/else"

[DavidVujic]

The documentation will be updated shortly, containing the new feature and how to configure it.

[gwdekker]

Interesting! Will have a look soon to see if I can make this work for us.