Update eSpeak, add Karakalpak

[seanbudd]

Link to issue number:

Closes #16495

Summary of the issue:

updates espeak for 2024.3

Description of user facing changes

adds Karakalpak language in eSpeak

Description of development approach

Followed steps in eSpeak readme

Testing strategy:

Followed steps in eSpeak readme, tested new language

Known issues with pull request:

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

Summary by CodeRabbit

• New Features

  • Added support for the Karakalpak language in eSpeak.

• Bug Fixes

  • Fixed issues with the Windows 11 Emoji Panel.
  • Improved web browser error reporting.

• Updates

  • Updated eSpeak to version 1.52-dev.
  • Updated Unicode CLDR to version 45.0.
  • Updated fast_diff_match_patch to version 2.1.0.
  • Updated LibLouis Braille translator to version 3.30.0.

[coderabbitai]

Walkthrough

The update primarily focuses on synchronizing the eSpeak NG submodule to a newer commit for enhanced language support and updating associated documentation. Notably, support for the Karakalpak language is added, several updates in versioning across different components are made, and documentation links are refreshed to improve accuracy and utility.

Changes

File(s)	Change Summary
include/espeak, projectDocs/dev/createDev...	Updated eSpeak NG submodule commit from cb62d93 to 54ee11a7.
include/espeak.md	Updated documentation links from ../user_docs/en/changes.t2t to ../user_docs/en/changes.md.
nvdaHelper/espeak/sconscript	Updated PACKAGE_VERSION, added dictionary entry for Karakalpak language (kaa_dict).
user_docs/en/changes.md	Included new features and bug fixes: Karakalpak language support, Unicode CLDR update, bug fixes.

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d85dae2 and 8bbca6c.

Files selected for processing (5)

• include/espeak (1 hunks)
• include/espeak.md (1 hunks)
• nvdaHelper/espeak/sconscript (2 hunks)
• projectDocs/dev/createDevEnvironment.md (1 hunks)
• user_docs/en/changes.md (2 hunks)

Files skipped from review due to trivial changes (1)

• include/espeak

Additional context used

Path-based instructions (4)

include/espeak.md (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

---

Pattern **/*.md: Focus on grammar, spelling, and punctuation. Also consider readability and clarity of contents. Ensure that changes follow the style of one sentence per line, suggest changes if this is not met.

projectDocs/dev/createDevEnvironment.md (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

---

Pattern **/*.md: Focus on grammar, spelling, and punctuation. Also consider readability and clarity of contents. Ensure that changes follow the style of one sentence per line, suggest changes if this is not met.

nvdaHelper/espeak/sconscript (1)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

user_docs/en/changes.md (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

---

Pattern **/*.md: Focus on grammar, spelling, and punctuation. Also consider readability and clarity of contents. Ensure that changes follow the style of one sentence per line, suggest changes if this is not met.

LanguageTool

include/espeak.md

[misspelling] ~3-~3: This word is normally spelled with a hyphen. (EN_COMPOUNDS_CROSS_PLATFORM)
Context: ...ontained in the espeak directory is a cross platform open source speech synthesizer.

B...

---

[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ... espeak directory is a cross platform open source speech synthesizer.

Building

NVD...

---

[uncategorized] ~13-~13: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’). (AUTO_HYPHEN)
Context: ...ys kept up to date.

We don't use the auto make files or the visual studio files, we ma...

---

[style] ~20-~20: ‘off of’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_OFF_OF)
Context: ...by NVDA

1. Start from a clean branch off of NVDA master
   1. Check out the late...

---

[uncategorized] ~20-~20: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...

1. Start from a clean branch off of NVDA master
   1. Check out the latest NV...

---

[uncategorized] ~23-~23: It appears that hyphens are missing in the adjective “up-to-date”. (UP_TO_DATE_HYPHEN)
Context: ...ory is clean.

1. Ensure submodules are up to date
   1. Synchronize submodules with `git...

---

[uncategorized] ~63-~63: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...g.
If the last thing is compiling some dictionary try excluding it.
This can be done in ...

---

[style] ~72-~72: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ...luded
from the build, they are deleted prior to compiling the dictionaries in the
[`nv...

---

[style] ~79-~79: To make your writing flow more naturally, try moving ‘also’ before the verb. (ALSO_PLACEMENT)
Context: ...k-ng/blob/master/src/espeak-ng.1.ronn) (note also [speak-ng command line](https://github....

---

[typographical] ~80-~80: Consider adding a comma after ‘historically’ for more clarity. (RB_LY_COMMA)
Context: ...f eSpeak, locally on Windows.
However, historically the Windows build for espeak-ng hasn't ...

projectDocs/dev/createDevEnvironment.md

[style] ~6-~6: Try using a more formal synonym here to elevate your writing. (PLAN_ON_INTEND)
Context: ...s://github.com/nvaccess/nvda.

If you plan on contributing to NVDA, you will need to [fork and clo...

---

[duplication] ~42-~42: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...to be installed on your system:

Python

Python, version 3.11...

Additional comments not posted (5)

include/espeak.md (1)

43-43: No issues detected with the updated documentation links.

projectDocs/dev/createDevEnvironment.md (2)

Line range hint 42-42: Verify if the repetition of the word "Python" is intentional for clarity. If not, consider rephrasing to avoid repetition.

---

80-80: Ensure the eSpeak NG submodule version and commit hash are accurate as per the latest changes.

#!/bin/bash
# Description: Verify the submodule version and commit hash for eSpeak NG.

# Test: Search for the submodule version in the git submodule status.
git submodule status | grep espeak-ng

nvdaHelper/espeak/sconscript (2)

96-96: Ensure that the PACKAGE_VERSION matches the actual version used in eSpeak, as discrepancies could lead to build issues or misreported versions.

#!/bin/bash
# Description: Verify the PACKAGE_VERSION in the build script matches the actual eSpeak version.

# Test: Compare the PACKAGE_VERSION with the version in the actual eSpeak config.
grep 'PACKAGE_VERSION' include/espeak/src/windows/config.h

---

228-228: Verify that the files kaa_list and kaa_rules exist and are correctly formatted to support the new Karakalpak language dictionary.

#!/bin/bash
# Description: Verify the existence and format of Karakalpak language files.

# Test: Check for the presence of 'kaa_list' and 'kaa_rules' in the espeak dictionary source directory.
ls include/espeak/dictsource | grep 'kaa_'

Warning

Review ran into problems

Problems (1)

• Git: Failed to clone repository. Please contact CodeRabbit support.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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]

Actionable comments posted: 2

Outside diff range and nitpick comments (3)

include/espeak.md (2)

Line range hint 3-3: Consider adding a hyphen to "cross platform" to form "cross-platform" as it is a compound adjective modifying "speech synthesizer".

---

Line range hint 13-13: Consider adding a hyphen to "auto make" to form "auto-make".

projectDocs/dev/createDevEnvironment.md (1)

Line range hint 6-6: Consider replacing "plan on" with "intend to" for a more formal tone in documentation.