{"id":18937447,"url":"https://github.com/verifytests/verify.questpdf","last_synced_at":"2025-04-15T18:32:03.678Z","repository":{"id":45264745,"uuid":"489807917","full_name":"VerifyTests/Verify.QuestPDF","owner":"VerifyTests","description":"Extends Verify to allow verification of documents via QuestPDF.","archived":false,"fork":false,"pushed_at":"2025-04-14T11:24:37.000Z","size":1317,"stargazers_count":16,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T12:29:57.424Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","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/VerifyTests.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"license.txt","code_of_conduct":"code_of_conduct.md","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},"funding":{"github":"VerifyTests"}},"created_at":"2022-05-08T00:06:51.000Z","updated_at":"2025-04-14T11:24:41.000Z","dependencies_parsed_at":"2024-01-17T11:38:18.721Z","dependency_job_id":"820cf264-d61a-4148-b937-911eb71a2283","html_url":"https://github.com/VerifyTests/Verify.QuestPDF","commit_stats":{"total_commits":93,"total_committers":2,"mean_commits":46.5,"dds":"0.010752688172043001","last_synced_commit":"af240c0bf4bd531fdfead2547a6898eed37ce304"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VerifyTests%2FVerify.QuestPDF","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VerifyTests%2FVerify.QuestPDF/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VerifyTests%2FVerify.QuestPDF/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VerifyTests%2FVerify.QuestPDF/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VerifyTests","download_url":"https://codeload.github.com/VerifyTests/Verify.QuestPDF/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249129232,"owners_count":21217310,"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":[],"created_at":"2024-11-08T12:11:11.611Z","updated_at":"2025-04-15T18:31:58.668Z","avatar_url":"https://github.com/VerifyTests.png","language":"C#","funding_links":["https://github.com/sponsors/VerifyTests"],"categories":[],"sub_categories":[],"readme":"# \u003cimg src=\"/src/icon.png\" height=\"30px\"\u003e Verify.QuestPDF\n\n[![Discussions](https://img.shields.io/badge/Verify-Discussions-yellow?svg=true\u0026label=)](https://github.com/orgs/VerifyTests/discussions)\n[![Build status](https://ci.appveyor.com/api/projects/status/au00qrkik2isl8vw?svg=true)](https://ci.appveyor.com/project/SimonCropp/Verify-QuestPDF)\n[![NuGet Status](https://img.shields.io/nuget/v/Verify.QuestPDF.svg)](https://www.nuget.org/packages/Verify.QuestPDF/)\n\nExtends [Verify](https://github.com/VerifyTests/Verify) to allow verification of documents via [QuestPDF](https://www.questpdf.com/).\n\n**See [Milestones](../../milestones?state=closed) for release notes.**\n\nDesigned to help assert the output of projects using QuestPDF to generate PDFs.\n\n\n## NuGet package\n\nhttps://nuget.org/packages/Verify.QuestPDF/\n\n\n## Usage\n\n\u003c!-- snippet: enable --\u003e\n\u003ca id='snippet-enable'\u003e\u003c/a\u003e\n```cs\n[ModuleInitializer]\npublic static void Init()\n{\n    VerifyImageMagick.RegisterComparers(0.015);\n    VerifyQuestPdf.Initialize();\n}\n```\n\u003csup\u003e\u003ca href='/src/Tests/ModuleInitializer.cs#L3-L12' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-enable' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\nThis sample uses [Verify.ImageMagick](https://github.com/VerifyTests/Verify.ImageMagick) to ignore small rendering differences that are expected between differens operating systesm.\n\nOther [compares](https://github.com/VerifyTests/Verify/blob/main/docs/comparer.md) options: \n\n * https://github.com/VerifyTests/Verify.ImageHash\n * https://github.com/VerifyTests/Verify.ImageMagick\n * https://github.com/VerifyTests/Verify.Phash\n * https://github.com/VerifyTests/Verify.ImageSharp.Compare\n\n\n### Code that generates a document \n\n\u003c!-- snippet: GenerateDocument --\u003e\n\u003ca id='snippet-GenerateDocument'\u003e\u003c/a\u003e\n```cs\nstatic IDocument GenerateDocument() =\u003e\n    Document.Create(container =\u003e\n    {\n        container.Page(AddPage);\n        container.Page(AddPage);\n    });\n\nstatic void AddPage(PageDescriptor page)\n{\n    page.Size(PageSizes.A5);\n    page.Margin(1, Unit.Centimetre);\n    page.PageColor(Colors.Grey.Lighten3);\n    page.DefaultTextStyle(_ =\u003e _.FontSize(20));\n\n    page.Header()\n        .Text(\"Hello PDF!\")\n        .SemiBold().FontSize(36);\n\n    page.Content()\n        .Column(_ =\u003e _.Item()\n            .Text(Placeholders.LoremIpsum()));\n\n    page.Footer()\n        .AlignCenter()\n        .Text(_ =\u003e\n        {\n            _.Span(\"Page \");\n            _.CurrentPageNumber();\n        });\n}\n```\n\u003csup\u003e\u003ca href='/src/Tests/Samples.cs#L39-L72' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-GenerateDocument' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n\n### Verify a Document\n\n\u003c!-- snippet: VerifyDocument --\u003e\n\u003ca id='snippet-VerifyDocument'\u003e\u003c/a\u003e\n```cs\n[Test]\npublic Task VerifyDocument()\n{\n    var document = GenerateDocument();\n    return Verify(document);\n}\n```\n\u003csup\u003e\u003ca href='/src/Tests/Samples.cs#L4-L13' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-VerifyDocument' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n\n### Results\n\n\n#### Metadata\n\n\u003c!-- snippet: Samples.VerifyDocument.verified.txt --\u003e\n\u003ca id='snippet-Samples.VerifyDocument.verified.txt'\u003e\u003c/a\u003e\n```txt\n{\n  Pages: 2,\n  Metadata: {\n    CreationDate: DateTimeOffset_1,\n    ModifiedDate: DateTimeOffset_2\n  },\n  Settings: {\n    ContentDirection: LeftToRight,\n    PdfA: false,\n    ImageCompressionQuality: High,\n    ImageRasterDpi: 288\n  }\n}\n```\n\u003csup\u003e\u003ca href='/src/Tests/Samples.VerifyDocument.verified.txt#L1-L13' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-Samples.VerifyDocument.verified.txt' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n\n#### Pdf as image\n\n\u003cimg src=\"src/Tests/Samples.VerifyDocument%2300.verified.png\" width=\"300px\"\u003e\n\n\n## PagesToInclude\n\nTo render only a defined number of pages at the start of a document:\n\n\u003c!-- snippet: PagesToInclude --\u003e\n\u003ca id='snippet-PagesToInclude'\u003e\u003c/a\u003e\n```cs\n[Test]\npublic Task PagesToInclude()\n{\n    var document = GenerateDocument();\n    return Verify(document)\n        .PagesToInclude(1);\n}\n```\n\u003csup\u003e\u003ca href='/src/Tests/Samples.cs#L15-L25' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-PagesToInclude' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n\n\n### Dynamic \n\nTo dynamically control what pages are rendered:\n\n\u003c!-- snippet: PagesToIncludeDynamic --\u003e\n\u003ca id='snippet-PagesToIncludeDynamic'\u003e\u003c/a\u003e\n```cs\n[Test]\npublic Task PagesToIncludeDynamic()\n{\n    var document = GenerateDocument();\n    return Verify(document)\n        .PagesToInclude(pageNumber =\u003e pageNumber == 2);\n}\n```\n\u003csup\u003e\u003ca href='/src/Tests/Samples.cs#L27-L37' title='Snippet source file'\u003esnippet source\u003c/a\u003e | \u003ca href='#snippet-PagesToIncludeDynamic' title='Start of snippet'\u003eanchor\u003c/a\u003e\u003c/sup\u003e\n\u003c!-- endSnippet --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverifytests%2Fverify.questpdf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fverifytests%2Fverify.questpdf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fverifytests%2Fverify.questpdf/lists"}