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

Update eSpeak-NG to 1.54-dev commit 961454ff #16976

Merged
merged 2 commits into from
Aug 8, 2024
Merged

Conversation

SaschaCowley
Copy link
Member

@SaschaCowley SaschaCowley commented Aug 8, 2024

Link to issue number:

Closes #16775

Summary of the issue:

eSpeak needs to be updated for 2024.4.

Description of user facing changes

Added languages Faroese and Xextan to eSpeak-NG.

Description of development approach

Followed the update instructions.

Testing strategy:

Rebuilt NVDA from source. Ran NVDA, switched synth to eSpeak-NG. Tested that speech output worked fine in English. Switched voice to Faroese and Xextan and ensured that there was still output.

Known issues with pull request:

None.

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
    • Introduced support for two new languages: Faroese and Xextan in the eSpeak module.
    • Updated command line options for better configuration management during updates.
  • Bug Fixes
    • Enhanced versioning to accurately reflect updates in the underlying eSpeak library.

@SaschaCowley SaschaCowley requested a review from a team August 8, 2024 04:57
@SaschaCowley SaschaCowley linked an issue Aug 8, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Aug 8, 2024

Walkthrough

The recent updates primarily focus on enhancing the eSpeak module within NVDA. Key changes include an update to the eSpeak library version and the addition of support for two new languages—Faroese and Xextan. Additionally, command-line options for configuration during updates are now effectively respected, improving the overall user experience. These modifications collectively enhance NVDA's functionality and accessibility.

Changes

File(s) Change Summary
include/espeak Updated subproject commit reference from 54ee11a79c66 to 961454ffaa89, indicating a version change.
nvdaHelper/espeak/sconscript Updated PACKAGE_VERSION to 1.52-dev 961454ff and added support for Faroese (fo_dict) and Xextan (xex_dict).
user_docs/en/changes.md Documented changes highlighting the new command line options and the addition of language support in eSpeak.

Assessment against linked issues

Objective Addressed Explanation
Update eSpeak for 2024.4 (#16775)

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

Outside diff range, codebase verification and nitpick comments (1)
nvdaHelper/espeak/sconscript (1)

377-383: Missing input files for new language dictionaries

The expected input files for the Faroese (fo_list, fo_rules) and Xextan (xex_list, xex_rules) dictionaries are not present in the repository. Please verify the existence and correct naming of these files to ensure the new language support functions as intended.

  • Ensure files fo_list, fo_rules, xex_list, and xex_rules are added to the repository.
Analysis chain

New language dictionaries added.

The fo_dict and xex_dict entries have been correctly added to support Faroese and Xextan languages.

Ensure that the input files fo_list, fo_rules, xex_list, and xex_rules exist and are correctly specified.

Also applies to: 950-956

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of input files for Faroese and Xextan dictionaries.

# Test: Check for the presence of required input files for the new language dictionaries.
expected_files=("fo_list" "fo_rules" "xex_list" "xex_rules")
for file in "${expected_files[@]}"; do
  if ! fd --type f --glob "$file"; then
    echo "Missing file: $file"
  fi
done

Length of output: 330


Script:

#!/bin/bash
# Description: Broad search for files related to Faroese and Xextan dictionaries.

# Test: Search for any files that might correspond to the expected input files for the new language dictionaries.
expected_patterns=("fo_*" "xex_*")
for pattern in "${expected_patterns[@]}"; do
  echo "Searching for files matching: $pattern"
  fd --type f --glob "$pattern"
done

Length of output: 339

Copy link
Member

@seanbudd seanbudd left a comment

Choose a reason for hiding this comment

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

Can you please update the commit reference in projectDocs\dev\createDevEnvironment.md too

@SaschaCowley SaschaCowley requested a review from seanbudd August 8, 2024 05:20
@SaschaCowley SaschaCowley merged commit 039f3f4 into master Aug 8, 2024
4 checks passed
@SaschaCowley SaschaCowley deleted the updateEspeak20244 branch August 8, 2024 07:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update eSpeak for 2024.4
2 participants