{"id":21534529,"url":"https://github.com/winseros/resharperreportconverter","last_synced_at":"2025-03-17T20:14:48.256Z","repository":{"id":81337525,"uuid":"169699040","full_name":"winseros/ReSharperReportConverter","owner":"winseros","description":"A set of scripts for transforming ReSharper CLT xml report files into human-readable HTML","archived":false,"fork":false,"pushed_at":"2020-06-03T14:44:27.000Z","size":43,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-24T07:11:28.669Z","etag":null,"topics":["dotnet","html-report","lint","linter","resharper","resharper-clt"],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/winseros.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-08T07:27:44.000Z","updated_at":"2023-09-08T17:50:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"399181cd-985c-4db1-90e3-4298f6c0208d","html_url":"https://github.com/winseros/ReSharperReportConverter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winseros%2FReSharperReportConverter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winseros%2FReSharperReportConverter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winseros%2FReSharperReportConverter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/winseros%2FReSharperReportConverter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/winseros","download_url":"https://codeload.github.com/winseros/ReSharperReportConverter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244102855,"owners_count":20398386,"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":["dotnet","html-report","lint","linter","resharper","resharper-clt"],"created_at":"2024-11-24T03:11:07.745Z","updated_at":"2025-03-17T20:14:48.220Z","avatar_url":"https://github.com/winseros.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReSharper CLT report converter\n\nTakes the standard [ReSharper CLT](https://www.jetbrains.com/resharper/download/#section=commandline) output and converts it into a human-readable _HMTL report_ or _console output_.\n\nThe package can be used inside docker. See [the example](how-to-docker).\n\n## Generate console output\n\n1) Generate a report file using the standard [ReSharper CLT](https://www.jetbrains.com/resharper/download/#section=commandline) commands, e.g.:\n    ```\n    inspectCode.exe -o=\"\u003cpath_to_report_xml\u003e\" \u003cpath_to_solution\u003e\n    ```\n\n2) Run the powershell script:\n    ```\n    write-console.ps1 -ResharperReport \u003cpath_to_report_xml\u003e -Colorize -FailOnIssues\n    ```\n\n3) See the console output\n\n### Example\n\n```\ninspectCode.exe -o=\".\\example-resharper-output\\resharper-output.xml\" ..\\GitlabTelegramChannel\\src\\TGramIntegration.sln\n\nwrite-console.ps1 -ResharperReport .\\example-resharper-output\\resharper-output.xml -OutputFile .\\example-report\\report.html\n```\n\n### Options\n`write-console.ps1` supports the following options\n\n#### ResharperReport\n**Type**: string\n\n**Description**: Path to ReSharper CTL output xml file\n\n**Mandatory**: yes\n\n#### Colorize\n**Type**: boolean\n\n**Description**: Should the output be colorized\n\n**Default**: false\n\n#### FailOnIssues\n**Type**: boolean\n\n**Description**: Should the `1` exit code be returned in case of any issues detected by ReSharper\n\n**Default**: false\n\n## Generate HTML report\n\n1) Generate a report file using the standard [ReSharper CLT](https://www.jetbrains.com/resharper/download/#section=commandline) commands, e.g.:\n    ```\n    inspectCode.exe -o=\"\u003cpath_to_report_xml\u003e\" \u003cpath_to_solution\u003e\n    ```\n\n2) Run the powershell script:\n    ```\n    make-html.ps1 -ResharperReport \u003cpath_to_report_xml\u003e -OutputFile \u003cpath_to_report_html\u003e -FailOnIssues\n    ```\n\n3) Use the generated HTML file as desired\n\n### Example\n\n```\ninspectCode.exe -o=\".\\example-resharper-output\\resharper-output.xml\" ..\\GitlabTelegramChannel\\src\\TGramIntegration.sln\n\nmake-html.ps1 -ResharperReport .\\example-resharper-output\\resharper-output.xml -OutputFile .\\example-report\\report.html -FailOnIssues\n```\n\n### Options\n`make-html.ps1` supports the following options\n\n#### ResharperReport\n**Type**: string\n\n**Description**: Path to ReSharper CTL output xml file\n\n**Mandatory**: yes\n\n#### OutputFile\n**Type**: string\n\n**Description**: Path to the resulting HTML file\n\n**Mandatory**: yes\n\n#### ProjectName\n**Type**: string\n\n**Description**: Project name to show in the resulting HTML file\n\n**Mandatory**: no\n\n**Default**: Unknown project\n\n#### UrlFormat\n**Type**: string\n\n**Description**: Items in the resulting HTML report are intended to work as hyperlinks and target to files at some source control (BitBucket/GitHub/GitLab). Use this parameter to specify address of your source control. The template strings has the following parameters \n* `{0}` - will be replaced with a file name\n* `{1}` - will be replaced with a line number\n\n**Mandatory**: no\n\n**Example**: \n```\n-UrlFormat \"https://github.com/winseros/GitlabTelegramChannel/tree/v1.0.1/src/{0}#L{1}\"\n```\n**Default**: `{0}#{1}`\n\n#### FailOnIssues\n**Type**: boolean\n\n**Description**: Should the `1` exit code be returned in case of any issues detected by ReSharper\n\n**Default**: false","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinseros%2Fresharperreportconverter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwinseros%2Fresharperreportconverter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwinseros%2Fresharperreportconverter/lists"}