Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

profanity

package module

Go to main page

Versions in this module

v1

v1.0.0

Aug 7, 2026

Changes in this version

+ func Censor(text string) string

+ func ContainsProfanity(text string) bool

+ func DefaultWords() []string

+ type Option func(*config)

+ func WithPhoneticNormalization() Option

+ func WithSeparatorCollapse() Option

+ func WithWhitelist(words ...string) Option

+ func WithWordListFile(path string) Option

+ func WithWords(words ...string) Option

+ type Profanity struct

+ func MustNew(opts ...Option) *Profanity

+ func New(opts ...Option) (*Profanity, error)

+ func (p *Profanity) AddCensorWords(words ...string)

+ func (p *Profanity) Censor(text string) string

+ func (p *Profanity) CensorWith(text string, censorChar rune) string

+ func (p *Profanity) ContainsProfanity(text string) bool

+ func (p *Profanity) FeedWords(ch <-chan string)

+ func (p *Profanity) Len() int

+ func (p *Profanity) LoadCensorWords(words []string, opts ...Option)

+ func (p *Profanity) LoadCensorWordsFromFile(path string, opts ...Option) error

+ func (p *Profanity) LoadDefaultCensorWords(opts ...Option)

+ func (p *Profanity) NewWordFeed(buffer int) chan<- string