Lyo.Profanity 2.0.1

Lyo.Profanity

File-based profanity filter. Finds and replaces profane words. Several languages, regex patterns, plain word lists, and configurable replacement strategies.

Features

• Word sources. JSON file, HTTP URL, or per-language WordsByLanguage
• Format support. Structured JSON ([{ id, match, tags, severity, exceptions }]), plain array ["word1", "word2"], or plain newline-separated text (one word per line)
• Replacement strategies. Remove, ReplaceWithChar, ReplaceWithWord, Mask, PreserveBoundary, DetectOnly
• Per-language. Load different word lists by BCP 47 / ISO 639-1 / ISO 639-3

Examples

Register and filter

services.AddProfanityFilterService(options =>
{
    options.WordsFilePath = "profanity-words.json";
    options.ReplacementStrategy = ProfanityReplacementStrategy.Mask;
});

// Or bind from configuration
services.AddProfanityFilterServiceFromConfiguration(configuration, "ProfanityFilter");

// In a service
var result = await _profanityFilter.FilterAsync("some text with bad word", ct);
// result.FilteredText, result.HasProfanity, result.Matches

Configuration (appsettings.json)

{
  "ProfanityFilter": {
    "WordsFilePath": "profanity-en.json",
    "WordsUrl": "https://example.com/words.json",
    "ReplacementStrategy": "Mask",
    "Language": "en-US",
    "AllowRefresh": true,
    "WordsByLanguage": {
      "en": { "WordsFilePath": "en.json" },
      "es": { "WordsFilePath": "es.json" }
    }
  }
}

Service registration

Lyo.Profanity.Extensions exposes three entry points on IServiceCollection. Choose exactly one when wiring the host:

FileProfanityFilterService resolves an optional ILogger<FileProfanityFilterService>, an optional IMetrics (used only when Options.EnableMetrics == true), and an optional HttpClient (used when WordsUrl is configured).

IProfanityFilterService methods

• Filter(string? input, CancellationToken) / Filter(string? input, LanguageCodeInfo language, CancellationToken) synchronous filtering. Returns ProfanityFilterResult (FilteredText, HasProfanity, Matches).
• FilterAsync(string? input, CancellationToken) / FilterAsync(string? input, LanguageCodeInfo language, CancellationToken) the same, async.
• ContainsProfanity(string? input, CancellationToken) / ContainsProfanity(string? input, LanguageCodeInfo language, CancellationToken) fast boolean check, no replacement.
• ContainsProfanityAsync(string? input, CancellationToken) / ContainsProfanityAsync(string? input, LanguageCodeInfo language, CancellationToken) async variants.
• RefreshWords(CancellationToken) / RefreshWordsAsync(CancellationToken) reload from the configured file/URL. No-op when Options.AllowRefresh is false or the source doesn't support refresh.

Word list formats

• Plain JSON array. ["word1", "word2"] becomes default entries (id == match == word, tags = [], severity = 1, exceptions = []).
• Structured JSON. [{ "id": "x", "match": "regex|word", "tags": [], "severity": 1, "exceptions": [] }]. match is compiled as a Regex and cached.
• Plain newline-separated text. One word per line, same defaults as the plain JSON array.

Replacement strategies

Dependencies

Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).

• Lyo.Common.Metadata (direct, lyo)
• Lyo.Exceptions (direct, lyo)
• Lyo.Metrics (direct, lyo)
• Microsoft.Extensions.Configuration.Binder 10.0.5 (direct, microsoft)
• Microsoft.Extensions.DependencyInjection.Abstractions 10.0.5 (direct, microsoft)
• Microsoft.Extensions.Logging.Abstractions 10.0.5 (direct, microsoft)
• Microsoft.Extensions.Options 10.0.5 (direct, microsoft)
• System.Text.Json 10.0.5 (direct, microsoft, netstandard2.0)
• Lyo.Common.Core (transitive, lyo)
• Microsoft.Bcl.AsyncInterfaces 10.0.5 (transitive, microsoft, netstandard2.0)
• System.Memory 4.6.3 (transitive, microsoft, netstandard2.0)