Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Changelog

All notable changes to this project are documented in this file.

this project follows [Semantic Versioning](https://semver.org/).

## [Unreleased]

Maintained fork of [euclio/spellbound](https://github.com/euclio/spellbound).

### Breaking
- `Checker::new()` now returns `Result<Self, Error>` instead of panicking when
the spellchecker (or hunspell dictionary) is unavailable
- `SpellingError` now includes UTF-8 byte `start` / `end` offsets into the
checked text (in addition to `text()`)

### Added
- `Error` / `Error::Unavailable`
- Broader Linux dictionary search paths and `en_US` / `en_GB` fallbacks
- Word tokenization with offsets on Unix (alphabetic / `'` runs)
- GitHub Actions CI (Linux, macOS, Windows; fmt; clippy)
- README documentation for the maintained fork and Linux hunspell setup

### Changed
- Edition 2021; dropped `lazy_static` / `extern crate`
- macOS uses `OnceLock` for the shared `NSSpellChecker`
- Windows COM failures map to `Error` where creating the checker; UTF-16
indices convert to UTF-8 byte ranges

### Removed
- Travis CI and APPVeyor configs

## [0.1.1] - 2020-02-05

Last release from upstream (`euclio/spellbound`).
5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ categories = ["os", "text-processing"]
documentation = "https://docs.rs/spellbound"
repository = "https://github.com/rtmongold/spellbound"
version = "0.2.0"
authors = ["Andy Russell <arussell123@gmail.com>"]
authors = [
"Andy Russell <arussell123@gmail.com>",
"Robert Mongold <rtmongold@gmail.com>"
]
edition = "2021"
license = "MIT OR Apache-2.0"
readme = "README.md"
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,8 @@ Needs a hunspell dictionary on disk (default search includes `/usr/share/hunspel
Without a dictionary, `Checker::new()` returns `Error::Unavailable`.

## License
MIT OR Apache-2.0
MIT OR Apache-2.0

## Credits

Originally by [Andy Russell](https://github.com/euclio). Maintained in this fork by Robert Mongold.
Loading