iainbrighton / PScribo

PowerShell documentation framework
MIT License
230 stars 35 forks source link

Adding JSON Plugin #122

Closed carceneaux closed 1 year ago

carceneaux commented 1 year ago

I debugged/tested the JSON plugin using several of the example scripts in the project as well as using several reports from the AsBuiltReport framework which leverages PScribo.

The purpose of this plugin is to be able to take already existing scripts using PScribo and provide the output in a method that can be ingested by a 3rd party tool. To that end, JSON seemed to be a pretty clear answer as PowerShell can natively do this.

carceneaux commented 1 year ago

Resolved all AppVeyor errors with the exception of one (shown below) as it related to a file not modified in this PR.

CleanShot 2022-12-06 at 16 38 08

I further investigated and it appears to be a newly added rule which is why it didn't pop up before.

carceneaux commented 1 year ago

Confirmed. New rule added 2 months ago in the latest PSScriptAnalyzer release.

CleanShot 2022-12-06 at 16 48 53

carceneaux commented 1 year ago

Created a new issue for this behavior and applied a workaround to patch the issue for now.

carceneaux commented 1 year ago

@iainbrighton Thoughts on this?

carceneaux commented 1 year ago

@iainbrighton Everything should now be good to go. Only failure in the build can be ignored as it's being resolved in #125.

Thanks for your time reviewing this! 😄

carceneaux commented 1 year ago

@iainbrighton Any further requests on this? Are we good to merge?

carceneaux commented 1 year ago

@iainbrighton Howdy! 😄 I just updated this PR to include the recent merges into the dev branch.

Any chance this PR can be merged?

iainbrighton commented 1 year ago

Any chance this PR can be merged?

@carceneaux If it's merged in its current form, there will be no support for the new List functionality. Do you plan on adding this functionality?

Thanks, Iain

carceneaux commented 1 year ago

Thanks, Iain! I'll create an issue for the new list functionality and test/add support for it.