Sync upstream AddonTemplate

.github/workflows/build_addon.yml

@@ -13,39 +13,44 @@ on:
 
 jobs:
   build:
+    # Building the add-on template as an add-on does not make sense (and fails).
+    # Do not modify this repo name with your own one! (should remain the template)
+    if: github.repository != 'nvaccess/addonTemplate'
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v6
-
-    - run: echo -e "pre-commit\nscons\nmarkdown">requirements.txt
-
-    - name: Set up Python
-      uses: actions/setup-python@v6
+    - name: Checkout repo
+      uses: actions/checkout@v6
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
       with:
-        python-version: 3.11
-        cache: 'pip'
-
+        enable-cache: true
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip wheel
-        pip install -r requirements.txt
         sudo apt-get update  -y
         sudo apt-get install -y gettext
+        uv sync
 
     - name: Code checks
-      run: export SKIP=no-commit-to-branch; pre-commit run --all
+      run: export SKIP=no-commit-to-branch,pyright; uv run pre-commit run --all-files
 
     - name: building addon
-      run: scons && scons pot
+      run: uv run scons && uv run scons pot
 
     - uses: actions/upload-artifact@v7
       with:
         name: packaged_addon
         path: |
           ./*.nvda-addon
+        archive: false
+
+    - uses: actions/upload-artifact@v7
+      with:
+        name: translation_template
+        path: |
           ./*.pot
+        archive: false
 
   upload_release:
     runs-on: ubuntu-latest
@@ -55,21 +60,24 @@ jobs:
       contents: write
     steps:
     - uses: actions/checkout@v6
-    - name: download releases files
+    - name: download all artifacts
       uses: actions/download-artifact@v8
+      with:
+        path: .
+        merge-multiple: true
     - name: Display structure of downloaded files
       run: ls -R
     - name: Calculate sha256
       run: |
         echo -e "\nSHA256: " >> changelog.md
-        sha256sum packaged_addon/*.nvda-addon >> changelog.md
+        sha256sum *.nvda-addon >> changelog.md
 
     - name: Release
       uses: softprops/action-gh-release@v3
       with:
         files: |
-          packaged_addon/*.nvda-addon
-          packaged_addon/*.pot
+          *.nvda-addon
+          *.pot
         body_path: changelog.md
         fail_on_unmatched_files: true
         prerelease: ${{ contains(github.ref, '-') }}

.gitignore

@@ -9,3 +9,4 @@ manifest.ini
 *.nvda-addon
 .sconsign.dblite
 /[0-9]*.[0-9]*.[0-9]*.json
+*.egg-info

.pre-commit-config.yaml

@@ -1,7 +1,87 @@
+# Copied from https://github.com/nvaccess/nvda
+# https://pre-commit.ci/
+# Configuration for Continuous Integration service
+ci:
+  # Pyright does not seem to work in pre-commit CI
+  skip: [pyright]
+  autoupdate_schedule: monthly
+  autoupdate_commit_msg: "Pre-commit auto-update"
+  autofix_commit_msg: "Pre-commit auto-fix"
+  submodules: true
+
+default_language_version:
+  python: python3.13
+
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
-    hooks:
-      - id: check-ast
-      - id: check-case-conflict
-      - id: check-yaml
+- repo: https://github.com/pre-commit-ci/pre-commit-ci-config
+  rev: v1.6.1
+  hooks:
+    - id: check-pre-commit-ci-config
+
+- repo: meta
+  hooks:
+    # ensures that exclude directives apply to any file in the repository.
+    - id: check-useless-excludes
+    # ensures that the configured hooks apply to at least one file in the repository.
+    - id: check-hooks-apply
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    # Prevents commits to certain branches
+    - id: no-commit-to-branch
+      args: ["--branch", "main", "--branch", "master", ]
+    # Checks that large files have not been added. Default cut-off for "large" files is 500kb.
+    - id: check-added-large-files
+    # Checks python syntax
+    - id: check-ast
+    # Checks for filenames that will conflict on case insensitive filesystems (the majority of Windows filesystems, most of the time)
+    - id: check-case-conflict
+    # Checks for artifacts from resolving merge conflicts.
+    - id: check-merge-conflict
+    # Checks Python files for debug statements, such as python's breakpoint function, or those inserted by some IDEs.
+    - id: debug-statements
+    # Removes trailing whitespace.
+    - id: trailing-whitespace
+      types_or: [python, c, c++, batch, markdown, toml, yaml, powershell]
+    # Ensures all files end in 1 (and only 1) newline.
+    - id: end-of-file-fixer
+      types_or: [python, c, c++, batch, markdown, toml, yaml, powershell]
+    # Removes the UTF-8 BOM from files that have it.
+    # See https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/codingStandards.md#encoding
+    - id: fix-byte-order-marker
+      types_or: [python, c, c++, batch, markdown, toml, yaml, powershell]
+    # Validates TOML files.
+    - id: check-toml
+    # Validates YAML files.
+    - id: check-yaml
+    # Ensures that links to lines in files under version control point to a particular commit.
+    - id: check-vcs-permalinks
+    # Avoids using reserved Windows filenames.
+    - id: check-illegal-windows-names
+- repo: https://github.com/asottile/add-trailing-comma
+  rev: v3.2.0
+  hooks:
+  # Ruff preserves indent/new-line formatting of function arguments, list items, and similar iterables,
+  # if a trailing comma is added.
+  # This adds a trailing comma to args/iterable items in case it was missed.
+  - id: add-trailing-comma
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Matches Ruff version in pyproject.
+  rev: v0.12.7
+  hooks:
+    - id: ruff
+      name: lint with ruff
+      args: [ --fix ]
+    - id: ruff-format
+      name: format with ruff
+
+- repo: local
+  hooks:
+
+    - id: pyright
+      name: type check with pyright
+      entry: uv run pyright
+      language: system
+      types: [python]

.vscode/typings/__builtins__.pyi

@@ -1,6 +1,2 @@
-def _(msg: str) -> str:
-	...
-
-
-def pgettext(context: str, message: str) -> str:
-	...
+def _(msg: str) -> str: ...
+def pgettext(context: str, message: str) -> str: ...

addon/doc/ar/readme.md

@@ -88,4 +88,4 @@
 - تم تقديم فاصل زمني قابل للتكوين لمراقبة الكائنات.
 
 [GitHub]: https://github.com/cary-rowen/objWatcher
-[GitHubIssue]: https://github.com/cary-rowen/objWatcher/issues
+[GitHubIssue]: https://github.com/cary-rowen/objWatcher/issues

addon/doc/es/readme.md

@@ -64,4 +64,3 @@ de observar.
 
 [GitHub]: https://github.com/cary-rowen/objWatcher [GitHubIssue]:
 https://github.com/cary-rowen/objWatcher/issues
-

addon/doc/fi/readme.md

@@ -64,4 +64,3 @@ ilmoitetaan. Lopeta tarkkailu painamalla kahdesti.
 
 [GitHub]: https://github.com/cary-rowen/objWatcher [GitHubIssue]:
 https://github.com/cary-rowen/objWatcher/issues
-

addon/doc/fr/readme.md

@@ -67,4 +67,3 @@ arrêter la surveillance.
 
 [GitHub]: https://github.com/cary-rowen/objWatcher [GitHubIssue]:
 https://github.com/cary-rowen/objWatcher/issues
-

addon/doc/pt_BR/readme.md

@@ -64,4 +64,3 @@ interromper a observação.
 
 [GitHub]: https://github.com/cary-rowen/objWatcher [GitHubIssue]:
 https://github.com/cary-rowen/objWatcher/issues
-

addon/doc/ru/readme.md

@@ -64,4 +64,3 @@
 
 [GitHub]: https://github.com/cary-rowen/objWatcher [GitHubIssue]:
 https://github.com/cary-rowen/objWatcher/issues
-

addon/doc/tr/readme.md

@@ -63,4 +63,3 @@ raporlanacaktır. İzlemeyi durdurmak için iki kez basın.
 
 [GitHub]: https://github.com/cary-rowen/objWatcher [GitHubIssue]:
 https://github.com/cary-rowen/objWatcher/issues
-

addon/doc/zh_CN/readme.md

@@ -9,9 +9,9 @@
 
 1. **字幕与歌词监视：**
    监视某些播放器的字幕或歌词对象，内容刷新时可以自动读出。
-2. **聊天活动监视：**  
-   监视 Unigram 或微信的会话列表中感兴趣的会话。有新消息时可自动读出，支持后台朗读。  
-3. **测试与调试：**  
+2. **聊天活动监视：**
+   监视 Unigram 或微信的会话列表中感兴趣的会话。有新消息时可自动读出，支持后台朗读。
+3. **测试与调试：**
    监视记事本的状态栏，以在内容插入/删除过程中自动读出行/列变化。
 
 ## 按键与手势
@@ -50,12 +50,12 @@
 
 ## 贡献者
 
-- **作者：**  
+- **作者：**
   - Cary-rowen: 核心开发者
   - hwf1324: 代码贡献者
   - Ibrahim Hamadeh: 代码贡献者
 
-- **本地化贡献者：**  
+- **本地化贡献者：**
   - Ibrahim Hamadeh: 阿拉伯语翻译
   - VovaMobile: 乌克兰语翻译
 

addon/globalPlugins/objWatcher/__init__.py

@@ -140,7 +140,7 @@ def script_HandleNumberKey(self, gesture):
 			log.warning(f"Invalid key detected: '{invalid_key}'.")
 			# Translators: Message to the user when an invalid gesture is detected
 			ui.message(
-				_("Invalid key: '{}'. Please use a numeric key like NVDA+Alt+0~9.").format(invalid_key)
+				_("Invalid key: '{}'. Please use a numeric key like NVDA+Alt+0~9.").format(invalid_key),
 			)
 			return
 
@@ -158,12 +158,13 @@ def script_HandleNumberKey(self, gesture):
 						if data["name"] == (data["lastText"] or self._getWatchingAttribute(data["obj"]))
 						# If name and lastText are different, report both name and lastText
 						else "{} - {}".format(
-							data["name"], data["lastText"] or self._getWatchingAttribute(data["obj"])
+							data["name"],
+							data["lastText"] or self._getWatchingAttribute(data["obj"]),
 						)
 						if data["name"]
 						# If name is empty, only report lastText or fallback to _getWatchingAttribute
 						else data["lastText"] or self._getWatchingAttribute(data["obj"]),
-					)
+					),
 				)
 				return
 
@@ -192,7 +193,7 @@ def script_HandleNumberKey(self, gesture):
 				"name": obj.name or _("Unnamed object"),
 				"addTime": time.time(),
 				"number": number,
-			}
+			},
 		)
 
 		# Start the timer if not paused and not already running
@@ -203,8 +204,9 @@ def script_HandleNumberKey(self, gesture):
 			# Translators: Message when an object is added to the watch list and watching not started
 			ui.message(
 				_("Added object to position {}: {}, Watching has not started.").format(
-					number, self.watchingObjs[-1]["name"]
-				)
+					number,
+					self.watchingObjs[-1]["name"],
+				),
 			)
 		cues.Start()
 		self.finish()  # Exit layer mode after adding the object
@@ -225,7 +227,7 @@ def _getMultiPressTimeout(self):
 	@script(
 		# Translators: Presented in input help mode.
 		description=_(
-			"Press once to delete the last watched object; press twice to delete all watched objects"
+			"Press once to delete the last watched object; press twice to delete all watched objects",
 		),
 	)
 	def script_DeleteLastChecked(self, gesture):
@@ -300,7 +302,7 @@ def onTimerEvent(self, event):
 					self.watchingObjs.remove(data)
 					# Translators: Message when an object is no longer available and has been removed
 					ui.message(
-						_("{} is no longer available and has been removed from watch list").format(name)
+						_("{} is no longer available and has been removed from watch list").format(name),
 					)
 					continue
 
@@ -375,7 +377,7 @@ def script_ToggleWindow(self, gesture):
 				"name": obj.name or _("Unnamed window"),
 				"addTime": time.time(),
 				"number": None,  # Special objects do not use number positions
-			}
+			},
 		)
 
 		# Start the timer if not paused and not already running

addon/globalPlugins/objWatcher/cues.py

@@ -15,5 +15,5 @@ def NoObj():
 
 
 def play_sound(filename):
-	path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'sounds', filename))
+	path = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "sounds", filename))
 	return playWaveFile(path + ".wav")

addon/globalPlugins/objWatcher/settings.py

@@ -24,8 +24,9 @@ def makeSettings(self, settingsSizer):
 		self.intervalEdit = settingsSizerHelper.addLabeledControl(
 			intervalLabelText,
 			nvdaControls.SelectOnFocusSpinCtrl,
-			min=10, max=500,
-			initial=int(config.conf["objWatcher"]["interval"])
+			min=10,
+			max=500,
+			initial=int(config.conf["objWatcher"]["interval"]),
 		)
 
 	def onSave(self):