Essentials icon indicating copy to clipboard operation
Essentials copied to clipboard

[FEATURE]-Improve Format of Joinmap Reporting

Open TrevorPayne opened this issue 3 years ago • 1 comments

Is your feature request related to a problem? Please describe. The joinmap reporting format is less than ideal for a human to parse.

Describe the solution you'd like The data reporting should be arranged to front load data that has less variable length, and those fields should be a fixed width to align pipe characters. Description Data should be the last piece of data reported because of the high variability in length

Describe alternatives you've considered Ignoring the reportjoinmap completely, but that relies on people documenting their plugins.

Additional context Perhaps we need to subvert the Debug.Console method here, because it provides additional context that manifests and uesless noise in the context of looking at the data you explicitly requested - perhaps we can leave the current "as is" and add some options to the command.

TrevorPayne avatar Mar 30 '22 21:03 TrevorPayne

It might be better here to use the CrestronConsole.ConsoleCommandResponse for printing the response to the printjoinmaps command. That along with the reordering of the data would make a lot of sense.

We should also take a look at #905 while we're adjusting this method.

andrew-welker avatar Mar 31 '22 00:03 andrew-welker

I've since implemented GetJoinmapMarkdown as an alternative to this that saves joinmap data to a markdown file on the processor that can be easily parsed, and even be used for rudimentary documentation of the joins.

TrevorPayne avatar Feb 17 '23 05:02 TrevorPayne

I was able to leverage the existing GetJoinmapMarkdown implementation to clean up joinmap printing.

Here's some example output;

image

TrevorPayne avatar Feb 17 '23 06:02 TrevorPayne

Merged to dev - marking closed

TrevorPayne avatar Feb 17 '23 16:02 TrevorPayne