Skip to content

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

feat: create linter to capitalize first person singular pronouns

Elijah Potter97291408b3c5
diff --git a/harper-core/src/linting/capitalize_personal_pronouns.rs b/harper-core/src/linting/capitalize_personal_pronouns.rs
new file mode 100644
index 000000000..849d0d814
--- /dev/null
+++ b/harper-core/src/linting/capitalize_personal_pronouns.rs
@@ -0,0 +1,67 @@
+use crate::{NounData, TokenKind, TokenStringExt, WordMetadata};
+
+use super::{Lint, LintKind, Linter, Suggestion};
+
+/// A super-simple linter that makes sure you capitalize "I".
+#[derive(Default)]
+pub struct CapitalizePersonalPronouns;
+
+impl Linter for CapitalizePersonalPronouns {
+ fn lint(&mut self, document: &crate::Document) -> Vec<Lint> {
+ let mut lints = Vec::new();
+
+ for tok in document.iter_words() {
+ if let TokenKind::Word(WordMetadata {
+ noun:
+ Some(NounData {
+ is_pronoun: Some(true),
+ ..
+ }),
+ ..
+ }) = tok.kind
+ {
+ if document.get_span_content(tok.span) == ['i'] {
+ lints.push(Lint {
+ span: tok.span,
+ lint_kind: LintKind::Capitalization,
+ suggestions: vec![Suggestion::ReplaceWith(vec!['I'])],
+ message: "First-person singular pronouns must be capitalized.".to_string(),
+ priority: 31,
+ });
+ }
+ }
+ }
+
+ lints
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::linting::tests::assert_suggestion_result;
+
+ use super::CapitalizePersonalPronouns;
+
+ #[test]
+ fn start() {
+ assert_suggestion_result("i am hungry", CapitalizePersonalPronouns, "I am hungry");
+ }
+
+ #[test]
+ fn end() {
+ assert_suggestion_result(
+ "There is no one stronger than i",
+ CapitalizePersonalPronouns,
+ "There is no one stronger than I",
+ );
+ }
+
+ #[test]
+ fn middle() {
+ assert_suggestion_result(
+ "First of all, i am not happy with this.",
+ CapitalizePersonalPronouns,
+ "First of all, I am not happy with this.",
+ );
+ }
+}
diff --git a/harper-core/src/linting/lint_group.rs b/harper-core/src/linting/lint_group.rs
index 88740f704..728679e9b 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::boring_words::BoringWords;
+use super::capitalize_personal_pronouns::CapitalizePersonalPronouns;
use super::correct_number_suffix::CorrectNumberSuffix;
use super::dot_initialisms::DotInitialisms;
use super::ellipsis_length::EllipsisLength;
@@ -131,7 +132,8 @@ create_lint_group_config!(
DotInitialisms => true,
BoringWords => false,
UseGenitive => false,
- ThatWhich => true
+ ThatWhich => true,
+ CapitalizePersonalPronouns => 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 e2978c1ce..70d6d237e 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 boring_words;
+mod capitalize_personal_pronouns;
mod correct_number_suffix;
mod dot_initialisms;
mod ellipsis_length;
@@ -26,6 +27,7 @@ mod wrong_quotes;
pub use an_a::AnA;
pub use avoid_curses::AvoidCurses;
pub use boring_words::BoringWords;
+pub use capitalize_personal_pronouns::CapitalizePersonalPronouns;
pub use correct_number_suffix::CorrectNumberSuffix;
pub use dot_initialisms::DotInitialisms;
pub use ellipsis_length::EllipsisLength;