Socket
Book a DemoInstallSign in
Socket

pact

Package Overview
Dependencies
Maintainers
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

pact

1.66.1
bundlerRubygems
Version published
Maintainers
5
Created
Source

How to roll your own Doc Generator

  • Create a ConsumerContractRenderer that responds to call and accepts a ConsumerContract (this is the name for the domain model of a "pact"). This should return a String. For an example, see the Markdown::ConsumerContractRenderer.
  • Create an IndexRenderer. This allows you to create an index file for your docs. It should respond to call and accept the String name of the consumer, and a hash of Hash of pact title => file_name, and return a String. For an example, see the Markdown::IndexRenderer.
  • Create a Generator. This is responsible for the overall file generating and writing process. Copy the Markdown::Generator and configure it with your own ConsumerContractRenderer, IndexRenderer and file details.

If you would like to generate HTML documentation, see how the HTMLPactRenderer in the Pact Broker does it.

FAQs

Package last updated on 20 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.