Support for Oxford English (rebased) - #53
Conversation
Reviewer's GuideThis PR introduces automated support for an Oxford English dictionary by generating an “en_to_en-OX” mapping, integrates it into the build and CI pipelines, updates the builtin dictionary configuration, adjusts tests to account for the new file, refines the tox setup, and adds an autofix workflow and regenerated manpage. Class diagram for builtin dictionary configuration updateclassDiagram
class BuiltinDictionaryConfig {
+name: str
+description: str
+filename: str
+auto_fix: bool | None
+enabled: bool | None
+source_langs: tuple | None
+target_langs: tuple | None
}
BuiltinDictionaryConfig <|-- EnToEnOXConfig
class EnToEnOXConfig {
+name = "en_to_en-OX"
+description = "for corrections from en to en-OX"
+filename = "_en_to_en-OX_AUTOGENERATED"
+auto_fix = None
+enabled = None
+source_langs = None
+target_langs = None
}
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Caution Review failedThe pull request is closed. Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds an autofix GitHub Actions workflow. Extends Makefile to generate a new autogenerated dictionary and wires targets to depend on it. Introduces a large autogenerated dictionary file and updates builtin dictionary references and tests accordingly. Updates British→American mappings and adds a generated manpage. Adjusts tox to run dictionary checks via make. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant PR as GitHub PR
participant GA as GitHub Actions (autofix.ci)
participant Make as make
participant Tools as normalize_spelling.sh
participant Repo as Repo (branch)
PR->>GA: opened/synchronize/labeled/unlabeled
GA->>Repo: actions/checkout@v5 (no credentials)
GA->>Make: make (generate autogenerated dictionary)
Make->>Tools: run normalization script
Tools-->>Make: output dictionary_en_to_en-OX_AUTOGENERATED.txt
Make-->>GA: build artifacts updated
GA->>Repo: autofix-ci/action (commit changes)
Repo-->>PR: updated PR with regenerated files
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
Poem
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (8)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `Makefile:7` </location>
<code_context>
+GENERATED := codetypo/data/dictionary_en_to_en-OX_AUTOGENERATED.txt
-check: check-dictionaries check-dist pytest ruff
+all: $(GENERATED) check-dictionaries codespell.1
+
+check: $(GENERATED) check-dictionaries check-dist pytest ruff
</code_context>
<issue_to_address>
**issue (typo):** Check if 'codespell.1' is intended or a typo for 'codetypo.1'.
'codespell.1' may be a typo and could lead to confusion or build issues if not corrected.
```suggestion
all: $(GENERATED) check-dictionaries codetypo.1
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Signed-off-by: fortishield <161459699+FortiShield@users.noreply.github.com>
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
||||||||||||||
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
| permissions: | ||
| contents: read |
There was a problem hiding this comment.
Suggestion: Grant write permissions for autofix workflow
| permissions: | |
| contents: read | |
| permissions: | |
| contents: write |
![codiumai-pr-agent-free[bot]](https://avatars.githubusercontent.com/in/354216?s=60&v=4){kind=small}
Co-authored-by: codiumai-pr-agent-free[bot] <138128286+codiumai-pr-agent-free[bot]@users.noreply.github.com> Signed-off-by: fortishield <161459699+FortiShield@users.noreply.github.com>
1 participant
Summary by Sourcery
Add support for an Oxford English dictionary by generating a new en-to-en-OX dictionary file and integrating it throughout the build, test, and CI pipelines
New Features:
Enhancements:
CI:
Documentation:
Summary by CodeRabbit