{"id":48625556,"url":"https://github.com/tiendc/go-profanity-out","last_synced_at":"2026-04-09T04:32:48.095Z","repository":{"id":299059544,"uuid":"992815440","full_name":"tiendc/go-profanity-out","owner":"tiendc","description":"Profanity detection library","archived":false,"fork":false,"pushed_at":"2025-06-14T11:43:39.000Z","size":15,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-14T12:33:35.127Z","etag":null,"topics":["badword-censor","badword-filter","badwords","go","golang","profanity-check","profanity-detection","profanity-filter","profanityfilter","swear","swear-filter","swearing-detector"],"latest_commit_sha":null,"homepage":"","language":"Go","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/tiendc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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,"zenodo":null}},"created_at":"2025-05-29T18:55:56.000Z","updated_at":"2025-06-14T11:43:42.000Z","dependencies_parsed_at":"2025-06-14T12:43:50.357Z","dependency_job_id":null,"html_url":"https://github.com/tiendc/go-profanity-out","commit_stats":null,"previous_names":["tiendc/go-profanity-out"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tiendc/go-profanity-out","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiendc%2Fgo-profanity-out","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiendc%2Fgo-profanity-out/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiendc%2Fgo-profanity-out/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiendc%2Fgo-profanity-out/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiendc","download_url":"https://codeload.github.com/tiendc/go-profanity-out/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiendc%2Fgo-profanity-out/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31586403,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"online","status_checked_at":"2026-04-09T02:00:06.848Z","response_time":112,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["badword-censor","badword-filter","badwords","go","golang","profanity-check","profanity-detection","profanity-filter","profanityfilter","swear","swear-filter","swearing-detector"],"created_at":"2026-04-09T04:32:46.773Z","updated_at":"2026-04-09T04:32:48.087Z","avatar_url":"https://github.com/tiendc.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Go Version][gover-img]][gover] [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![GoReport][rpt-img]][rpt]\n\n# Profanity detection library\n\nThis project is inspired by [github.com/TwiN/go-away](https://github.com/TwiN/go-away) and\n[github.com/finnbear/moderation](https://github.com/finnbear/moderation). It also uses\nlanguage data from the libs (with modifications).\n\nThis project is still in development and more tests are needed to ensure the accuracy.\nHowever, you may use it in your work as it can produce good results.\n\n## Highlights\n\n- Fully supports Unicode\n- Utilizes radix tree to improve performance\n\n## Installation\n\n```shell\ngo get github.com/tiendc/go-profanity-out\n```\n\n## How to use\n\n```go\nimport (\n    profanityout \"github.com/tiendc/go-profanity-out\"\n    profanityDataEN \"github.com/tiendc/go-profanity-out/data/en\"\n)\n\ndetector := profanityout.NewProfanityDetector().\n    WithProfaneWords(profanityDataEN.DefaultProfanities).          // required\n    WithFalsePositiveWords(profanityDataEN.DefaultFalsePositives). // required\n    WithSuspectWords(profanityDataEN.DefaultSuspects).             // required\n    WithLeetSpeakCharacters(profanityDataEN.LeetSpeakCharacters).  // required\n    WithSpecialCharacters(profanityDataEN.SpecialCharacters).      // required\n    WithWildcardCharacters(profanityDataEN.WildcardCharacters).    // required\n    WithSanitizeLeetSpeak(true).                                   // default: true\n    WithSanitizeSpecialCharacters(true).                           // default: true\n    WithSanitizeSpaces(true).                                      // default: true\n    WithSanitizeRepeatedCharacters(true).                          // default: true\n    WithSanitizeWildcardCharacters(true).                          // default: true\n    WithSanitizeAccents(true).                                     // default: true\n    WithProcessInputAsHTML(false).                                 // default: false\n    WithConfidenceCalculator(calculator).                          // default: built-in\n    WithCensorCharacter('*')                                       // default: *\n\n// Scan for at most one profanity (result may contain found suspect words and/or false positives)\nmatches := detector.ScanProfanity(\"fuck this $h!!t\") // profane: true\n\n// Scan for all profanities\nmatches := detector.ScanAllProfanities(\"fuck this $h!!t\") // profane: true\n\n// Censor the profanities\nres, matches := detector.Censor(\"fuck this $h!!t\") // res == \"**** this *****\"\n\n// WithSanitizeLeetSpeak: true\nScanProfanity(\"$h!t\") // profane: true\n// WithSanitizeLeetSpeak: false\nScanProfanity(\"$h!t\") // profane: false\n\n// WithSanitizeSpecialCharacters: true\nScanProfanity(\"sh_it\") // profane: true\n// WithSanitizeSpecialCharacters: false\nScanProfanity(\"sh_it\") // profane: false\n\n// WithSanitizeSpaces: true\nScanProfanity(\"f u c k\") // profane: true\n// WithSanitizeSpaces: false\nScanProfanity(\"f u c k\") // profane: false\n\n// WithSanitizeRepeatedCharacters: true\nScanProfanity(\"fuuuuck\") // profane: true\n// WithSanitizeRepeatedCharacters: false\nScanProfanity(\"fuuuuck\") // profane: false\n\n// WithSanitizeWildcardCharacters: true\n// NOTE: wildcard characters can be in both input and/or profanity dictionary\nScanProfanity(\"f**k\") // profane: true\nWithProfaneWords([]string{\"f*ck\"}).ScanProfanity(\"fxck\")     // profane: true\nWithProfaneWords([]string{\"*fuck*\"}).ScanProfanity(\"xfuckx\") // profane: true\n// WithSanitizeWildcardCharacters: false\nScanProfanity(\"f**k\")   // profane: false\nScanProfanity(\"fxck\")   // profane: false\nScanProfanity(\"xfuckx\") // profane: false\n\n// WithSanitizeAccents: true\nScanProfanity(\"fúck\") // profane: true\n// WithSanitizeAccents: false\nScanProfanity(\"fúck\") // profane: false\n\n// WithProcessInputAsHTML: true\nScanProfanity(\"\u0026lt;ock\") // profane: true\n// WithProcessInputAsHTML: false\nScanProfanity(\"\u0026lt;ock\") // profane: false\n```\n\n## Benchmarks\n\n[Benchmark code](https://gist.github.com/tiendc/bd5a0655ad07251f626402d819786d84)\n\n```shell\ntiendc/go-profanity-out\ntiendc/go-profanity-out-10      9024        129919 ns/op       44038 B/op        306 allocs/op \nTwiN/go-away\nTwiN/go-away-10                 2745        415685 ns/op      444899 B/op        498 allocs/op\nfinnbear/moderation\nfinnbear/moderation-10         15432         77601 ns/op        2496 B/op         22 allocs/op\n```\n\n## Help wanted\n\n- You are welcome to make pull requests for new functions and bug fixes.\n- It's really nice if you can add more input data for English and other languages.\n\n## License\n\n- [MIT License](LICENSE)\n\n[doc-img]: https://pkg.go.dev/badge/github.com/tiendc/go-profanity-out\n[doc]: https://pkg.go.dev/github.com/tiendc/go-profanity-out\n[gover-img]: https://img.shields.io/badge/Go-%3E%3D%201.20-blue\n[gover]: https://img.shields.io/badge/Go-%3E%3D%201.20-blue\n[ci-img]: https://github.com/tiendc/go-profanity-out/actions/workflows/go.yml/badge.svg\n[ci]: https://github.com/tiendc/go-profanity-out/actions/workflows/go.yml\n[cov-img]: https://codecov.io/gh/tiendc/go-profanity-out/branch/main/graph/badge.svg\n[cov]: https://codecov.io/gh/tiendc/go-profanity-out\n[rpt-img]: https://goreportcard.com/badge/github.com/tiendc/go-profanity-out\n[rpt]: https://goreportcard.com/report/github.com/tiendc/go-profanity-out\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiendc%2Fgo-profanity-out","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiendc%2Fgo-profanity-out","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiendc%2Fgo-profanity-out/lists"}