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

feat(locales): support haitian creole #998

Merged
merged 4 commits into from
Nov 30, 2024
Merged

feat(locales): support haitian creole #998

merged 4 commits into from
Nov 30, 2024

Conversation

rhahao
Copy link
Member

@rhahao rhahao commented Nov 30, 2024

No description provided.

Copy link

coderabbitai bot commented Nov 30, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several updates across multiple files, primarily enhancing language support for the JW EPUB Parser project. The README.md file has been corrected for spelling and updated to include Haitian Creole in the supported languages. The crowdin.yml configuration file has its pull request title changed to reflect a bug fix. Additionally, two new language imports for Haitian Creole and Estonian have been added to both src/browser/utils.browser.ts and src/node/utils.node.ts, along with new date parsing patterns in src/common/date_parser.ts. Furthermore, a new override.ts file has been introduced to manage language-specific string overrides.

Changes

File Change Summary
README.md Corrected spelling of "English" and added "Haitian Creole" to the supported languages list. Updated the return structure description of the loadEPUB function.
crowdin.yml Changed pull_request_title from 'feat(localize): updated translation from Crowdin' to 'fix(locales): updated translation from Crowdin'.
src/browser/utils.browser.ts Added imports for Haitian Creole (CR) and Estonian (ST) language resources to the languages object.
src/common/date_parser.ts Introduced new date patterns for mwbDatePatterns and wDatePatterns for the Estonian language.
src/node/utils.node.ts Added imports for Haitian Creole (CR) and Estonian (ST) language resources to the languages object.
src/common/override.ts Introduced a new file with an overrides object for language-specific string modifications.
src/types/index.ts Added new type declaration for Override to manage language-specific overrides.
test/fixtures/mwb_CR_202411.js Added a new fixture file for meeting information in Haitian Creole.
test/fixtures/w_CR_202411.js Added a new fixture file for study sessions in Haitian Creole.
test/enhancedParsing/list.json Added a new entry for the language "CR" associated with issue "202411".

Possibly related PRs

Warning

Rate limit exceeded

@rhahao has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 11d0501 and 538c303.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 11d0501 and 538c303.

📒 Files selected for processing (1)
  • test/enhancedParsing/list.json (1 hunks)

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 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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Nov 30, 2024
Copy link

sonarqubecloud bot commented Nov 30, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
2 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copy link

@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: 1

🧹 Outside diff range and nitpick comments (4)
src/common/override.ts (1)

1-13: Consider adding comments to explain the purpose of each override.

Adding brief comments for each override entry can improve code readability and maintainability by providing context for why specific overrides are necessary.

src/common/parsing_rules.ts (1)

60-63: Optimize by reusing the existing regex match result.

Instead of calling exec again on langPattern, you can reuse the matchFirstPattern result to avoid redundant computations.

Apply this diff to refactor the code:

 const matchFirstPattern = finalSrc.match(langPattern);

 if (!matchFirstPattern) {
   throw new JWEPUBParserError('jw-epub-parser', `Parsing failed. The input was: ${finalSrc}`);
 }

-const groupsFirstPattern = Array.from(langPattern.exec(finalSrc)!);
+const groupsFirstPattern = Array.from(matchFirstPattern);
src/types/index.ts (1)

85-89: Add documentation for the Override type.

Including comments that describe the Override type enhances code clarity and helps other developers understand its structure and purpose.

src/common/date_parser.ts (1)

353-363: Simplify the override handling logic using optional chaining.

You can simplify the override logic by leveraging optional chaining and nullish coalescing to make the code more concise and readable.

Apply this diff to simplify the code:

-    let finalSrc = src;
-    const overrideLang = overrides[lang];
-    if (overrideLang) {
-      const overrideSrc = overrideLang[src];
-      if (overrideSrc) {
-        finalSrc = overrideSrc;
-      }
-    }
+    const finalSrc = overrides[lang]?.[src] ?? src;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d4cecff and 11d0501.

📒 Files selected for processing (6)
  • src/common/date_parser.ts (4 hunks)
  • src/common/override.ts (1 hunks)
  • src/common/parsing_rules.ts (3 hunks)
  • src/types/index.ts (1 hunks)
  • test/fixtures/mwb_CR_202411.js (1 hunks)
  • test/fixtures/w_CR_202411.js (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • test/fixtures/w_CR_202411.js
  • test/fixtures/mwb_CR_202411.js
🔇 Additional comments (3)
src/common/parsing_rules.ts (1)

23-33: Ensure robust handling of overrides and potential edge cases.

The implementation correctly updates finalSrc when an override exists. However, consider the following:

  • Validate that src is a non-empty string to prevent unexpected behavior when src is undefined or empty.
  • Ensure that overrides do not unintentionally shadow original values, especially if src keys overlap in unexpected ways.

Would you like assistance in adding unit tests to cover these edge cases?

src/common/date_parser.ts (2)

79-79: Addition of 'ST' language code for MWB date patterns is correct.

The new language code ST has been correctly added to mwbDatePatterns with the appropriate regular expression pattern.


260-260: Addition of 'ST' language code for Watchtower date patterns is correct.

The new language code ST has been correctly added to wDatePatterns with the appropriate regular expression pattern.

src/common/date_parser.ts Show resolved Hide resolved
@rhahao rhahao merged commit 5e6f255 into sws2apps:main Nov 30, 2024
9 checks passed
@rhahao
Copy link
Member Author

rhahao commented Nov 30, 2024

🎉 This PR is included in version 3.29.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant