Presenting Content type property diff

[SteveL-MSFT]

Summary of the new feature / enhancement

The discussion from the WG regarding the FileContent resource was around how to present to the user which line in the content was different rather than just indicating the entire content property was different.

Proposed technical implementation details (optional)

Resource can optionally return the diff if it implements test directly. However, this is currently expected to be a list of properties that differ. We can enhance this by adding a structured syntax to identify a specific line. For example:

content:200

This would indicate that line 200 in property content differs.

[ThomasNieto]

Question, why do we want DSC to do this type of diff? If there is a content property shouldn't the resource return the actual state back to DSC and let a higher order tool handle rich diffs?

[SteveL-MSFT]

Thomas Nieto (@ThomasNieto) this was part of the discussion today in the WG. Without any change, the diffProperties would simply show content was different. The intent is that it would be helpful to the user since resources today can return stateAndDiff to be allowed to return more detailed diff. In this case, the line number.

The other idea discussed today was an extension point so a TUI could be written to show a side-by-side diff, but of course higher order tools can perform their own diff and show those results. I think one question is even for higher order tools, something like content:200 (meaning the content property, line 200) would make it easier for that higher order tool to show the diff than for it to replicate how the engine and resources determine diffs.

[ThomasNieto]

I'm a little confused why would no change result in diffProperties show content was different?

[SteveL-MSFT]

I'm a little confused why would no change result in diffProperties show content was different?

If content has NOT changed, then it wouldn't show. We're talking about the case where the file content has changed and making it easier for the user to identify the difference.