Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat: created linter for ellipsis length

Elijah Potter151967cb0df5
diff --git a/harper-core/src/document.rs b/harper-core/src/document.rs
index 21ae64d2b..fcbb933ba 100644
--- a/harper-core/src/document.rs
+++ b/harper-core/src/document.rs
@@ -511,7 +511,7 @@ impl Document {
let mut to_remove = VecDeque::new();
for found_slice in found {
- if found_slice.len() <= 2 {
+ if found_slice.len() <= 1 {
continue;
}
@@ -601,6 +601,7 @@ impl TokenStringExt for Document {
create_fns_on_doc!(quote);
create_fns_on_doc!(number);
create_fns_on_doc!(at);
+ create_fns_on_doc!(ellipsis);
fn first_sentence_word(&self) -> Option<Token> {
self.tokens.first_sentence_word()
@@ -775,4 +776,14 @@ mod tests {
fn parses_ellipsis() {
assert_token_count("...", 1);
}
+
+ #[test]
+ fn parses_long_ellipsis() {
+ assert_token_count(".....", 1);
+ }
+
+ #[test]
+ fn parses_short_ellipsis() {
+ assert_token_count("..", 1);
+ }
}
diff --git a/harper-core/src/linting/ellipsis_length.rs b/harper-core/src/linting/ellipsis_length.rs
new file mode 100644
index 000000000..c74106cdd
--- /dev/null
+++ b/harper-core/src/linting/ellipsis_length.rs
@@ -0,0 +1,59 @@
+use itertools::Itertools;
+
+use super::{Lint, LintKind, Linter, Suggestion};
+use crate::TokenStringExt;
+
+/// A linter that checks that an ellipsis doesn't contain too many periods (or
+/// too few).
+#[derive(Debug, Default)]
+pub struct EllipsisLength;
+
+impl Linter for EllipsisLength {
+ fn lint(&mut self, document: &crate::Document) -> Vec<super::Lint> {
+ let mut lints = Vec::new();
+
+ for tok in document.iter_ellipsiss() {
+ let tok_content = document.get_span_content(tok.span);
+
+ if tok_content.is_empty() {
+ continue;
+ }
+
+ if tok_content.first().cloned() == Some('.')
+ && tok_content.iter().all_equal()
+ && tok_content.len() != 3
+ {
+ lints.push(Lint {
+ span: tok.span,
+ lint_kind: LintKind::Formatting,
+ suggestions: vec![Suggestion::ReplaceWith(vec!['.', '.', '.'])],
+ message: "Horizontal ellipsis must have 3 dots.".to_string(),
+ priority: 31
+ })
+ }
+ }
+
+ lints
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::EllipsisLength;
+ use crate::linting::tests::assert_lint_count;
+
+ #[test]
+ fn allows_correct_ellipsis() {
+ assert_lint_count("...", EllipsisLength, 0);
+ }
+
+ #[test]
+ fn corrects_long_ellipsis() {
+ assert_lint_count(".....", EllipsisLength, 1);
+ }
+
+ #[test]
+ fn corrects_short_ellipsis() {
+ assert_lint_count("..", EllipsisLength, 1);
+ }
+}
diff --git a/harper-core/src/linting/lint_group.rs b/harper-core/src/linting/lint_group.rs
index 533649ad0..d15eab632 100644
--- a/harper-core/src/linting/lint_group.rs
+++ b/harper-core/src/linting/lint_group.rs
@@ -4,6 +4,7 @@ use serde::{Deserialize, Serialize};
use super::an_a::AnA;
use super::avoid_curses::AvoidCurses;
use super::correct_number_suffix::CorrectNumberSuffix;
+use super::ellipsis_length::EllipsisLength;
use super::linking_verbs::LinkingVerbs;
use super::long_sentences::LongSentences;
use super::matcher::Matcher;
@@ -111,7 +112,8 @@ create_lint_group_config!(
MultipleSequentialPronouns => true,
LinkingVerbs => false,
AvoidCurses => true,
- TerminatingConjunctions => true
+ TerminatingConjunctions => true,
+ EllipsisLength => true
);
impl<T: Dictionary + Default> Default for LintGroup<T> {
diff --git a/harper-core/src/linting/mod.rs b/harper-core/src/linting/mod.rs
index 587bba181..422564ec8 100644
--- a/harper-core/src/linting/mod.rs
+++ b/harper-core/src/linting/mod.rs
@@ -1,6 +1,7 @@
mod an_a;
mod avoid_curses;
mod correct_number_suffix;
+mod ellipsis_length;
mod linking_verbs;
mod lint;
mod lint_group;
diff --git a/harper-core/src/patterns/sequence_pattern.rs b/harper-core/src/patterns/sequence_pattern.rs
index e7e0ec180..11572e113 100644
--- a/harper-core/src/patterns/sequence_pattern.rs
+++ b/harper-core/src/patterns/sequence_pattern.rs
@@ -131,7 +131,7 @@ mod tests {
#[test]
fn matches_n_whitespace_tokens() {
- let mut pat = SequencePattern::default()
+ let pat = SequencePattern::default()
.then_any_word()
.then_whitespace()
.then_any_word();
diff --git a/harper-core/src/token.rs b/harper-core/src/token.rs
index 3cebb4fef..716465c8a 100644
--- a/harper-core/src/token.rs
+++ b/harper-core/src/token.rs
@@ -97,6 +97,10 @@ impl TokenKind {
)
}
+ pub fn is_ellipsis(&self) -> bool {
+ matches!(self, TokenKind::Punctuation(Punctuation::Ellipsis))
+ }
+
pub fn is_swear(&self) -> bool {
matches!(
self,
@@ -325,6 +329,7 @@ pub trait TokenStringExt {
create_decl_for!(quote);
create_decl_for!(number);
create_decl_for!(at);
+ create_decl_for!(ellipsis);
fn iter_linking_verb_indices(&self) -> impl Iterator<Item = usize> + '_;
fn iter_linking_verbs(&self) -> impl Iterator<Item = Token> + '_;
@@ -338,6 +343,7 @@ impl TokenStringExt for [Token] {
create_fns_for!(quote);
create_fns_for!(number);
create_fns_for!(at);
+ create_fns_for!(ellipsis);
fn first_non_whitespace(&self) -> Option<Token> {
self.iter().find(|t| !t.kind.is_whitespace()).copied()