Cli-microsoft365: Improve the default text output when upgrading an SPFx project

[wobba]

It might just be me, but when updating an SPFx solution using the CLI, I always output the report as an md file, and I always scroll to the summary to get the aggregated pieces of what I need to do.

So for me, having a default ouput as a file named something like upgrade-1.4.0-1.5.1.md, and also having the summary at the top and not at the bottom of the report would save me a few keystrokes and seconds :)

[waldekmastykarz]

Good suggestion. I like the idea of having default output set to md for the spfx project upgrade command.

With regards to the summary, would it help if on the top we had a quicklink that would take you to the summary section or do you browse it in md format and the link wouldn't be helpful at all?

[wobba]

I do browse it in MD format (typora) so a quick link would be just as useful in my case.

The other option would be output to text with easy to |less and copy paste what I needed..sections separated by ------. I'll try work a sample tomorrow on that part.

[waldekmastykarz]

The first change we could do easily. I'm curious about the second part as currently the text output is kind of useless with the resolutions which you need to do the upgrade. Thinking if the text mode shouldn't be merely a listing of the issues without any resolutions, but would that be helpful at all?

[wobba]

This is how I'd like to see the text output.

Console command
---------------------
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact
npm i @microsoft/[email protected] --save-exact -D
npm i @microsoft/[email protected] --save-exact -D
npm i @microsoft/[email protected] --save-exact -D
npm i [email protected] --save-exact -D

.yo-rc-json
------------
{
  "@microsoft/generator-sharepoint": {
    "version": "1.6.0"
  }
}

etc.

[waldekmastykarz]

So for the text output, you'd like resolutions grouped per file/type without additional explanation?

[wobba]

As a summary yes. The why is not important to me, I need to upgrade :-)

[waldekmastykarz]

Thinking about it, the challenge with showing only the file name and all resolutions grouped per file is that it would be impossible for you to tell the difference between adding something to the file and removing something from it. Currently the resolution shows the affected code but whether you should add that to the particular file or remove from it is included in the finding's description. So to make it clearer, what we could do is the following:

Console command
---------------------
npm i @microsoft/[email protected] @microsoft/[email protected] @microsoft/[email protected] @microsoft/[email protected] -SE
npm i @microsoft/[email protected] @microsoft/[email protected] @microsoft/[email protected] [email protected] -DE

.yo-rc-json
------------
Update version in .yo-rc.json:
{
  "@microsoft/generator-sharepoint": {
    "version": "1.6.0"
  }
}

Remove framework in .yo-rc.json:
{
  "@microsoft/generator-sharepoint": {
    "framework": "react"
  }
}

What do you think @wobba @sympmarc?

[wobba]

Works for me and a good solution.