[FEATURE] Modernise writing output results
Open
Nobody has claimed this yet.
feature: output
- Dominant language
- C#
- Stars
- 474
- Forks
- 65
- Avg merge
- 22h 25m
- Merged PRs (30d)
- 26
Description
Your suggestion
Currently writing output is handled by src/PSRule/Pipeline/Output/ with support for a number of different file formats.
There is a number of challenges with the current implementation:
- Output can only be written to one format at a time.
- Output is fully buffered in memory before being written to an output file, instead of being streamed to files, and reducing memory usage.
- Output formats are not customizable and offers limited configuration options.
- Getting the output from
PSRuleto other libraries such as language server and chat tools is complex.
Alternatives
na
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the implementation under src/PSRule/Pipeline/Output/ and map how formats are selected, buffered, configured, and exposed to callers. Define the output API and format requirements before changing anything; done means the design addresses multiple formats, streaming, customization, and integrations with language-server and chat tools.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100