win: fix Defender service #128 #385 #393 #402 #426

This commit adds disabling missing low-level Defender service/drivers,
improve disabling existing ones, and improve their documentation.

Key changes:

- Add disabling missing Defender services.
- Add disabling missing Defender processes.
- Add soft-deleting of missing service files
- Fix `ServiceKeepAlive` value #393, #426
- Add disabling system modification restrictions for persistent Disable
  service disabling.
- Recommend more Defender scripts on 'Strict' level

Other supporting changes:

- Add more documentation for related scripts.
- Move disabling `SecHealthUI` to disabling Windows Security.
- Fix `DisableService` attempting to disable the service even though its
  disabled.
- Add ability to disable service on revert in
  `DisableServiceInRegistry`.
- Improve categorization for simplicity, add new categories for new
  scripts.
- Add ability to run `DeleteRegistryValue` as `TrustedInstaller`.
- Rename some scripts/categories for simplicity and clarity.

.editorconfig

@@ -3,7 +3,7 @@ root = true # Top-most EditorConfig file
 [*]
 end_of_line = lf
 
-[*.{js,jsx,ts,tsx,vue,sh}]
+[*.{js,jsx,ts,tsx,vue,sh,scss}]
 indent_style = space
 indent_size = 2
 trim_trailing_whitespace = true
@@ -24,3 +24,10 @@ indent_style = space
 indent_size = 4
 trim_trailing_whitespace = true
 insert_final_newline = true
+
+[*.{scss}] # SASS guidelines: https://archive.today/2024.02.16-232553/https://sass-guidelin.es/
+indent_style = space
+indent_size = 2 # Recommended by SASS guidelines
+max_line_length = 100 # Recommended by SASS guidelines
+trim_trailing_whitespace = true
+insert_final_newline = true

.github/ISSUE_TEMPLATE/1-bug-report-scripts.md

@@ -1,57 +0,0 @@
----
-name: Bug report (script bug or unexpected script behavior)
-about: Create a bug report for generated scripts to help privacy.sexy improve
-labels: bug
-title: '[BUG]: '
----
-
-<!--
-Thank you for reporting an issue with generated script(s).
-Please fill in as much of the template below as you're able.
-As a small open source project with small community, it can sometimes take a long time for issues to be addressed so please be patient. 
--->
-
-### Description
-
-<!--
-A clear and concise description of what the bug is.
--->
-
-### OS
-
-<!--
-Which OS are you using? What version of OS you were using?
-On Windows: Open "Start button" > "Settings" > "System" > "About".
-On macOS: Open "Apple menu (top left corner)" > "About This Mac".
-On Linux: Open terminal > type: lsb_release -a > copy paste the result.
--->
-
-### Reproduction steps
-
-<!--
-How can the bug be recreated?
-It's the most important information in the bug report. Bugs that cannot be reproduced cannot be fixed and verified.
-E.g.
-    1. Go to '...'
-    2. Click on '....'
-    3. Scroll down to '....'
-    4. See error
--->
-
-### Scripts
-
-<!--
-If applicable, please attach the generated privacy.sexy file instead of copy pasting which becomes too long.
--->
-
-### Screenshots
-
-<!--
-If applicable, add screenshots to help explain your problem.
--->
-
-### Additional information
-
-<!--
-If applicable, add any other context about the problem here.
--->

.github/ISSUE_TEMPLATE/1-bug-report-scripts.yaml

@@ -0,0 +1,114 @@
+name: "Bug Report: Script Issues"
+description: 🐛 Report issues with generated scripts to enhance privacy.sexy
+labels: [ 'bug' ]
+title: '[Bug]: '
+body:
+  -
+    type: markdown
+    attributes:
+      value: |-
+        Thank you for contributing to privacy.sexy and guiding our direction! 🌟
+        Please complete as much of the form below as possible.
+        Your feedback is valuable, even if you can't provide all details.
+  -
+    type: textarea
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+      placeholder: >-
+        For example: "After running the cleanup script, music playback stopped functioning."
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: How can the bug be recreated?
+      description: |-
+        This is the most important information in the bug report.
+        Bugs that cannot be reproduced cannot be fixed or verified.
+      placeholder: |-
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Operating system
+      description: |-
+        Please specify your operating system and its version.
+
+        - On Windows: Open "Start button" > "Settings" > "System" > "About".
+        - On macOS: Open "Apple menu (top left corner)" > "About This Mac".
+        - On Linux: Open terminal > type: lsb_release -a > copy paste the result.
+      placeholder: >-
+        For example: "Windows 11 Pro 22H3"
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Script file
+      description: |-
+        If applicable, share the generated privacy.sexy file.
+
+        GitHub may restrict script file attachments.
+        Upload your script file to a service like [GitHub Gist](https://gist.github.com/) and share the link here.
+
+        If you used the desktop version to run the script, it is already stored on your system.
+        See the [documentation to locate it](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md#secure-script-executionstorage).
+
+        > **💡 Tip:** You can attach script files by dragging them into this area.
+      placeholder: |-
+        Attach the script, or post GitHub Gist link.
+        For example: https://gist.github.com/privacysexy-forks/6d85ad8ca27acc8c6a5417d4af28c9b6.
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Screenshots
+      description: |-
+        If applicable, add screenshots to help explain your problem.
+
+        > **💡 Tip:** You can attach screenshots by clicking this area to highlight it and then pasting them or dragging files in.
+      placeholder: Attach screenshots here or link to image hosting.
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Additional information
+      description: |-
+        If applicable, add any other context about the problem here.
+
+        Helpful information includes:
+
+        - Application logs (desktop version only), see: [how to find application logs](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md#logging).
+        - Terminal output
+        - Proposed solutions
+        - Other related context such as related issues, software behavior, etc.
+
+        > **💡 Tip:** You can attach log files by dragging them into this area.
+      placeholder: >-
+        For example: "Here are the logs I get from the privacy.sexy 0.13.2 desktop application: ..."
+    validations:
+      required: false
+  -
+    type: markdown
+    attributes:
+      value: |-
+        ---
+
+        **✉️ A friendly note from the maintainer:**
+
+        > [!NOTE]
+        > We are a small open-source project with a small community.
+        > It can sometimes take a long time for issues to be addressed, so please be patient.
+        > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️.
+        > But your issue will eventually get attention regardless.
+        > <p align="right">@undergroundwires</p>
+
+        ---

.github/ISSUE_TEMPLATE/2-bug-report-general.yaml

@@ -0,0 +1,104 @@
+name: "Bug Report: General"
+description: 🐛 Report general issues to enhance privacy.sexy
+labels: [ 'bug' ]
+title: '[Bug]: '
+body:
+  -
+    type: markdown
+    attributes:
+      value: |-
+        Thank you for contributing to privacy.sexy and guiding our direction! 🌟
+        Please complete as much of the form below as possible.
+        Your feedback is valuable, even if you can't provide all details.
+  -
+    type: textarea
+    attributes:
+      label: Description
+      description: Provide a clear and concise description of the issue.
+      placeholder: >-
+        For example: "I cannot select any scripts."
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Reproduction steps
+      description: |-
+        This is the most important information in the bug report.
+        Bugs that cannot be reproduced cannot be fixed or verified.
+      placeholder: |-
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Expected behavior
+      description: Describe what you expected to happen when the error occurred.
+      placeholder: >-
+        For example: "I expected the settings menu to open smoothly without crashing.".
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Screenshots
+      description: |-
+        If applicable, add screenshots to help explain your problem.
+
+        > **💡 Tip:** You can attach screenshots by clicking this area to highlight it and then pasting them or dragging files in.
+      placeholder: >-
+        Attach screenshots here or link to image hosting.
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: privacy.sexy environment details
+      description: |-
+        If applicable, mention how you were using privacy.sexy when the bug occurred:
+
+        - Web (on which operating system and browser?)
+        - Or desktop (Windows, macOS, or Linux?)
+      placeholder: >-
+        For example: "The web version on Edge browser on Windows 11 23H2."
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Additional context
+      description: |-
+        If applicable, add any other context about the problem here.
+
+        Helpful information includes:
+
+        - Application logs (desktop version only), see: [how to find application logs](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/desktop/desktop-vs-web-features.md#logging).
+        - Terminal output
+        - Proposed solutions
+        - Other related context such as related issues, software behavior, etc.
+
+        > **💡 Tip:** You can attach log files by dragging them into this area.
+      placeholder: >-
+        For example: "Here are the logs I get from the privacy.sexy 0.13.2 desktop application: ..."
+    validations:
+      required: false
+  -
+    type: markdown
+    attributes:
+      value: |-
+        ---
+
+        **✉️ A friendly note from the maintainer:**
+
+        > [!NOTE]
+        > We are a small open-source project with a small community.
+        > It can sometimes take a long time for issues to be addressed, so please be patient.
+        > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️.
+        > But your issue will eventually get attention regardless.
+        > <p align="right">@undergroundwires</p>
+
+        ---

.github/ISSUE_TEMPLATE/2-bug-report-generic.md

@@ -1,55 +0,0 @@
----
-name: Bug report (unrelated to generated scripts)
-about: Create a bug report that's not related to generated scripts to help privacy.sexy improve
-labels: bug
-title: '[BUG]: '
----
-
-<!--
-Thank you for reporting an issue.
-Please fill in as much of the template below as you're able.
-As a small open source project with small community, it can sometimes take a long time for issues to be addressed so please be patient. 
--->
-
-### Description
-
-<!--
-A clear and concise description of what the bug is.
--->
-
-### Reproduction steps
-
-<!--
-It's the most important information in the bug report. Bugs that cannot be reproduced cannot be fixed and verified.
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
--->
-
-### Expected behavior
-
-<!--
-A clear and concise description of what you expected to happen.
--->
-
-### Screenshots
-
-<!--
-If applicable, add screenshots to help explain your problem.
--->
-
-### Distribution
-
-<!--
-If applicable, mention how you were using privacy.sexy when the bug was encountered:
-   - Web (on Desktop or mobile?)
-   - Or desktop (Windows, macOS or Linux?)
--->
-
-### Additional context
-
-<!--
-If applicable, add any other context about the problem here.
--->

.github/ISSUE_TEMPLATE/3-feature-request.md

@@ -1,36 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for privacy.sexy
-labels: enhancement
----
-
-<!--
-Thank you for suggesting an idea to improve privacy better 🤗.
-Please fill in as much of the template below as you're able.
--->
-
-### Problem description
-
-<!--
-What are we trying to solve?
-Please add a clear and concise description of the problem you are seeking to solve with this feature request.
-E.g. I'm always frustrated when [...]
--->
-
-### Proposed solution
-
-<!--
-Describe the solution you'd like in a clear and concise manner.
--->
-
-### Alternatives considered
-
-<!--
-A clear and concise description of any alternative solutions or features you've considered.
--->
-
-### Additional information
-
-<!--
-If applicable, add any other context or screenshots about the feature request here.
--->

.github/ISSUE_TEMPLATE/3-suggestion-feature.yaml

@@ -0,0 +1,73 @@
+name: "Suggestion: Feature"
+description: 💡 Suggest new ideas to enhance privacy.sexy
+labels: [ 'enhancement' ]
+title: '[Feature]: '
+body:
+  -
+    type: markdown
+    attributes:
+      value: |-
+        Thank you for contributing to privacy.sexy and guiding our direction! 🌟
+        Please complete as much of the form below as possible.
+        Your feedback is valuable, even if you can't provide all details.
+  -
+    type: textarea
+    attributes:
+      label: Problem statement
+      description: |-
+        What are we trying to solve?
+
+        Please add a clear and concise description of the problem you are seeking to solve with this feature request.
+      placeholder: >-
+        For example: "Every time I use the app, I struggle with..."
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Proposed solution
+      description: |-
+        Describe the solution you'd like in a clear and concise manner.
+      placeholder: >-
+        For example: "It would be great if the app could..."
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Alternatives considered
+      description: |-
+        Have you considered any alternative solutions or features?
+        Different perspectives can inspire new ideas.
+      placeholder: >-
+        For example: "We could also solve it by...".
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Additional information
+      description: |-
+        If applicable, add any other context or screenshots about the feature request here.
+
+        > **💡 Tip:** You can attach files or screenshots by dragging them into this area.
+      placeholder: >-
+        For example: "Challenges can be ..., but I'm unsure about ..., here is some documentation about it: ..."
+    validations:
+      required: false
+  -
+    type: markdown
+    attributes:
+      value: |-
+        ---
+
+        **✉️ A friendly note from the maintainer:**
+
+        > [!NOTE]
+        > We are a small open-source project with a small community.
+        > It can sometimes take a long time for issues to be addressed, so please be patient.
+        > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️.
+        > But your issue will eventually get attention regardless.
+        > <p align="right">@undergroundwires</p>
+
+        ---

.github/ISSUE_TEMPLATE/4-new-script-suggestion.md

@@ -1,60 +0,0 @@
----
-name: New script suggestion
-about: Suggest a new script for privacy.sexy
-labels: enhancement
----
-
-<!--
-Thank you for contributing to privacy.sexy! 🌟
-For guidance, see our script guidelines: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md.
-Consider submitting a PR for faster implementation: https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md#extend-scripts.
--->
-
-### Operating system
-
-<!--
-  Specify the OS: Windows, macOS, or Linux.
--->
-
-### Name
-
-<!--
-  Suggest a name for the script.
-  Naming conventions: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#name.
--->
-
-### Code
-
-<!--
-  Provide or explain the code to execute when the script runs.
-  Code guidelines: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#code.
--->
-
-### Revert code
-
-<!--
-  Include code to revert changes to the default state.
-  Leave blank for non-reversible scripts.
--->
-
-### Category
-
-<!--
-  Suggest a category for the script.
-  If unsure, leave blank for maintainers to decide.
--->
-
-### Recommendation level
-
-<!--
-  Suggest a recommendation level: STANDARD (non-breaking), STRICT (limits functionality), or NONE (for advanced users).
-  If unsure, leave blank for maintainers to decide.
--->
-
-### Documentation/References
-
-<!--
-  Provide any relevant documentation or references.
-  Prefer high-quality sources such as vendor documentation.
-  Documentation guidelines: https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#documentation.
--->

.github/ISSUE_TEMPLATE/4-suggestion-new-script.yaml

@@ -0,0 +1,133 @@
+name: "Suggestion: New Script"
+description: 💡 Suggest new scripts to enhance privacy.sexy
+labels: [ 'enhancement' ]
+title: '[New script]: '
+body:
+  -
+    type: markdown
+    attributes:
+      value: |-
+        Thank you for contributing to privacy.sexy and guiding our direction! 🌟
+        Please complete as much of the form below as possible.
+        Your feedback is valuable, even if you can't provide all details.
+
+        For guidance, see our [script guidelines](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md).
+        Consider submitting a PR to get your script added more quickly: (see [CONTRIBUTING.md](https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md#extend-scripts))
+  -
+    type: dropdown
+    attributes:
+      label: Operating system
+      description: Which operating system will the new script configure?
+      options:
+        - macOS
+        - Windows
+        - Linux
+        - All of them
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Name of the script
+      description: |-
+        Suggest a name for the script that clearly describes its function.
+
+        See [script naming conventions](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#name) for best practices.
+      placeholder: E.g, "Disable error data submission"
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Documentation/References
+      description: |-
+        Provide any relevant documentation or references.
+        Prefer high-quality sources such as vendor documentation.
+
+        See [documentation guidelines](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#documentation) for best practices.
+      placeholder: >-
+        For example: "This script will disable the error data submission, see https://microsoft.com/...".
+    validations:
+      required: true
+  -
+    type: textarea
+    attributes:
+      label: Code
+      description: |-
+        If possible, provide or explain the code that the script should execute.
+
+        See [script code guidelines](https://github.com/undergroundwires/privacy.sexy/blob/master/docs/script-guidelines.md#code).
+      placeholder: |-
+        For example: "Set registry key like this `reg add "HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\DataCollection" /v "AllowTelemetry" /t "REG_DWORD" /d "1"`".
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Revert code
+      description: |-
+        If applicable, provide revert code to restore the changes made by the script.
+
+        The revert code restores changes to their default state before script execution.
+
+        Leave blank for non-reversible scripts.
+      placeholder: |-
+        For example: "Revert to operating system default like this `reg add "HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\DataCollection" /v "AllowTelemetry" /t "REG_DWORD" /d "0"`".
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Suggested category
+      description: |-
+        Suggest a category for the script.
+
+        If unsure, leave blank for maintainers to decide.
+      placeholder: >-
+        For example: "Privacy Cleanup > Clear system logs"
+  -
+    type: dropdown
+    attributes:
+      label: Recommendation level
+      description: |-
+        Suggest a recommendation level for the script:
+
+        - **Standard**: Recommended for most users without side-effects.
+        - **Strict**: Provides improved privacy at the cost of some functionality.
+        - **None**: For advanced users or specific needs.
+
+        If unsure, leave blank for maintainers to decide.
+      options:
+        - Standard
+        - Strict
+        - None (do not recommend)
+    validations:
+      required: false
+  -
+    type: textarea
+    attributes:
+      label: Additional information
+      description: |-
+        If applicable, add any other context or screenshots about the script request here.
+
+        > **💡 Tip:** You can attach additional documents or screenshots by dragging them into this area or pasting directly.
+      placeholder: >-
+        For example: "Challenges can be ..., but I am unsure about ..."
+    validations:
+      required: false
+  -
+    type: markdown
+    attributes:
+      value: |-
+        ---
+
+        **✉️ A friendly note from the maintainer:**
+
+        > [!NOTE]
+        > We are a small open-source project with a small community.
+        > It can sometimes take a long time for issues to be addressed, so please be patient.
+        > Consider [donating](https://undergroundwires.dev/donate) to keep privacy.sexy alive and improve support ❤️.
+        > But your issue will eventually get attention regardless.
+        > <p align="right">@undergroundwires</p>
+
+        ---

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1,7 @@
+# This file must be named `config.yml`. GitHub does not recognize the file if it is named `config.yaml`.
 blank_issues_enabled: true
+contact_links:
+  - name: Donate
+    url: https://undergroundwires.dev/donate/
+    about: ❤️ Donate to support the free software you love to keep it alive.
+  # A separate link for reporting vulnerabilities is not included here because GitHub generates it automatically.

.github/actions/force-ipv4/README.md

@@ -0,0 +1,32 @@
+# force-ipv4
+
+## Overview
+
+This GitHub action enforces IPv4 for all outgoing network requests. It addresses connectivity issues encountered in GitHub runners, where IPv6 requests may lead to timeouts due to the lack of IPv6 support [1] [2].
+
+## Background
+
+Some applications attempt network connections over IPv6.
+Such as requests made by Node's `fetch` API causes `UND_ERR_CONNECT_TIMEOUT` [3] [4] and similar issues [5].
+This happens when the software cannot handle this such as by using Happy Eyeballs [6] [7].
+
+## Usage
+
+To use this action in your GitHub workflow, add the following step before any job that requires network access:
+
+```yaml
+- name: Enforce IPv4 Connectivity
+  uses: ./.github/actions/force-ipv4
+```
+
+## Note
+
+This action is a workaround addressing specific IPv6-related connectivity issues on GitHub runners and may not be necessary if GitHub's infrastructure evolves to fully support IPv6 in the future.
+
+[1]: https://archive.ph/2024.03.28-185829/https://github.com/actions/runner/issues/3138 "Actions Runner fails on IPv6 only host · Issue #3138 · actions/runner · GitHub | github.com"
+[2]: https://archive.ph/2024.03.28-185838/https://github.com/actions/runner-images/issues/668 "IPv6 on GitHub-hosted runners · Issue #668 · actions/runner-images · GitHub | github.com"
+[3]: https://archive.ph/2024.03.28-185847/https://github.com/actions/runner/issues/3213 "GitHub runner cannot send `fetch` with `node`, failing with IPv6 DNS error `UND_ERR_CONNECT_TIMEOUT` · Issue #3213 · actions/runner · GitHub | github.com"
+[4]: https://archive.ph/2024.03.28-185853/https://github.com/actions/runner-images/issues/9540 "Cannot send outbound requests using node fetch, failing with IPv6 DNS error UND_ERR_CONNECT_TIMEOUT · Issue #9540 · actions/runner-images · GitHub | github.com"
+[5]: https://archive.today/2024.03.30-113315/https://github.com/nodejs/node/issues/40537 "\"localhost\" favours IPv6 in node v17, used to favour IPv4 · Issue #40537 · nodejs/node · GitHub"
+[6]: https://archive.ph/2024.03.28-185900/https://github.com/nodejs/node/issues/41625 "Happy Eyeballs support (address IPv6 issues in Node 17) · Issue #41625 · nodejs/node · GitHub | github.com"
+[7]: https://archive.ph/2024.03.28-185910/https://github.com/nodejs/undici/issues/1531 "fetch times out in under 5 seconds · Issue #1531 · nodejs/undici · GitHub | github.com"

.github/actions/force-ipv4/action.yml

@@ -0,0 +1,12 @@
+inputs:
+  project-root:
+    required: false
+    default: '.'
+runs:
+  using: composite
+  steps:
+    -
+      name: Run prefer IPv4 script
+      shell: bash
+      run: ./.github/actions/force-ipv4/force-ipv4.sh
+      working-directory: ${{ inputs.project-root }}

.github/actions/force-ipv4/force-ipv4.sh

@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+
+main() {
+  if is_linux; then
+    echo 'Configuring Linux...'
+
+    configure_warp_with_doh_and_ipv6_exclusion_on_linux # [WORKS] Resolves the issue when run independently on GitHub runners lacking IPv6 support.
+    prefer_ipv4_on_linux # [DOES NOT WORK] It does not resolve the issue when run independently on GitHub runners without IPv6 support.
+
+    # Considered alternatives:
+    # - `sysctl` commands, and direct changes to `/proc/sys/net/` and `/etc/sysctl.conf` led to silent
+    #   Node 18 exits (code: 13) when using `fetch`.
+  elif is_macos; then
+    echo 'Configuring macOS...'
+
+    configure_warp_with_doh_and_ipv6_exclusion_on_macos # [WORKS] Resolves the issue when run independently on GitHub runners lacking IPv6 support.
+    disable_ipv6_on_macos # [WORKS INCONSISTENTLY] Resolves the issue inconsistently when run independently on GitHub runners without IPv6 support.
+  fi
+  echo "IPv4: $(curl --ipv4 --silent --max-time 15 --retry 3 --user-agent Mozilla https://api.ip.sb/geoip)"
+  echo "IPv6: $(curl --ipv6 --silent --max-time 15 --retry 3 --user-agent Mozilla https://api.ip.sb/geoip)"
+}
+
+is_linux() {
+  [[ "$(uname -s)" == "Linux" ]]
+}
+
+is_macos() {
+  [[ "$(uname -s)" == "Darwin" ]]
+}
+
+configure_warp_with_doh_and_ipv6_exclusion_on_linux() {
+  install_warp_on_debian
+  configure_warp_doh_and_exclude_ipv6
+}
+
+configure_warp_with_doh_and_ipv6_exclusion_on_macos() {
+  brew install cloudflare-warp
+  configure_warp_doh_and_exclude_ipv6
+}
+
+configure_warp_doh_and_exclude_ipv6() {
+  echo 'Beginning configuration of the Cloudflare WARP client with DNS-over-HTTPS and IPv6 exclusion...'
+  echo 'Initiating client registration with Cloudflare...'
+  warp-cli --accept-tos registration new
+  echo 'Configuring WARP to operate in DNS-over-HTTPS mode (warp+doh)...'
+  warp-cli --accept-tos mode warp+doh
+  echo 'Excluding IPv6 traffic from WARP by configuring it as a split tunnel...'
+  warp-cli --accept-tos add-excluded-route '::/0' # Exclude IPv6, forcing IPv4 resolution
+  # `tunnel ip add` does not work with IP ranges, see https://community.cloudflare.com/t/cant-cidr-for-split-tunnling/630834
+  echo 'Establishing WARP connection...'
+  warp-cli --accept-tos connect
+}
+
+install_warp_on_debian() {
+  curl -fsSL https://pkg.cloudflareclient.com/pubkey.gpg | sudo gpg --yes --dearmor --output /usr/share/keyrings/cloudflare-warp-archive-keyring.gpg
+  echo "deb [arch=amd64 signed-by=/usr/share/keyrings/cloudflare-warp-archive-keyring.gpg] https://pkg.cloudflareclient.com/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/cloudflare-client.list
+  sudo apt-get update
+  sudo apt-get install -y cloudflare-warp
+}
+
+disable_ipv6_on_macos() {
+  networksetup -listallnetworkservices \
+    | tail -n +2 \
+    | while IFS= read -r interface; do
+        echo "Disabling IPv6 on: $interface..."
+        networksetup -setv6off "$interface"
+      done
+}
+
+prefer_ipv4_on_linux() {
+  local -r gai_config_file_path='/etc/gai.conf'
+  if [ ! -f "$gai_config_file_path" ]; then
+      echo "Creating $gai_config_file_path since it doesn't exist..."
+      touch "$gai_config_file_path"
+  fi
+  echo "precedence ::ffff:0:0/96  100" | sudo tee -a "$gai_config_file_path" > /dev/null
+  echo "Configuration complete."
+}
+
+main

.github/actions/install-imagemagick/action.yml

@@ -0,0 +1,12 @@
+inputs:
+  project-root:
+    required: false
+    default: '.'
+runs:
+  using: composite
+  steps:
+    -
+      name: Install ImageMagick
+      shell: bash
+      run: ./.github/actions/install-imagemagick/install-imagemagick.sh
+      working-directory: ${{ inputs.project-root }}

.github/actions/install-imagemagick/install-imagemagick.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+main() {
+  local install_command
+  if ! install_command=$(get_install_command); then
+    fatal_error 'Could not find available command to install'
+  fi
+  if ! eval "$install_command"; then
+    echo "Failed to install ImageMagick. Command: ${install_command}"
+    exit 1
+  fi
+  echo 'ImageMagick installation completed successfully'
+}
+
+get_install_command() {
+  case "$OSTYPE" in
+    darwin*)
+      ensure_command_exists 'brew'
+      echo 'brew install imagemagick'
+      ;;
+    linux-gnu*)
+      if is_ubuntu; then
+        ensure_command_exists 'apt'
+        echo 'sudo apt install -y imagemagick'
+      else
+        fatal_error 'Unsupported Linux distribution'
+      fi
+      ;;
+    msys*|cygwin*)
+      ensure_command_exists 'choco'
+      echo 'choco install -y imagemagick'
+      ;;
+    *)
+      fatal_error "Unsupported operating system: $OSTYPE"
+      ;;
+  esac
+}
+
+ensure_command_exists() {
+  local -r command="$1"
+  if ! command -v "$command" >/dev/null 2>&1; then
+    fatal_error "Command missing: $command"
+  fi
+}
+
+fatal_error() {
+  local -r error_message="$1"
+  >&2 echo "❌ $error_message"
+  exit 1
+}
+
+is_ubuntu() {
+  [ -f /etc/os-release ] && grep -qi 'ubuntu' /etc/os-release
+}
+
+main

.github/actions/setup-node/action.yml

@@ -5,4 +5,5 @@ runs:
       name: Setup node
       uses: actions/setup-node@v4
       with:
-        node-version: 18.x
+        node-version: 20.x
+        # check-latest: true # Newest versions can potentially have undiscovered bugs or regressions

.github/actions/upload-artifact/action.yaml

@@ -0,0 +1,15 @@
+inputs:
+  name:
+    required: true
+  path:
+    required: true
+
+runs:
+  using: composite
+  steps:
+    -
+      name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ inputs.name }}
+        path: ${{ inputs.path }}

.github/workflows/checks.build.yaml

@@ -72,16 +72,19 @@ jobs:
   build-docker:
     strategy:
       matrix:
-        os: [ macos, ubuntu ] # Windows runners do not support Linux containers
+        os:
+          - macos-13 # Downgraded due to lack of nested virtualization support in ARM-based runners (See: actions/runner-images#9460, actions/runner-images#9741, abiosoft/colima#1023)
+          - ubuntu-latest
+          # - windows-latest # Windows runners do not support Linux containers
       fail-fast: false # Allows to see results from other combinations
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
     steps:
       -
         name: Checkout
         uses: actions/checkout@v4
       -
         name: Install Docker on macOS
-        if: matrix.os == 'macos' # macOS runner is missing Docker
+        if: contains(matrix.os, 'macos') # macOS runner is missing Docker
         run: |-
           # Install Docker
           brew install docker
@@ -95,6 +98,12 @@ jobs:
       -
         name: Run Docker image on port 8080
         run: docker run -d -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest
+      -
+        name: Enforce IPv4 Connectivity # Used due to GitHub runners' lack of IPv6 support, preventing request timeouts.
+        uses: ./.github/actions/force-ipv4
       -
         name: Check server is up and returns HTTP 200
-        run: node ./scripts/verify-web-server-status.js --url http://localhost:8080
+        run: >-
+          node ./scripts/verify-web-server-status.js \
+            --url http://localhost:8080  \
+            --max-retries ${{ matrix.os == 'macos' && '90' || '30' }}

.github/workflows/checks.desktop-runtime-errors.yaml

@@ -9,9 +9,13 @@ jobs:
   run-check:
     strategy:
       matrix:
-        os: [ macos, ubuntu, windows ]
+        os:
+          - macos-latest  # Apple silicon (ARM64)
+          - macos-13      # Intel-based (x86-64)
+          - ubuntu-latest
+          - windows-latest
       fail-fast: false # Allows to see results from other combinations
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
     steps:
       -
         name: Checkout
@@ -22,9 +26,12 @@ jobs:
       -
         name: Install dependencies
         uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Install ImageMagick # For screenshots
+        uses: ./.github/actions/install-imagemagick
       -
         name: Configure Ubuntu
-        if: matrix.os == 'ubuntu'
+        if: contains(matrix.os, 'ubuntu')
         shell: bash
         run: |-
           sudo apt update
@@ -52,11 +59,20 @@ jobs:
           sudo Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
           echo "DISPLAY=:99" >> $GITHUB_ENV
 
-          # Install ImageMagick for screenshots
-          sudo apt install -y imagemagick
-
           # Install xdotool and xprop (from x11-utils) for window title capturing
           sudo apt install -y xdotool x11-utils
+
+          # Workaround for Electron AppImage apps failing to initialize on Ubuntu 24.04 due to AppArmor restrictions
+          # Disables unprivileged user namespaces restriction to allow Electron apps to run
+          # Reference: https://github.com/electron/electron/issues/42510
+          sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
+
+          # Workaround for Mesa driver issues on Ubuntu 24.04
+          # Installs latest Mesa drivers from Kisak PPA
+          # Reference: https://askubuntu.com/q/1516040
+          sudo add-apt-repository ppa:kisak/kisak-mesa
+          sudo apt update
+          sudo apt upgrade
       -
         name: Test
         shell: bash
@@ -66,7 +82,7 @@ jobs:
       -
         name: Upload screenshot
         if: always() # Run even if previous step fails
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         with:
           name: screenshot-${{ matrix.os }}
           path: screenshot.png

.github/workflows/checks.external-urls.yaml

@@ -1,6 +1,7 @@
 name: checks.external-urls
 
 on:
+  push:
   schedule:
     - cron: '0 0 * * 0' # at 00:00 on every Sunday
 
@@ -17,6 +18,13 @@ jobs:
       -
         name: Install dependencies
         uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Enforce IPv4 Connectivity # Used due to GitHub runners' lack of IPv6 support, preventing request timeouts.
+        uses: ./.github/actions/force-ipv4
       -
         name: Test
         run: npm run check:external-urls
+        env:
+          RANDOMIZED_URL_CHECK_LIMIT: "${{ github.event_name == 'push' && '100' || '3000' }}"
+          # - Scheduled checks has high limit for thorough testing.
+          # - For push events, triggered by code changes, the amount of URLs are limited to provide quick feedback.

.github/workflows/checks.quality.yaml

@@ -1,18 +1,19 @@
-name: quality-checks
+name: checks.quality
 
 on: [ push, pull_request ]
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}-latest
     strategy:
       matrix:
         lint-command:
           - npm run lint:eslint
           - npm run lint:yaml
           - npm run lint:md
-          - npm run lint:md:relative-urls
           - npm run lint:md:consistency
+          - npm run lint:md:relative-urls
+          - npm run lint:md:external-urls
         os: [ macos, ubuntu, windows ]
       fail-fast: false # Still interested to see results from other combinations
     steps:
@@ -28,3 +29,74 @@ jobs:
       -
         name: Lint
         run: ${{ matrix.lint-command }}
+
+  todo-check:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Scan latest commit for TODO comments
+        shell: bash
+        run: |-
+          readonly todo_comment_search_pattern='TODO'':' # Define search pattern in parts to prevent IDE from flagging this script line as a TODO item
+          if git grep "$todo_comment_search_pattern" HEAD; then
+            echo 'TODO comments found in the latest commit.'
+            exit 1
+          else
+            echo 'No TODO comments found in the latest commit.'
+            exit 0
+          fi
+
+  pylint:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        os: [ macos, ubuntu, windows ]
+      fail-fast: false # Still interested to see results from other combinations
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      -
+        name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pylint
+      -
+        name: Analyzing the code with pylint
+        run: npm run lint:pylint
+
+  validate-collection-files:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        os: [ macos, ubuntu, windows ]
+      fail-fast: false # Still interested to see results from other combinations
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      -
+        name: Install dependencies
+        run: python3 -m pip install -r ./scripts/validate-collections-yaml/requirements.txt
+      -
+        name: Validate
+        run: python3 ./scripts/validate-collections-yaml

.github/workflows/checks.scripts.yaml

@@ -15,6 +15,9 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v4
+      -
+        name: Install ImageMagick
+        uses: ./.github/actions/install-imagemagick
       -
         name: Setup node
         uses: ./.github/actions/setup-node
@@ -53,3 +56,31 @@ jobs:
       -
         name: Run install-deps
         run: ${{ matrix.install-command }}
+
+  configure-vscode:
+    runs-on: ${{ matrix.os.name }}-latest
+    strategy:
+      matrix:
+        os:
+          - name: macos
+            install-vscode-command: brew install --cask visual-studio-code
+          - name: ubuntu
+            install-vscode-command: sudo snap install code --classic
+          - name: windows
+            install-vscode-command: choco install vscode
+      fail-fast: false # Still interested to see results from other combinations
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      -
+        name: Install VSCode
+        run: ${{ matrix.os.install-vscode-command }}
+      -
+        name: Configure VSCode
+        run: python3 ./scripts/configure_vscode.py

.github/workflows/release.desktop.yaml

@@ -20,6 +20,7 @@ jobs:
           fetch-depth: 0 # fetch all history
       -
         name: Checkout to bump commit
+        shell: bash
         run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
       -
         name: Setup node

.github/workflows/tests.e2e.yaml

@@ -51,14 +51,14 @@ jobs:
       -
         name: Upload screenshots
         if: failure() # Run only if previous steps fail because screenshots will be generated only if E2E test failed
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         with:
           name: e2e-screenshots-${{ matrix.os }}
           path: ${{ steps.artifacts.outputs.SCREENSHOTS_DIR }}
       -
         name: Upload videos
         if: always() # Run even if previous steps fail because test run video is always captured
-        uses: actions/upload-artifact@v3
+        uses: ./.github/actions/upload-artifact
         with:
           name: e2e-videos-${{ matrix.os }}
           path: ${{ steps.artifacts.outputs.VIDEOS_DIR }}

.gitignore

@@ -14,3 +14,7 @@ node_modules
 
 # macOS
 .DS_Store
+
+# Python
+__pycache__
+.venv

.vscode/extensions.json

@@ -5,8 +5,10 @@
     "wengerk.highlight-bad-chars",      // Highlights bad chars.
     "wayou.vscode-todo-highlight",      // Highlights TODO.
     "wix.vscode-import-cost",           // Shows in KB how much a require include in code.
-    // Documentation
+    // Markdown
     "davidanson.vscode-markdownlint",   // Lints markdown.
+    // YAML
+    "redhat.vscode-yaml",               // Lints YAML files, validates against schema.
     // TypeScript / JavaScript
     "dbaeumer.vscode-eslint",           // Lints JavaScript/TypeScript.
     "pmneo.tsimporter",                 // Provides better auto-complete for TypeScripts imports.

2

@@ -1,31 +0,0 @@
-Show error on AV removal on desktop $264, $304
-
-This solves $264 where users do not get error messages when running
-script file fails due to antivirus intervention (it being blocking the
-script file as soon as privacy.sexy generates it to run it). Now if the
-desktop app users tries to save or run a script file and it afils due to
-antivirus removal, they'll get a special error message with guiding next
-steps.
-
-- Add additional check to able to fail if the file writing fails. This
-  includes trying to reading the written file back as suggested in $304.
-  This successfully detects antivirus (Defender) intervation as read
-  file operation triggers the antivirus scan that deletes the file.
-- Show directory and file path in error messages as suggested in $304.
-- Show an error message with more detailed information if an antivirus
-  is detected.
-
-# Please enter the commit message for your changes. Lines starting
-# with '#' will be ignored, and an empty message aborts the commit.
-#
-# Date:      Tue Jan 16 16:23:08 2024 +0100
-#
-# On branch master
-# Your branch is ahead of 'origin/master' by 1 commit.
-#   (use "git push" to publish your local commits)
-#
-# Changes to be committed:
-#	modified:   ../../application/CodeRunner/CodeRunner.ts
-#	new file:   NodeReliableFileWriter.ts
-#	new file:   ReliableFileWriter.ts
-#

CHANGELOG.md

@@ -1,5 +1,187 @@
 # Changelog
 
+## 0.13.6 (2024-08-13)
+
+* win: improve service disabling as TrustedInstaller | [5d365f6](https://github.com/undergroundwires/privacy.sexy/commit/5d365f65fa0e34925b16b2eac2af53c31e34e99a)
+* Fix documentation button spacing on small screens | [70959cc](https://github.com/undergroundwires/privacy.sexy/commit/70959ccadafac5abcfa83e90cdb0537890b05f14)
+* Fix close button overlap by scrollbar | [19ea8db](https://github.com/undergroundwires/privacy.sexy/commit/19ea8dbc5bc2dc436200cd40bf2a84c3fc3c6471)
+* win: refactor version-specific actions | [0239b52](https://github.com/undergroundwires/privacy.sexy/commit/0239b523859d5c2b80033cc03f0248a9af35f28f)
+* win: support Microsoft Store Firefox installations | [8d7a7eb](https://github.com/undergroundwires/privacy.sexy/commit/8d7a7eb434b2d83e32fa758db7e6798849bad41c)
+* Refactor text utilities and expand their usage | [851917e](https://github.com/undergroundwires/privacy.sexy/commit/851917e049c41c679644ddbe8ad4b6e45e5c8f35)
+* Bump dependencies to latest | [dd7239b](https://github.com/undergroundwires/privacy.sexy/commit/dd7239b8c14027274926279a4c8c7e5845b55558)
+* Refactor styles to match new CSS nesting behavior | [abe03ce](https://github.com/undergroundwires/privacy.sexy/commit/abe03cef3f691f6e56faee991cd2da9c45244279)
+* Improve compiler error display for latest Chromium | [b16e136](https://github.com/undergroundwires/privacy.sexy/commit/b16e13678ce1b8a6871eba8196e82bb321410067)
+* Fix intermittent `ModalDialog` unit test failures | [a650558](https://github.com/undergroundwires/privacy.sexy/commit/a6505587bf4a448f5f3de930004a95ee203416b8)
+* Ensure tests do not log warning or errors | [ae0165f](https://github.com/undergroundwires/privacy.sexy/commit/ae0165f1fe7dba9dd8ddaa1afa722a939772d3b6)
+* win: improve disabling SmartScreen #385 | [11e566d](https://github.com/undergroundwires/privacy.sexy/commit/11e566d0e5177214a2600f3fd2097aea62373b24)
+* win: unify registry setting as TrustedInstaller | [8526d25](https://github.com/undergroundwires/privacy.sexy/commit/8526d2510b34cbd7e79342f79d444419f601b186)
+* win: improve, fix, restructure CEIP disabling | [c2d3cdd](https://github.com/undergroundwires/privacy.sexy/commit/c2d3cddc47d8d4b34bff63d959612919fa971012)
+* win: centralize, improve Defender data collection | [b185255](https://github.com/undergroundwires/privacy.sexy/commit/b185255a0a72d5bfa96d6cf60f868ecc67149d68)
+* win: fix and document VStudio license removal | [109fc01](https://github.com/undergroundwires/privacy.sexy/commit/109fc01c9a047002c4309e7f8a2ca4647c494a8a)
+* win: improve registry/recent cleaning | [48d97af](https://github.com/undergroundwires/privacy.sexy/commit/48d97afdf6c2964cab7951208e1b0a02c3fd4c9b)
+* Relax linting to allow null recommendation | [6fbc816](https://github.com/undergroundwires/privacy.sexy/commit/6fbc81675f7f063c4ee2502b8d9f169aacb39ae4)
+* Refactor executable IDs to use strings #262 | [ded55a6](https://github.com/undergroundwires/privacy.sexy/commit/ded55a66d6044a03d4e18330e146b69d159509a3)
+* win: fix, improve and unify Windows version logic | [f89c232](https://github.com/undergroundwires/privacy.sexy/commit/f89c2322b05d19b82914b20416ecefd7bc7e3702)
+* Fix PowerShell code block inlining in compiler | [d77c3cb](https://github.com/undergroundwires/privacy.sexy/commit/d77c3cbbe212d9929e083181cc331b45d01e2883)
+* win: improve registry value deletion #381 | [55c23e9](https://github.com/undergroundwires/privacy.sexy/commit/55c23e9d4cee3b7f74c26a4ac8516535048d67f2)
+* win: improve folder hiding in "This PC" #16 | [e8add5e](https://github.com/undergroundwires/privacy.sexy/commit/e8add5ec08d2e8b7636cc9c8f0f9a33e4b004265)
+* win: improve Microsoft Edge associations removal | [c2f4b68](https://github.com/undergroundwires/privacy.sexy/commit/c2f4b6878635e97f9c4be7bf2ee194a2deebb38a)
+* win: unify registry data setting, fix #380 | [4cea6b2](https://github.com/undergroundwires/privacy.sexy/commit/4cea6b26ec2717c792c2471cc587f370274f90c4)
+* win: improve disabling NCSI #189, #216, #279 | [c7e57b8](https://github.com/undergroundwires/privacy.sexy/commit/c7e57b8913f409a1c149ba598dc2f8786df0f9a9)
+* win, mac: fix minor typos, formatting, dead URLs | [29e1069](https://github.com/undergroundwires/privacy.sexy/commit/29e1069bf2bc317e3c255b38c1ba0ab078b42d98)
+* win: fix, constrain and document WNS #227 #314 | [50ba00b](https://github.com/undergroundwires/privacy.sexy/commit/50ba00b0af6232fc9187532635b04c4d9d9a68af)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.5...0.13.6)
+
+## 0.13.5 (2024-06-26)
+
+* ci/cd: centralize and bump artifact uploads | [22d6c79](https://github.com/undergroundwires/privacy.sexy/commit/22d6c7991eb2c138578a7d41950f301906dbf703)
+* win: document and improve Firefox telemetry #259 | [8341411](https://github.com/undergroundwires/privacy.sexy/commit/8341411be434c6d145e942b1792020ccf02f58c8)
+* Add image to `README.md` to thank supporters | [fa2a92b](https://github.com/undergroundwires/privacy.sexy/commit/fa2a92bf893933bf5cd04512a712b7aa1b921277)
+* win: improve executable blocking, Chrome reporting | [f21ef92](https://github.com/undergroundwires/privacy.sexy/commit/f21ef9250a2f459dbd4f789d857c78298fc202e6)
+* mac: discourage and document captive portal script | [b29cd7b](https://github.com/undergroundwires/privacy.sexy/commit/b29cd7b5f74accf92c9700c3171670f82c8cb3b3)
+* win: fix revert scripts for removing shortcuts | [8becc7d](https://github.com/undergroundwires/privacy.sexy/commit/8becc7dbc46af4441900e9841a716a53735bc82e)
+* Refactor to unify scripts/categories as Executable | [c138f74](https://github.com/undergroundwires/privacy.sexy/commit/c138f74460bafaba3da55a65f3942bb6f95b1d99)
+* Add object property validation in parser #369 | [6ecfa9b](https://github.com/undergroundwires/privacy.sexy/commit/6ecfa9b954edc10401acaf5c735eec0fc9f991cd)
+* win: fix missing app access recommendations #369 | [1c2d82d](https://github.com/undergroundwires/privacy.sexy/commit/1c2d82dc9bd412ea601ab2550ba0b4f7d144f8e8)
+* win: fix text and handwriting script omission #369 | [1a10cf2](https://github.com/undergroundwires/privacy.sexy/commit/1a10cf2e5f87cd8eb421ef77f6ce764b5482515e)
+* mac: document, improve, encourage clearing logs | [e9a5285](https://github.com/undergroundwires/privacy.sexy/commit/e9a52859f63609c3f56def0b3e4d1ac6e5661536)
+* Add schema validation for collection files #369 | [dc03bff](https://github.com/undergroundwires/privacy.sexy/commit/dc03bff324d673101002bb16f14e0429e8170fbb)
+* win: fix incomplete VSCEIP, location scripts | [48761f6](https://github.com/undergroundwires/privacy.sexy/commit/48761f62a242f0910307994271cbe6730fb30f7e)
+* Add type validation for parameters and fix types | [fac26a6](https://github.com/undergroundwires/privacy.sexy/commit/fac26a6ca07479c84fe62c5ea2a572dad1898ef8)
+* Bump Electron to latest | [ed93614](https://github.com/undergroundwires/privacy.sexy/commit/ed93614ca34b1ab166e645cc5bedd497b0caeaac)
+* Trim compiler error output for better readability | [78c62cf](https://github.com/undergroundwires/privacy.sexy/commit/78c62cfc953dbba543d8bdc42828a4ef4b13a7c7)
+* win: fix errors due to missing Edge uninstaller | [2f82873](https://github.com/undergroundwires/privacy.sexy/commit/2f828735a87f98ba87b4fc826823d1482d4f2db2)
+* win: fix latest Edge removal on Windows 10 #309 | [e7031a3](https://github.com/undergroundwires/privacy.sexy/commit/e7031a3ae4e57b6522c6ca67fc30e8a8718506b2)
+* win: categorize, rename, doc Chrome & Edge scripts | [f286f92](https://github.com/undergroundwires/privacy.sexy/commit/f286f92b1fec49e89eea8982dffbc3d6ef1defde)
+* win: add disabling Edge/WebView2 auto-updates #309 | [ed7e69c](https://github.com/undergroundwires/privacy.sexy/commit/ed7e69c07efe83fdb7f4af13aa220ff991fbbe59)
+* win, linux, mac: fix typos #373 | [c09c5ff](https://github.com/undergroundwires/privacy.sexy/commit/c09c5ffa47865f7c76910644558b6783ed44f1e4)
+* win: add more Edge scripts including AI & ads | [1430d52](https://github.com/undergroundwires/privacy.sexy/commit/1430d5215ab094d8201710761d631dc2bd740918)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.4...0.13.5)
+
+## 0.13.4 (2024-05-27)
+
+* Add specific empty function name compiler error | [870120b](https://github.com/undergroundwires/privacy.sexy/commit/870120bc13909a3681e0f0a2351806849476342f)
+* ci/cd: fix recent Docker build failures on macOS | [a1922c5](https://github.com/undergroundwires/privacy.sexy/commit/a1922c50c12b3b7806e9e681ace842194a178bda)
+* win: standardize registry edit + delete on revert | [cec0b4b](https://github.com/undergroundwires/privacy.sexy/commit/cec0b4b4f63c3563a0e7923ce6324a38d71a3955)
+* Fix e2e test failing on Windows | [4a7efa2](https://github.com/undergroundwires/privacy.sexy/commit/4a7efa27c8df73ef9b7960afed29f216b066cba2)
+* Add support for macOS universal binary #348, #362 | [d25c4e8](https://github.com/undergroundwires/privacy.sexy/commit/d25c4e8c812b8d012010ba38070a2931dcd28908)
+* Migrate to GitHub issue forms | [9ab3ff7](https://github.com/undergroundwires/privacy.sexy/commit/9ab3ff75b0a69ac2ba27dd02e82db9b5bd76ea0f)
+* ci/cd: fix quality checks not running on all OSes | [2390530](https://github.com/undergroundwires/privacy.sexy/commit/2390530d929fb92c266558c52376569a0ecb90c1)
+* Bump Vue to latest and fix universal selector CSS | [aae5434](https://github.com/undergroundwires/privacy.sexy/commit/aae54344511ec51d17ad0420a92cb5a064e0e7bb)
+* Centralize and optimize `ResizeObserver` usage | [2923621](https://github.com/undergroundwires/privacy.sexy/commit/292362135db0519ec1050bab80ed373aad115731)
+* win: improve app access disabling and docs #138 | [ff3d5c4](https://github.com/undergroundwires/privacy.sexy/commit/ff3d5c48419f663379f5aba8936636c22f2c5de8)
+* win: document and discourage RSA key script #363 | [f347fde](https://github.com/undergroundwires/privacy.sexy/commit/f347fde0c85f8b51b0060fdea0a2724b042aaeed)
+* win: improve printing removal /w Print Queue #279 | [150e067](https://github.com/undergroundwires/privacy.sexy/commit/150e0670392bb62348c20ec644a4ed8a6bbffe74)
+* win: discourage blocking app access #121 #339 #350 | [7794846](https://github.com/undergroundwires/privacy.sexy/commit/77948461856e6837ddfbcbbef72a1bf9fc706b4e)
+* Improve context for errors thrown by compiler | [4212c7b](https://github.com/undergroundwires/privacy.sexy/commit/4212c7b9e0b1500378a1e4e88efc2d59f39f3d29)
+* win: document disabling firewall #115 #152 #364 | [12b1f18](https://github.com/undergroundwires/privacy.sexy/commit/12b1f183f7ce966d6ce090d98aeea7ec491f8c7c)
+* win: add script to disable Recall feature | [ce4cfdd](https://github.com/undergroundwires/privacy.sexy/commit/ce4cfdd169b7da0edc3da61143c988ed5f3c976e)
+* win, mac, linux: fix typos and dead URLs #367 | [9e34e64](https://github.com/undergroundwires/privacy.sexy/commit/9e34e644493674ca709b64a47206763d5d4bd60c)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.3...0.13.4)
+
+## 0.13.3 (2024-05-11)
+
+* win: organize and document network disablement | [2eed6f4](https://github.com/undergroundwires/privacy.sexy/commit/2eed6f4afb6cf85fdc1d6acb808f82405a35cafd)
+* win: improve disabling SMBv1 protocol | [f584fab](https://github.com/undergroundwires/privacy.sexy/commit/f584fabb50c7de70ba43751d721af94d8fa2fa8a)
+* win: improve disabling insecure renegotiations | [f261ab4](https://github.com/undergroundwires/privacy.sexy/commit/f261ab4cd9a53e31325e5c6da9129542971fe84b)
+* win: doc, improve, encourage cipher disabling | [8b224ee](https://github.com/undergroundwires/privacy.sexy/commit/8b224eefe71be6a556a1085d8fe20dbd4b889430)
+* ci/cd: add check for TODO comments | [4e21f05](https://github.com/undergroundwires/privacy.sexy/commit/4e21f05031d6cc90cda684bd598bec4735f8103b)
+* win: improve 'Snipping Tool' removal #343 | [e18907c](https://github.com/undergroundwires/privacy.sexy/commit/e18907ca91e483255b44d14d7d923d7eef92afbd)
+* ci/cd: lint Python scripts using `pylint` | [23bac0f](https://github.com/undergroundwires/privacy.sexy/commit/23bac0fc76ad697abb34f3fb327df5cdeb40286a)
+* win: improve disabling insecure hashes #131 | [d19dde6](https://github.com/undergroundwires/privacy.sexy/commit/d19dde603ddac47022ee2e0ea865d53857560c26)
+* Add system requirements documentation #134 | [0fc2ffc](https://github.com/undergroundwires/privacy.sexy/commit/0fc2ffc1ea36a9248c6a92da85a29f7b04b33796)
+* win, linux, mac: fix various typos #349 | [694bf1a](https://github.com/undergroundwires/privacy.sexy/commit/694bf1a74d935531d7cd46891823af1fa58c3c8c)
+* Fix script cancellation with new dialog on Linux | [8c17396](https://github.com/undergroundwires/privacy.sexy/commit/8c173962857a39dc0c9e5886cb2af4937e6618e7)
+* win: improve disabling protocols | [4ef16ce](https://github.com/undergroundwires/privacy.sexy/commit/4ef16cea56789120cd041412d86b5577cccf0725)
+* win: fix Copilot by excluding `r.bing.com` #329 | [66a5688](https://github.com/undergroundwires/privacy.sexy/commit/66a56888a4b3ead1a6bfef0feffa0218535701fe)
+* Fix blank window on load on desktop version #348 | [813d820](https://github.com/undergroundwires/privacy.sexy/commit/813d820b85e1b623c50f8e0325ad372bf2f344f9)
+* Improve desktop icon quality and generation | [ab25e0a](https://github.com/undergroundwires/privacy.sexy/commit/ab25e0a066be14ea979dafd0f80e1091bd5d33f8)
+* win: improve enabling secure connections #175 | [c75df1c](https://github.com/undergroundwires/privacy.sexy/commit/c75df1c8c1151b64cbf014383dea0b748a8c78b3)
+* Fix VSCode script issues with added CI/CD tests | [1d7cafc](https://github.com/undergroundwires/privacy.sexy/commit/1d7cafc831dcc339a10646794410dad7096bfe60)
+* Fix win execution with whitespace in username #351 | [a334320](https://github.com/undergroundwires/privacy.sexy/commit/a3343205b1196d5a81fd3cee2ae661ce871a7bef)
+* Fix misaligned tooltip positions in modal dialogs | [dd71536](https://github.com/undergroundwires/privacy.sexy/commit/dd71536316ec819caeb418b8635d544ac80e58ad)
+* Fix Chromium scrollbar-induced layout shifts | [bc4879c](https://github.com/undergroundwires/privacy.sexy/commit/bc4879cfe97becac3c54f6b40780a89464d3b772)
+* ci/cd: remove `check-latest` from `setup-node` | [52a4730](https://github.com/undergroundwires/privacy.sexy/commit/52a4730073b8ebfb2ce9d530b44e4a179f5849fe)
+* win: categorize and rename network security #131 | [9fd193e](https://github.com/undergroundwires/privacy.sexy/commit/9fd193e676f1f0646898f5130fbfaaf25050b2e3)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.2...0.13.3)
+
+## 0.13.2 (2024-04-15)
+
+* Update documentation for `logo-update.js` script | [4a9b430](https://github.com/undergroundwires/privacy.sexy/commit/4a9b430702bc6082426b50ecc3a06362b5720796)
+* win: improve and document removing Phone apps #279 | [8924337](https://github.com/undergroundwires/privacy.sexy/commit/89243371faa5d6aef5fce52b0d54a442143cdd39)
+* Fix bottom gap in card expansion panel | [79183d6](https://github.com/undergroundwires/privacy.sexy/commit/79183d64173e588d88bf074d5b50a52a71c2d885)
+* ci/cd: Fix macOS Docker build reliability issues | [8a5592f](https://github.com/undergroundwires/privacy.sexy/commit/8a5592f92be4366a806afc9eee9135696a1dd993)
+* ci/cd: fix IPv6 timeouts with `force-ipv4` action | [52fadcd](https://github.com/undergroundwires/privacy.sexy/commit/52fadcd6177ed06216be9c67dad57192ae02a4f9)
+* ci/cd: bump Node.js environment to 20.x | [59decd1](https://github.com/undergroundwires/privacy.sexy/commit/59decd17e273bada1493eaa855c43cbabf90308f)
+* ci/cd: trigger URL checks more, and limit amount | [4fb6302](https://github.com/undergroundwires/privacy.sexy/commit/4fb6302c67f2a3fedff419e8c22872593cf800ef)
+* Fix overflow in tree node content on small screens | [557cea3](https://github.com/undergroundwires/privacy.sexy/commit/557cea3f4866dc33236874f5fe4d2d69ee963dae)
+* Fix horizontal layout shift after script selection | [bc7e1fa](https://github.com/undergroundwires/privacy.sexy/commit/bc7e1faa1c3f2b61bf2046fdd6d6a4141b484662)
+* Fix card header expansion glitch on card collapse | [5d940b5](https://github.com/undergroundwires/privacy.sexy/commit/5d940b57ef2a4c219932cd15201401f8550cfb41)
+* Ignore `ResizeObserver` errors in Cypress tests | [4472c28](https://github.com/undergroundwires/privacy.sexy/commit/4472c2852e4b87083bda7979471ab9f377d17a01)
+* win: improve and document secret key scripts | [49f22f0](https://github.com/undergroundwires/privacy.sexy/commit/49f22f048f39e7388633c488b5fe59101b831984)
+* Fix card arrow not being animated in sync | [7b546c5](https://github.com/undergroundwires/privacy.sexy/commit/7b546c567c4683a37fe94595362f4c2bf92ffd59)
+* win: improve Windows feature disablement scripts | [b68711e](https://github.com/undergroundwires/privacy.sexy/commit/b68711ef88982c0ee2b1d41b4452e899821adc64)
+* Fix top script menu overflow on small screens | [b7a20d9](https://github.com/undergroundwires/privacy.sexy/commit/b7a20d9d41ea8bcefdd553b87641f3c22b4cde97)
+* win: fix Visual Studio remote analysis script #327 | [4142d08](https://github.com/undergroundwires/privacy.sexy/commit/4142d084f64a3b540487ff68b28032977d12006d)
+* win: improve firewall docs /w `winget` impact #142 | [ffd647d](https://github.com/undergroundwires/privacy.sexy/commit/ffd647d1529375474b81900cc7bee4c32fbf861f)
+* Centralize and use global spacing variables | [ae17200](https://github.com/undergroundwires/privacy.sexy/commit/ae172000a64416e5a3e2b2e32b7846f039f445f0)
+* win: improve service revert and docs | [b87b7aa](https://github.com/undergroundwires/privacy.sexy/commit/b87b7aac7d118a23a0d1bfb881e385347de4adb7)
+* Bump dependencies to latest, hold ESLint | [f3571ab](https://github.com/undergroundwires/privacy.sexy/commit/f3571abeafdbe1e6d152958fab26de91a9c08bc3)
+* Fix inability to tap outside modal on mobile | [cb144ae](https://github.com/undergroundwires/privacy.sexy/commit/cb144ae47273deeb7058d4b1380e480ebccdaf81)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.1...0.13.2)
+
+## 0.13.1 (2024-03-22)
+
+* ci/cd: Fix cross-platform git command compability | [255c51c](https://github.com/undergroundwires/privacy.sexy/commit/255c51c8a0524d3ea8a3b16ffc1b178650525010)
+* Fix tooltip falling behind elements on fade out | [1964524](https://github.com/undergroundwires/privacy.sexy/commit/19645248ab7bc78dc872fa176c1a3650d7d6d644)
+* Improve VSCode detection in `configure_vscode.py` | [98845e6](https://github.com/undergroundwires/privacy.sexy/commit/98845e6caee168db131aaf0736533e450827a52c)
+* Bump TypeScript to 5.3 with `verbatimModuleSyntax` | [a721e82](https://github.com/undergroundwires/privacy.sexy/commit/a721e82a4fb603c0732ccfdffc87396c2a01363e)
+* Migrate to Vite 5 and adjust configurations | [4ac1425](https://github.com/undergroundwires/privacy.sexy/commit/4ac1425f76079352268c488f3ff607d1fdc1beb2)
+* win: improve and unify service start/stop logic | [adc2089](https://github.com/undergroundwires/privacy.sexy/commit/adc20898873d50a8873ffc74c48257e69a45d367)
+* Upgrade vitest to v1 and fix test definitions | [e721885](https://github.com/undergroundwires/privacy.sexy/commit/e7218850ba62a7bebaf4768b13e46cba0dedd906)
+* Improve URL checks to reduce false-negatives | [5abf8ff](https://github.com/undergroundwires/privacy.sexy/commit/5abf8ff216a1da737fd489864eeee880f78d6601)
+* win: improve OneDrive data deletion safety | [5eff3a0](https://github.com/undergroundwires/privacy.sexy/commit/5eff3a04886d0d23a6e4c13a0178bb247105c5cb)
+* Bump Electron to latest and use native ESM | [840adf9](https://github.com/undergroundwires/privacy.sexy/commit/840adf9429ed47f9e88c05e90f1d3ab930c2dfc4)
+* Fix tooltip styling inconsistency | [ec34ac1](https://github.com/undergroundwires/privacy.sexy/commit/ec34ac1124e8b8ae53bf31a4dbdc88bb078b3d4e)
+* win: fix VSCode manual update switch script #312 | [b71ad79](https://github.com/undergroundwires/privacy.sexy/commit/b71ad797a3af0db45143249903cb5e178692de7c)
+* mac, linux, win: fix dead URLs and improve docs | [abec9de](https://github.com/undergroundwires/privacy.sexy/commit/abec9def075d82fdaee9663ef8fe1a488911f45b)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.13.0...0.13.1)
+
+## 0.13.0 (2024-02-11)
+
+* win: add disabling clipboard features #251, #247 | [c6ebba8](https://github.com/undergroundwires/privacy.sexy/commit/c6ebba85fb1b362be0d81d3078f19db71e0528b2)
+* win: improve search privacy scripts #117 | [541f9aa](https://github.com/undergroundwires/privacy.sexy/commit/541f9aa5ee1b5f4885063b65beaf6cd873f0d786)
+* win: add disabling Windows Copilot #263, #266 | [cd42550](https://github.com/undergroundwires/privacy.sexy/commit/cd425502ae882bba9642dc2171c2b5771946b5a9)
+* win: add Dropbox telemetry blocking #125, #118 | [10829d6](https://github.com/undergroundwires/privacy.sexy/commit/10829d65aa3fb0df937bb8829244e6290bb748c7)
+* Improve selection type documentation | [7af8daa](https://github.com/undergroundwires/privacy.sexy/commit/7af8daa3411b24efb6385c7876a49bd372753f38)
+* Expand script names to take full available width | [d277139](https://github.com/undergroundwires/privacy.sexy/commit/d277139dd50eeb4e4057b0a7d8fc4ac2d70785de)
+* Limit tooltip width for improved readability | [6ab6dac](https://github.com/undergroundwires/privacy.sexy/commit/6ab6dacd1be2d7bf1863b07b121d86f2a379ac67)
+* Add markdown support for script/category names | [a5ffed4](https://github.com/undergroundwires/privacy.sexy/commit/a5ffed4cd60d9d058d5374145c1176b10fad1660)
+* Normalize and improve font sizes | [4da306b](https://github.com/undergroundwires/privacy.sexy/commit/4da306b9f79b0bb7a64bb197fb246258cf435b8d)
+* Change 'revert' button to title case | [937f459](https://github.com/undergroundwires/privacy.sexy/commit/937f4593d1a91081ab6b1bcb8f85d03879d7cf07)
+* Remove playful emojis (🍑🍆) | [aa4205f](https://github.com/undergroundwires/privacy.sexy/commit/aa4205ff7af7d05cfb5e82bf541b521d49bbd1c8)
+* Improve UI code styling for all platforms | [311fcb1](https://github.com/undergroundwires/privacy.sexy/commit/311fcb18133d1343f6a9ae5bd7a25795a1d12c49)
+* Render bracket references as superscript text | [b9c89b7](https://github.com/undergroundwires/privacy.sexy/commit/b9c89b701fc77d20dcc706419a8659ad156c4fc2)
+* Change slogan and refactor project info naming | [a54e164](https://github.com/undergroundwires/privacy.sexy/commit/a54e16488ce32219bcf811b5da85f06584b293fb)
+* Add 'Revert All Selection' feature #68 | [55fa7ea](https://github.com/undergroundwires/privacy.sexy/commit/55fa7eae71031357d6f03f0d349a09cd446270d3)
+* win, mac, linux: add privacy.sexy cleanup scripts | [63366a4](https://github.com/undergroundwires/privacy.sexy/commit/63366a4ec2533a376849d692211e9972b56ab4a8)
+* Extend search by including documentation content | [6142f3a](https://github.com/undergroundwires/privacy.sexy/commit/6142f3a2973d20493f784f323f3be57fa8deaeef)
+* Remove 'preview' label from Linux options | [ebd8285](https://github.com/undergroundwires/privacy.sexy/commit/ebd82853ddc56f1cc2fc9be3fe0b3001b07f0186)
+* Change fonts for improved readability | [d5bbc32](https://github.com/undergroundwires/privacy.sexy/commit/d5bbc321f902dc60618ffdfda0d583a4a433f7af)
+* Apply global styles for visual consistency | [faa7a38](https://github.com/undergroundwires/privacy.sexy/commit/faa7a38a7d16390f27e4a3e51017b81665cf85ca)
+* Add UI animations for expand/collapse actions | [fb08f03](https://github.com/undergroundwires/privacy.sexy/commit/fb08f037651e1a7d453b9a6af724cbccecc5b903)
+* win: relocate service disabling and improve docs | [894687c](https://github.com/undergroundwires/privacy.sexy/commit/894687c0e0375a24f40bcd720ea69c9b2aa62a58)
+* win: add host blocking category #26 | [17152c8](https://github.com/undergroundwires/privacy.sexy/commit/17152c84dc639e75560998a6feddfd46e0f713ce)
+* Update meta title and description | [c7fa4b6](https://github.com/undergroundwires/privacy.sexy/commit/c7fa4b6d020ac6fd3bf72bb4e57022dffb1ba921)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.10...0.13.0)
+
 ## 0.12.10 (2024-01-17)
 
 * Fix CSP for Vue, Ace, Vite, Safari compatibility | [940febc](https://github.com/undergroundwires/privacy.sexy/commit/940febc3e80cfd0c01b5cc8282ebaab6b024d1b5)

README.md

@@ -1,6 +1,6 @@
-# privacy.sexy — Now you have the choice
+# privacy.sexy — Privacy is sexy
 
-> Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆
+> Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy.
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
@@ -60,8 +60,8 @@
   <br />
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
     <img
-      alt="Quality checks status"
+      alt="Status of quality checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.quality/badge.svg"
     />
   </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
@@ -122,9 +122,12 @@
 ## Get started
 
 - 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
-- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.10/privacy.sexy-Setup-0.12.10.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.10/privacy.sexy-0.12.10.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.10/privacy.sexy-0.12.10.AppImage). For more options, see [here](#additional-install-options).
+- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.6/privacy.sexy-Setup-0.13.6.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.6/privacy.sexy-0.13.6.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.13.6/privacy.sexy-0.13.6.AppImage). For more options, see [here](#additional-install-options).
 
-For a detailed comparison of features between the desktop and web versions of privacy.sexy, see [Desktop vs. Web Features](./docs/desktop-vs-web-features.md).
+See also:
+
+- [Desktop vs. Web Features](./docs/desktop/desktop-vs-web-features.md): Differences and unique aspects of desktop and web versions.
+- [System Requirements](./docs/desktop/system-requirements.md): Hardware and software requirements for the desktop version.
 
 💡 Regularly applying your configuration with privacy.sexy is recommended, especially after each new release and major operating system updates. Each version updates scripts to enhance stability, privacy, and security.
 
@@ -183,3 +186,7 @@ Check [architecture.md](./docs/architecture.md) for an overview of design and ho
 Security is a top priority at privacy.sexy.
 An extensive commitment to security verification ensures this priority.
 For any security concerns or vulnerabilities, please consult the [Security Policy](./SECURITY.md).
+
+## Supporters
+
+[![Supporters appreciation banner showing the supporters](https://undergroundwires.dev/img/supporters.jpg)](https://undergroundwires.dev/supporters)

SECURITY.md

@@ -37,14 +37,23 @@ privacy.sexy adopts a defense in depth strategy to protect users on multiple lay
 - **Auditing and Transparency:**
   The desktop application improves security and transparency by logging application activities and retaining files of executed scripts
   This facilitates detailed auditability and effective troubleshooting, contributing to the integrity and reliability of the application.
+  Recognizing that some users prefer not to keep these records, privacy.sexy provides specialized scripts for deletion of these logs.
 - **Privilege Management:**
   The desktop application operates without persistent administrative or `sudo` privileges, reinforcing its security posture. It requests
   elevation of privileges for system modifications with explicit user consent and logs every action taken with high privileges. This
   approach actively minimizes potential security risks by limiting privileged operations and aligning with the principle of least privilege.
 - **Secure Script Execution/Storage:**
-  Before executing any script, the desktop application stores a copy to allow antivirus software to perform scans. This safeguards against
+  - **Antivirus scans:**
-  any unwanted modifications. Furthermore, the application incorporates integrity checks for tamper protection. If the script file differs from
+    Before executing any script, the desktop application stores a copy to allow antivirus software to perform scans.
-  the user's selected script, the application will not execute or save the script, ensuring the processing of authentic scripts.
+    This step allows confirming that the scripts are secure and safe to use.
+  - **Tamper protection:**
+    The application incorporates integrity checks for tamper protection.
+    If the script file differs from the user's selected script, the application will not execute or save the script, ensuring the processing
+    of authentic scripts.
+    This safeguards against any unwanted modifications.
+  - **Clean-up:**
+    Recognizing that some users prefer not to keep these records, privacy.sexy provides specialized scripts for deletion of these scripts.
+    This allows users to maintain their privacy by removing traces of their usage patterns or script preferences.
 
 ### Update Security and Integrity
 

build/README.md

@@ -1,5 +0,0 @@
-# build
-
-This folder contains files that are used by Electron to serve the desktop version.
-
-Icons are created from the main logo file and should not be changed manually, see [related documentation](./../img/README.md).

docs/application.md

@@ -41,5 +41,5 @@ Application layer compiles templating syntax during parsing to create the end sc
 
 The steps to extend the templating syntax:
 
-1. Add a new parser under [SyntaxParsers](./../src/application/Parser/Script/Compiler/Expressions/SyntaxParsers) where you can look at other parsers to understand more.
+1. Add a new parser under [SyntaxParsers](./../src/application/Parser/Executable/Script/Compiler/Expressions/SyntaxParsers) where you can look at other parsers to understand more.
-2. Register your in [CompositeExpressionParser](./../src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts).
+2. Register your in [CompositeExpressionParser](./../src/application/Parser/Executable/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts).

docs/collection-files.md

@@ -1,11 +1,11 @@
 # Collection files
 
 privacy.sexy is a data-driven application that reads YAML files.
-This document details the structure and syntax of the YAML files located in [`application/collections`](./../src/application/collections/), which form the backbone of the application's data model.
+This document details the structure and syntax of the YAML files located in [`application/collections`](./../src/application/collections/), which form the backbone of the application's data model. The YAML schema [`.schema.yaml`](./../src/application/collections/.schema.yaml) is provided to provide better IDE support and be used in automated validations.
 
 Related documentation:
 
-- 📖 [`collection.yaml.d.ts`](./../src/application/collections/collection.yaml.d.ts) outlines code types.
+- 📖 [`Collections README`](./../src/application/collections/README.md) includes references to code as documentation.
 - 📖 [Script Guidelines](./script-guidelines.md) provide guidance on script creation including best-practices.
 
 ## Objects
@@ -28,11 +28,22 @@ Related documentation:
 - `scripting:` ***[`ScriptingDefinition`](#scriptingdefinition)*** **(required)**
   - Sets the scripting language for all inline code used within the collection.
 
-### `Category`
+### Executables
+
+They represent independently executable actions with documentation and reversibility.
+
+An Executable is a logical entity that can
+
+- execute once compiled,
+- include a `docs` property for documentation.
+
+It's either [Category](#category) or a [Script](#script).
+
+#### `Category`
 
 Represents a logical group of scripts and subcategories.
 
-#### `Category` syntax
+##### `Category` syntax
 
 - `category:` *`string`*  **(required)**
   - Name of the category.
@@ -43,7 +54,7 @@ Represents a logical group of scripts and subcategories.
 - `docs`: *`string`* | `[`*`string`*`, ... ]`
   - Markdown-formatted documentation related to the category.
 
-### `Script`
+#### `Script`
 
 Represents an individual tweak.
 
@@ -58,7 +69,7 @@ Types (like [functions](#function)):
 
 📖 For detailed guidelines, see [Script Guidelines](./script-guidelines.md).
 
-#### `Script` syntax
+##### `Script` syntax
 
 - `name`: *`string`* **(required)**
   - Script name.

docs/desktop/desktop-vs-web-features.md

@@ -1,6 +1,6 @@
 # Desktop vs. Web Features
 
-This table highlights differences between the desktop and web versions of `privacy.sexy`.
+This table outlines the differences between the desktop and web versions of `privacy.sexy`.
 
 | Feature | Desktop | Web |
 | ------- | ------- | --- |
@@ -8,10 +8,8 @@ This table highlights differences between the desktop and web versions of `priva
 | [Offline usage](#offline-usage) | 🟢 Available | 🟡 Partially available |
 | [Auto-updates](#auto-updates) | 🟢 Available | 🟢 Available |
 | [Logging](#logging) | 🟢 Available | 🔴 Not available |
-| [Script execution](#script-execution) | 🟢 Available | 🔴 Not available |
-| [Error handling](#error-handling) | 🟢 Advanced | 🟡 Limited |
-| [Native dialogs](#native-dialogs) | 🟢 Available | 🔴 Not available |
 | [Secure script execution/storage](#secure-script-executionstorage) | 🟢 Available | 🔴 Not available |
+| [Native dialogs](#native-dialogs) | 🟢 Available | 🔴 Not available |
 
 ## Feature descriptions
 
@@ -30,14 +28,16 @@ Desktop version inherently allows offline usage.
 
 ### Auto-updates
 
-Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./ci-cd.md).
+Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./../ci-cd.md).
 
 The desktop version ensures secure delivery through cryptographic signatures and version checks.
 
-[Security is a top priority](./../SECURITY.md#update-security-and-integrity) at privacy.sexy.
+[Security is a top priority](./../../SECURITY.md#update-security-and-integrity) at privacy.sexy.
 
-> **Note for macOS users:** On macOS, the desktop version's auto-update process involves manual steps due to Apple's code signing costs.
+> **Note for macOS users:**
+> On macOS, the desktop version's auto-update process involves manual steps due to Apple's code signing costs.
 > Users get notified about updates but might need to complete the installation manually.
+> Updater stores update installation files temporarily at `$HOME/Library/Application Support/privacy.sexy/updates`.
 > Consider [donating](https://github.com/sponsors/undergroundwires) to help improve this process ❤️.
 
 ### Logging
@@ -51,7 +51,9 @@ Log file locations vary by operating system:
 - Linux: `$HOME/.config/privacy.sexy/logs`
 - Windows: `%APPDATA%\privacy.sexy\logs`
 
-### Script execution
+> 💡 privacy.sexy provides scripts to securely erase these logs.
+
+### Secure script execution/storage
 
 The desktop version of privacy.sexy enables direct script execution, providing a seamless and integrated experience.
 This direct execution capability isn't available in the web version due to inherent browser restrictions.
@@ -65,31 +67,29 @@ These locations vary based on the operating system:
 - Linux: `$HOME/.config/privacy.sexy/runs`
 - Windows: `%APPDATA%\privacy.sexy\runs`
 
-### Error handling
+> 💡 privacy.sexy provides scripts to securely erase your script execution history.
 
-The desktop version of privacy.sexy features advanced error handling capabilities.
+**Script antivirus scans:**
-It employs robust and reliable execution strategies, including self-healing mechanisms, and provides guidance and troubleshooting information to resolve issues effectively.
-In contrast, the web version has more basic error handling due to browser limitations and the nature of web applications.
 
-### Native dialogs
+To enhance system protection, the desktop version of privacy.sexy automatically verifies the security of script
+execution files by reading them back.
+This process triggers antivirus scans to verify that scripts are safe before the execution.
 
-The desktop version uses native dialogs, offering more features and reliability compared to the browser's file system dialogs.
+**Script integrity checks:**
-These native dialogs provide a more integrated and user-friendly experience, aligning with the operating system's standard interface and functionalities.
-
-### Secure script execution/storage
-
-**Integrity checks:**
 
 The desktop version of privacy.sexy implements robust integrity checks for both script execution and storage.
 Featuring tamper protection, the application actively verifies the integrity of script files before executing or saving them.
 If the actual contents of a script file do not align with the expected contents, the application refuses to execute or save the script.
 This proactive approach ensures only unaltered and verified scripts undergo processing, thereby enhancing both security and reliability.
-Due to browser constraints, this feature is absent in the web version.
 
 **Error handling:**
 
+The desktop version of privacy.sexy features advanced error handling capabilities.
 In scenarios where script execution or storage encounters failure, the desktop application initiates automated troubleshooting and self-healing processes.
-It also guides users through potential issues with filesystem or third-party software, such as antivirus interventions.
+It employs robust and reliable execution strategies, including self-healing mechanisms, and provides guidance and troubleshooting information to resolve issues effectively.
-Specifically, the application is capable of identifying when antivirus software blocks or removes a script, providing users with tailored error messages
+This proactive error handling and user guidance enhances the application's security and reliability.
-and detailed resolution steps. This level of proactive error handling and user guidance enhances the application's security and reliability,
+
-offering a feature not achievable in the web version due to browser limitations.
+### Native dialogs
+
+The desktop version uses native dialogs, offering more features and reliability compared to the browser's file system dialogs.
+These native dialogs provide a more integrated and user-friendly experience, aligning with the operating system's standard interface and functionalities.

docs/desktop/system-requirements.md

@@ -0,0 +1,36 @@
+# System Requirements for the Desktop Version
+
+The following system requirements are the official ones for the desktop version.
+While we have tested and confirmed these requirements, the application might also work on other
+systems or configurations that haven't undergone official testing.
+
+## Windows
+
+- **Version:** Windows 10 and later.
+- **Processor:** Intel Pentium 4 or later.
+- **Architecture:** 64-bit (x86-64), ARM (ARM64).
+
+> **⚠️ Compatibility Note:**
+> ARM version is only compatible with Windows 11 and later.
+> It runs non-natively, leading to slower performance due to emulation [1].
+
+## macOS
+
+- **Version:** macOS Catalina (10.15) and later.
+- **Architecture:** Intel-based (x86-64), Apple silicon (ARM64).
+
+## Linux
+
+- **Version:** Ubuntu 18.04 and later, Fedora 32 and later, and Debian 10 and later.
+- **Processor:** Intel Pentium 4 or later.
+- **Architecture:** 64-bit (x86-64).
+
+## References
+
+System requirements reflect Electron's platform capabilities [2] and Chromium's recommended configurations [3].
+
+For details on the build process, see [electron-builder configuration file](./../../electron-builder.cjs).
+
+[1]: https://web.archive.org/web/20240428082726/https://learn.microsoft.com/en-us/windows/arm/add-arm-support#emulation-on-arm-based-devices-for-x86-or-x64-windows-apps "Add support Arm devices to your Windows app | Microsoft Learn | learn.microsoft.com"
+[2]: https://archive.ph/2024.04.28-082958/https://github.com/electron/electron/blob/main/README.md#platform-support "Platform Support | electron/README.md at main · electron/electron · GitHub | github.com"
+[3]: https://web.archive.org/web/20240428082945/https://support.google.com/chrome/a/answer/7100626?hl=en "Chrome browser system requirements - Chrome Enterprise and Education Help | support.google.com"

docs/development.md

@@ -39,6 +39,7 @@ See [ci-cd.md](./ci-cd.md) for more information.
 - Markdown: `npm run lint:md`
 - Markdown consistency `npm run lint:md:consistency`
 - Markdown relative URLs: `npm run lint:md:relative-urls`
+- Markdown external URLs: `npm run lint:md:external-urls`
 - JavaScript/TypeScript: `npm run lint:eslint`
 - Yaml: `npm run lint:yaml`
 
@@ -80,8 +81,10 @@ See [ci-cd.md](./ci-cd.md) for more information.
 - [**`npm run install-deps [-- <options>]`**](../scripts/npm-install.js):
   - Manages NPM dependency installation, it offers capabilities like doing a fresh install, retries on network errors, and other features.
   - For example, you can run `npm run install-deps -- --fresh` to do clean installation of dependencies.
-- [**`python ./scripts/configure_vscode.py`**](../scripts/configure_vscode.py):
+- [**`python3 ./scripts/configure_vscode.py`**](../scripts/configure_vscode.py):
   - Optimizes Visual Studio Code settings and installs essential extensions, enhancing the development environment.
+- [**`python3 ./scripts/validate-collections-yaml`**](../scripts/validate-collections-yaml/README.md):
+  - Validates the syntax and structure of collection YAML files.
 
 #### Automation scripts
 

docs/presentation.md

@@ -14,25 +14,38 @@ The presentation layer uses an event-driven architecture for bidirectional react
   - [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
   - [**`index.html`**](./../src/presentation/index.html): The `index.html` entry file, located at the root of the project as required by Vite
   - [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
-  - [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
+  - [**`components/`**](./../src/presentation/components/): Contains Vue components, helpers and styles coupled to Vue components.
     - [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
       - [**`Hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
   - [**`/public/`**](../src/presentation/public/): Contains static assets.
   - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
     - [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
     - [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
-      - [**`components/`**](./../src/presentation/assets/styles/components): Contains styles coupled to Vue components.
       - [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint..
   - [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
-    - [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
+    - [`/main/` **`index.ts`**](./../src/presentation/electron/main/index.ts): Main entry for Electron, managing application windows and lifecycle events.
-    - [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
+    - [`/preload/` **`index.ts`**](./../src/presentation/electron/preload/index.ts): Script executed before the renderer, securing Node.js features for renderer use.
+    - [**`/shared/`**](./../src/presentation/electron/shared/): Shared logic between different Electron processes.
+    - [**`/build/`**](./../src/presentation/electron/build/): `electron-builder` build resources directory, [README.md](./../src/presentation/electron/build/README.md).
 - [**`/vite.config.ts`**](./../vite.config.ts): Contains Vite configurations for building web application.
 - [**`/electron.vite.config.ts`**](./../electron.vite.config.ts): Contains Vite configurations for building desktop applications.
 - [**`/postcss.config.cjs`**](./../postcss.config.cjs): Contains PostCSS configurations for Vite.
 
 ## Visual design best-practices
 
-Add visual clues for clickable items. It should be as clear as possible that they're interactable at first look without hovering. They should also have different visual state when hovering/touching on them that indicates that they are being clicked, which helps with accessibility.
+- **Clickables**:
+  Add visual clues for clickable items.
+  It should be as clear as possible that they're interactable at first look without hovering.
+  They should also have different visual state when hovering/touching on them that indicates that they are being clicked, which helps with accessibility.
+- **Borders**:
+  privacy.sexy prefers sharper edges in its design language.
+- **Fonts**:
+  - Use the primary font for regular text and monospace font for code or specific data.
+  - Use cursive and logo fonts solely for branding.
+  - Refer to [standardized font size variables](../src/presentation/assets/styles/_typography.scss) for font sizing, avoiding arbitrary `px`, `em`, `rem`, or percentage values.
+- **Spacing**:
+  Use [global spacing variables](../src/presentation/assets/styles/_spacing.scss) for consistent margin, padding, and gap definitions.
+  This provides uniform spatial distribution and alignment of elements, enhancing visual harmony and making the UI more scalable and maintainable.
 
 ## Application data
 

docs/script-guidelines.md

@@ -27,6 +27,7 @@ Key attributes of a good script:
   - `Minimize` over `Limit`, `Reduce`
   - `Maximize` over `Extend`, `Delay`, `Postpone`, `Prolong`
   - `Remove` over `Uninstall`
+  - `Improve` over `Increase`
 - Structure your phrases for clarity, examples:
   - Prefer `Disable XX telemetry` over `Disable telemetry in XX`
   - Prefer `Clear XX data` over `Clear data from XX`, or `Clear data of XX`.
@@ -35,8 +36,8 @@ Key attributes of a good script:
 ## Documentation
 
 - Use credible and reputable sources for references.
-- Use archived links by using [archive.org](https://archive.org) or [archive.today](https://archive.today).
+- Use archived links by using [archive.org](https://archive.org) or [archive.ph](https://archive.ph).
-  - Format archive.today links fully, for example: `https://archive.today/YYYYMMDDhhmmss/https://privacy.sexy`.
+  - Format archive.today links fully, for example: `https://archive.ph/YYYYMMDDhhmmss/https://privacy.sexy`.
 - Explain the default behavior if the script is not executed.
 
 ## Shared functions

electron-builder.cjs

@@ -1,8 +1,13 @@
 /* eslint-disable no-template-curly-in-string */
 
-const { join } = require('node:path');
+const { join, resolve } = require('node:path');
+const { readdirSync, existsSync } = require('node:fs');
 const { electronBundled, electronUnbundled } = require('./dist-dirs.json');
 
+/**
+* @type {import('electron-builder').Configuration}
+* @see https://www.electron.build/configuration/configuration
+*/
 module.exports = {
   // Common options
   publish: {
@@ -12,9 +17,12 @@ module.exports = {
   },
   directories: {
     output: electronBundled,
+    buildResources: resolvePathFromProjectRoot('src/presentation/electron/build'),
   },
   extraMetadata: {
-    main: join(electronUnbundled, 'main/index.cjs'), // do not `path.resolve`, it expects a relative path
+    main: findMainEntryFile(
+      join(electronUnbundled, 'main'), // do not `path.resolve`, it expects a relative path
+    ),
   },
 
   // Windows
@@ -35,9 +43,32 @@ module.exports = {
 
   // macOS
   mac: {
+    target: {
       target: 'dmg',
+      arch: 'universal',
+    },
   },
   dmg: {
     artifactName: '${name}-${version}.${ext}',
   },
 };
+
+/**
+ * Finds by accommodating different JS file extensions and module formats.
+ */
+function findMainEntryFile(parentDirectory) {
+  const absoluteParentDirectory = resolvePathFromProjectRoot(parentDirectory);
+  if (!existsSync(absoluteParentDirectory)) {
+    return null; // Avoid disrupting other processes such `npm install`.
+  }
+  const files = readdirSync(absoluteParentDirectory);
+  const entryFile = files.find((file) => /^index\.(cjs|mjs|js)$/.test(file));
+  if (!entryFile) {
+    throw new Error(`Main entry file not found in ${absoluteParentDirectory}.`);
+  }
+  return join(parentDirectory, entryFile);
+}
+
+function resolvePathFromProjectRoot(pathSegment) {
+  return resolve(__dirname, pathSegment);
+}

electron.vite.config.ts

@@ -1,5 +1,5 @@
 import { resolve } from 'node:path';
-import { mergeConfig, UserConfig } from 'vite';
+import { mergeConfig, type UserConfig } from 'vite';
 import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
 import { getAliases, getClientEnvironmentVariables } from './vite-config-helper';
 import { createVueConfig } from './vite.config';
@@ -14,7 +14,7 @@ const ELECTRON_DIST_SUBDIRECTORIES = {
   renderer: resolveElectronDistSubdirectory('renderer'),
 };
 
-process.env.ELECTRON_ENTRY = resolve(ELECTRON_DIST_SUBDIRECTORIES.main, 'index.cjs');
+process.env.ELECTRON_ENTRY = resolve(ELECTRON_DIST_SUBDIRECTORIES.main, 'index.mjs');
 
 export default defineConfig({
   main: getSharedElectronConfig({
@@ -54,13 +54,23 @@ function getSharedElectronConfig(options: {
       },
       rollupOptions: {
         output: {
-          // Mark: electron-esm-support
+          format: 'es',
-          //  This is needed so `type="module"` works
+
-          entryFileNames: '[name].cjs',
+          // Ensure all generated files use '.mjs' for module consistency.
+          // Otherwise, preloader process get `.mjs` extension but main process get `.js` extension, see https://github.com/alex8088/electron-vite/issues/397.
+          entryFileNames: '[name].mjs',
         },
       },
     },
-    plugins: [externalizeDepsPlugin()],
+    plugins: [externalizeDepsPlugin({
+      exclude: [
+        // Keep 'electron-log' in bundling process.
+        // This is a workaround for inability of Electron's ESM loader to resolve subpath imports.
+        // Do not externalize `electron-log` so subpath imports such as `electron-log/main` works.
+        // See https://github.com/electron/electron/issues/41241, https://github.com/alex8088/electron-vite/issues/401
+        'electron-log',
+      ],
+    })],
     define: {
       ...getClientEnvironmentVariables(),
     },

package.json

@@ -1,9 +1,9 @@
 {
   "name": "privacy.sexy",
-  "version": "0.12.10",
+  "version": "0.13.6",
   "private": true,
-  "slogan": "Now you have the choice",
+  "slogan": "Privacy is sexy",
-  "description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
+  "description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy.",
   "author": "undergroundwires",
   "type": "module",
   "scripts": {
@@ -14,7 +14,7 @@
     "test:integration": "vitest run --dir tests/integration",
     "test:cy:run": "start-server-and-test \"vite build && vite preview --port 7070\" http://localhost:7070 \"cypress run --config baseUrl=http://localhost:7070\"",
     "test:cy:open": "start-server-and-test \"vite --port 7070 --mode production\" http://localhost:7070 \"cypress open --config baseUrl=http://localhost:7070\"",
-    "lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:eslint && npm run lint:yaml",
+    "lint": "npm run lint:md && npm run lint:md:consistency && npm run lint:md:relative-urls && npm run lint:md:external-urls && npm run lint:eslint && npm run lint:yaml && npm run lint:pylint",
     "install-deps": "node scripts/npm-install.js",
     "icons:build": "node scripts/logo-update.js",
     "check:desktop": "vitest run --dir tests/checks/desktop-runtime-errors --environment node",
@@ -28,66 +28,70 @@
     "lint:md": "markdownlint **/*.md --ignore node_modules",
     "lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent",
     "lint:md:relative-urls": "remark . --frail --use remark-validate-links",
+    "lint:md:external-urls": "remark . --frail --use remark-lint-no-dead-urls",
     "lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
+    "lint:pylint": "pylint **/*.py",
     "postinstall": "electron-builder install-app-deps",
     "postuninstall": "electron-builder install-app-deps"
   },
   "dependencies": {
-    "@floating-ui/vue": "^1.0.2",
+    "@floating-ui/vue": "^1.1.1",
     "@juggle/resize-observer": "^3.4.0",
-    "ace-builds": "^1.30.0",
+    "ace-builds": "^1.35.3",
-    "electron-log": "^5.0.1",
+    "electron-log": "^5.1.6",
-    "electron-progressbar": "^2.1.0",
+    "electron-progressbar": "^2.2.1",
-    "electron-updater": "^6.1.4",
+    "electron-updater": "^6.2.1",
     "file-saver": "^2.0.5",
-    "markdown-it": "^13.0.2",
+    "markdown-it": "^14.1.0",
-    "vue": "^3.3.7"
+    "vue": "^3.4.32"
   },
   "devDependencies": {
-    "@modyfi/vite-plugin-yaml": "^1.0.4",
+    "@modyfi/vite-plugin-yaml": "^1.1.0",
-    "@rushstack/eslint-patch": "^1.6.1",
+    "@rushstack/eslint-patch": "^1.10.3",
-    "@types/ace": "^0.0.49",
+    "@types/ace": "^0.0.52",
-    "@types/file-saver": "^2.0.5",
+    "@types/file-saver": "^2.0.7",
-    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@types/markdown-it": "^14.1.1",
-    "@typescript-eslint/parser": "^6.17.0",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
-    "@vitejs/plugin-legacy": "^4.1.1",
+    "@typescript-eslint/parser": "6.21.0",
-    "@vitejs/plugin-vue": "^4.4.0",
+    "@vitejs/plugin-legacy": "^5.4.1",
+    "@vitejs/plugin-vue": "^5.0.5",
     "@vue/eslint-config-airbnb-with-typescript": "^8.0.0",
-    "@vue/eslint-config-typescript": "^12.0.0",
+    "@vue/eslint-config-typescript": "12.0.0",
-    "@vue/test-utils": "^2.4.1",
+    "@vue/test-utils": "^2.4.6",
-    "autoprefixer": "^10.4.16",
+    "autoprefixer": "^10.4.19",
-    "cypress": "^13.3.1",
+    "cypress": "^13.13.1",
-    "electron": "^27.0.0",
+    "electron": "^31.2.1",
-    "electron-builder": "^24.6.4",
+    "electron-builder": "^24.13.3",
     "electron-devtools-installer": "^3.2.0",
-    "electron-icon-builder": "^2.0.1",
+    "electron-vite": "^2.3.0",
-    "electron-vite": "^1.0.28",
+    "eslint": "8.57.0",
-    "eslint": "^8.56.0",
+    "eslint-plugin-cypress": "^3.3.0",
-    "eslint-plugin-cypress": "^2.15.1",
+    "eslint-plugin-vue": "^9.27.0",
-    "eslint-plugin-vue": "^9.19.2",
+    "eslint-plugin-vuejs-accessibility": "^2.4.0",
-    "eslint-plugin-vuejs-accessibility": "^2.2.0",
+    "jsdom": "^24.1.0",
-    "icon-gen": "^4.0.0",
+    "markdownlint-cli": "^0.41.0",
-    "jsdom": "^22.1.0",
+    "postcss": "^8.4.39",
-    "markdownlint-cli": "^0.37.0",
+    "remark-cli": "^12.0.1",
-    "postcss": "^8.4.31",
+    "remark-lint-no-dead-urls": "^2.0.0",
-    "remark-cli": "^12.0.0",
+    "remark-preset-lint-consistent": "^6.0.0",
-    "remark-lint-no-dead-urls": "^1.1.0",
+    "remark-validate-links": "^13.0.1",
-    "remark-preset-lint-consistent": "^5.1.2",
+    "sass": "~1.79.4",
-    "remark-validate-links": "^13.0.0",
+    "start-server-and-test": "^2.0.4",
-    "sass": "^1.69.3",
+    "terser": "^5.31.3",
-    "start-server-and-test": "^2.0.1",
+    "tslib": "^2.6.3",
-    "svgexport": "^0.4.2",
+    "typescript": "~5.5.4",
-    "terser": "^5.21.0",
+    "vite": "^5.4.8",
-    "tslib": "^2.6.2",
+    "vitest": "^2.0.3",
-    "typescript": "^5.2.2",
+    "vue-tsc": "^2.0.26",
-    "vite": "^4.4.11",
-    "vitest": "^0.34.6",
-    "vue-tsc": "^1.8.19",
     "yaml-lint": "^1.7.0"
   },
   "//devDependencies": {
     "terser": "Used by `@vitejs/plugin-legacy` for minification",
-    "@rushstack/eslint-patch": "Needed by `@vue/eslint-config-typescript` and `@vue/eslint-config-airbnb-with-typescript`"
+    "@rushstack/eslint-patch": "Needed by `@vue/eslint-config-typescript` and `@vue/eslint-config-airbnb-with-typescript`",
+    "@typescript-eslint/eslint-plugin": "Cannot migrate to v7 because of `@vue/eslint-config-airbnb-with-typescript`, see https://github.com/vuejs/eslint-config-airbnb/issues/63",
+    "@typescript-eslint/parser": "Cannot migrate to v7 because of `@vue/eslint-config-airbnb-with-typescript`, see https://github.com/vuejs/eslint-config-airbnb/issues/63",
+    "@vue/eslint-config-typescript": "Cannot migrate to v13 because of `@vue/eslint-config-airbnb-with-typescript`, see https://github.com/vuejs/eslint-config-airbnb/issues/63",
+    "eslint": "Cannot migrate to v9 `@typescript-eslint/eslint-plugin` (≤ v7), `@typescript-eslint/parser` (≤ v7), `@vue/eslint-config-airbnb-with-typescript@` (≤ v8) requires `eslint` ≤ v8, see https://github.com/vuejs/eslint-config-airbnb/issues/65, https://github.com/typescript-eslint/typescript-eslint/issues/8211"
   },
   "homepage": "https://privacy.sexy",
   "repository": {

scripts/configure_vscode.py

@@ -1,15 +1,20 @@
 """
+Description:
   This script configures project-level VSCode settings in '.vscode/settings.json' for
   development and installs recommended extensions from '.vscode/extensions.json'.
+
+Usage:
+  python3 ./scripts/configure_vscode.py
 """
 # pylint: disable=missing-function-docstring
 
 import os
 import json
+from pathlib import Path
 import subprocess
 import sys
 import re
-from typing import Any
+from typing import Any, Optional
 from shutil import which
 
 VSCODE_SETTINGS_JSON_FILE: str = '.vscode/settings.json'
@@ -39,7 +44,7 @@ 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(f"📄 Created empty {VSCODE_SETTINGS_JSON_FILE}")
+    print_success(f"Created empty {VSCODE_SETTINGS_JSON_FILE}")
 
 def add_or_update_settings() -> None:
     configure_setting_key('eslint.validate', ['vue', 'javascript', 'typescript'])
@@ -53,6 +58,10 @@ def add_or_update_settings() -> None:
     # Details: # pylint: disable-next=line-too-long
     #   - https://archive.ph/2024.01.06-003914/https://github.com/microsoft/vscode/issues/179274, https://web.archive.org/web/20240106003915/https://github.com/microsoft/vscode/issues/179274
 
+    # Disable telemetry
+    configure_setting_key('redhat.telemetry.enabled', False)
+    configure_setting_key('gitlens.telemetry.enabled', False)
+
 def configure_setting_key(configuration_key: str, desired_value: Any) -> None:
     try:
         with open(VSCODE_SETTINGS_JSON_FILE, 'r+', encoding='utf-8') as file:
@@ -84,7 +93,7 @@ def install_recommended_extensions() -> None:
         if not extensions:
             print_skip(f"No recommendations found in the {VSCODE_EXTENSIONS_JSON_FILE} file.")
             return
-        vscode_cli_path = which('code') # More reliable than using `code`, especially on Windows.
+        vscode_cli_path = locate_vscode_cli()
         if vscode_cli_path is None:
             print_error('Visual Studio Code CLI (`code`) tool not found.')
             return
@@ -92,6 +101,19 @@ def install_recommended_extensions() -> None:
     except json.JSONDecodeError:
         print_error(f"Invalid JSON in {VSCODE_EXTENSIONS_JSON_FILE}")
 
+def locate_vscode_cli() -> Optional[str]:
+    vscode_alias = which('code') # More reliable than using `code`, especially on Windows.
+    if vscode_alias:
+        return vscode_alias
+    potential_vscode_cli_paths = [
+        # VS Code on macOS may not register 'code' command in PATH
+        '/Applications/Visual Studio Code.app/Contents/Resources/app/bin/code'
+    ]
+    for vscode_cli_candidate_path in potential_vscode_cli_paths:
+        if Path(vscode_cli_candidate_path).is_file():
+            return vscode_cli_candidate_path
+    return None
+
 def remove_json_comments(json_like: str) -> str:
     pattern: str = r'(?:"(?:\\.|[^"\\])*"|/\*[\s\S]*?\*/|//.*)|([^:]//.*$)'
     return re.sub(
@@ -123,6 +145,12 @@ def install_vscode_extensions(vscode_cli_path: str, extensions: list[str]) -> No
                 f"Visual Studio Code CLI tool not found: {vscode_cli_path}."
                 f"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}",
+            ]))
     total_extensions = len(extensions)
     print_installation_results(successful_installations, total_extensions)
 
@@ -147,16 +175,16 @@ def print_installation_results(successful_installations: int, total_extensions:
         print_error("Failed to install any of the recommended extensions.")
 
 def print_error(message: str) -> None:
-    print(f"💀 Error: {message}", file=sys.stderr)
+    print(f"[ERROR] {message}", file=sys.stderr)
 
 def print_success(message: str) -> None:
-    print(f"✅ Success: {message}")
+    print(f"[SUCCESS] {message}")
 
 def print_skip(message: str) -> None:
-    print(f"⏩ Skipped: {message}")
+    print(f"[SKIPPED] {message}")
 
 def print_warning(message: str) -> None:
-    print(f"⚠️ Warning: {message}", file=sys.stderr)
+    print(f"[WARNING] {message}", file=sys.stderr)
 
 if __name__ == "__main__":
     main()

scripts/logo-update.js

@@ -1,84 +1,120 @@
-#!/usr/bin/env bash
+/**
-import { resolve, join } from 'node:path';
+ * Description:
-import { rm, mkdtemp, stat } from 'node:fs/promises';
+ *  This script updates the logo images across the project based on the primary
+ *  logo file ('img/logo.svg' file).
+ *
+ *  It handles the creation and update of various icon sizes for different purposes,
+ *  including desktop launcher icons, tray icons, and web favicons from a single source
+ *  SVG logo file.
+ *
+ * Usage:
+ *    node ./scripts/logo-update.js
+ *
+ * Notes:
+ *    ImageMagick must be installed and accessible in the system's PATH
+ */
+
+import { resolve, join, dirname } from 'node:path';
+import { stat } from 'node:fs/promises';
 import { spawn } from 'node:child_process';
 import { URL, fileURLToPath } from 'node:url';
+import electronBuilderConfig from '../electron-builder.cjs';
 
-class Paths {
+class ImageAssetPaths {
-  constructor(selfDirectory) {
+  constructor(currentScriptDirectory) {
-    const projectRoot = resolve(selfDirectory, '../');
+    const projectRoot = resolve(currentScriptDirectory, '../');
     this.sourceImage = join(projectRoot, 'img/logo.svg');
     this.publicDirectory = join(projectRoot, 'src/presentation/public');
-    this.electronBuildDirectory = join(projectRoot, 'build');
+    this.electronBuildResourcesDirectory = electronBuilderConfig.directories.buildResources;
+  }
+
+  get electronTrayIconFile() {
+    return join(this.publicDirectory, 'icon.png');
+  }
+
+  get webFaviconFile() {
+    return join(this.publicDirectory, 'favicon.ico');
   }
 
   toString() {
-    return `Source image: ${this.sourceImage}\n`
+    return `Source image: ${this.sourceImage}`
-      + `Public directory: ${this.publicDirectory}\n`
+      + `\nPublic directory: ${this.publicDirectory}`
-      + `Electron build directory: ${this.electronBuildDirectory}`;
+      + `\n\t Electron tray icon file: ${this.electronTrayIconFile}`
+      + `\n\t Web favicon file: ${this.webFaviconFile}`
+      + `\nElectron build directory: ${this.electronBuildResourcesDirectory}`;
   }
 }
 
 async function main() {
-  const paths = new Paths(getCurrentScriptDirectory());
+  const paths = new ImageAssetPaths(getCurrentScriptDirectory());
   console.log(`Paths:\n\t${paths.toString().replaceAll('\n', '\n\t')}`);
-  await updateDesktopLauncherAndTrayIcon(paths.sourceImage, paths.publicDirectory);
+  const convertCommand = await findAvailableImageMagickCommand();
-  await updateWebFavicon(paths.sourceImage, paths.publicDirectory);
+  await generateDesktopAndTrayIcons(
-  await updateDesktopIcons(paths.sourceImage, paths.electronBuildDirectory);
+    paths.sourceImage,
+    paths.electronTrayIconFile,
+    convertCommand,
+  );
+  await generateWebFavicon(
+    paths.sourceImage,
+    paths.webFaviconFile,
+    convertCommand,
+  );
+  await generateDesktopIcons(
+    paths.sourceImage,
+    paths.electronBuildResourcesDirectory,
+    convertCommand,
+  );
   console.log('🎉 (Re)created icons successfully.');
 }
 
-async function updateDesktopLauncherAndTrayIcon(sourceImage, publicFolder) {
+async function generateDesktopAndTrayIcons(sourceImage, targetFile, convertCommand) {
+  // Reference: https://web.archive.org/web/20240502124306/https://www.electronjs.org/docs/latest/api/tray
+  console.log(`Updating desktop launcher and tray icon at ${targetFile}.`);
   await ensureFileExists(sourceImage);
-  await ensureFolderExists(publicFolder);
+  await ensureParentFolderExists(targetFile);
-  const electronTrayIconFile = join(publicFolder, 'icon.png');
+  await convertFromSvgToPng(
-  console.log(`Updating desktop launcher and tray icon at ${electronTrayIconFile}.`);
+    convertCommand,
-  await runCommand(
-    'npx',
-    'svgexport',
     sourceImage,
-    electronTrayIconFile,
+    targetFile,
+    '512x512',
   );
 }
 
-async function updateWebFavicon(sourceImage, faviconFolder) {
+async function generateWebFavicon(sourceImage, faviconFilePath, convertCommand) {
-  console.log('Updating favicon');
+  console.log(`Updating favicon at ${faviconFilePath}.`);
   await ensureFileExists(sourceImage);
-  await ensureFolderExists(faviconFolder);
+  await ensureParentFolderExists(faviconFilePath);
-  await runCommand(
+  await convertFromSvgToIco(
-    'npx',
+    convertCommand,
-    'icon-gen',
+    sourceImage,
-    `--input ${sourceImage}`,
+    faviconFilePath,
-    `--output ${faviconFolder}`,
+    [16, 24, 32, 48, 64, 128, 256],
-    '--ico',
-    '--ico-name \'favicon\'',
-    '--report',
   );
 }
 
-async function updateDesktopIcons(sourceImage, electronIconsDir) {
+async function generateDesktopIcons(sourceImage, electronBuildResourcesDirectory, convertCommand) {
+  console.log(`Creating Electron icon files to ${electronBuildResourcesDirectory}.`);
+  // Reference: https://web.archive.org/web/20240501103645/https://www.electron.build/icons.html
+  await ensureFolderExists(electronBuildResourcesDirectory);
   await ensureFileExists(sourceImage);
-  await ensureFolderExists(electronIconsDir);
+  const electronMainIconFile = join(electronBuildResourcesDirectory, 'icon.png');
-  const temporaryDir = await mkdtemp('icon-');
+  await convertFromSvgToPng(
-  const temporaryPngFile = join(temporaryDir, 'icon.png');
+    convertCommand,
-  console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by `icon-builder`
-  await runCommand(
-    'npx',
-    'svgexport',
     sourceImage,
-    temporaryPngFile,
+    electronMainIconFile,
-    '1024:1024',
+    '1024x1024', // Should be at least 512x512
   );
-  console.log(`Creating electron icons to ${electronIconsDir}.`);
+  // Relying on `electron-builder`s conversion from png to ico results in pixelated look on Windows
-  await runCommand(
+  // 10 and 11 according to tests, see:
-    'npx',
+  //  - https://web.archive.org/web/20240502114650/https://github.com/electron-userland/electron-builder/issues/7328
-    'electron-icon-builder',
+  //  - https://web.archive.org/web/20240502115448/https://github.com/electron-userland/electron-builder/issues/3867
-    `--input="${temporaryPngFile}"`,
+  const electronWindowsIconFile = join(electronBuildResourcesDirectory, 'icon.ico');
-    `--output="${electronIconsDir}"`,
+  await convertFromSvgToIco(
-    '--flatten',
+    convertCommand,
+    sourceImage,
+    electronWindowsIconFile,
+    [16, 24, 32, 48, 64, 128, 256],
   );
-  console.log('Cleaning up temporary directory.');
-  await rm(temporaryDir, { recursive: true, force: true });
 }
 
 async function ensureFileExists(filePath) {
@@ -89,12 +125,60 @@ async function ensureFileExists(filePath) {
 }
 
 async function ensureFolderExists(folderPath) {
+  if (!folderPath) {
+    throw new Error('Path is missing');
+  }
   const path = await stat(folderPath);
   if (!path.isDirectory()) {
     throw new Error(`Not a directory: ${folderPath}`);
   }
 }
 
+function ensureParentFolderExists(filePath) {
+  return ensureFolderExists(dirname(filePath));
+}
+
+const BaseImageMagickConvertArguments = Object.freeze([
+  '-background none', // Transparent, so they do not get filled with white.
+  '-strip', // Strip metadata.
+  '-gravity Center', // Center the image when there's empty space
+]);
+
+async function convertFromSvgToIco(
+  convertCommand,
+  inputFile,
+  outputFile,
+  sizes,
+) {
+  await runCommand(
+    convertCommand,
+    ...BaseImageMagickConvertArguments,
+    `-density ${Math.max(...sizes).toString()}`, // High enough for sharpness
+    `-define icon:auto-resize=${sizes.map((s) => s.toString()).join(',')}`, // Automatically store multiple sizes in an ico image
+    '-compress None',
+    inputFile,
+    outputFile,
+  );
+}
+
+async function convertFromSvgToPng(
+  convertCommand,
+  inputFile,
+  outputFile,
+  size = undefined,
+) {
+  await runCommand(
+    convertCommand,
+    ...BaseImageMagickConvertArguments,
+    ...(size === undefined ? [] : [
+      `-resize ${size}`,
+      `-density ${size}`, // High enough for sharpness
+    ]),
+    inputFile,
+    outputFile,
+  );
+}
+
 async function runCommand(...args) {
   const command = args.join(' ');
   console.log(`Running command: ${command}`);
@@ -124,4 +208,27 @@ function getCurrentScriptDirectory() {
   return fileURLToPath(new URL('.', import.meta.url));
 }
 
+async function findAvailableImageMagickCommand() {
+  // Reference: https://web.archive.org/web/20240502120041/https://imagemagick.org/script/convert.php
+  const potentialBaseCommands = [
+    'convert', // Legacy command, usually available on Linux/macOS installations
+    'magick convert', // Newer command, available on Windows installations
+  ];
+  for (const baseCommand of potentialBaseCommands) {
+    const testCommand = `${baseCommand} -version`;
+    try {
+      await runCommand(testCommand); // eslint-disable-line no-await-in-loop
+      console.log(`Confirmed: ImageMagick command '${baseCommand}' is available and operational.`);
+      return baseCommand;
+    } catch (err) {
+      console.log(`Error: The command '${baseCommand}' is not found or failed to execute. Detailed error: ${err.message}"`);
+    }
+  }
+  throw new Error([
+    'Unable to locate any operational ImageMagick command.',
+    `Attempted commands were: ${potentialBaseCommands.join(', ')}.`,
+    'Please ensure ImageMagick is correctly installed and accessible.',
+  ].join('\n'));
+}
+
 await main();

scripts/validate-collections-yaml/README.md

@@ -0,0 +1,51 @@
+# validate-collections-yaml
+
+This script validates YAML collection files against a predefined schema to ensure their integrity.
+
+## Prerequisites
+
+- Python 3.x installed on your system.
+
+## Running in a Virtual Environment (Recommended)
+
+Using a virtual environment isolates dependencies and prevents conflicts.
+
+1. **Create a virtual environment:**
+
+   ```bash
+   python3 -m venv ./scripts/validate-collections-yaml/.venv
+   ```
+
+2. **Activate the virtual environment:**
+
+   ```bash
+   source ./scripts/validate-collections-yaml/.venv/bin/activate
+   ```
+
+3. **Install dependencies:**
+
+   ```bash
+   python3 -m pip install -r ./scripts/validate-collections-yaml/requirements.txt
+   ```
+
+4. **Run the script:**
+
+   ```bash
+   python3 ./scripts/validate-collections-yaml
+   ```
+
+## Running Globally
+
+Running the script globally is less recommended due to potential dependency conflicts.
+
+1. **Install dependencies:**
+
+   ```bash
+   python3 -m pip install -r ./scripts/validate-collections-yaml/requirements.txt
+   ```
+
+2. **Run the script:**
+
+   ```bash
+   python3 ./scripts/validate-collections-yaml
+   ```

scripts/validate-collections-yaml/__main__.py

@@ -0,0 +1,62 @@
+"""
+Description:
+  This script validates collection YAML files against the expected schema.
+
+Usage:
+  python3 ./scripts/validate-collections-yaml
+
+Notes:
+  This script requires the `jsonschema` and `pyyaml` packages (see requirements.txt).
+"""
+# pylint: disable=missing-function-docstring
+from os import path
+import sys
+from glob import glob
+from typing import List
+from jsonschema import exceptions, validate # pylint: disable=import-error
+import yaml # pylint: disable=import-error
+
+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)
+    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.')
+
+    total_invalid_files = 0
+    for collection_file_path in collection_file_paths:
+        file_name = path.basename(collection_file_path)
+        print(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.')
+        except exceptions.ValidationError as err:
+            print(f'Error: Validation failed for {file_name}.', file=sys.stderr)
+            print(str(err), file=sys.stderr)
+            total_invalid_files += 1
+
+    if total_invalid_files > 0:
+        print(f'Validation complete with {total_invalid_files} invalid files.', file=sys.stderr)
+        sys.exit(1)
+    else:
+        print('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()
+
+def find_collection_files(glob_pattern: str) -> List[str]:
+    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)
+
+if __name__ == '__main__':
+    main()

scripts/validate-collections-yaml/requirements.txt

@@ -0,0 +1,6 @@
+attrs==23.2.0
+jsonschema==4.22.0
+jsonschema-specifications==2023.12.1
+PyYAML==6.0.1
+referencing==0.35.1
+rpds-py==0.18.1

scripts/verify-build-artifacts.js

@@ -44,8 +44,8 @@ function getBuildVerificationConfigs() {
     '--electron-unbundled': {
       printDistDirScriptArgument: '--electron-unbundled',
       filePatterns: [
-        /main[/\\]index\.cjs/,
+        /main[/\\]index\.(cjs|mjs|js)/,
-        /preload[/\\]index\.cjs/,
+        /preload[/\\]index\.(cjs|mjs|js)/,
         /renderer[/\\]index\.htm(l)?/,
       ],
     },
@@ -91,7 +91,7 @@ async function verifyFilesExist(directoryPath, filePatterns) {
     if (!match) {
       die(
         `No file matches the pattern ${pattern.source} in directory \`${directoryPath}\``,
-        `\nFiles in directory:\n${files.map((file) => `\t- ${file}`).join('\n')}`,
+        `\nFiles in directory:\n${files.map((file) => `- ${file}`).join('\n')}`,
       );
     }
   }

scripts/verify-web-server-status.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 /**
  * Description:
  *  This script checks if a server, provided as a CLI argument, is up
@@ -6,57 +8,80 @@
  *  and will retry a specified number of times.
  *
  * Usage:
- *   node ./scripts/verify-web-server-status.js --url [URL]
+ *  node ./scripts/verify-web-server-status.js --url [URL] [--max-retries NUMBER]
  *
  * Options:
  *  --url           URL of the server to check
+ *  --max-retries   Maximum number of retry attempts (default: 30)
  */
 
-import { get } from 'http';
+const DEFAULT_MAX_RETRIES = 30;
-
-const MAX_RETRIES = 30;
 const RETRY_DELAY_IN_SECONDS = 3;
-const URL_PARAMETER_NAME = '--url';
+const PARAMETER_NAME_URL = '--url';
+const PARAMETER_NAME_MAX_RETRIES = '--max-retries';
 
-function checkServer(currentRetryCount = 1) {
+async function checkServer(currentRetryCount = 1) {
-  const serverUrl = getServerUrl();
+  const serverUrl = readRequiredParameterValue(PARAMETER_NAME_URL);
-  console.log(`Requesting ${serverUrl}...`);
+  const maxRetries = parseNumber(
-  get(serverUrl, (res) => {
+    readOptionalParameterValue(PARAMETER_NAME_MAX_RETRIES, DEFAULT_MAX_RETRIES),
-    if (res.statusCode === 200) {
+  );
+  console.log(`🌐 Requesting ${serverUrl}...`);
+  try {
+    const response = await fetch(serverUrl);
+    if (response.status === 200) {
       console.log('🎊 Success: The server is up and returned HTTP 200.');
       process.exit(0);
     } else {
-      console.log(`Server returned HTTP status code ${res.statusCode}.`);
+      exitWithError(`Server returned unexpected HTTP status code ${response.statusCode}.`);
-      retry(currentRetryCount);
+    }
+  } catch (error) {
+    console.error('Error making the request:', error);
+    scheduleNextRetry(maxRetries, currentRetryCount);
   }
-  }).on('error', (err) => {
-    console.error('Error making the request:', err);
-    retry(currentRetryCount);
-  });
 }
 
-function retry(currentRetryCount) {
+function scheduleNextRetry(maxRetries, currentRetryCount) {
-  console.log(`Attempt ${currentRetryCount}/${MAX_RETRIES}:`);
+  console.log(`Attempt ${currentRetryCount}/${maxRetries}:`);
   console.log(`Retrying in ${RETRY_DELAY_IN_SECONDS} seconds.`);
 
-  const remainingTime = (MAX_RETRIES - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
+  const remainingTime = (maxRetries - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
   console.log(`Time remaining before timeout: ${remainingTime}s`);
 
-  if (currentRetryCount < MAX_RETRIES) {
+  if (currentRetryCount < maxRetries) {
     setTimeout(() => checkServer(currentRetryCount + 1), RETRY_DELAY_IN_SECONDS * 1000);
   } else {
-    console.log('Failure: The server at did not return HTTP 200 within the allocated time. Exiting.');
+    exitWithError('The server at did not return HTTP 200 within the allocated time.');
-    process.exit(1);
   }
 }
 
-function getServerUrl() {
+function readRequiredParameterValue(parameterName) {
-  const urlIndex = process.argv.indexOf(URL_PARAMETER_NAME);
+  const parameterValue = readOptionalParameterValue(parameterName);
-  if (urlIndex === -1 || urlIndex === process.argv.length - 1) {
+  if (parameterValue === undefined) {
-    console.error(`Parameter "${URL_PARAMETER_NAME}" is not provided.`);
+    exitWithError(`Parameter "${parameterName}" is required but not provided.`);
-    process.exit(1);
   }
-  return process.argv[urlIndex + 1];
+  return parameterValue;
 }
 
-checkServer();
+function readOptionalParameterValue(parameterName, defaultValue) {
+  const index = process.argv.indexOf(parameterName);
+  if (index === -1 || index === process.argv.length - 1) {
+    return defaultValue;
+  }
+  return process.argv[index + 1];
+}
+
+function parseNumber(numberLike) {
+  const number = parseInt(numberLike, 10);
+  if (Number.isNaN(number)) {
+    exitWithError(`Invalid number: ${numberLike}`);
+  }
+  return number;
+}
+
+function exitWithError(message) {
+  console.error(`Failure: ${message}`);
+  console.log('Exiting');
+  process.exit(1);
+}
+
+await checkServer();

src/application/ApplicationFactory.ts

@@ -1,7 +1,7 @@
-import { IApplication } from '@/domain/IApplication';
+import type { IApplication } from '@/domain/IApplication';
 import { AsyncLazy } from '@/infrastructure/Threading/AsyncLazy';
-import { IApplicationFactory } from './IApplicationFactory';
 import { parseApplication } from './Parser/ApplicationParser';
+import type { IApplicationFactory } from './IApplicationFactory';
 
 export type ApplicationGetterType = () => IApplication;
 const ApplicationGetter: ApplicationGetterType = parseApplication;

src/application/CodeRunner/CodeRunner.ts

@@ -11,10 +11,11 @@ export type CodeRunErrorType =
   | 'FileWriteError'
   | 'FileReadbackVerificationError'
   | 'FilePathGenerationError'
-  | 'UnsupportedOperatingSystem'
+  | 'UnsupportedPlatform'
-  | 'FileExecutionError'
   | 'DirectoryCreationError'
-  | 'UnexpectedError';
+  | 'FilePermissionChangeError'
+  | 'FileExecutionError'
+  | 'ExternalProcessTermination';
 
 interface CodeRunStatus {
   readonly success: boolean;

src/application/Common/CustomError.ts

@@ -1,4 +1,4 @@
-import { isFunction } from '@/TypeHelpers';
+import { isFunction, type ConstructorArguments } from '@/TypeHelpers';
 
 /*
   Provides a unified and resilient way to extend errors across platforms.
@@ -12,8 +12,8 @@ import { isFunction } from '@/TypeHelpers';
     > https://web.archive.org/web/20230810014143/https://github.com/Microsoft/TypeScript-wiki/blob/main/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
 */
 export abstract class CustomError extends Error {
-  constructor(message?: string, options?: ErrorOptions) {
+  constructor(...args: ConstructorArguments<typeof Error>) {
-    super(message, options);
+    super(...args);
 
     fixPrototype(this, new.target.prototype);
     ensureStackTrace(this);

src/application/Common/Enum.ts

@@ -5,13 +5,13 @@ export type EnumType = number | string;
 export type EnumVariable<T extends EnumType, TEnumValue extends EnumType>
   = { [key in T]: TEnumValue };
 
-export interface IEnumParser<TEnum> {
+export interface EnumParser<TEnum> {
   parseEnum(value: string, propertyName: string): TEnum;
 }
 
 export function createEnumParser<T extends EnumType, TEnumValue extends EnumType>(
   enumVariable: EnumVariable<T, TEnumValue>,
-): IEnumParser<TEnumValue> {
+): EnumParser<TEnumValue> {
   return {
     parseEnum: (value, propertyName) => parseEnumValue(value, propertyName, enumVariable),
   };
@@ -33,23 +33,25 @@ function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
   if (!casedValue) {
     throw new Error(`unknown ${enumName}: "${value}"`);
   }
-  return enumVariable[casedValue as keyof typeof enumVariable];
+  return enumVariable[casedValue as keyof EnumVariable<T, TEnumValue>];
 }
 
 export function getEnumNames
 <T extends EnumType, TEnumValue extends EnumType>(
   enumVariable: EnumVariable<T, TEnumValue>,
-): string[] {
+): (string & keyof EnumVariable<T, TEnumValue>)[] {
   return Object
     .values(enumVariable)
-    .filter((enumMember): enumMember is string => isString(enumMember));
+    .filter((
+      enumMember,
+    ): enumMember is string & (keyof EnumVariable<T, TEnumValue>) => isString(enumMember));
 }
 
 export function getEnumValues<T extends EnumType, TEnumValue extends EnumType>(
   enumVariable: EnumVariable<T, TEnumValue>,
 ): TEnumValue[] {
   return getEnumNames(enumVariable)
-    .map((level) => enumVariable[level]) as TEnumValue[];
+    .map((name) => enumVariable[name]) as TEnumValue[];
 }
 
 export function assertInRange<T extends EnumType, TEnumValue extends EnumType>(

src/application/Common/ScriptingLanguage/ScriptingLanguageFactory.ts

@@ -1,6 +1,6 @@
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
 import { assertInRange } from '@/application/Common/Enum';
-import { IScriptingLanguageFactory } from './IScriptingLanguageFactory';
+import type { IScriptingLanguageFactory } from './IScriptingLanguageFactory';
 
 type Getter<T> = () => T;
 

src/application/Common/Shuffle.ts

@@ -0,0 +1,12 @@
+/*
+  Shuffle an array of strings, returning a new array with elements in random order.
+  Uses the Fisher-Yates (or Durstenfeld) algorithm.
+*/
+export function shuffle<T>(array: readonly T[]): T[] {
+  const shuffledArray = [...array];
+  for (let i = array.length - 1; i > 0; i--) {
+    const j = Math.floor(Math.random() * (i + 1));
+    [shuffledArray[i], shuffledArray[j]] = [shuffledArray[j], shuffledArray[i]];
+  }
+  return shuffledArray;
+}

src/application/Common/Text/FilterEmptyStrings.ts

@@ -0,0 +1,25 @@
+import { isArray } from '@/TypeHelpers';
+
+export type OptionalString = string | undefined | null;
+
+export function filterEmptyStrings(
+  texts: readonly OptionalString[],
+  isArrayType: typeof isArray = isArray,
+): string[] {
+  if (!isArrayType(texts)) {
+    throw new Error(`Invalid input: Expected an array, but received type ${typeof texts}.`);
+  }
+  assertArrayItemsAreStringLike(texts);
+  return texts
+    .filter((title): title is string => Boolean(title));
+}
+
+function assertArrayItemsAreStringLike(
+  texts: readonly unknown[],
+): asserts texts is readonly OptionalString[] {
+  const invalidItems = texts.filter((item) => !(typeof item === 'string' || item === undefined || item === null));
+  if (invalidItems.length > 0) {
+    const invalidTypes = invalidItems.map((item) => typeof item).join(', ');
+    throw new Error(`Invalid array items: Expected items as string, undefined, or null. Received invalid types: ${invalidTypes}.`);
+  }
+}

src/application/Common/Text/IndentText.ts

@@ -0,0 +1,29 @@
+import { isString } from '@/TypeHelpers';
+import { splitTextIntoLines } from './SplitTextIntoLines';
+
+export function indentText(
+  text: string,
+  indentLevel = 1,
+  utilities: TextIndentationUtilities = DefaultUtilities,
+): string {
+  if (!utilities.isStringType(text)) {
+    throw new Error(`Indentation error: The input must be a string. Received type: ${typeof text}.`);
+  }
+  if (indentLevel <= 0) {
+    throw new Error(`Indentation error: The indent level must be a positive integer. Received: ${indentLevel}.`);
+  }
+  const indentation = '\t'.repeat(indentLevel);
+  return utilities.splitIntoLines(text)
+    .map((line) => (line ? `${indentation}${line}` : line))
+    .join('\n');
+}
+
+interface TextIndentationUtilities {
+  readonly splitIntoLines: typeof splitTextIntoLines;
+  readonly isStringType: typeof isString;
+}
+
+const DefaultUtilities: TextIndentationUtilities = {
+  splitIntoLines: splitTextIntoLines,
+  isStringType: isString,
+};

src/application/Common/Text/SplitTextIntoLines.ts

@@ -0,0 +1,11 @@
+import { isString } from '@/TypeHelpers';
+
+export function splitTextIntoLines(
+  text: string,
+  isStringType = isString,
+): string[] {
+  if (!isStringType(text)) {
+    throw new Error(`Line splitting error: Expected a string but received type '${typeof text}'.`);
+  }
+  return text.split(/\r\n|\r|\n/);
+}

src/application/Common/Timing/BatchedDebounce.ts

@@ -1,5 +1,5 @@
 import { PlatformTimer } from './PlatformTimer';
-import { TimeoutType, Timer } from './Timer';
+import type { TimeoutType, Timer } from './Timer';
 
 export function batchedDebounce<T>(
   callback: (batches: readonly T[]) => void,

src/application/Common/Timing/PlatformTimer.ts

@@ -1,4 +1,4 @@
-import { Timer } from './Timer';
+import type { Timer } from './Timer';
 
 export const PlatformTimer: Timer = {
   setTimeout: (callback, ms) => setTimeout(callback, ms),

src/application/Common/Timing/Throttle.ts

@@ -1,44 +1,164 @@
-import { Timer, TimeoutType } from './Timer';
+/* eslint-disable max-classes-per-file */
 import { PlatformTimer } from './PlatformTimer';
+import type { Timer, TimeoutType } from './Timer';
 
 export type CallbackType = (..._: readonly unknown[]) => void;
 
-export function throttle(
+export interface ThrottleOptions {
-  callback: CallbackType,
+  /** Skip the immediate execution of the callback on the first invoke */
-  waitInMs: number,
+  readonly excludeLeadingCall: boolean;
-  timer: Timer = PlatformTimer,
+  readonly timer: Timer;
-): CallbackType {
-  const throttler = new Throttler(timer, waitInMs, callback);
-  return (...args: unknown[]) => throttler.invoke(...args);
 }
 
-class Throttler {
+const DefaultOptions: ThrottleOptions = {
-  private queuedExecutionId: TimeoutType | undefined;
+  excludeLeadingCall: false,
+  timer: PlatformTimer,
+};
 
-  private previouslyRun: number;
+export interface ThrottleFunction {
+  (
+    callback: CallbackType,
+    waitInMs: number,
+    options?: Partial<ThrottleOptions>,
+  ): CallbackType;
+}
+
+export const throttle: ThrottleFunction = (
+  callback: CallbackType,
+  waitInMs: number,
+  options: Partial<ThrottleOptions> = DefaultOptions,
+): CallbackType => {
+  const defaultedOptions: ThrottleOptions = {
+    ...DefaultOptions,
+    ...options,
+  };
+  const throttler = new Throttler(waitInMs, callback, defaultedOptions);
+  return (...args: unknown[]) => throttler.invoke(...args);
+};
+
+class Throttler {
+  private lastExecutionTime: number | null = null;
+
+  private executionScheduler: DelayedCallbackScheduler;
 
   constructor(
-    private readonly timer: Timer,
     private readonly waitInMs: number,
     private readonly callback: CallbackType,
+    private readonly options: ThrottleOptions,
   ) {
     if (!waitInMs) { throw new Error('missing delay'); }
     if (waitInMs < 0) { throw new Error('negative delay'); }
+    this.executionScheduler = new DelayedCallbackScheduler(options.timer);
   }
 
   public invoke(...args: unknown[]): void {
-    const now = this.timer.dateNow();
+    switch (true) {
-    if (this.queuedExecutionId !== undefined) {
+      case this.isLeadingCallWithinThrottlePeriod(): {
-      this.timer.clearTimeout(this.queuedExecutionId);
+        if (this.options.excludeLeadingCall) {
-      this.queuedExecutionId = undefined;
+          this.scheduleNext(args);
+          return;
         }
-    if (!this.previouslyRun || (now - this.previouslyRun >= this.waitInMs)) {
+        this.executeNow(args);
+        return;
+      }
+      case this.isAlreadyScheduled(): {
+        this.updateNextScheduled(args);
+        return;
+      }
+      case !this.isThrottlePeriodPassed(): {
+        this.scheduleNext(args);
+        return;
+      }
+      default:
+        throw new Error('Throttle logical error: no conditions for execution or scheduling were met.');
+    }
+  }
+
+  private isLeadingCallWithinThrottlePeriod(): boolean {
+    return this.isThrottlePeriodPassed()
+      && !this.isAlreadyScheduled();
+  }
+
+  private isThrottlePeriodPassed(): boolean {
+    if (this.lastExecutionTime === null) {
+      return true;
+    }
+    const timeSinceLastExecution = this.options.timer.dateNow() - this.lastExecutionTime;
+    const isThrottleTimePassed = timeSinceLastExecution >= this.waitInMs;
+    return isThrottleTimePassed;
+  }
+
+  private isAlreadyScheduled(): boolean {
+    return this.executionScheduler.getNext() !== null;
+  }
+
+  private scheduleNext(args: unknown[]): void {
+    if (this.executionScheduler.getNext()) {
+      throw new Error('An execution is already scheduled.');
+    }
+    this.executionScheduler.resetNext(
+      () => this.executeNow(args),
+      this.waitInMs,
+    );
+  }
+
+  private updateNextScheduled(args: unknown[]): void {
+    const nextScheduled = this.executionScheduler.getNext();
+    if (!nextScheduled) {
+      throw new Error('A non-existent scheduled execution cannot be updated.');
+    }
+    const nextDelay = nextScheduled.scheduledTime - this.dateNow();
+    this.executionScheduler.resetNext(
+      () => this.executeNow(args),
+      nextDelay,
+    );
+  }
+
+  private executeNow(args: unknown[]): void {
     this.callback(...args);
-      this.previouslyRun = now;
+    this.lastExecutionTime = this.dateNow();
-    } else {
+  }
-      const nextCall = () => this.invoke(...args);
+
-      const nextCallDelayInMs = this.waitInMs - (now - this.previouslyRun);
+  private dateNow(): number {
-      this.queuedExecutionId = this.timer.setTimeout(nextCall, nextCallDelayInMs);
+    return this.options.timer.dateNow();
   }
 }
+
+interface ScheduledCallback {
+  readonly scheduleTimeoutId: TimeoutType;
+  readonly scheduledTime: number;
+}
+
+class DelayedCallbackScheduler {
+  private scheduledCallback: ScheduledCallback | null = null;
+
+  constructor(
+    private readonly timer: Timer,
+  ) { }
+
+  public getNext(): ScheduledCallback | null {
+    return this.scheduledCallback;
+  }
+
+  public resetNext(
+    callback: () => void,
+    delayInMs: number,
+  ) {
+    this.clear();
+    this.scheduledCallback = {
+      scheduledTime: this.timer.dateNow() + delayInMs,
+      scheduleTimeoutId: this.timer.setTimeout(() => {
+        this.clear();
+        callback();
+      }, delayInMs),
+    };
+  }
+
+  private clear() {
+    if (this.scheduledCallback === null) {
+      return;
+    }
+    this.timer.clearTimeout(this.scheduledCallback.scheduleTimeoutId);
+    this.scheduledCallback = null;
+  }
 }

src/application/Context/ApplicationContext.ts

@@ -1,11 +1,11 @@
-import { IApplication } from '@/domain/IApplication';
+import type { IApplication } from '@/domain/IApplication';
 import { OperatingSystem } from '@/domain/OperatingSystem';
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import type { ICategoryCollection } from '@/domain/Collection/ICategoryCollection';
 import { EventSource } from '@/infrastructure/Events/EventSource';
 import { assertInRange } from '@/application/Common/Enum';
 import { CategoryCollectionState } from './State/CategoryCollectionState';
-import { ICategoryCollectionState } from './State/ICategoryCollectionState';
+import type { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
-import { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
+import type { ICategoryCollectionState } from './State/ICategoryCollectionState';
 
 type StateMachine = Map<OperatingSystem, ICategoryCollectionState>;
 
@@ -17,7 +17,7 @@ export class ApplicationContext implements IApplicationContext {
   public currentOs: OperatingSystem;
 
   public get state(): ICategoryCollectionState {
-    return this.states[this.collection.os];
+    return this.getState(this.collection.os);
   }
 
   private readonly states: StateMachine;
@@ -26,30 +26,51 @@ export class ApplicationContext implements IApplicationContext {
     public readonly app: IApplication,
     initialContext: OperatingSystem,
   ) {
+    this.setContext(initialContext);
     this.states = initializeStates(app);
-    this.changeContext(initialContext);
   }
 
   public changeContext(os: OperatingSystem): void {
-    assertInRange(os, OperatingSystem);
     if (this.currentOs === os) {
       return;
     }
-    const collection = this.app.getCollection(os);
-    this.collection = collection;
     const event: IApplicationContextChangedEvent = {
-      newState: this.states[os],
+      newState: this.getState(os),
-      oldState: this.states[this.currentOs],
+      oldState: this.getState(this.currentOs),
     };
+    this.setContext(os);
     this.contextChanged.notify(event);
+  }
+
+  private setContext(os: OperatingSystem): void {
+    validateOperatingSystem(os, this.app);
+    this.collection = this.app.getCollection(os);
     this.currentOs = os;
   }
+
+  private getState(os: OperatingSystem): ICategoryCollectionState {
+    const state = this.states.get(os);
+    if (!state) {
+      throw new Error(`Operating system "${OperatingSystem[os]}" state is unknown.`);
+    }
+    return state;
+  }
+}
+
+function validateOperatingSystem(
+  os: OperatingSystem,
+  app: IApplication,
+): void {
+  assertInRange(os, OperatingSystem);
+  if (!app.getSupportedOsList().includes(os)) {
+    throw new Error(`Operating system "${OperatingSystem[os]}" is not supported.`);
+  }
 }
 
 function initializeStates(app: IApplication): StateMachine {
   const machine = new Map<OperatingSystem, ICategoryCollectionState>();
   for (const collection of app.collections) {
-    machine[collection.os] = new CategoryCollectionState(collection);
+    machine.set(collection.os, new CategoryCollectionState(collection));
   }
   return machine;
 }

src/application/Context/ApplicationContextFactory.ts

@@ -1,10 +1,10 @@
-import { IApplicationContext } from '@/application/Context/IApplicationContext';
+import type { IApplicationContext } from '@/application/Context/IApplicationContext';
 import { OperatingSystem } from '@/domain/OperatingSystem';
-import { IApplication } from '@/domain/IApplication';
+import type { IApplication } from '@/domain/IApplication';
 import { CurrentEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironmentFactory';
-import { IApplicationFactory } from '../IApplicationFactory';
 import { ApplicationFactory } from '../ApplicationFactory';
 import { ApplicationContext } from './ApplicationContext';
+import type { IApplicationFactory } from '../IApplicationFactory';
 
 export async function buildContext(
   factory: IApplicationFactory = ApplicationFactory.Current,

src/application/Context/IApplicationContext.ts

@@ -1,7 +1,7 @@
 import { OperatingSystem } from '@/domain/OperatingSystem';
-import { IEventSource } from '@/infrastructure/Events/IEventSource';
+import type { IEventSource } from '@/infrastructure/Events/IEventSource';
-import { IApplication } from '@/domain/IApplication';
+import type { IApplication } from '@/domain/IApplication';
-import { ICategoryCollectionState, IReadOnlyCategoryCollectionState } from './State/ICategoryCollectionState';
+import type { ICategoryCollectionState, IReadOnlyCategoryCollectionState } from './State/ICategoryCollectionState';
 
 export interface IReadOnlyApplicationContext {
   readonly app: IApplication;

src/application/Context/State/CategoryCollectionState.ts

@@ -1,12 +1,12 @@
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import type { ICategoryCollection } from '@/domain/Collection/ICategoryCollection';
 import { OperatingSystem } from '@/domain/OperatingSystem';
-import { UserFilter } from './Filter/UserFilter';
+import { AdaptiveFilterContext } from './Filter/AdaptiveFilterContext';
-import { IUserFilter } from './Filter/IUserFilter';
 import { ApplicationCode } from './Code/ApplicationCode';
-import { UserSelection } from './Selection/UserSelection';
-import { ICategoryCollectionState } from './ICategoryCollectionState';
-import { IApplicationCode } from './Code/IApplicationCode';
 import { UserSelectionFacade } from './Selection/UserSelectionFacade';
+import type { FilterContext } from './Filter/FilterContext';
+import type { UserSelection } from './Selection/UserSelection';
+import type { ICategoryCollectionState } from './ICategoryCollectionState';
+import type { IApplicationCode } from './Code/IApplicationCode';
 
 export class CategoryCollectionState implements ICategoryCollectionState {
   public readonly os: OperatingSystem;
@@ -15,7 +15,7 @@ export class CategoryCollectionState implements ICategoryCollectionState {
 
   public readonly selection: UserSelection;
 
-  public readonly filter: IUserFilter;
+  public readonly filter: FilterContext;
 
   public constructor(
     public readonly collection: ICategoryCollection,
@@ -45,7 +45,7 @@ const DefaultSelectionFactory: SelectionFactory = (
 ) => new UserSelectionFacade(...params);
 
 export type FilterFactory = (
-  ...params: ConstructorParameters<typeof UserFilter>
+  ...params: ConstructorParameters<typeof AdaptiveFilterContext>
-) => IUserFilter;
+) => FilterContext;
 
-const DefaultFilterFactory: FilterFactory = (...params) => new UserFilter(...params);
+const DefaultFilterFactory: FilterFactory = (...params) => new AdaptiveFilterContext(...params);

src/application/Context/State/Code/ApplicationCode.ts

@@ -1,13 +1,13 @@
 import { EventSource } from '@/infrastructure/Events/EventSource';
-import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
+import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
-import { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
+import type { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
 import { CodeChangedEvent } from './Event/CodeChangedEvent';
 import { CodePosition } from './Position/CodePosition';
-import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
 import { UserScriptGenerator } from './Generation/UserScriptGenerator';
-import { IApplicationCode } from './IApplicationCode';
+import type { IUserScriptGenerator } from './Generation/IUserScriptGenerator';
-import { IUserScriptGenerator } from './Generation/IUserScriptGenerator';
+import type { ICodeChangedEvent } from './Event/ICodeChangedEvent';
+import type { IApplicationCode } from './IApplicationCode';
 
 export class ApplicationCode implements IApplicationCode {
   public readonly changed = new EventSource<ICodeChangedEvent>();

src/application/Context/State/Code/Event/CodeChangedEvent.ts

@@ -1,18 +1,20 @@
-import { IScript } from '@/domain/IScript';
+import type { Script } from '@/domain/Executables/Script/Script';
-import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
+import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
-import { ICodeChangedEvent } from './ICodeChangedEvent';
+import { splitTextIntoLines } from '@/application/Common/Text/SplitTextIntoLines';
+import type { ExecutableId } from '@/domain/Executables/Identifiable';
+import type { ICodeChangedEvent } from './ICodeChangedEvent';
 
 export class CodeChangedEvent implements ICodeChangedEvent {
   public readonly code: string;
 
-  public readonly addedScripts: ReadonlyArray<IScript>;
+  public readonly addedScripts: ReadonlyArray<Script>;
 
-  public readonly removedScripts: ReadonlyArray<IScript>;
+  public readonly removedScripts: ReadonlyArray<Script>;
 
-  public readonly changedScripts: ReadonlyArray<IScript>;
+  public readonly changedScripts: ReadonlyArray<Script>;
 
-  private readonly scripts: Map<IScript, ICodePosition>;
+  private readonly scripts: Map<Script, ICodePosition>;
 
   constructor(
     code: string,
@@ -25,7 +27,7 @@ export class CodeChangedEvent implements ICodeChangedEvent {
     this.addedScripts = selectIfNotExists(newScripts, oldScripts);
     this.removedScripts = selectIfNotExists(oldScripts, newScripts);
     this.changedScripts = getChangedScripts(oldScripts, newScripts);
-    this.scripts = new Map<IScript, ICodePosition>();
+    this.scripts = new Map<Script, ICodePosition>();
     scripts.forEach((position, selection) => {
       this.scripts.set(selection.script, position);
     });
@@ -35,13 +37,13 @@ export class CodeChangedEvent implements ICodeChangedEvent {
     return this.scripts.size === 0;
   }
 
-  public getScriptPositionInCode(script: IScript): ICodePosition {
+  public getScriptPositionInCode(script: Script): ICodePosition {
-    return this.getPositionById(script.id);
+    return this.getPositionById(script.executableId);
   }
 
-  private getPositionById(scriptId: string): ICodePosition {
+  private getPositionById(scriptId: ExecutableId): ICodePosition {
     const position = [...this.scripts.entries()]
-      .filter(([s]) => s.id === scriptId)
+      .filter(([s]) => s.executableId === scriptId)
       .map(([, pos]) => pos)
       .at(0);
     if (!position) {
@@ -52,7 +54,7 @@ export class CodeChangedEvent implements ICodeChangedEvent {
 }
 
 function ensureAllPositionsExist(script: string, positions: ReadonlyArray<ICodePosition>) {
-  const totalLines = script.split(/\r\n|\r|\n/).length;
+  const totalLines = splitTextIntoLines(script).length;
   const missingPositions = positions.filter((position) => position.endLine > totalLines);
   if (missingPositions.length > 0) {
     throw new Error(
@@ -65,7 +67,7 @@ function ensureAllPositionsExist(script: string, positions: ReadonlyArray<ICodeP
 function getChangedScripts(
   oldScripts: ReadonlyArray<SelectedScript>,
   newScripts: ReadonlyArray<SelectedScript>,
-): ReadonlyArray<IScript> {
+): ReadonlyArray<Script> {
   return newScripts
     .filter((newScript) => oldScripts.find((oldScript) => oldScript.id === newScript.id
       && oldScript.revert !== newScript.revert))

src/application/Context/State/Code/Event/ICodeChangedEvent.ts

@@ -1,11 +1,11 @@
-import { IScript } from '@/domain/IScript';
+import type { Script } from '@/domain/Executables/Script/Script';
-import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
+import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
 
 export interface ICodeChangedEvent {
   readonly code: string;
-  readonly addedScripts: ReadonlyArray<IScript>;
+  readonly addedScripts: ReadonlyArray<Script>;
-  readonly removedScripts: ReadonlyArray<IScript>;
+  readonly removedScripts: ReadonlyArray<Script>;
-  readonly changedScripts: ReadonlyArray<IScript>;
+  readonly changedScripts: ReadonlyArray<Script>;
   isEmpty(): boolean;
-  getScriptPositionInCode(script: IScript): ICodePosition;
+  getScriptPositionInCode(script: Script): ICodePosition;
 }

src/application/Context/State/Code/Generation/CodeBuilder.ts

@@ -1,4 +1,5 @@
-import { ICodeBuilder } from './ICodeBuilder';
+import { splitTextIntoLines } from '@/application/Common/Text/SplitTextIntoLines';
+import type { ICodeBuilder } from './ICodeBuilder';
 
 const TotalFunctionSeparatorChars = 58;
 
@@ -15,7 +16,7 @@ export abstract class CodeBuilder implements ICodeBuilder {
       this.lines.push('');
       return this;
     }
-    const lines = code.match(/[^\r\n]+/g);
+    const lines = splitTextIntoLines(code);
     if (lines) {
       this.lines.push(...lines);
     }

src/application/Context/State/Code/Generation/CodeBuilderFactory.ts

@@ -1,9 +1,9 @@
 import { ScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/ScriptingLanguageFactory';
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
-import { ICodeBuilder } from './ICodeBuilder';
 import { BatchBuilder } from './Languages/BatchBuilder';
 import { ShellBuilder } from './Languages/ShellBuilder';
-import { ICodeBuilderFactory } from './ICodeBuilderFactory';
+import type { ICodeBuilder } from './ICodeBuilder';
+import type { ICodeBuilderFactory } from './ICodeBuilderFactory';
 
 export class CodeBuilderFactory
   extends ScriptingLanguageFactory<ICodeBuilder>

src/application/Context/State/Code/Generation/ICodeBuilderFactory.ts

@@ -1,4 +1,4 @@
-import { IScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/IScriptingLanguageFactory';
+import type { IScriptingLanguageFactory } from '@/application/Common/ScriptingLanguage/IScriptingLanguageFactory';
-import { ICodeBuilder } from './ICodeBuilder';
+import type { ICodeBuilder } from './ICodeBuilder';
 
 export type ICodeBuilderFactory = IScriptingLanguageFactory<ICodeBuilder>;

src/application/Context/State/Code/Generation/IUserScript.ts

@@ -1,5 +1,5 @@
-import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
+import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
 
 export interface IUserScript {
   readonly code: string;

src/application/Context/State/Code/Generation/IUserScriptGenerator.ts

@@ -1,6 +1,6 @@
-import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
+import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
-import { IUserScript } from './IUserScript';
+import type { IUserScript } from './IUserScript';
 
 export interface IUserScriptGenerator {
   buildCode(

src/application/Context/State/Code/Generation/UserScriptGenerator.ts

@@ -1,12 +1,12 @@
-import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
+import type { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
-import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
+import type { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import type { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
 import { CodePosition } from '../Position/CodePosition';
-import { IUserScriptGenerator } from './IUserScriptGenerator';
-import { IUserScript } from './IUserScript';
-import { ICodeBuilder } from './ICodeBuilder';
-import { ICodeBuilderFactory } from './ICodeBuilderFactory';
 import { CodeBuilderFactory } from './CodeBuilderFactory';
+import type { IUserScriptGenerator } from './IUserScriptGenerator';
+import type { IUserScript } from './IUserScript';
+import type { ICodeBuilder } from './ICodeBuilder';
+import type { ICodeBuilderFactory } from './ICodeBuilderFactory';
 
 export class UserScriptGenerator implements IUserScriptGenerator {
   constructor(private readonly codeBuilderFactory: ICodeBuilderFactory = new CodeBuilderFactory()) {

src/application/Context/State/Code/IApplicationCode.ts

@@ -1,5 +1,5 @@
-import { IEventSource } from '@/infrastructure/Events/IEventSource';
+import type { IEventSource } from '@/infrastructure/Events/IEventSource';
-import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
+import type { ICodeChangedEvent } from './Event/ICodeChangedEvent';
 
 export interface IApplicationCode {
   readonly changed: IEventSource<ICodeChangedEvent>;

src/application/Context/State/Code/Position/CodePosition.ts

@@ -1,4 +1,4 @@
-import { ICodePosition } from './ICodePosition';
+import type { ICodePosition } from './ICodePosition';
 
 export class CodePosition implements ICodePosition {
   public get totalLines(): number {

src/application/Context/State/Filter/AdaptiveFilterContext.ts

@@ -0,0 +1,35 @@
+import { EventSource } from '@/infrastructure/Events/EventSource';
+import type { ICategoryCollection } from '@/domain/Collection/ICategoryCollection';
+import { FilterChange } from './Event/FilterChange';
+import { LinearFilterStrategy } from './Strategy/LinearFilterStrategy';
+import type { FilterResult } from './Result/FilterResult';
+import type { FilterContext } from './FilterContext';
+import type { FilterChangeDetails } from './Event/FilterChangeDetails';
+import type { FilterStrategy } from './Strategy/FilterStrategy';
+
+export class AdaptiveFilterContext implements FilterContext {
+  public readonly filterChanged = new EventSource<FilterChangeDetails>();
+
+  public currentFilter: FilterResult | undefined;
+
+  constructor(
+    private readonly collection: ICategoryCollection,
+    private readonly filterStrategy: FilterStrategy = new LinearFilterStrategy(),
+  ) {
+
+  }
+
+  public applyFilter(filter: string): void {
+    if (!filter) {
+      throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter');
+    }
+    const result = this.filterStrategy.applyFilter(filter, this.collection);
+    this.currentFilter = result;
+    this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
+  }
+
+  public clearFilter(): void {
+    this.currentFilter = undefined;
+    this.filterChanged.notify(FilterChange.forClear());
+  }
+}

src/application/Context/State/Filter/Event/FilterChange.ts

@@ -1,24 +1,24 @@
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
+import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
 import { FilterActionType } from './FilterActionType';
-import {
+import type {
-  IFilterChangeDetails, IFilterChangeDetailsVisitor,
+  FilterChangeDetails, FilterChangeDetailsVisitor,
   ApplyFilterAction, ClearFilterAction,
-} from './IFilterChangeDetails';
+} from './FilterChangeDetails';
 
-export class FilterChange implements IFilterChangeDetails {
+export class FilterChange implements FilterChangeDetails {
   public static forApply(
-    filter: IFilterResult,
+    filter: FilterResult,
-  ): IFilterChangeDetails {
+  ): FilterChangeDetails {
     return new FilterChange({ type: FilterActionType.Apply, filter });
   }
 
-  public static forClear(): IFilterChangeDetails {
+  public static forClear(): FilterChangeDetails {
     return new FilterChange({ type: FilterActionType.Clear });
   }
 
   private constructor(public readonly action: ApplyFilterAction | ClearFilterAction) { }
 
-  public visit(visitor: IFilterChangeDetailsVisitor): void {
+  public visit(visitor: FilterChangeDetailsVisitor): void {
     switch (this.action.type) {
       case FilterActionType.Apply:
         if (visitor.onApply) {

src/application/Context/State/Filter/Event/FilterChangeDetails.ts

@@ -0,0 +1,23 @@
+import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
+import type { FilterActionType } from './FilterActionType';
+
+export interface FilterChangeDetails {
+  readonly action: FilterAction;
+  visit(visitor: FilterChangeDetailsVisitor): void;
+}
+
+export interface FilterChangeDetailsVisitor {
+  readonly onClear?: () => void;
+  readonly onApply?: (filter: FilterResult) => void;
+}
+
+export type ApplyFilterAction = {
+  readonly type: FilterActionType.Apply,
+  readonly filter: FilterResult;
+};
+
+export type ClearFilterAction = {
+  readonly type: FilterActionType.Clear,
+};
+
+export type FilterAction = ApplyFilterAction | ClearFilterAction;

src/application/Context/State/Filter/Event/IFilterChangeDetails.ts

@@ -1,23 +0,0 @@
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
-import { FilterActionType } from './FilterActionType';
-
-export interface IFilterChangeDetails {
-  readonly action: FilterAction;
-  visit(visitor: IFilterChangeDetailsVisitor): void;
-}
-
-export interface IFilterChangeDetailsVisitor {
-  readonly onClear?: () => void;
-  readonly onApply?: (filter: IFilterResult) => void;
-}
-
-export type ApplyFilterAction = {
-  readonly type: FilterActionType.Apply,
-  readonly filter: IFilterResult;
-};
-
-export type ClearFilterAction = {
-  readonly type: FilterActionType.Clear,
-};
-
-export type FilterAction = ApplyFilterAction | ClearFilterAction;

src/application/Context/State/Filter/FilterContext.ts

@@ -0,0 +1,13 @@
+import type { IEventSource } from '@/infrastructure/Events/IEventSource';
+import type { FilterResult } from './Result/FilterResult';
+import type { FilterChangeDetails } from './Event/FilterChangeDetails';
+
+export interface ReadonlyFilterContext {
+  readonly currentFilter: FilterResult | undefined;
+  readonly filterChanged: IEventSource<FilterChangeDetails>;
+}
+
+export interface FilterContext extends ReadonlyFilterContext {
+  applyFilter(filter: string): void;
+  clearFilter(): void;
+}

src/application/Context/State/Filter/FilterResult.ts

@@ -1,18 +0,0 @@
-import { IScript } from '@/domain/IScript';
-import { ICategory } from '@/domain/ICategory';
-import { IFilterResult } from './IFilterResult';
-
-export class FilterResult implements IFilterResult {
-  constructor(
-    public readonly scriptMatches: ReadonlyArray<IScript>,
-    public readonly categoryMatches: ReadonlyArray<ICategory>,
-    public readonly query: string,
-  ) {
-    if (!query) { throw new Error('Query is empty or undefined'); }
-  }
-
-  public hasAnyMatches(): boolean {
-    return this.scriptMatches.length > 0
-      || this.categoryMatches.length > 0;
-  }
-}

src/application/Context/State/Filter/IFilterResult.ts

@@ -1,8 +0,0 @@
-import { IScript, ICategory } from '@/domain/ICategory';
-
-export interface IFilterResult {
-  readonly categoryMatches: ReadonlyArray<ICategory>;
-  readonly scriptMatches: ReadonlyArray<IScript>;
-  readonly query: string;
-  hasAnyMatches(): boolean;
-}

src/application/Context/State/Filter/IUserFilter.ts

@@ -1,13 +0,0 @@
-import { IEventSource } from '@/infrastructure/Events/IEventSource';
-import { IFilterResult } from './IFilterResult';
-import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
-
-export interface IReadOnlyUserFilter {
-  readonly currentFilter: IFilterResult | undefined;
-  readonly filterChanged: IEventSource<IFilterChangeDetails>;
-}
-
-export interface IUserFilter extends IReadOnlyUserFilter {
-  applyFilter(filter: string): void;
-  clearFilter(): void;
-}

src/application/Context/State/Filter/Result/AppliedFilterResult.ts

@@ -0,0 +1,18 @@
+import type { Script } from '@/domain/Executables/Script/Script';
+import type { Category } from '@/domain/Executables/Category/Category';
+import type { FilterResult } from './FilterResult';
+
+export class AppliedFilterResult implements FilterResult {
+  constructor(
+    public readonly scriptMatches: ReadonlyArray<Script>,
+    public readonly categoryMatches: ReadonlyArray<Category>,
+    public readonly query: string,
+  ) {
+    if (!query) { throw new Error('Query is empty or undefined'); }
+  }
+
+  public hasAnyMatches(): boolean {
+    return this.scriptMatches.length > 0
+      || this.categoryMatches.length > 0;
+  }
+}

src/application/Context/State/Filter/Result/FilterResult.ts

@@ -0,0 +1,9 @@
+import type { Category } from '@/domain/Executables/Category/Category';
+import type { Script } from '@/domain/Executables/Script/Script';
+
+export interface FilterResult {
+  readonly categoryMatches: ReadonlyArray<Category>;
+  readonly scriptMatches: ReadonlyArray<Script>;
+  readonly query: string;
+  hasAnyMatches(): boolean;
+}

src/application/Context/State/Filter/Strategy/FilterStrategy.ts

@@ -0,0 +1,9 @@
+import type { ICategoryCollection } from '@/domain/Collection/ICategoryCollection';
+import type { FilterResult } from '../Result/FilterResult';
+
+export interface FilterStrategy {
+  applyFilter(
+    filter: string,
+    collection: ICategoryCollection,
+  ): FilterResult;
+}

src/application/Context/State/Filter/Strategy/LinearFilterStrategy.ts

@@ -0,0 +1,81 @@
+import type { Category } from '@/domain/Executables/Category/Category';
+import type { ScriptCode } from '@/domain/Executables/Script/Code/ScriptCode';
+import type { Documentable } from '@/domain/Executables/Documentable';
+import type { ICategoryCollection } from '@/domain/Collection/ICategoryCollection';
+import type { Script } from '@/domain/Executables/Script/Script';
+import { AppliedFilterResult } from '../Result/AppliedFilterResult';
+import type { FilterStrategy } from './FilterStrategy';
+import type { FilterResult } from '../Result/FilterResult';
+
+export class LinearFilterStrategy implements FilterStrategy {
+  applyFilter(filter: string, collection: ICategoryCollection): FilterResult {
+    const filterLowercase = filter.toLocaleLowerCase();
+    const filteredScripts = collection.getAllScripts().filter(
+      (script) => matchesScript(script, filterLowercase),
+    );
+    const filteredCategories = collection.getAllCategories().filter(
+      (category) => matchesCategory(category, filterLowercase),
+    );
+    return new AppliedFilterResult(
+      filteredScripts,
+      filteredCategories,
+      filter,
+    );
+  }
+}
+
+function matchesCategory(
+  category: Category,
+  filterLowercase: string,
+): boolean {
+  return matchesAny(
+    () => matchName(category.name, filterLowercase),
+    () => matchDocumentation(category, filterLowercase),
+  );
+}
+
+function matchesScript(
+  script: Script,
+  filterLowercase: string,
+): boolean {
+  return matchesAny(
+    () => matchName(script.name, filterLowercase),
+    () => matchCode(script.code, filterLowercase),
+    () => matchDocumentation(script, filterLowercase),
+  );
+}
+
+function matchesAny(
+  ...predicates: ReadonlyArray<() => boolean>
+): boolean {
+  return predicates.some((predicate) => predicate());
+}
+
+function matchName(
+  name: string,
+  filterLowercase: string,
+): boolean {
+  return name.toLowerCase().includes(filterLowercase);
+}
+
+function matchCode(
+  code: ScriptCode,
+  filterLowercase: string,
+): boolean {
+  if (code.execute.toLowerCase().includes(filterLowercase)) {
+    return true;
+  }
+  if (code.revert?.toLowerCase().includes(filterLowercase)) {
+    return true;
+  }
+  return false;
+}
+
+function matchDocumentation(
+  documentable: Documentable,
+  filterLowercase: string,
+): boolean {
+  return documentable.docs.some(
+    (doc) => doc.toLocaleLowerCase().includes(filterLowercase),
+  );
+}

src/application/Context/State/Filter/UserFilter.ts

@@ -1,56 +0,0 @@
-import { IScript } from '@/domain/IScript';
-import { EventSource } from '@/infrastructure/Events/EventSource';
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
-import { FilterResult } from './FilterResult';
-import { IFilterResult } from './IFilterResult';
-import { IUserFilter } from './IUserFilter';
-import { IFilterChangeDetails } from './Event/IFilterChangeDetails';
-import { FilterChange } from './Event/FilterChange';
-
-export class UserFilter implements IUserFilter {
-  public readonly filterChanged = new EventSource<IFilterChangeDetails>();
-
-  public currentFilter: IFilterResult | undefined;
-
-  constructor(private collection: ICategoryCollection) {
-
-  }
-
-  public applyFilter(filter: string): void {
-    if (!filter) {
-      throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter');
-    }
-    const filterLowercase = filter.toLocaleLowerCase();
-    const filteredScripts = this.collection.getAllScripts().filter(
-      (script) => isScriptAMatch(script, filterLowercase),
-    );
-    const filteredCategories = this.collection.getAllCategories().filter(
-      (category) => category.name.toLowerCase().includes(filterLowercase),
-    );
-    const matches = new FilterResult(
-      filteredScripts,
-      filteredCategories,
-      filter,
-    );
-    this.currentFilter = matches;
-    this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
-  }
-
-  public clearFilter(): void {
-    this.currentFilter = undefined;
-    this.filterChanged.notify(FilterChange.forClear());
-  }
-}
-
-function isScriptAMatch(script: IScript, filterLowercase: string) {
-  if (script.name.toLowerCase().includes(filterLowercase)) {
-    return true;
-  }
-  if (script.code.execute.toLowerCase().includes(filterLowercase)) {
-    return true;
-  }
-  if (script.code.revert) {
-    return script.code.revert.toLowerCase().includes(filterLowercase);
-  }
-  return false;
-}

src/application/Context/State/ICategoryCollectionState.ts

@@ -1,18 +1,18 @@
-import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import type { ICategoryCollection } from '@/domain/Collection/ICategoryCollection';
 import { OperatingSystem } from '@/domain/OperatingSystem';
-import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter';
+import type { IApplicationCode } from './Code/IApplicationCode';
-import { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection';
+import type { ReadonlyFilterContext, FilterContext } from './Filter/FilterContext';
-import { IApplicationCode } from './Code/IApplicationCode';
+import type { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection';
 
 export interface IReadOnlyCategoryCollectionState {
   readonly code: IApplicationCode;
   readonly os: OperatingSystem;
-  readonly filter: IReadOnlyUserFilter;
+  readonly filter: ReadonlyFilterContext;
   readonly selection: ReadonlyUserSelection;
   readonly collection: ICategoryCollection;
 }
 
 export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState {
-  readonly filter: IUserFilter;
+  readonly filter: FilterContext;
   readonly selection: UserSelection;
 }