Skip to content

Sync Main #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
master-wayne7 merged 2 commits into from
Sep 5, 2026
Merged

Sync Main #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a566ba
chore: release 3.0.1 - clarify lazy auto-init docs
master-wayne7 Sep 5, 2026
caf3fc5
Merge pull request #54 from master-wayne7/release/3.0.1
master-wayne7 Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## 3.0.1

### Documentation
- Clarified that 3.0.0's lazy auto-initialization loads the full `Language.english` word list (`lib/data/en.dart`, ~13k words) on first use — not the small legacy `constants/badwords.dart` list (~1.7k words) that 2.x fell back to when `init` was never called. This is a real behavior difference for apps upgrading from 2.x without calling `init` (e.g. `"adult"` now matches, where it previously did not).
- Corrected the "Migrating from v1.x" table, which incorrectly attributed the optional/lazy-init behavior to v2.0.0 instead of 3.0.0.
- Added a "Keeping the legacy word list" section to the README showing how to opt back into the old `constants/badwords.dart` list via `useDefaultWords: false` + `extraWords: badWords`.

Thanks to [@ecolab-neil](https://github.com/ecolab-neil) for reporting this in [#52](https://github.com/master-wayne7/safe_text/issues/52).

## 3.0.0

- **Converted from a Flutter package to a pure Dart package.** The `flutter` SDK dependency has been removed; `safe_text` now works in any Dart project (native, web, server, CLI) with no Flutter requirement.
Expand All @@ -10,7 +19,6 @@
```
- **`SafeTextFilter.containsBadWord` is now synchronous** (`bool` instead of `Future<bool>`). Remove the `await` from existing call sites.
- **Lazy auto-initialization.** `SafeTextFilter.init` is now optional — if you never call it, the filter lazily initializes with `Language.english` on first use (`filterText` / `containsBadWord`). Explicit `init(language: ...)` still takes precedence when you need a specific language.
- **Breaking behavior change for callers upgrading from 2.x who never called `init`:** in 2.x, an uninitialized filter fell back to the small built-in `constants/badwords.dart` list (~1.7k words). As of 3.0.0, an uninitialized filter instead lazily loads the full `Language.english` list (~13k words) — a different, much larger word list (e.g. `"adult"` now matches, where it previously did not). If you depended on the smaller 2.x fallback, pass `useDefaultWords: false` and `extraWords: badWords` (from `package:safe_text/constants/badwords.dart`) explicitly.

## 2.1.7

Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: safe_text
description: A fast Dart profanity & swear word filter with phone number detection, powered by Aho-Corasick. Supports 80+ languages and 55,000+ curated bad words.
version: 3.0.0
version: 3.0.1
homepage: https://github.com/master-wayne7/safe_text
repository: https://github.com/master-wayne7/safe_text
issue_tracker: https://github.com/master-wayne7/safe_text/issues
Expand Down
Loading