{"id":14063551,"url":"https://github.com/equelin/Format-Pester","last_synced_at":"2025-07-29T15:34:07.519Z","repository":{"id":90375831,"uuid":"61305401","full_name":"equelin/Format-Pester","owner":"equelin","description":"Powershell module for documenting Pester's results","archived":false,"fork":false,"pushed_at":"2019-01-09T10:40:18.000Z","size":759,"stargazers_count":84,"open_issues_count":4,"forks_count":8,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-11-23T10:34:55.253Z","etag":null,"topics":["nunit","pester","powershell"],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/equelin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-06-16T15:33:51.000Z","updated_at":"2024-09-28T05:05:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"6a741943-11fb-4fc2-943b-19cde94e3138","html_url":"https://github.com/equelin/Format-Pester","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equelin%2FFormat-Pester","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equelin%2FFormat-Pester/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equelin%2FFormat-Pester/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equelin%2FFormat-Pester/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/equelin","download_url":"https://codeload.github.com/equelin/Format-Pester/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228028494,"owners_count":17858341,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nunit","pester","powershell"],"created_at":"2024-08-13T07:03:23.640Z","updated_at":"2024-12-04T01:31:00.131Z","avatar_url":"https://github.com/equelin.png","language":"PowerShell","readme":"[![Build status](https://ci.appveyor.com/api/projects/status/36q06wp2c4vwfu7w/branch/master?svg=true)](https://ci.appveyor.com/project/equelin/format-pester/branch/master)\r\n\r\n# Format-Pester\r\n\r\nPowershell module for documenting Pester's results.\r\n\r\nAll the formatting work is done by the module [PScribo](https://github.com/iainbrighton/PScribo).\r\n\r\nReports are generated based on a custom PowerShell object returned by Invoke-Pester. You have to provide the parameter `PassThru` to Pester. Currently, NUnit style files generated by Pester are not supported.\r\n\r\nIf you can't generate report on a computer where tests are executed please save tests results piping them to `Export-Clixml`.\r\n\r\nYou can be interested also in the\r\n- [ReportUnit](https://github.com/reportunit/reportunit) tool. It's a report generator for the test-runner family. It uses stock reports from NUnit, MsTest, xUnit, TestNG and Gallio and converts them into HTML reports with dashboards.\r\n- [PSTestReport](https://github.com/Xainey/PSTestReport) - it's an early example to generate a static PowerShell test report. You can read about it in the blog post [\"Hitchhikers Guide to the PowerShell Module Pipeline\"](https://xainey.github.io/2017/powershell-module-pipeline) by Michael Willis.\r\n\r\n## Report example\r\n\r\n![](./img/Format-Pester-1.6.0-part.png)\r\n\r\nPartial screenshot for a HTML report generated by Format-Pester v. 1.6.0, PScribo v. 0.7.19, [the full screenshot](./img/Format-Pester-1.6.0-full.png).\r\n\r\nYou can find more examples [here](/examples/).\r\n\r\n## Supported languages\r\n\r\nSince version 1.3.0 internationalization of generated reports is supported. It means that reports parts e.g. section names, columns headers, etc. can be wrote in a different language than English.\r\n\r\nCurrently available languages are:\r\n\r\n- en-US - English United States - main language\r\n- pl-PL - Polish\r\n\r\nIf you would like to add support for your language please read the section [Information for translators](https://github.com/equelin/Format-Pester/wiki/Information-for-translators) in the project's wiki.\r\n\r\n# Requirements\r\n\r\n- Powershell v.4.x, v.5.x\r\n- [Pester](https://github.com/pester/Pester) v.4.x\r\n- [PScribo](https://github.com/iainbrighton/PScribo)\r\n\r\n# Usage\r\n\r\nFormat-Pester is a PowerShell module so it has to be imported before using it - you can find more instructions in the [wiki](https://github.com/equelin/Format-Pester/wiki/Importing-Format-Pester).\r\n\r\n## Example 1\r\n\r\n```PowerShell\r\n  Invoke-Pester -PassThru | Format-Pester -Path . -Format HTML,Word,Text\r\n```\r\n\r\nThis command will document the results of the Pester's tests. Documents will be stored in the current path and they will be available in 3 formats (.html,.docx and .txt).\r\n\r\n## Example 2\r\n\r\n```PowerShell\r\n    Invoke-Pester -PassThru | Export-Clixml -Path .\\Test-Result.xml\r\n\r\n    Import-Clixml -Path .\\Test-Result.xml | Format-Pester -Format .\\ -BaseFileName Test-Result -Format HTML -FailedOnly\r\n```\r\n\r\nYou can run the first command on a server where PScribo and Format-Pester are not installed. The tests results object will be stored in a xmf file.\r\n\r\nAfter copying the file to the computer where PScribo and Format-Pester are available you can generate a report. In this example, the HTML file will be generated with results of failed tests only.\r\n\r\n## Online help\r\n\r\nYou can read [online version of help](/doc/Format-Pester.md) - online help generated by [platyPS module](https://github.com/powershell/platyps).\r\n\r\n# Initial author\r\n\r\n- Erwan Quélin - [GitHub](https://github.com/equelin) - [Twitter](https://twitter.com/erwanquelin)\r\n\r\n# Contributors\r\n\r\n- Travis Plunk - [GitHub](https://github.com/TravisEz13) - [Twitter](https://twitter.com/TravisPlunk)\r\n- Wojciech Sciesinski - [GitHub](https://github.com/it-praktyk) - [Twitter](https://twitter.com/ITpraktyk)\r\n\r\n# [Version history](VERSIONS.md)\r\n\r\n# [TODO and development plans](TODO.md)\r\n\r\n# License\r\n\r\nCopyright 2016-17 Erwan Quelin and the community.  \r\nLicensed under [the MIT License](LICENSE)\r\n","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequelin%2FFormat-Pester","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fequelin%2FFormat-Pester","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequelin%2FFormat-Pester/lists"}