Documentation
¶
Overview ¶
Package redact keeps a real document and a real person out of the artifacts the drivers write. It carries no build tag: the live driver and the eval harness are both behind tags and run only by hand, so rules that lived beside either of them were tested almost never, and the eval harness had no redaction at all.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
Address = regexp.MustCompile(`[A-Za-z0-9._%+\-]+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,}`)
)
Transcript keeps a real document and a real person out of the transcript, which people paste into issues and chat.
Two kinds of thing, caught two ways. An id, a URL and an address have a shape, so a pattern finds them wherever they appear. **A person's name does not.** There is no shape for "Ann Petersen", so names are caught by position, and position works only because the renderers in internal/service and internal/render wrote every one of them: `owner X`, a reply line, and ` by X` from Info.text, list_revisions, search_documents, list_comments and list_suggestions.
A person is redacted to the end of the line, and everything after the name goes with it — a comment's quote and body, a suggestion's diff, a revision's `(kept)`. That is a real cost, paid deliberately: a display name has no reliable terminator. Directory names carry parentheses ("Ann Petersen (Acme Corp)"), so stopping at the first `(` to save a trailing timestamp left the organisation in the transcript — which is the half hard rule 1 is actually about. Over-redaction is the safe direction here, and nothing downstream depends on it: a step parses the untouched text (see `shown`).
Functions ¶
func Clip ¶
Clip redacts and then truncates, in that order. Truncating first lets a value straddling the cut stop matching its shape rule and survive, which a test in this package holds.
func Transcript ¶
Transcript applies every rule above. See the block comment on the rules for why names are caught by position and everything else by shape.
Types ¶
This section is empty.
Source Files