chore(lib): fully refactor the library for v3 #117

jeertmans · 2024-04-19T13:25:12Z

The goal of this PR is to reorganize the crate so that:

LanguageTool API related stuff is self-contained in src/lib/. This folder should not contain anything else, except a few mandatory CLI related features, guarded behind #[cfg_attr(feature = "cli", derive(...))] and similar;
put WordsAdd and WordsDelete inside submodules;
put CLI related stuff inside src/cli, and renamed cli.rs to src/lib/mod.rs;
in src/cli/check.rs, prepare the necessary logic to (1) read multiple filenames, (2) detect file type and use correct parser (i.e., Typst, Markdown, or raw text), and (3) generate a many requests as needed, splitting long text if needed.
some work may be needed to join multiple requests that were generated using data annotation, as Typst and Markdown parser will eventually generate annotated data
Error::ResponseEncode and Error::RequestEncode are remove and only Error::Request is used.
A bit unrelated, but we can edit

languagetool-rust/.github/workflows/rustlib.yml

Line 33 in a217b40

tag: [latest, '5.5', '5.6', '5.7', '5.8', '5.9', '6.0', '6.1']

so that it also covers 6.2, 6.3, 6.4, and 6.5

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

src/check.rs|861 col 4| If ‘Type’ is a classification term, ‘a’ is not necessary. Use “Type of”. (The phrases ‘kind of’ and ‘sort of’ are informal if they mean ‘to some extent’.) (KIND_OF_A[1])
Suggestions: Type of
Rule: https://community.languagetool.org/rule/show/KIND_OF_A?lang=en-US&subId=1
Category: GRAMMAR
src/check.rs|884 col 38| Possible agreement error - use third-person verb forms for singular and mass nouns. (MASS_AGREEMENT[11])
Suggestions: starts
Rule: https://community.languagetool.org/rule/show/MASS_AGREEMENT?lang=en-US&subId=11
Category: GRAMMAR
src/check.rs|993 col 20| This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING
src/check.rs|1017 col 20| Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION
src/check.rs|1121 col 13| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Response, response
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING
src/check.rs|1174 col 18| Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION
src/check.rs|1189 col 13| If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Offset, offset
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

CHANGELOG.md

src/api/check.rs

src/api/mod.rs

src/check.rs

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

[LanguageTool] _{reported by reviewdog 🐶}
A comma may be missing after the conjunctive/linking adverb ‘Thus’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[1])
Suggestions: Thus,
URL: https://languagetool.org/insights/post/linking-words/
Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=1
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 475 in 6192d9b

/// used. Thus this parameter can be used to specify the preferred variants

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Text, text
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 545 in 6192d9b

self.text = Some(text);

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Data, data
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 546 in 6192d9b

self.data = None;

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Data, data
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 553 in 6192d9b

self.data = Some(data);

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Text, text
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 554 in 6192d9b

self.text = None;

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Language, language
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 567 in 6192d9b

self.language = language;

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Text, text
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 578 in 6192d9b

if let Some(ref text) = self.text {

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Data, data
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 580 in 6192d9b

} else if let Some(ref data) = self.data {

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Text, text
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 583 in 6192d9b

if let Some(ref t) = da.text {

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Markup, markup
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 585 in 6192d9b

} else if let Some(ref t) = da.markup {

[LanguageTool] _{reported by reviewdog 🐶}
Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Suggestions: text
Rule: https://community.languagetool.org/rule/show/ENGLISH_WORD_REPEAT_RULE?lang=en-US
Category: MISC

languagetool-rust/src/check.rs

Line 679 in 6192d9b

/// - raw text, if `--text TEXT` is provided;

[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

languagetool-rust/src/check.rs

Line 818 in 6192d9b

/// Category id.

[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

languagetool-rust/src/check.rs

Line 819 in 6192d9b

pub id: String,

[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

languagetool-rust/src/check.rs

Line 841 in 6192d9b

/// Rule id.

[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

languagetool-rust/src/check.rs

Line 842 in 6192d9b

pub id: String,

[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

languagetool-rust/src/check.rs

Line 846 in 6192d9b

/// Rule sub id.

[LanguageTool] _{reported by reviewdog 🐶}
If ‘Type’ is a classification term, ‘a’ is not necessary. Use “Type of”. (The phrases ‘kind of’ and ‘sort of’ are informal if they mean ‘to some extent’.) (KIND_OF_A[1])
Suggestions: Type of
Rule: https://community.languagetool.org/rule/show/KIND_OF_A?lang=en-US&subId=1
Category: GRAMMAR

languagetool-rust/src/check.rs

Line 861 in 6192d9b

/// Type of a given match.

[LanguageTool] _{reported by reviewdog 🐶}
Possible agreement error - use third-person verb forms for singular and mass nouns. (MASS_AGREEMENT[11])
Suggestions: starts
Rule: https://community.languagetool.org/rule/show/MASS_AGREEMENT?lang=en-US&subId=11
Category: GRAMMAR

languagetool-rust/src/check.rs

Line 884 in 6192d9b

/// Char index at which the match start.

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 959 in 6192d9b

pub fn iter_matches(&self) -> std::slice::Iter<'_, Match> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 964 in 6192d9b

pub fn iter_matches_mut(&mut self) -> std::slice::IterMut<'_, Match> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 981 in 6192d9b

acc.push_str(", ");

[LanguageTool] _{reported by reviewdog 🐶}
This abbreviation for “identification” is spelled all-uppercase. (ID_CASING[2])
Suggestions: ID
Rule: https://community.languagetool.org/rule/show/ID_CASING?lang=en-US&subId=2
Category: CASING

languagetool-rust/src/check.rs

Line 993 in 6192d9b

id: Some(&m.rule.id),

[LanguageTool] _{reported by reviewdog 🐶}
Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1017 in 6192d9b

..Default::default()

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1026 in 6192d9b

annotation.push('\n');

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1061 in 6192d9b

pub fn iter_matches(&self) -> std::slice::Iter<'_, Match> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1066 in 6192d9b

pub fn iter_matches_mut(&mut self) -> std::slice::IterMut<'_, Match> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1073 in 6192d9b

    
           pub fn iter_match_positions(&self) -> MatchPositions<'_, std::slice::Iter<'_, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1073 in 6192d9b

    
           pub fn iter_match_positions(&self) -> MatchPositions<'_, std::slice::Iter<'_, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1113 in 6192d9b

    
           let iter: MatchPositions<'_, std::slice::IterMut<'_, Match>> = (&mut resp).into();

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1113 in 6192d9b

    
           let iter: MatchPositions<'_, std::slice::IterMut<'_, Match>> = (&mut resp).into();

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Response, response
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 1121 in 6192d9b

resp.response

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1127 in 6192d9b

pub struct MatchPositions<'source, T> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1128 in 6192d9b

text_chars: std::str::Chars<'source>,

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1135 in 6192d9b

impl<'source> From<&'source ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1135 in 6192d9b

impl<'source> From<&'source ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1136 in 6192d9b

for MatchPositions<'source, std::slice::Iter<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1136 in 6192d9b

for MatchPositions<'source, std::slice::Iter<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1138 in 6192d9b

fn from(response: &'source ResponseWithContext) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1149 in 6192d9b

impl<'source> From<&'source mut ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1149 in 6192d9b

impl<'source> From<&'source mut ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1150 in 6192d9b

for MatchPositions<'source, std::slice::IterMut<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1150 in 6192d9b

for MatchPositions<'source, std::slice::IterMut<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1152 in 6192d9b

fn from(response: &'source mut ResponseWithContext) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1163 in 6192d9b

impl<'source, T> MatchPositions<'source, T> {

[LanguageTool] _{reported by reviewdog 🐶}
Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1174 in 6192d9b

for _ in 0..n {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1176 in 6192d9b

Some('\n') => {

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Offset, offset
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 1189 in 6192d9b

self.offset = m.offset;

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1193 in 6192d9b

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::Iter<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1193 in 6192d9b

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::Iter<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1193 in 6192d9b

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::Iter<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1194 in 6192d9b

type Item = (usize, usize, &'source Match);

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1206 in 6192d9b

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::IterMut<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1206 in 6192d9b

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::IterMut<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1206 in 6192d9b

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::IterMut<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1207 in 6192d9b

type Item = (usize, usize, &'source mut Match);

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1224 in 6192d9b

enum Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1225 in 6192d9b

Text(&'source str),

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1226 in 6192d9b

Skip(&'source str),

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in 6192d9b

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in 6192d9b

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in 6192d9b

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1233 in 6192d9b

fn from(s: &'source str) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1242 in 6192d9b

impl<'source> From<Token<'source>> for DataAnnotation {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1242 in 6192d9b

impl<'source> From<Token<'source>> for DataAnnotation {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1253 in 6192d9b

let words: Vec<&str> = "My name is Q34XY".split(' ').collect();

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/lib.rs

Line 6 in 6192d9b

#![doc = include_str!("../README.md")]

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/lib.rs

Line 6 in 6192d9b

#![doc = include_str!("../README.md")]

src/api/check.rs

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Response, response
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 1121 in eeecd33

resp.response

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1127 in eeecd33

pub struct MatchPositions<'source, T> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1128 in eeecd33

text_chars: std::str::Chars<'source>,

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1135 in eeecd33

impl<'source> From<&'source ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1135 in eeecd33

impl<'source> From<&'source ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1136 in eeecd33

for MatchPositions<'source, std::slice::Iter<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1136 in eeecd33

for MatchPositions<'source, std::slice::Iter<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1138 in eeecd33

fn from(response: &'source ResponseWithContext) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1149 in eeecd33

impl<'source> From<&'source mut ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1149 in eeecd33

impl<'source> From<&'source mut ResponseWithContext>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1150 in eeecd33

for MatchPositions<'source, std::slice::IterMut<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1150 in eeecd33

for MatchPositions<'source, std::slice::IterMut<'source, Match>>

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1152 in eeecd33

fn from(response: &'source mut ResponseWithContext) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1163 in eeecd33

impl<'source, T> MatchPositions<'source, T> {

[LanguageTool] _{reported by reviewdog 🐶}
Two consecutive dots (DOUBLE_PUNCTUATION)
Suggestions: ., …
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-periods
Rule: https://community.languagetool.org/rule/show/DOUBLE_PUNCTUATION?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1174 in eeecd33

for _ in 0..n {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1176 in eeecd33

Some('\n') => {

[LanguageTool] _{reported by reviewdog 🐶}
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Offset, offset
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

languagetool-rust/src/check.rs

Line 1189 in eeecd33

self.offset = m.offset;

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1193 in eeecd33

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::Iter<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1193 in eeecd33

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::Iter<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1193 in eeecd33

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::Iter<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1194 in eeecd33

type Item = (usize, usize, &'source Match);

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1206 in eeecd33

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::IterMut<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1206 in eeecd33

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::IterMut<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1206 in eeecd33

    
           impl<'source> Iterator for MatchPositions<'source, std::slice::IterMut<'source, Match>> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1207 in eeecd33

type Item = (usize, usize, &'source mut Match);

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1224 in eeecd33

enum Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1225 in eeecd33

Text(&'source str),

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1226 in eeecd33

Skip(&'source str),

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in eeecd33

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in eeecd33

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in eeecd33

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1233 in eeecd33

fn from(s: &'source str) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1242 in eeecd33

impl<'source> From<Token<'source>> for DataAnnotation {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1242 in eeecd33

impl<'source> From<Token<'source>> for DataAnnotation {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1253 in eeecd33

let words: Vec<&str> = "My name is Q34XY".split(' ').collect();

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/lib.rs

Line 6 in eeecd33

#![doc = include_str!("../README.md")]

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/lib.rs

Line 6 in eeecd33

#![doc = include_str!("../README.md")]

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1232 in dd7b73b

impl<'source> From<&'source str> for Token<'source> {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1233 in dd7b73b

fn from(s: &'source str) -> Self {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1242 in dd7b73b

impl<'source> From<Token<'source>> for DataAnnotation {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1242 in dd7b73b

impl<'source> From<Token<'source>> for DataAnnotation {

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘'’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/check.rs

Line 1253 in dd7b73b

let words: Vec<&str> = "My name is Q34XY".split(' ').collect();

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/lib.rs

Line 6 in dd7b73b

#![doc = include_str!("../README.md")]

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

languagetool-rust/src/lib.rs

Line 6 in dd7b73b

#![doc = include_str!("../README.md")]

* fix!: adjustments after refactor * Update README.md Co-authored-by: Jérome Eertmans <jeertmans@icloud.com> * docs(changelog): remove mention of support for markdown and typst files for now * refactor: use `check::Request`, `check::Response` and `check::ResponseWithContext` * chore: formatting * fix: minimum Rust version needs to be higher for `clap` * fix: doc test * refactor: use crate's result type for the `check` method on `Client` * refactor: use crate's result type for the `languages` method on `Client` * Update src/api/mod.rs Co-authored-by: Jérome Eertmans <jeertmans@icloud.com> * Update src/api/mod.rs Co-authored-by: Jérome Eertmans <jeertmans@icloud.com> * fix: convert `reqwest` error --------- Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

src/api/check.rs

src/api/mod.rs

src/lib.rs

* fix!: adjustments after refactor * Update README.md Co-authored-by: Jérome Eertmans <jeertmans@icloud.com> * docs(changelog): remove mention of support for markdown and typst files for now * refactor: use `check::Request`, `check::Response` and `check::ResponseWithContext` * chore: formatting * fix: minimum Rust version needs to be higher for `clap` * fix: doc test * refactor: use crate's result type for the `check` method on `Client` * refactor: use crate's result type for the `languages` method on `Client` * Update src/api/mod.rs Co-authored-by: Jérome Eertmans <jeertmans@icloud.com> * Update src/api/mod.rs Co-authored-by: Jérome Eertmans <jeertmans@icloud.com> * fix: convert `reqwest` error --------- Co-authored-by: Jérome Eertmans <jeertmans@icloud.com>

codspeed-hq · 2024-09-29T08:23:45Z

CodSpeed Performance Report

Congrats! CodSpeed is installed 🎉

🆕 6 new benchmarks were detected.

You will start to see performance impacts in the reports once the benchmarks are run from your default branch.

Detected benchmarks

large (109.1 ms)
medium (109 ms)
small (108.5 ms)
large (126.6 ms)
medium (112.8 ms)
small (109.3 ms)

codecov · 2024-09-29T08:31:40Z

Codecov Report

Attention: Patch coverage is 20.00000% with 28 lines in your changes missing coverage. Please review.

Project coverage is 22.93%. Comparing base (eff21fc) to head (a7247e4).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
src/api/server.rs	26.66%	11 Missing ⚠️
src/api/mod.rs	0.00%	10 Missing ⚠️
src/api/check.rs	50.00%	3 Missing ⚠️
src/api/words/mod.rs	0.00%	3 Missing ⚠️
src/cli.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #117      +/-   ##
==========================================
- Coverage   23.55%   22.93%   -0.62%     
==========================================
  Files           7        8       +1     
  Lines         518      532      +14     
==========================================
  Hits          122      122              
- Misses        396      410      +14

Flag	Coverage Δ
	`22.93% <20.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jeertmans · 2024-09-29T08:35:40Z

Hi @Rolv-Apneseth! So I just did some efforts to clean the CI, and also slightly updated the main comment of this PR. What would you like to work on? I don't have much time to actually implement things, as I have other work to do for my thesis ^^', but I am happy to perform reviews :-)

Rolv-Apneseth · 2024-09-29T10:15:14Z

Hi! I don't mind, what do you think is a reasonable next step here? Also best of luck with your thesis

jeertmans · 2024-09-29T10:54:19Z

Hi! I don't mind, what do you think is a reasonable next step here? Also best of luck with your thesis

Thanks! Can you just check the to-do list above, and see what you can do?

Rolv-Apneseth · 2024-09-29T17:54:34Z

Sure, so maybe for the first one I can just move all API code to a src/lib/ directory, and move cli stuff to src/cli/mod.rs? WordsAdd and WordsDelete should already be in submodules.

Also would you mind explaining the reasoning behind the cli feature? I thought that would just be separated out entirely and only used in main.rs

jeertmans · 2024-09-29T19:23:50Z

Sure, so maybe for the first one I can just move all API code to a src/lib/ directory, and move cli stuff to src/cli/mod.rs? WordsAdd and WordsDelete should already be in submodules.

Sure, looks good!

Also would you mind explaining the reasoning behind the cli feature? I thought that would just be separated out entirely and only used in main.rs

Of course :-)
Two main reasons:

People may want to use LTRS as a crate, and I don't want to enforce them to download and compile the code that is only used for building the CLI. Using a feature allows excluding this part of the library.
I don't want to pollute the "language tool API binding" parts with too much code that is not related to it. The only exceptions are the derive macros that are way more convenient to put directly on the original request structures.

Did I answer your question?

Rolv-Apneseth · 2024-09-29T19:45:18Z

Not quite sorry. I understand being able to disable it, but what is the benefit of enabling it? Why not just have the CLI stuff separated entirely from the library side, and only used in the binary

jeertmans · 2024-09-29T21:04:26Z

Not quite sorry. I understand being able to disable it, but what is the benefit of enabling it? Why not just have the CLI stuff separated entirely from the library side, and only used in the binary

There is too much things to be put inside just main.rs

Creating a sub crate allows to have a cleaner workspace, and testing libraries is also easier. Finally, people could be interested to have the CLI tools exposed in the public API, e.g., to create a wrapper application. There may be better project organization, and I am of course open to suggestion.

Rolv-Apneseth · 2024-09-29T21:37:16Z

people could be interested to have the CLI tools exposed in the public API, e.g., to create a wrapper application.

I see, alright that makes sense, thank you

Rolv-Apneseth · 2024-09-29T21:38:19Z

Perhaps we could split it into a separate workspace with a library of it's own? It would need to be published as a separate crate though I guess. Anyway, not necessary, just a possibility.

Rolv-Apneseth · 2024-10-02T23:24:05Z

I'm actually not sure how to split it up as it is, could you advise a bit on how to proceed? The CLI and rest of the API functionality are very heavily intertwined and I need lib.rs where it is so that it can import api.

Only easy change I can see would be moving docker.rs and api.rs into an api directory, as it appears to me like everything for docker depends on the cli feature anyway? I could use some clarification on that one - is it only meant to be used via the library? It could be nice to have a docker subcommand for the CLI if that code is works as intended.

I personally think it's fine how it is currently if you want to keep the setup with the cli feature. I would consider removing the feature altogether though as it's unlikely to be useful to others in my opinion, as they can just use the library to achieve the primary functionality of this project, or call the binary and read it's output if they do need some kind of wrapper.

jeertmans · 2024-10-05T11:18:31Z

Hey @Rolv-Apneseth, sorry for the late reply!

For the multiple crate workspace, this is indeed a solution, but it also requires some additional work for (1) publishing crates and (2) potentially exposing more things to the public API so they can be used in the "cli" crate. All that being said, splitting the work in separate crates is not urgent, not to say the hassle, I think.

So, I prefer to stick with the current layout:

lib.rs  <-- this exports modules as public, even the `mod cli` that is exported behind the `cli` feature
main.rs <-- this imports the main Clap command and runs it
error.rs  <-- this defines error types used all across the crate
api/
  mod.rs
  check.rs <-- I think it would be better to allow string references, not `String`, or a least Cow<'str>, because we may want to have dumb copies, especially when serializing requests already performs a copy, so we never need owned data
  word.rs
  langages.rs
  docker.rs
  server.rs  <-- we might want to remove the logic for splitting requests, and only put it in CLI, not sure (I want the server to be dead simple, but still provide a way for efficient multiple requests). I am open to any suggestion.
cli/
  mod.rs <-- this creates the main Clap command, that is simply imported and executed in main.rs
  check.rs <-- this, e.g., should handle arguments like files, stdin, 'raw' and produce appropriate requests (e.g., one request for file). Usually, you create a Clap command that flattens `api::check::Request`.
  words.rs <-- should be dead simple
  languages <-- should be dead simple
  ...

E.g., cli/docker.rs would import everything needed from lib/docker.rs and create the DockerCommand, see https://github.com/jeertmans/languagetool-rust/blob/a217b4061f35a915920514ba73a55720f3fdff29/src/lib/docker.rs#L154C1-L173C2

This command is then imported in cli/mod.rs to build the full CLI.

I know it may not be 100% clear, especially as it isn't still crystal clear to me what I would prefer doing, but I hope the small "directory tree" explanation helped. Let me know what you think and let's start to take decisions :-)

Rolv-Apneseth · 2024-10-05T13:22:39Z

Hey, all good.

So, I prefer to stick with the current layout

Sure, makes sense.

we might want to remove the logic for splitting requests, and only put it in CLI, not sure (I want the server to be dead simple, but still provide a way for efficient multiple requests). I am open to any suggestion

I'm don't know what's best, but probably OK to keep it in with the server logic?

As for the other things - I believe I have a better idea of what the goal is now. I'll make a PR hopefully today and you can request whatever changes you want, so we can get into the specifics

jeertmans · 2024-10-05T19:17:58Z

Hey, all good.

So, I prefer to stick with the current layout

Sure, makes sense.

we might want to remove the logic for splitting requests, and only put it in CLI, not sure (I want the server to be dead simple, but still provide a way for efficient multiple requests). I am open to any suggestion

I'm don't know what's best, but probably OK to keep it in with the server logic?

As for the other things - I believe I have a better idea of what the goal is now. I'll make a PR hopefully today and you can request whatever changes you want, so we can get into the specifics

Great! Please suggest anything :-) I am currently a bit overwhelmed with work on my thesis, it's hard for my to give this project more than a few hours a week, which also means I didn't have yet enough time to pause and think about how to clearly plan the next steps.

So go on and work on whatever part you prefer about this PR, I will try to review them relatively quickly, and I hope to give more time to this project after my deadlines (i.e., end of October).

Rolv-Apneseth · 2024-10-05T19:21:07Z

Yeah no worries, there's no rush with any of this anyway. I'm working on some refactoring now, we'll see if I finish today or tomorrow but either way you can review and make suggestions just whenever you get the chance

jeertmans added the library Relate to the library (i.e., crate) label Apr 19, 2024

This comment was marked as outdated.

Sign in to view

github-actions bot reviewed Apr 19, 2024

View reviewed changes

jeertmans mentioned this pull request Sep 18, 2024

feat: longer texts or more helpful output #119

Open

github-actions bot reviewed Sep 19, 2024

View reviewed changes

src/api/check.rs Show resolved Hide resolved

github-actions bot reviewed Sep 19, 2024

View reviewed changes

jeertmans added enhancement New feature or request cli Related to the CLI labels Sep 19, 2024

Rolv-Apneseth mentioned this pull request Sep 21, 2024

chore(lib): continuation of v3 refactor (see #117) #120

Merged

github-actions bot reviewed Sep 28, 2024

View reviewed changes

This comment was marked as outdated.

Sign in to view

jeertmans and others added 5 commits September 29, 2024 10:12

chore(lib): fully refactor the library for v3

6531ec5

fix(docs): CHANGELOG.md

eef5101

fix(docs): CHANGELOG.md

153b454

fix(ci): remove PDM install

dccdcbc

jeertmans force-pushed the v3 branch from b842bf1 to d411823 Compare September 29, 2024 08:15

fix(lib): remove duplicate key

df0130b

jeertmans added 2 commits September 29, 2024 10:26

fix(ci): add codecov token

039af11

Merge branch 'main' into v3

a7247e4

Rolv-Apneseth mentioned this pull request Oct 5, 2024

refactor: further separate CLI logic from the API related functionality (see #117) #124

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(lib): fully refactor the library for v3 #117

chore(lib): fully refactor the library for v3 #117

jeertmans commented Apr 19, 2024 •

edited

Loading

This comment was marked as outdated.

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

This comment was marked as outdated.

codspeed-hq bot commented Sep 29, 2024 •

edited

Loading

Detected benchmarks

codecov bot commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

Rolv-Apneseth commented Oct 2, 2024

jeertmans commented Oct 5, 2024

Rolv-Apneseth commented Oct 5, 2024

jeertmans commented Oct 5, 2024

Rolv-Apneseth commented Oct 5, 2024

chore(lib): fully refactor the library for v3 #117

Are you sure you want to change the base?

chore(lib): fully refactor the library for v3 #117

Conversation

jeertmans commented Apr 19, 2024 • edited Loading

This comment was marked as outdated.

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

codspeed-hq bot commented Sep 29, 2024 • edited Loading

CodSpeed Performance Report

Congrats! CodSpeed is installed 🎉

Detected benchmarks

codecov bot commented Sep 29, 2024

Codecov Report

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

jeertmans commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

Rolv-Apneseth commented Sep 29, 2024

Rolv-Apneseth commented Oct 2, 2024

jeertmans commented Oct 5, 2024

Rolv-Apneseth commented Oct 5, 2024

jeertmans commented Oct 5, 2024

Rolv-Apneseth commented Oct 5, 2024

jeertmans commented Apr 19, 2024 •

edited

Loading

codspeed-hq bot commented Sep 29, 2024 •

edited

Loading