Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pt] Added AP to rule ID:VERB_QUE_É_VERB_SER #11207

Merged
merged 2 commits into from
Jan 24, 2025

Conversation

marcoagpinto
Copy link
Member

@marcoagpinto marcoagpinto commented Jan 24, 2025

Just an antipattern.

Summary by CodeRabbit

  • New Features
    • Enhanced Portuguese language rule configuration with a new grammatical antipattern to improve language detection and style checking.
    • Added more precise token matching for specific sentence structures involving determiners, "que", and verb forms.
    • Expanded the part-of-speech dictionary by adding the term "X" as a noun for better language processing.

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Walkthrough

This pull request introduces a new antipattern in the Portuguese language module's style rules XML configuration. The antipattern defines a specific grammatical sequence involving determiners, the word "que", verb forms "é" or "são", and additional token conditions. The new rule targets a particular linguistic construction in Portuguese, with two example sentences demonstrating its application. Additionally, a new entry for the term "X" has been added to the part-of-speech dictionary, expanding the vocabulary recognized by the language module.

Changes

File Change Summary
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml Added a new XML <antipattern> element with complex token matching conditions for Portuguese grammatical structures.
languagetool-language-modules/pt/src/main/resources/org/languagetool/resource/pt/added.txt Added a new entry defining the term "X" as a noun (NPMS000) in the part-of-speech dictionary.

Possibly related issues

Possibly related PRs

Suggested reviewers

  • jaumeortola

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dec03ed and 5302bf3.

📒 Files selected for processing (1)
  • languagetool-language-modules/pt/src/main/resources/org/languagetool/resource/pt/added.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (python)
🔇 Additional comments (2)
languagetool-language-modules/pt/src/main/resources/org/languagetool/resource/pt/added.txt (2)

260-260: LGTM! Entry follows the correct format and placement.

The new entry follows the file's tab-separated format and is correctly placed in the manual entries section.


260-260: Verify the usage context of 'X' in the antipattern rule.

Since this entry is related to the VERB_QUE_É_VERB_SER antipattern rule, please verify its intended usage in the rule definition.

Run the following script to check how this entry is used in the antipattern rule:


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml (2)

15092-15093: Examples should demonstrate edge cases.

While the provided examples are valid, they only demonstrate the basic case. Consider adding examples that:

  1. Test the maximum skip distance (4 tokens)
  2. Show variations of preposition + article combinations
  3. Include both singular ("é") and plural ("são") cases with minimum tokens

15085-15094: Consider adding XML comments for maintainability.

The antipattern would benefit from a comment explaining:

  1. The grammatical construction it's trying to match
  2. Why this is an exception to the rule
  3. The meaning of each token's postag pattern

Add a comment block like this:

+            <!--
+            Antipattern for constructions where "que é/são" is followed by an indefinite determiner
+            SPS00:DA = preposition + article
+            DP = demonstrative pronoun
+            DI = indefinite determiner
+            -->
             <antipattern>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2fac3c4 and dec03ed.

📒 Files selected for processing (1)
  • languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml (1 hunks)
🔇 Additional comments (1)
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml (1)

15087-15091: Verify the token sequence and skip value.

The antipattern structure looks correct, but the skip='4' value on line 15088 might be too permissive and could lead to false positives. Consider if a smaller skip value would be sufficient.

Let's analyze other similar patterns in the codebase:

@marcoagpinto marcoagpinto merged commit da6c127 into master Jan 24, 2025
4 of 5 checks passed
@marcoagpinto marcoagpinto deleted the lt_marcoagpinto_20250124_2301 branch January 24, 2025 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant