[pull] master from nvaccess:master

.coderabbit.yml

@@ -26,6 +26,10 @@ reviews:
       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.
+      When providing code suggestions, particularly when requested, ensure GitHub's suggestion format is used, i.e.:
+      ```suggestion
+      <code changes>
+      ```
       "
     - path: "**/*.py"
       instructions: "

.git-blame-ignore-revs

@@ -20,3 +20,10 @@ d3ce6b8879b14464058d5eaf3f914f803e8f22ac
 d7b29daceb98e717aeb4828eb9e71e34e9e33b5e
 55fb00ad342b0cd4b0a8913cfc75e0ea61b28100
 b31c94cf5856832f2fff2c6270e1d5e44c9cd6af
+b9ebcbf5a9ef408372b2dc3073b2bfa4226a2586
+# Fix trailing whitespaces
+f227ca64c7f4cb41f83f531436c6dd11cf3c1d58
+# Add trailing commas
+be112ed44cb68f622a770c72fd29dd10899e9d07
+# Fix E721
+73a3529d8b10eb73a45117eead906c0a9cb4c41b

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,7 +8,7 @@ about: Create a report to help us improve
 Please thoroughly read NVDA's wiki article on how to fill in this template, including how to provide the required files.
 Issues may be closed if the required information is not present.
 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md
-Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests. 
+Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
 
 Each of the questions and sections below start with multiple hash symbols (#). Place your answers and information on the blank line below each question.
 -->
@@ -17,14 +17,14 @@ Each of the questions and sections below start with multiple hash symbols (#). P
 
 ### Actual behavior:
 <!--
-Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here. 
+Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
 Use braille viewer to copy and paste here.
 You may additionally include an explanation.
 -->
 
 ### Expected behavior:
 <!--
-Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here. 
+Use "Speak command keys" (NVDA+4) and speech viewer to copy and paste here.
 Use braille viewer to copy and paste here.
 You may additionally include an explanation.
 -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,7 +8,7 @@ about: Suggest an idea for this project
 Please thoroughly read NVDA's wiki article on how to fill in this template, including how to provide the required files.
 Issues may be closed if the required information is not present.
 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md
-Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests. 
+Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
 
 Each of the questions and sections below start with multiple hash symbols (#). Place your answers and information on the blank line below each question.
 -->

.github/ISSUE_TEMPLATE/special_case_issue.md

@@ -5,23 +5,23 @@ about: A complex or exceptional issue that doesn't fit into the usual templates
 ---
 
 <!--
-Please read the text in this edit field before filling it in. 
+Please read the text in this edit field before filling it in.
 
 For guidance on how to fill in this template, including how to provide the required files, please see:
 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/githubIssueTemplateExplanationAndExamples.md
 
-If your issue doesn't neatly fit into either the bug report or feature request categories, and it involves a more complex or unique scenario, use this template. 
+If your issue doesn't neatly fit into either the bug report or feature request categories, and it involves a more complex or unique scenario, use this template.
 Before proceeding, please review the existing templates to ensure that those do not better suit your needs:
 - Bug Report Template: https://github.com/nvaccess/nvda/issues/new?template=bug_report.md
 - Feature Request Template: https://github.com/nvaccess/nvda/issues/new?template=feature_request.md
 
 If the required information is not provided upon request, the issue may be closed.
 
-Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. 
-NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. 
+Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md.
+NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project.
 This includes creating or commenting on issues and pull requests.
 
-Questions below start with multiple hash symbols (#). 
+Questions below start with multiple hash symbols (#).
 Please place your answers and information on the blank line below each question.
 -->
 
@@ -47,4 +47,3 @@ Please place your answers and information on the blank line below each question.
 
 
 ### Additional information (if applicable)
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,9 @@
 <!-- Please read and fill in the following template, for an explanation of the sections see:
 https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/githubPullRequestTemplateExplanationAndExamples.md
-Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests. 
+Please also note that the NVDA project has a Citizen and Contributor Code of Conduct which can be found at https://github.com/nvaccess/nvda/blob/master/CODE_OF_CONDUCT.md. NV Access expects that all contributors and other community members read and abide by the rules set out in this document while participating or contributing to this project. This includes creating or commenting on issues and pull requests.
 
 Please initially open PRs as a draft.
-When you would like a review, mark the PR as "ready for review". 
+When you would like a review, mark the PR as "ready for review".
 See https://github.com/nvaccess/nvda/blob/master/.github/CONTRIBUTING.md.
 -->
 
@@ -42,7 +42,7 @@ https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/githubPullRequestTe
   - System (end to end) tests
   - Manual testing
 - [ ] UX of all users considered:
-  - Speech 
+  - Speech
   - Braille
   - Low Vision
   - Different web browsers

.github/workflows/assign-milestone-on-close.yml

@@ -0,0 +1,41 @@
+name: Assign Milestone on Close
+
+env:
+  MILESTONE_ID: ${{ vars.MILESTONE_ID }}
+
+on:
+  issues:
+    types: [closed]
+  pull_request:
+    types: [closed]
+
+jobs:
+  assign-milestone:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if milestone is set
+        id: check-milestone
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const issueOrPr = context.payload.issue || context.payload.pull_request;
+            if (!issueOrPr.milestone) {
+              core.setOutput('milestoneNotSet', 'true');
+            } else {
+              core.setOutput('milestoneNotSet', 'false');
+            }
+
+      - name: Assign default milestone
+        if: steps.check-milestone.outputs.milestoneNotSet == 'true'
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            const issueOrPrNumber = (context.payload.issue || context.payload.pull_request).number;
+            const repository = context.repo;
+            await github.rest.issues.update({
+              ...repository,
+              issue_number: issueOrPrNumber,
+              milestone: process.env.MILESTONE_ID
+            });

.pre-commit-config.yaml

@@ -1,14 +1,30 @@
+exclude: ^user_docs/(?!en/).*$
+
+# https://pre-commit.ci/
+# Configuration for Continuous Integration service
+ci:
+  # Can't run Windows scripts on Linux
+  # These also do not apply fixes, only run tests
+  skip: [scons-source, checkPot, unitTest, licenseCheck]
+  submodules: true
+  autoupdate_commit_msg: "Pre-commit auto-update"
+  autofix_commit_msg: "Pre-commit auto-fix"
+
 repos:
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.6.0
   hooks:
     # Checks python syntax
     - id: check-ast
+      # File uses encoding not supported in Linux
+      exclude: source/comInterfaces/_944DE083_8FB8_45CF_BCB7_C477ACB2F897_0_1_0.py
     - id: check-case-conflict
     - id: check-merge-conflict
-    - id: end-of-file-fixer
     - id: trailing-whitespace
+      types_or: [python, c, c++, batch, markdown]
+    - id: end-of-file-fixer
+      types_or: [python, c, c++, batch, markdown]
 
 - repo: https://github.com/asottile/add-trailing-comma
   rev: v3.1.0
@@ -20,7 +36,7 @@ repos:
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Matches Ruff version in requirements.
-  rev: v0.5.0
+  rev: v0.5.5
   hooks:
     - id: ruff
       name: lint with ruff
@@ -30,21 +46,28 @@ repos:
 
 - repo: local
   hooks:
+    - id: scons-source
+      name: build c/c++ files
+      entry: cmd.exe /c "scons source --all-cores"
+      language: system
+      pass_filenames: false
+      types_or: [c, c++]
     - id: checkPot
       name: translation string check
-      entry: cmd.exe /c "scons checkPot -j 4"
+      entry: cmd.exe /c "scons checkPot --all-cores"
       language: system
       pass_filenames: false
-      types: [python, pofile]
+      types: [python]
+      files: ^source/.*$
     - id: unitTest
       name: unit tests
       entry: ./rununittests.bat
       language: script
       pass_filenames: false
-      types: [python, c, c++, batch]
+      types_or: [python, c, c++, batch]
     - id: licenseCheck
       name: Check license compatibility of pip dependencies
-      files: requirements.txt
+      files: ^(requirements\.txt|runlicensecheck\.bat)$
       entry: ./runlicensecheck.bat
       language: script
       pass_filenames: false

CODE_OF_CONDUCT.md

@@ -3,10 +3,10 @@
 ## 1. Purpose
 A primary goal of NV Access and NVDA is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, nationality, socioeconomic status, education, level of experience and religion (or lack thereof).
 This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behaviour.
-We invite all those who participate in the NVDA community to help us create safe and positive experiences for everyone. NVDA is a user driven initiative. 
+We invite all those who participate in the NVDA community to help us create safe and positive experiences for everyone. NVDA is a user driven initiative.
 
 ## 2. Open Source Citizenship
-A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognise and strengthen the relationships between our actions and their effects on our community. 
+A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognise and strengthen the relationships between our actions and their effects on our community.
 Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
 If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
 
@@ -45,21 +45,21 @@ If a community member engages in unacceptable behaviour, NV Access Staff may tak
 NV Access Staff have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.
 
 ## 6. Reporting Guidelines
-If you are subject to or witness unacceptable behaviour, or have any other concerns, please notify NV Access staff as soon as possible via [email protected]. The information required for notifications includes PR/Issue Number, nature of breach, community member responsible, date and time of breach. Please note that the details of the reporter will not be disclosed, unless required to by law. 
+If you are subject to or witness unacceptable behaviour, or have any other concerns, please notify NV Access staff as soon as possible via [email protected]. The information required for notifications includes PR/Issue Number, nature of breach, community member responsible, date and time of breach. Please note that the details of the reporter will not be disclosed, unless required to by law.
 
 ## 7. Addressing Grievances
-If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify NV Access at [email protected] with a concise description of your grievance. 
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify NV Access at [email protected] with a concise description of your grievance.
 
 ## 8. Scope
 We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
-This code of conduct and its related procedures also applies to unacceptable behaviour occurring outside the scope of community activities when such behaviour has the potential to adversely affect the safety and well-being of community members. 
-For others setting up or running an NVDA group of any kind, it is strongly recommended that a complementary Citizen and Contributor Code of Conduct is adopted. 
+This code of conduct and its related procedures also applies to unacceptable behaviour occurring outside the scope of community activities when such behaviour has the potential to adversely affect the safety and well-being of community members.
+For others setting up or running an NVDA group of any kind, it is strongly recommended that a complementary Citizen and Contributor Code of Conduct is adopted.
 
 ## 9. Contact info
 [email protected]
 
 ## 10. License and attribution
-The Citizen and Contributor Code of Conduct is distributed by NV Access Limited. 
+The Citizen and Contributor Code of Conduct is distributed by NV Access Limited.
 Portions of text were derived from the GitHub sample Citizen and Contributor Code of Conduct, which is distributed under a Creative Commons Attribution-ShareAlike license.
 
 Revision history:

appveyor/README.md

@@ -1,4 +1,4 @@
-`appveyor.yml` specifies build settings which generally [override online UI driven settings](https://www.appveyor.com/docs/build-configuration/#appveyoryml-and-ui-coexistence). 
+`appveyor.yml` specifies build settings which generally [override online UI driven settings](https://www.appveyor.com/docs/build-configuration/#appveyoryml-and-ui-coexistence).
 
 # Branch and tag filtering
 
@@ -12,7 +12,7 @@ Builds will fail if any command has a non-zero exit code. PowerShell scripts con
 
 ## Setup process
 
-Before we begin the install process, AppVeyor clones our repository and checks out the commit of the build. 
+Before we begin the install process, AppVeyor clones our repository and checks out the commit of the build.
 
 ### `install`
 
@@ -31,7 +31,7 @@ Performs a build of NVDA and related artifacts for testing and deployment.
 
 ## Testing
 
-Unlike the rest of the build, tests do not exit early if they fail or raise an error. If any test fails, `testFailExitCode` is set to 1. The `after_test` build phase will exit the build if any tests fail so that all test failures can be recorded where possible. 
+Unlike the rest of the build, tests do not exit early if they fail or raise an error. If any test fails, `testFailExitCode` is set to 1. The `after_test` build phase will exit the build if any tests fail so that all test failures can be recorded where possible.
 
 Before testing we:
 
@@ -48,9 +48,9 @@ The tests we perform are:
 
 ## Artifacts
 
-Artifacts are added to the build throughout the process. 
+Artifacts are added to the build throughout the process.
 
-Artifacts in `output\*` and `output\*\*` are automatically packaged after successful tests. If something fails before then, we manually push these artifacts in `on_failure`. Artifacts outside of `output` are pushed manually as they are created. 
+Artifacts in `output\*` and `output\*\*` are automatically packaged after successful tests. If something fails before then, we manually push these artifacts in `on_failure`. Artifacts outside of `output` are pushed manually as they are created.
 
 At the end of the build, regardless of failure, we upload the list of successfully installed python packages in `pushPackagingInfo.ps1`. This is performed here in case scons (partially) fails.
 

include/espeak.md

@@ -64,7 +64,7 @@ If the last thing is compiling some dictionary try excluding it.
 This can be done in [`nvdaHelper/espeak/sconscript`](../nvdaHelper/espeak/sconscript).
 Remember to report this to the eSpeak-ng project.
 
-If the build fails, take note of the error, compare the diff of the `Makefile.am` file and mirror 
+If the build fails, take note of the error, compare the diff of the `Makefile.am` file and mirror
 any changes in our `sconscript` file.
 
 ### Known issues

nvdaHelper/common/PerfTimer.cpp

@@ -64,12 +64,12 @@ std::string PerfTimer::GetPerfResults() {
 	std::stringstream sstream;
 	sstream << "Perf Results\n";
 	for(auto& result : perfResults){
-		sstream << result.first << " Total time: " << result.second.totalTime 
+		sstream << result.first << " Total time: " << result.second.totalTime
 		<< " Hit count: " << result.second.numberOfHits;
 		if(result.second.totalTime > 0 && result.second.numberOfHits > 0) {
 			sstream << " Average Time: " << result.second.totalTime / result.second.numberOfHits;
 		}
 		sstream << '\n';
 	}
 	return sstream.str();
-}
+}

nvdaHelper/common/PerfTimer.h

@@ -68,4 +68,4 @@ class PerfTimer {
 	static std::map<std::string, PerfResult> s_results; ///< The results being collected.
 };
 
-#endif
+#endif