-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): wrote linter to look for separated closed compound words
- Loading branch information
1 parent
9f6737b
commit f4ba4d0
Showing
5 changed files
with
166 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| use std::sync::Arc; | ||
|
|
||
| use itertools::Itertools; | ||
|
|
||
| use crate::{CharString, Dictionary, Document, FstDictionary, Span}; | ||
|
|
||
| use super::{Lint, LintKind, Linter, Suggestion}; | ||
|
|
||
| pub struct CompoundWords { | ||
| dict: Arc<FstDictionary>, | ||
| } | ||
|
|
||
| impl CompoundWords { | ||
| pub fn new() -> Self { | ||
| Self { | ||
| dict: FstDictionary::curated(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl Default for CompoundWords { | ||
| fn default() -> Self { | ||
| Self::new() | ||
| } | ||
| } | ||
|
|
||
| impl Linter for CompoundWords { | ||
| fn lint(&mut self, document: &Document) -> Vec<Lint> { | ||
| let mut lints = Vec::new(); | ||
|
|
||
| let mut merged_word = CharString::new(); | ||
|
|
||
| for (a, w, b) in document.tokens().tuple_windows() { | ||
| if !a.kind.is_word() || !w.kind.is_whitespace() || !b.kind.is_word() { | ||
| continue; | ||
| } | ||
|
|
||
| let a_chars = document.get_span_content(a.span); | ||
| let b_chars = document.get_span_content(b.span); | ||
|
|
||
| // Not super helpful in this case, so we skip it | ||
| if matches!(a_chars, ['a']) { | ||
| continue; | ||
| } | ||
|
|
||
| merged_word.clear(); | ||
| merged_word.extend_from_slice(a_chars); | ||
| merged_word.extend_from_slice(b_chars); | ||
|
|
||
| if self.dict.contains_word(&merged_word) { | ||
| lints.push(Lint { | ||
| span: Span::new(a.span.start, b.span.end), | ||
| lint_kind: LintKind::Spelling, | ||
| suggestions: vec![Suggestion::ReplaceWith(merged_word.to_vec())], | ||
| message: "These two words are often combined to form a closed compound word." | ||
| .to_owned(), | ||
| priority: 63, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| lints | ||
| } | ||
|
|
||
| fn description(&self) -> &str { | ||
| "Accidentally inserting a space inside a word is common. This rule looks for valid words that are split by whitespace." | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use crate::linting::tests::assert_lint_count; | ||
|
|
||
| use super::CompoundWords; | ||
|
|
||
| #[test] | ||
| fn scarecrow() { | ||
| assert_lint_count( | ||
| "I saw a scare crow in the field today.", | ||
| CompoundWords::default(), | ||
| 1, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn clean() { | ||
| assert_lint_count( | ||
| "When referring to the political party, make sure to treat them as a proper noun.", | ||
| CompoundWords::default(), | ||
| 0, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn bookshelf() { | ||
| assert_lint_count( | ||
| "I have a big book shelf in my room.", | ||
| CompoundWords::default(), | ||
| 1, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn sunscreen() { | ||
| assert_lint_count( | ||
| "Don't forget to apply your sunscreen before going out.", | ||
| CompoundWords::default(), | ||
| 0, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn makeup() { | ||
| assert_lint_count( | ||
| "She spent a lot of time doing her make up this morning.", | ||
| CompoundWords::default(), | ||
| 1, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn birthday() { | ||
| assert_lint_count( | ||
| "We're having a big party to celebrate the couple's birthday today.", | ||
| CompoundWords::default(), | ||
| 0, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn hometown() { | ||
| assert_lint_count( | ||
| "My home town is a beautiful place with many historical land marks.", | ||
| CompoundWords::default(), | ||
| 2, | ||
| ); | ||
| } | ||
|
|
||
| #[test] | ||
| fn assertions() { | ||
| assert_lint_count( | ||
| "Make sure to compile with debug ass ertions disabled.", | ||
| CompoundWords::default(), | ||
| 1, | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters