dustinblackman / dustinblackman/languagetool-code-comments
Comments sent to LanguageTool are not stripped of their language-specific comment marks
- Dominant language
- Rust
- Stars
- 37
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
For instance, for https://github.com/dustinblackman/languagetool-code-comments/blob/main/tests/fixtures/astro.astro#L7, the text that gets sent to the LanguageTool server for analysis is ``, where I would have expected that `I am a comment number two.` be sent.
This can result in LanguageTool reporting various language issues, such as a [Do you wish to insert an arrow?](https://community.languagetool.org/rule/show/ARROWS?lang=en-GB&subId=2) typography issue.
Although I understand that stripping the language-specific comment marks may not be trivial (because it is language-specific), the current behaviour is surely not optimal.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with tests/fixtures/astro.astro#L7 and trace how that comment text is prepared before it is sent to the LanguageTool server. Check how language-specific comment marks are handled and define done as sending only the comment content, such as “I am a comment number two.”, without the surrounding markers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100