undergroundwires · peter9811 · Feb 22, 2025 · Feb 22, 2025 · Mar 1, 2025 · Mar 1, 2025
diff --git a/README.md b/README.md
@@ -39,73 +39,73 @@
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="E2E tests status"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml/badge.svg"
     />
   </a>
   <!-- Security checks -->
   <br />
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.sast.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of dependency security checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.sast/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.sast.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.dependencies.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of Static Analysis Security Testing (SAST)"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.dependencies/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.dependencies.yaml/badge.svg"
     />
   </a>
   <!-- Checks -->
   <br />
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of quality checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.quality/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of build checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.build/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of runtime error checks for the desktop application"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.desktop-runtime-errors/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.scripts.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of script che
F440
cks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.scripts/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.scripts.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.external-urls.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Status of external URL checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.external-urls/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.external-urls.yaml/badge.svg"
     />
   </a>
   <!-- Release -->
   <br />
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Git release status"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/release-git/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Site release status"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/release-site/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Desktop application release status"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/release-desktop/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop/badge.svg"
     />
   </a>
   <!-- Others -->

diff --git a/docs/ci-cd.md b/docs/ci-cd.md
@@ -42,4 +42,4 @@ Convention for naming pipeline files: **`<type>.<name>.yaml`**.
 - Kebab-case allows to have better URL references to them.
   - [README.md](./../README.md) uses URL references to show status badges for actions.
 
-[1]: https://web.archive.org/web/20250126141528/https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows "Workflow syntax for GitHub Actions - GitHub Docs | docs.github.com"
+[1]: https://web.archive.org/web/20250126141528/https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows "Workflow syntax for GitHub Actions - GitHub Docs | docs.github.com"
diff --git a/scripts/configure_vscode.py b/scripts/configure_vscode.py
@@ -14,19 +14,25 @@
 import subprocess
 import sys
 import re
-from typing import Any, Optional
+from typing import Any, Optional, List
 from shutil import which
 
 VSCODE_SETTINGS_JSON_FILE: str = '.vscode/settings.json'
 VSCODE_EXTENSIONS_JSON_FILE: str = '.vscode/extensions.json'
 
+ESLINT_URL = "https://web.archive.org/web/20230801024405/https://eslint.vuejs.org/user-guide/#visual-studio-code"
+GTK_PATH_URL = "https://archive.ph/2024.01.06-003914/https://github.com/microsoft/vscode/issues/179274"
+GTK_PATH_URL_ALT = "https://web.archive.org/web/20240106003915/https://github.com/microsoft/vscode/issues/179274"
+
 def main() -> None:
+    """Main function to configure VSCode settings and install extensions."""
     ensure_vscode_directory_exists()
     ensure_setting_file_exists()
     add_or_update_settings()
     install_recommended_extensions()
 
 def ensure_vscode_directory_exists() -> None:
+    """Ensure the .vscode directory exists."""
     vscode_directory_path = os.path.dirname(VSCODE_SETTINGS_JSON_FILE)
     try:
         os.makedirs(vscode_directory_path, exist_ok=True)
@@ -35,6 +41,7 @@ def ensure_vscode_directory_exists() -> None:
         print_error(f"Error handling directory {vscode_directory_path}: {error}")
 
 def ensure_setting_file_exists() -> None:
+    """Ensure the VSCode settings file exists."""
     try:
         if os.path.isfile(VSCODE_SETTINGS_JSON_FILE):
             print_success(f"VSCode settings file exists: {VSCODE_SETTINGS_JSON_FILE}")
@@ -44,13 +51,14 @@ def ensure_setting_file_exists() -> None:
             print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
     except IOError as error:
         print_error(f"Error creating file {VSCODE_SETTINGS_JSON_FILE}: {error}")
-    print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
+print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
 
 def add_or_update_settings() -> None:
+    """Add or update VSCode settings."""
     configure_setting_key('eslint.validate', ['vue', 'javascript', 'typescript'])
     # Set ESLint validation for specific file types.
     # Details: # pylint: disable-next=line-too-long
-    #   - https://web.archive.org/web/20230801024405/https://eslint.vuejs.org/user-guide/#visual-studio-code
+    #   - {ESLINT_URL}
 
     configure_setting_key('terminal.integrated.env.linux', {"GTK_PATH": ""})
     # Unset GTK_PATH on Linux for Electron development in sandboxed environments
@@ -63,6 +71,7 @@ def add_or_update_settings() -> None:
     configure_setting_key('gitlens.telemetry.enabled', False)
 
 def configure_setting_key(configuration_key: str, desired_value: Any) -> None:
+    """Configure a specific setting key in the VSCode settings file."""
     try:
         with open(VSCODE_SETTINGS_JSON_FILE, 'r+', encoding='utf-8') as file:
             settings: dict = json.load(file)
@@ -80,6 +89,7 @@ def configure_setting_key(configuration_key: str, desired_value: Any) -> None:
         print_error(f"Failed to update JSON for key {configuration_key}.")
 
 def install_recommended_extensions() -> None:
+    """Install recommended VSCode extensions."""
     if not os.path.isfile(VSCODE_EXTENSIONS_JSON_FILE):
         print_error(
             f"The extensions.json file does not exist in the path: {VSCODE_EXTENSIONS_JSON_FILE}."
@@ -89,7 +99,7 @@ def install_recommended_extensions() -> None:
         json_content: str = remove_json_comments(file.read())
     try:
         data: dict = json.loads(json_content)
-        extensions: list[str] = data.get("recommendations", [])
+        extensions: List[str] = data.get("recommendations", [])
         if not extensions:
             print_skip(f"No recommendations found in the {VSCODE_EXTENSIONS_JSON_FILE} file.")
             return
@@ -102,6 +112,7 @@ def install_recommended_extensions() -> None:
         print_error(f"Invalid JSON in {VSCODE_EXTENSIONS_JSON_FILE}")
 
 def locate_vscode_cli() -> Optional[str]:
+    """Locate the VSCode CLI tool."""
     vscode_alias = which('code') # More reliable than using `code`, especially on Windows.
     if vscode_alias:
         return vscode_alias
@@ -115,13 +126,15 @@ def locate_vscode_cli() -> Optional[str]:
     return None
 
 def remove_json_comments(json_like: st
EDB7
r) -> str:
+    """Remove comments from JSON-like strings."""
     pattern: str = r'(?:"(?:\\.|[^"\\])*"|/\*[\s\S]*?\*/|//.*)|([^:]//.*$)'
     return re.sub(
         pattern,
         lambda m: '' if m.group(1) else m.group(0), json_like, flags=re.MULTILINE,
     )
 
-def install_vscode_extensions(vscode_cli_path: str, extensions: list[str]) -> None:
+def install_vscode_extensions(vscode_cli_path: str, extensions: List[str]) -> None:
+    """Install VSCode extensions using the CLI tool."""
     successful_installations = 0
     for ext in extensions:
         try:
@@ -132,7 +145,7 @@ def install_vscode_extensions(vscode_cli_path: str, extensions: list[str]) -> No
                 text=True,
             )
             if "already installed" in result.stdout:
-                print_skip(f"Created or verified directory: {ext}")
+                print_skip(f"Extension already installed: {ext}")
             else:
                 print_success(f"Installed extension: {ext}")
             successful_installations += 1
@@ -141,49 +154,43 @@ def install_vscode_extensions(vscode_cli_path: str, extensions: list[str]) -> No
             print_subprocess_output(e)
             print_error(f"Failed to install extension: {ext}")
         except FileNotFoundError:
-            print_error(' '.join([
-                f"Visual Studio Code CLI tool not found: {vscode_cli_path}."
-                f"Could not install extension: {ext}",
-            ]))
+            print_error(f"Visual Studio Code CLI tool not found: {vscode_cli_path}. Could not install extension: {ext}")
         except Exception as e: # pylint: disable=broad-except
-            print_error(' '.join([
-                f"Failed to install extension '{ext}'.",
-                f"Attempted using Visual Studio Code CLI at: '{vscode_cli_path}'.",
-                f"Encountered error: {e}",
-            ]))
+            print_error(f"Failed to install extension '{ext}'. Attempted using Visual Studio Code CLI at: '{vscode_cli_path}'. Encountered error: {e}")
     total_extensions = len(extensions)
     print_installation_results(successful_installations, total_extensions)
 
 def print_subprocess_output(result: subprocess.CompletedProcess[str]) -> None:
+    """Print the output of a subprocess."""
     output = '\n'.join([text.strip() for text in [result.stdout, result.stderr] if text])
     if not output:
         return
     formatted_output = '\t' + output.strip().replace('\n', '\n\t')
     print(formatted_output)
 
 def print_installation_results(successful_installations: int, total_extensions: int) -> None:
+    """Print the results of the extension installation process."""
     if successful_installations == total_extensions:
-        print_success(
-            f"Successfully installed or verified all {total_extensions} recommended extensions."
-        )
+        print_success(f"Successfully installed or verified all {total_extensions} recommended extensions.")
     elif successful_installations > 0:
-        print_warning(
-            f"Partially successful: Installed or verified {successful_installations} "
-            f"out of {total_extensions} recommended extensions."
-        )
+        print_warning(f"Partially successful: Installed or verified {successful_installations} out of {total_extensions} recommended extensions.")
     else:
         print_error("Failed to install any of the recommended extensions.")
 
 def print_error(message: str) -> None:
+    """Print an error message."""
     print(f"[ERROR] {message}", file=sys.stderr)
 
 def print_success(message: str) -> None:
+    """Print a success message."""
     print(f"[SUCCESS] {message}")
 
 def print_skip(message: str) -> None:
+    """Print a skip message."""
     print(f"[SKIPPED] {message}")
 
 def print_warning(message: str) -> None:
+    """Print a warning message."""
     print(f"[WARNING] {message}", file=sys.stderr)
 
 if __name__ == "__main__":

diff --git a/scripts/npm-install.js b/scripts/npm-install.js
@@ -65,7 +65,7 @@ async function main() {
   console.log('Starting dependency installation...');
   const exitCode = await executeWithRetry(
     command,
-    options.workingDirectory,
+    options.rootDirectory,
     MAX_RETRIES,
     RETRY_DELAY_IN_MS,
   );
@@ -79,7 +79,7 @@ async function main() {
 
 async function removeNodeModules(workingDirectory) {
   const nodeModulesDirectory = resolve(workingDirectory, 'node_modules');
-  if (await exists('./node_modules')) {
+  if (await exists(nodeModulesDirectory)) {
     console.log('Removing node_modules...');
     await rm(nodeModulesDirectory, { recursive: true });
   }
@@ -96,7 +96,7 @@ async function removePackageLockJson(workingDirectory) {
 async function ensureNpmIsAvailable() {
   const exitCode = await executeCommand('npm --version');
   if (exitCode !== 0) {
-    throw new Error('`npm` in not available!');
+    throw new Error('`npm` is not available!');
   }
 }
 
@@ -118,7 +118,7 @@ function buildCommand(ci, outputErrors) {
 function getOptions() {
   const processArgs = process.argv.slice(2); // Slice off the node and script name
   return {
-    rootDirectory: processArgs.includes('--root-directory') ? processArgs[processArgs.indexOf('--root-directory') + 1] : process.cwd(),
+    rootDirectory: processArgs.includes(ARG_NAMES.rootDirectory) ? processArgs[processArgs.indexOf(ARG_NAMES.rootDirectory) + 1] : process.cwd(),
     outputErrors: !processArgs.includes(ARG_NAMES.ignoreErrors),
     ci: processArgs.includes(ARG_NAMES.ci),
     fresh: processArgs.includes(ARG_NAMES.fresh),

diff --git a/scripts/validate-collections-yaml/__main__.py b/scripts/validate-collections-yaml/__main__.py
@@ -9,6 +9,7 @@
   This script requires the `jsonschema` and `pyyaml` packages (see requirements.txt).
 """
 # pylint: disable=missing-function-docstring
+import logging
 from os import path
 import sys
 from glob import glob
@@ -19,44 +20,57 @@
 SCHEMA_FILE_PATH = './src/application/collections/.schema.yaml'
 COLLECTIONS_GLOB_PATTERN = './src/application/collections/*.yaml'
 
-def main() -> None:
-    schema_yaml = read_file(SCHEMA_FILE_PATH)
+logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+
+def main(schema_file_path: str = SCHEMA_FILE_PATH
1E09
, collections_glob_pattern: str = COLLECTIONS_GLOB_PATTERN) -> None:
+    schema_yaml = read_file(schema_file_path)
     schema_json = convert_yaml_to_json(schema_yaml)
-    collection_file_paths = find_collection_files(COLLECTIONS_GLOB_PATTERN)
-    print(f'Found {len(collection_file_paths)} YAML files to validate.')
+    collection_file_paths = find_collection_files(collections_glob_pattern)
+    logging.info(f'Found {len(collection_file_paths)} YAML files to validate.')
 
     total_invalid_files = 0
     for collection_file_path in collection_file_paths:
         file_name = path.basename(collection_file_path)
-        print(f'Validating {file_name}...')
+        logging.info(f'Validating {file_name}...')
         collection_yaml = read_file(collection_file_path)
         collection_json = convert_yaml_to_json(collection_yaml)
         try:
             validate(instance=collection_json, schema=schema_json)
-            print(f'Success: {file_name} is valid.')
+            logging.info(f'Success: {file_name} is valid.')
         except exceptions.ValidationError as err:
-            print(f'Error: Validation failed for {file_name}.', file=sys.stderr)
-            print(str(err), file=sys.stderr)
+            logging.error(f'Error: Validation failed for {file_name}.')
+            logging.error(str(err))
             total_invalid_files += 1
 
     if total_invalid_files > 0:
-        print(f'Validation complete with {total_invalid_files} invalid files.', file=sys.stderr)
+        logging.error(f'Validation complete with {total_invalid_files} invalid files.')
         sys.exit(1)
     else:
-        print('Validation complete. All files are valid.')
+        logging.info('Validation complete. All files are valid.')
         sys.exit(0)
 
 def read_file(file_path: str) -> str:
-    with open(file_path, 'r', encoding='utf-8') as file:
-        return file.read()
+    """Reads the content of a file and returns it as a string."""
+    try:
+        with open(file_path, 'r', encoding='utf-8') as file:
+            return file.read()
+    except Exception as e:
+        logging.error(f'Error reading file {file_path}: {e}')
+        sys.exit(1)
 
 def find_collection_files(glob_pattern: str) -> List[str]:
+    """Finds and returns a list of collection file paths matching the glob pattern."""
     files = glob(glob_pattern)
     filtered_files = [f for f in files if not path.basename(f).startswith('.')]
     return filtered_files
 
 def convert_yaml_to_json(yaml_content: str) -> dict:
-    return yaml.safe_load(yaml_content)
+    """Converts YAML content to a JSON-compatible dictionary."""
+    try:
+        return yaml.safe_load(yaml_content)
+    except yaml.YAMLError as e:
+        logging.error(f'Error converting YAML to JSON: {e}')
+        sys.exit(1)
 
 if __name__ == '__main__':
     main()