Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli implements the patrolbot CLI.
|
Package cli implements the patrolbot CLI. |
|
commands/config
Package config implements the "patrolbot config" command
|
Package config implements the "patrolbot config" command |
|
commands/config/view
Package view implements the "patrolbot config view" command
|
Package view implements the "patrolbot config view" command |
|
commands/init
Package init implements the "patrolbot init" command
|
Package init implements the "patrolbot init" command |
|
commands/patrol
Package patrol implements the "patrolbot patrol" command
|
Package patrol implements the "patrolbot patrol" command |
|
commands/register
Package register implements the "patrolbot register" command
|
Package register implements the "patrolbot register" command |
|
commands/report
Package report implements the "patrolbot report" command
|
Package report implements the "patrolbot report" command |
|
commands/serve
Package serve implements the "patrolbot serve" command
|
Package serve implements the "patrolbot serve" command |
|
Package clock provides an interface around the standard library's time package so that unit tests can inject a mock clock.
|
Package clock provides an interface around the standard library's time package so that unit tests can inject a mock clock. |
|
Package config provides functionality to load config from YAML files, environment variables, and command-line arguments.
|
Package config provides functionality to load config from YAML files, environment variables, and command-line arguments. |
|
Package discord provides a Discord API client, as well as types and functions for receiving Interactions via HTTP webhook
|
Package discord provides a Discord API client, as well as types and functions for receiving Interactions via HTTP webhook |
|
Package errdefs provides error types for common PatrolBot errors that warrant special handling in the CLI or bot server.
|
Package errdefs provides error types for common PatrolBot errors that warrant special handling in the CLI or bot server. |
|
Package gcp provides utilties for running PatrolBot on Google Cloud Platform.
|
Package gcp provides utilties for running PatrolBot on Google Cloud Platform. |
|
Package interactions provides the functionality for handling Discord interactions.
|
Package interactions provides the functionality for handling Discord interactions. |
|
Package mediawiki provides a client for interacting with the MediaWiki Action API.
|
Package mediawiki provides a client for interacting with the MediaWiki Action API. |
|
Package patroller provides functionality for iterating through unpatrolled revisions in a MediaWiki backlog.
|
Package patroller provides functionality for iterating through unpatrolled revisions in a MediaWiki backlog. |
|
report
|
|
|
data
Package data exports the type of the ReportData object in PatrolBot report templates.
|
Package data exports the type of the ReportData object in PatrolBot report templates. |
|
provider
Package provider sources report data from the MediaWiki [Action API].
|
Package provider sources report data from the MediaWiki [Action API]. |
|
reporter
Package reporter provides functionality for generating reports with data sourced from the MediaWiki [Action API].
|
Package reporter provides functionality for generating reports with data sourced from the MediaWiki [Action API]. |
|
Package server implements the HTTP server for handling Discord interactions via webhooks.
|
Package server implements the HTTP server for handling Discord interactions via webhooks. |
|
testscriptutil
|
|
|
discordsign
Package discordsign provides funcionality for generating request signature headers in testscript tests to simulate Discord interaction webhook requests.
|
Package discordsign provides funcionality for generating request signature headers in testscript tests to simulate Discord interaction webhook requests. |
|
httpstub
Package httpstub provides functionality for stubbing an HTTP server and spying on requests in testscript tests.
|
Package httpstub provides functionality for stubbing an HTTP server and spying on requests in testscript tests. |
|
tools
|
|
|
genschema
command
Genschema generates a JSON schema for PatrolBot config.
|
Genschema generates a JSON schema for PatrolBot config. |
|
gentestdata
command
Gentestdata generates real MediaWiki Action API responses, which can then be used to mock the API in tests
|
Gentestdata generates real MediaWiki Action API responses, which can then be used to mock the API in tests |
Click to show internal directories.
Click to hide internal directories.