win, linux, mac: fix typos and improve naming

- Use instruction format such as "do this, do that" to provide clear,
  direct instructions. This format minimize confusion and is easy to
  follow. They are specific and leave no room for interpretation,
  stating precisely what needs to be done without ambiguity.
- Fix typos and grammar issues.
- Improve consistency in script and category names.
- Revise sentences for more natural English language flow.
- Change brand name casing to match official branding.
- Change title case (all words start capitalized) to sentence case.
- Prioritize consistency over variations.
- Add minor documentation to explain scripts where the names are not
  clear.
- Add naming guidelines.

.editorconfig

@@ -1,7 +1,11 @@
-[*.{js,jsx,ts,tsx,vue}]
+[*.{js,jsx,ts,tsx,vue,sh}]
 indent_style = space
 indent_size = 2
 end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
 max_line_length = 100
+
+[{Dockerfile}]
+indent_style = space
+indent_size = 4

.eslintignore

@@ -1 +0,0 @@
-dist/

.eslintrc.cjs

@@ -0,0 +1,95 @@
+const { rules: baseStyleRules } = require('eslint-config-airbnb-base/rules/style');
+const tsconfigJson = require('./tsconfig.json');
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+    es2022: true, // add globals and sets parserOptions.ecmaVersion to 2022
+  },
+  extends: [
+    // Vue specific rules, eslint-plugin-vue
+    'plugin:vue/essential',
+
+    // Extends eslint-config-airbnb
+    '@vue/eslint-config-airbnb-with-typescript',
+
+    // Extends @typescript-eslint/recommended
+    // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    '@vue/typescript/recommended',
+  ],
+  rules: {
+    ...getOwnRules(),
+    ...getTurnedOffBrokenRules(),
+    ...getOpinionatedRuleOverrides(),
+    ...getTodoRules(),
+  },
+};
+
+function getOwnRules() {
+  return {
+    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'linebreak-style': ['error', 'unix'], // This is also enforced in .editorconfig and .gitattributes files
+    'import/order': [ // Enforce strict import order taking account into aliases
+      'error',
+      {
+        groups: [ // Enforce more strict order than AirBnb
+          'builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
+        pathGroups: [ // Fix manually configured paths being incorrectly grouped as "external"
+          ...getAliasesFromTsConfig(),
+          'js-yaml-loader!@/**',
+        ].map((pattern) => ({ pattern, group: 'internal' })),
+      },
+    ],
+  };
+}
+
+function getTodoRules() { // Should be worked on separate future commits
+  return {
+    'import/no-extraneous-dependencies': 'off',
+    // Accessibility improvements:
+    'vuejs-accessibility/form-control-has-label': 'off',
+    'vuejs-accessibility/click-events-have-key-events': 'off',
+    'vuejs-accessibility/anchor-has-content': 'off',
+    'vuejs-accessibility/accessible-emoji': 'off',
+  };
+}
+
+function getTurnedOffBrokenRules() {
+  return {
+    // Broken in TypeScript
+    'no-useless-constructor': 'off', // Cannot interpret TypeScript constructors
+    'no-shadow': 'off', // Fails with TypeScript enums
+  };
+}
+
+function getOpinionatedRuleOverrides() {
+  return {
+    // https://erkinekici.com/articles/linting-trap#no-use-before-define
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    // https://erkinekici.com/articles/linting-trap#arrow-body-style
+    'arrow-body-style': 'off',
+    // https://erkinekici.com/articles/linting-trap#no-plusplus
+    'no-plusplus': 'off',
+    // https://erkinekici.com/articles/linting-trap#no-param-reassign
+    'no-param-reassign': 'off',
+    // https://erkinekici.com/articles/linting-trap#class-methods-use-this
+    'class-methods-use-this': 'off',
+    // https://erkinekici.com/articles/linting-trap#importprefer-default-export
+    'import/prefer-default-export': 'off',
+    // https://erkinekici.com/articles/linting-trap#disallowing-for-of
+    // Original: https://github.com/airbnb/javascript/blob/d8cb404da74c302506f91e5928f30cc75109e74d/packages/eslint-config-airbnb-base/rules/style.js#L333-L351
+    'no-restricted-syntax': [
+      baseStyleRules['no-restricted-syntax'][0],
+      ...baseStyleRules['no-restricted-syntax'].slice(1).filter((rule) => rule.selector !== 'ForOfStatement'),
+    ],
+  };
+}
+
+function getAliasesFromTsConfig() {
+  return Object.keys(tsconfigJson.compilerOptions.paths)
+    .map((path) => `${path}*`);
+}

.eslintrc.js

@@ -1,298 +0,0 @@
-const { rules: baseBestPracticesRules } = require('eslint-config-airbnb-base/rules/best-practices');
-const { rules: baseErrorsRules } = require('eslint-config-airbnb-base/rules/errors');
-const { rules: baseES6Rules } = require('eslint-config-airbnb-base/rules/es6');
-const { rules: baseImportsRules } = require('eslint-config-airbnb-base/rules/imports');
-const { rules: baseStyleRules } = require('eslint-config-airbnb-base/rules/style');
-const { rules: baseVariablesRules } = require('eslint-config-airbnb-base/rules/variables');
-const tsconfigJson = require('./tsconfig.json');
-
-module.exports = {
-  root: true,
-  env: {
-    node: true,
-  },
-  extends: [
-    // Vue specific rules, eslint-plugin-vue
-    // Added by Vue CLI
-    'plugin:vue/essential',
-
-    // Extends eslint-config-airbnb
-    // Added by Vue CLI
-    // Here until https://github.com/vuejs/eslint-config-airbnb/issues/23 is done
-    '@vue/airbnb',
-
-    // Extends @typescript-eslint/recommended
-    // Uses the recommended rules from the @typescript-eslint/eslint-plugin
-    // Added by Vue CLI
-    '@vue/typescript/recommended',
-  ],
-  parserOptions: {
-    ecmaVersion: 12, // ECMA 2021
-    /*
-      Having 'latest' leads to:
-      ```
-        Parsing error: ecmaVersion must be a number. Received value of type string instead
-      ```
-      For .js files in the project
-    */
-  },
-  rules: {
-    ...getOwnRules(),
-    ...getTurnedOffBrokenRules(),
-    ...getOpinionatedRuleOverrides(),
-    ...getTodoRules(),
-  },
-  overrides: [
-    {
-      files: [
-        '**/__tests__/*.{j,t}s?(x)',
-        '**/tests/unit/**/*.spec.{j,t}s?(x)',
-      ],
-      env: {
-        mocha: true,
-      },
-    },
-    {
-      files: ['**/*.ts?(x)', '**/*.d.ts'],
-      parserOptions: {
-        // Setting project is required for some rules such as @typescript-eslint/dot-notation,
-        // @typescript-eslint/return-await and @typescript-eslint/no-throw-literal.
-        // If this property is missing they fail due to missing parser.
-        project: ['./tsconfig.json'],
-      },
-      rules: {
-        ...getTypeScriptOverrides(),
-      },
-    },
-    {
-      files: ['**/tests/**/*.{j,t}s?(x)'],
-      rules: {
-        'no-console': 'off',
-      },
-    },
-  ],
-};
-
-function getOwnRules() {
-  return {
-    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
-    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
-    'linebreak-style': ['error', 'unix'], // This is also enforced in .editorconfig and .gitattributes files
-    'import/order': [ // Enforce strict import order taking account into aliases
-      'error',
-      {
-        groups: [ // Enforce more strict order than AirBnb
-          'builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
-        pathGroups: [ // Fix manually configured paths being incorrectly grouped as "external"
-          ...getAliasesFromTsConfig(),
-          'js-yaml-loader!@/**',
-        ].map((pattern) => ({ pattern, group: 'internal' })),
-      },
-    ],
-  };
-}
-
-function getTodoRules() { // Should be worked on separate future commits
-  return {
-    'import/no-extraneous-dependencies': 'off',
-    // Accessibility improvements:
-    'vuejs-accessibility/form-control-has-label': 'off',
-    'vuejs-accessibility/click-events-have-key-events': 'off',
-    'vuejs-accessibility/anchor-has-content': 'off',
-    'vuejs-accessibility/accessible-emoji': 'off',
-  };
-}
-
-function getTurnedOffBrokenRules() {
-  return {
-    // Broken in TypeScript
-    'no-useless-constructor': 'off', // Cannot interpret TypeScript constructors
-    'no-shadow': 'off', // Fails with TypeScript enums
-  };
-}
-
-function getOpinionatedRuleOverrides() {
-  return {
-    // https://erkinekici.com/articles/linting-trap#no-use-before-define
-    'no-use-before-define': 'off',
-    // https://erkinekici.com/articles/linting-trap#arrow-body-style
-    'arrow-body-style': 'off',
-    // https://erkinekici.com/articles/linting-trap#no-plusplus
-    'no-plusplus': 'off',
-    // https://erkinekici.com/articles/linting-trap#no-param-reassign
-    'no-param-reassign': 'off',
-    // https://erkinekici.com/articles/linting-trap#class-methods-use-this
-    'class-methods-use-this': 'off',
-    // https://erkinekici.com/articles/linting-trap#importprefer-default-export
-    'import/prefer-default-export': 'off',
-    // https://erkinekici.com/articles/linting-trap#disallowing-for-of
-    // Original: https://github.com/airbnb/javascript/blob/d8cb404da74c302506f91e5928f30cc75109e74d/packages/eslint-config-airbnb-base/rules/style.js#L333-L351
-    'no-restricted-syntax': [
-      baseStyleRules['no-restricted-syntax'][0],
-      ...baseStyleRules['no-restricted-syntax'].slice(1).filter((rule) => rule.selector !== 'ForOfStatement'),
-    ],
-  };
-}
-
-function getTypeScriptOverrides() {
-  /*
-    Here until Vue supports AirBnb Typescript overrides (vuejs/eslint-config-airbnb#23).
-    Based on `eslint-config-airbnb-typescript`.
-      Source: https://github.com/iamturns/eslint-config-airbnb-typescript/blob/v16.1.0/lib/shared.js
-      It cannot be used directly due to compilation errors.
-  */
-  return {
-    'brace-style': 'off',
-    '@typescript-eslint/brace-style': baseStyleRules['brace-style'],
-
-    camelcase: 'off',
-    '@typescript-eslint/naming-convention': [
-      'error',
-      { selector: 'variable', format: ['camelCase', 'PascalCase', 'UPPER_CASE'] },
-      { selector: 'function', format: ['camelCase', 'PascalCase'] },
-      { selector: 'typeLike', format: ['PascalCase'] },
-    ],
-
-    'comma-dangle': 'off',
-    '@typescript-eslint/comma-dangle': [
-      baseStyleRules['comma-dangle'][0],
-      {
-        ...baseStyleRules['comma-dangle'][1],
-        enums: baseStyleRules['comma-dangle'][1].arrays,
-        generics: baseStyleRules['comma-dangle'][1].arrays,
-        tuples: baseStyleRules['comma-dangle'][1].arrays,
-      },
-    ],
-
-    'comma-spacing': 'off',
-    '@typescript-eslint/comma-spacing': baseStyleRules['comma-spacing'],
-
-    'default-param-last': 'off',
-    '@typescript-eslint/default-param-last': baseBestPracticesRules['default-param-last'],
-
-    'dot-notation': 'off',
-    '@typescript-eslint/dot-notation': baseBestPracticesRules['dot-notation'],
-
-    'func-call-spacing': 'off',
-    '@typescript-eslint/func-call-spacing': baseStyleRules['func-call-spacing'],
-
-    // ❌ Broken for some cases, but still useful.
-    // Here until Prettifier is used.
-    indent: 'off',
-    '@typescript-eslint/indent': baseStyleRules.indent,
-
-    'keyword-spacing': 'off',
-    '@typescript-eslint/keyword-spacing': baseStyleRules['keyword-spacing'],
-
-    'lines-between-class-members': 'off',
-    '@typescript-eslint/lines-between-class-members': baseStyleRules['lines-between-class-members'],
-
-    'no-array-constructor': 'off',
-    '@typescript-eslint/no-array-constructor': baseStyleRules['no-array-constructor'],
-
-    'no-dupe-class-members': 'off',
-    '@typescript-eslint/no-dupe-class-members': baseES6Rules['no-dupe-class-members'],
-
-    'no-empty-function': 'off',
-    '@typescript-eslint/no-empty-function': baseBestPracticesRules['no-empty-function'],
-
-    'no-extra-parens': 'off',
-    '@typescript-eslint/no-extra-parens': baseErrorsRules['no-extra-parens'],
-
-    'no-extra-semi': 'off',
-    '@typescript-eslint/no-extra-semi': baseErrorsRules['no-extra-semi'],
-
-    // ❌ Fails due to missing parser
-    // 'no-implied-eval': 'off',
-    // 'no-new-func': 'off',
-    // '@typescript-eslint/no-implied-eval': baseBestPracticesRules['no-implied-eval'],
-
-    'no-loss-of-precision': 'off',
-    '@typescript-eslint/no-loss-of-precision': baseErrorsRules['no-loss-of-precision'],
-
-    'no-loop-func': 'off',
-    '@typescript-eslint/no-loop-func': baseBestPracticesRules['no-loop-func'],
-
-    'no-magic-numbers': 'off',
-    '@typescript-eslint/no-magic-numbers': baseBestPracticesRules['no-magic-numbers'],
-
-    'no-redeclare': 'off',
-    '@typescript-eslint/no-redeclare': baseBestPracticesRules['no-redeclare'],
-
-    // ESLint variant does not work with TypeScript enums.
-    'no-shadow': 'off',
-    '@typescript-eslint/no-shadow': baseVariablesRules['no-shadow'],
-
-    'no-throw-literal': 'off',
-    '@typescript-eslint/no-throw-literal': baseBestPracticesRules['no-throw-literal'],
-
-    'no-unused-expressions': 'off',
-    '@typescript-eslint/no-unused-expressions': baseBestPracticesRules['no-unused-expressions'],
-
-    'no-unused-vars': 'off',
-    '@typescript-eslint/no-unused-vars': baseVariablesRules['no-unused-vars'],
-
-    // https://erkinekici.com/articles/linting-trap#no-use-before-define
-    // 'no-use-before-define': 'off',
-    // '@typescript-eslint/no-use-before-define': baseVariablesRules['no-use-before-define'],
-
-    // ESLint variant does not understand TypeScript constructors.
-    // eslint/eslint/#14118, typescript-eslint/typescript-eslint#873
-    'no-useless-constructor': 'off',
-    '@typescript-eslint/no-useless-constructor': baseES6Rules['no-useless-constructor'],
-
-    quotes: 'off',
-    '@typescript-eslint/quotes': baseStyleRules.quotes,
-
-    semi: 'off',
-    '@typescript-eslint/semi': baseStyleRules.semi,
-
-    'space-before-function-paren': 'off',
-    '@typescript-eslint/space-before-function-paren': baseStyleRules['space-before-function-paren'],
-
-    'require-await': 'off',
-    '@typescript-eslint/require-await': baseBestPracticesRules['require-await'],
-
-    'no-return-await': 'off',
-    '@typescript-eslint/return-await': baseBestPracticesRules['no-return-await'],
-
-    'space-infix-ops': 'off',
-    '@typescript-eslint/space-infix-ops': baseStyleRules['space-infix-ops'],
-
-    'object-curly-spacing': 'off',
-    '@typescript-eslint/object-curly-spacing': baseStyleRules['object-curly-spacing'],
-
-    'import/extensions': [
-      baseImportsRules['import/extensions'][0],
-      baseImportsRules['import/extensions'][1],
-      {
-        ...baseImportsRules['import/extensions'][2],
-        ts: 'never',
-        tsx: 'never',
-      },
-    ],
-
-    // Changes required is not yet implemented:
-    // 'import/no-extraneous-dependencies': [
-    //   baseImportsRules['import/no-extraneous-dependencies'][0],
-    //   {
-    //     ...baseImportsRules['import/no-extraneous-dependencies'][1],
-    //     devDependencies: baseImportsRules[
-    //       'import/no-extraneous-dependencies'
-    //     ][1].devDependencies.reduce((result, devDep) => {
-    //       const toAppend = [devDep];
-    //       const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, 'ts$1');
-    //       if (devDepWithTs !== devDep) {
-    //         toAppend.push(devDepWithTs);
-    //       }
-    //       return [...result, ...toAppend];
-    //     }, []),
-    //   },
-    // ],
-  };
-}
-
-function getAliasesFromTsConfig() {
-  return Object.keys(tsconfigJson.compilerOptions.paths)
-    .map((path) => `${path}*`);
-}

.github/actions/npm-install-dependencies/action.yml

@@ -0,0 +1,12 @@
+inputs:
+  working-directory:
+    required: false
+    default: '.'
+runs:
+  using: composite
+  steps:
+    -
+      name: Run `npm ci` with retries
+      shell: bash
+      run: npm run install-deps -- --ci
+      working-directory: ${{ inputs.working-directory }}

.github/workflows/checks.build.yaml

@@ -1,4 +1,4 @@
-name: build-checks
+name: checks.build
 
 on:
   push:
@@ -9,7 +9,13 @@ jobs:
     strategy:
       matrix:
         os: [ macos, ubuntu, windows ]
-        mode: [ development, test, production ]
+        mode: [
+          # Vite mode: https://vitejs.dev/guide/env-and-mode.html
+          development,  # Used by `dev` command
+          production,   # Used by `build` command
+          # Vitest mode: https://vitest.dev/guide/cli.html
+          test,         # Used by Vitest
+        ]
       fail-fast: false # Allows to see results from other combinations
     runs-on: ${{ matrix.os }}-latest
     steps:
@@ -21,17 +27,23 @@ jobs:
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        run: npm ci
+        uses: ./.github/actions/npm-install-dependencies
       -
-        name: Build
+        name: Build web
         run: npm run build -- --mode ${{ matrix.mode }}
+      -
+        name: Verify web build artifacts
+        run: npm run check:verify-build-artifacts -- --web
 
-  # A new job is used due to environments/modes different from Vue CLI, https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
   build-desktop:
     strategy:
       matrix:
         os: [ macos, ubuntu, windows ]
-        mode: [ development, production ] # "test" is not supported https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1627
+        mode: [
+          # electron-vite modes: https://electron-vite.org/guide/env-and-mode.html#global-env-variables
+          development,  # Used by `dev` command
+          production,   # Used by `build` and `preview` commands
+        ]
       fail-fast: false # Allows to see results from other combinations
     runs-on: ${{ matrix.os }}-latest
     steps:
@@ -43,21 +55,24 @@ jobs:
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        run: npm ci
+        uses: ./.github/actions/npm-install-dependencies
       -
-        name: Install cross-env
+        name: Prebuild desktop
-        # Used to set NODE_ENV due to https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
+        run: npm run electron:prebuild -- --mode ${{ matrix.mode }}
-        run: npm install --global cross-env
       -
-        name: Build
+        name: Verify unbundled desktop build artifacts
-        run: |-  
+        run: npm run check:verify-build-artifacts -- --electron-unbundled
-          cross-env-shell NODE_ENV=${{ matrix.mode }}
+      -
-          npm run electron:build -- --publish never --mode ${{ matrix.mode }}
+        name: Build (bundle and package) desktop application
+        run: npm run electron:build -- --publish never
+      -
+        name: Verify bundled desktop build artifacts
+        run: npm run check:verify-build-artifacts -- --electron-bundled
 
-  create-icons:
+  build-docker:
     strategy:
       matrix:
-        os: [ macos, ubuntu, windows ]
+        os: [ macos, ubuntu ] # Windows runners do not support Linux containers
       fail-fast: false # Allows to see results from other combinations
     runs-on: ${{ matrix.os }}-latest
     steps:
@@ -65,11 +80,21 @@ jobs:
         name: Checkout
         uses: actions/checkout@v2
       -
-        name: Setup node
+        name: Install Docker on macOS
-        uses: ./.github/actions/setup-node
+        if: matrix.os == 'macos' # macOS runner is missing Docker
+        run: |-
+          # Install Docker
+          brew install docker
+          # Docker on macOS misses daemon due to licensing, so install colima as runtime
+          brew install colima
+          # Start the daemon
+          colima start
       -
-        name: Install dependencies
+        name: Build Docker image
-        run: npm ci
+        run: docker build -t undergroundwires/privacy.sexy:latest .
       -
-        name: Create icons
+        name: Run Docker image on port 8080
-        run: npm run create-icons
+        run: docker run -d -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest
+      -
+        name: Check server is up and returns HTTP 200
+        run: node ./scripts/verify-web-server-status.js --url http://localhost:8080

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

@@ -0,0 +1,72 @@
+name: checks.desktop-runtime-errors
+# Verifies desktop builds for Electron applications across multiple OS platforms (macOS ,Ubuntu, and Windows).
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  run-check:
+    strategy:
+      matrix:
+        os: [ macos, ubuntu, windows ]
+      fail-fast: false # Allows to see results from other combinations
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Install dependencies
+        uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Configure Ubuntu
+        if: matrix.os == 'ubuntu'
+        shell: bash
+        run: |-
+          sudo apt update
+
+          # Configure AppImage dependencies
+          sudo apt install -y libfuse2
+
+          # Configure DBUS (fixes `Failed to connect to the bus: Could not parse server address: Unknown address type`)
+           if ! command -v 'dbus-launch' &> /dev/null; then
+            echo 'DBUS does not exist, installing...'
+            sudo apt install -y dbus-x11 # Gives both dbus and dbus-launch utility
+          fi
+          sudo systemctl start dbus
+          DBUS_LAUNCH_OUTPUT=$(dbus-launch)
+          if [ $? -eq 0 ]; then
+            echo "${DBUS_LAUNCH_OUTPUT}" >> $GITHUB_ENV
+          else
+            echo 'Error: dbus-launch command did not execute successfully. Exiting.' >&2
+            echo "${DBUS_LAUNCH_OUTPUT}" >&2
+            exit 1
+          fi
+
+          # Configure fake (virtual) display
+          sudo apt install -y xvfb
+          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
+      -
+        name: Test
+        shell: bash
+        run: |-
+          export SCREENSHOT=true
+          npm run check:desktop
+      -
+        name: Upload screenshot
+        if: always() # Run even if previous step fails
+        uses: actions/upload-artifact@v3
+        with:
+          name: screenshot-${{ matrix.os }}
+          path: screenshot.png

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

@@ -0,0 +1,22 @@
+name: checks.external-urls
+
+on:
+  schedule:
+    - cron: '0 0 * * 0' # at 00:00 on every Sunday
+
+jobs:
+  run-check:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Install dependencies
+        uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Test
+        run: npm run check:external-urls

.github/workflows/checks.quality.yaml

@@ -16,11 +16,15 @@ jobs:
         os: [ macos, ubuntu, windows ]
       fail-fast: false # Still interested to see results from other combinations
     steps:
-      - name: Checkout
+      -
+        name: Checkout
         uses: actions/checkout@v2
-      - name: Setup node
+      -
+        name: Setup node
         uses: ./.github/actions/setup-node
-      - name: Install dependencies
+      -
-        run: npm ci
+        name: Install dependencies
-      - name: Lint
+        uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Lint
         run: ${{ matrix.lint-command }}

.github/workflows/checks.scripts.yaml

@@ -0,0 +1,55 @@
+name: checks.scripts
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  icons-build:
+    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@v2
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Install dependencies
+        uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Create icons
+        run: npm run icons:build
+
+  install-deps:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        install-deps-before: [true, false]
+        install-command:
+          - npm run install-deps
+          - npm run install-deps -- --no-errors
+          - npm run install-deps -- --ci
+          - npm run install-deps -- --fresh --non-deterministic
+          - npm run install-deps -- --fresh
+          - npm run install-deps -- --non-deterministic
+        os: [ macos, ubuntu, windows ]
+      fail-fast: false # Still interested to see results from other combinations
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Install dependencies
+        if: matrix.install-deps-before == true
+        uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Run install-deps
+        run: ${{ matrix.install-command }}

.github/workflows/checks.security.dependencies.yaml

@@ -1,4 +1,4 @@
-name: security-checks
+name: checks.security.dependencies
 
 on:
   push:
@@ -19,4 +19,4 @@ jobs:
         uses: ./.github/actions/setup-node
       -
         name: NPM audit
-        run: exit "$(npm audit)" # Since node 15.x, it does not fail with error if we don't explicitly exit
+        run:  npm audit --omit=dev

.github/workflows/checks.security.sast.yaml

@@ -0,0 +1,42 @@
+name: checks.security.sast
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0' # at 00:00 on every Sunday
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [
+          javascript # analyzes code written in JavaScript, TypeScript and both.
+        ]
+
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+      -
+        name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+      -
+        name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

.github/workflows/release.desktop.yaml

@@ -13,20 +13,29 @@ jobs:
       fail-fast: false # So publish runs for other OSes if one fails
     runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@v2
+      -
+        uses: actions/checkout@v2
         with:
           ref: master # otherwise it defaults to the version tag missing bump commit
           fetch-depth: 0 # fetch all history
-      - name: Checkout to bump commit
+      -
+        name: Checkout to bump commit
         run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
-      - name: Setup node
+      -
+        name: Setup node
         uses: ./.github/actions/setup-node
-      - name: Install dependencies
+      -
-        run: npm ci
+        name: Install dependencies
-      - name: Run unit tests
+        uses: ./.github/actions/npm-install-dependencies
+      -
+        name: Run unit tests
         run: npm run test:unit
-      - name: Publish desktop app
+      -
-        run: npm run electron:build -- -p always # https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/recipes.html#upload-release-to-github
+        name: Prebuild
+        run: npm run electron:prebuild
+      -
+        name: Build and publish
+        run: npm run electron:build -- --publish always
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           EP_GH_IGNORE_TIME: true # Otherwise publishing fails if GitHub release is more than 2 hours old https://github.com/electron-userland/electron-builder/issues/2074

.github/workflows/release.site.yaml

@@ -84,8 +84,9 @@ jobs:
         uses: ./app/.github/actions/setup-node
       -
         name: "App: Install dependencies"
-        run: npm ci
+        uses: ./app/.github/actions/npm-install-dependencies
-        working-directory: app
+        with:
+          working-directory: app
       -
         name: "App: Run unit tests"
         run: npm run test:unit
@@ -94,11 +95,21 @@ jobs:
         name: "App: Build"
         run: npm run build
         working-directory: app
+      -
+        name: "App: Verify web build artifacts"
+        run: npm run check:verify-build-artifacts -- --web
+        working-directory: app
       -
         name: "App: Deploy to S3"
+        shell: bash
         run: >-
+          declare web_output_dir
+          if ! web_output_dir=$(cd app && node scripts/print-dist-dir.js --web); then
+            echo 'Error: Could not determine distribution directory.'
+            exit 1
+          fi
           bash "aws/scripts/deploy/deploy-to-s3.sh" \
-            --folder app/dist \
+            --folder "${web_output_dir}" \
             --web-stack-name privacysexy-web-stack --web-stack-s3-name-output-name S3BucketName \
             --storage-class ONEZONE_IA \
             --role-arn ${{secrets.AWS_S3_SITE_DEPLOYMENT_ROLE_ARN}} \

.github/workflows/tests.e2e.yaml

@@ -20,7 +20,7 @@ jobs:
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        run: npm ci
+        uses: ./.github/actions/npm-install-dependencies
       -
         name: Run e2e tests
-        run: npm run test:e2e -- --headless
+        run: npm run test:cy:run

.github/workflows/tests.integration.yaml

@@ -22,7 +22,7 @@ jobs:
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        run: npm ci
+        uses: ./.github/actions/npm-install-dependencies
       -
         name: Run integration tests
         run: npm run test:integration

.github/workflows/tests.unit.yaml

@@ -20,7 +20,7 @@ jobs:
         uses: ./.github/actions/setup-node
       -
         name: Install dependencies
-        run: npm ci
+        uses: ./.github/actions/npm-install-dependencies
       -
         name: Run unit tests
         run: npm run test:unit

.gitignore

@@ -1,10 +1,5 @@
 node_modules
-dist/
+/dist-*/
 .vs
 .vscode/**/*
 !.vscode/extensions.json
-#Electron-builder output
-/dist_electron
-# Cypress
-/tests/e2e/screenshots
-/tests/e2e/videos

.vscode/extensions.json

@@ -11,8 +11,8 @@
     "dbaeumer.vscode-eslint",           // Lints JavaScript/TypeScript.
     "pmneo.tsimporter",                 // Provides better auto-complete for TypeScripts imports.
     // Vue
-    "jcbuisson.vue",                    // Highlights syntax.
+    "Vue.volar",                        // Official Vue extensions
-    "octref.vetur",                     // Adds Vetur, Vue tooling support.
+    "Vue.vscode-typescript-vue-plugin", // Official TypeScript Vue Plugin
     // Scripting
     "timonwong.shellcheck",             // Lints bash files.
     "ms-vscode.powershell",             // Lints PowerShell files.

CHANGELOG.md

@@ -1,5 +1,103 @@
 # Changelog
 
+## 0.12.4 (2023-09-25)
+
+* win: fix Windows spotlight revert, docs, recommend | [659fea7](https://github.com/undergroundwires/privacy.sexy/commit/659fea7afcabcd0ea273cfdcc8c4bae190c126f3)
+* win: fix Edge telemetry disabling for v116+ #242 | [6d301f9](https://github.com/undergroundwires/privacy.sexy/commit/6d301f99616ed49975876803d0098eafe4d3cb2e)
+* win: fix, improve disabling automatic updates #252 | [6e9b65d](https://github.com/undergroundwires/privacy.sexy/commit/6e9b65d8b1b481c1471dde90876c37838b4ac4e5)
+* win: refactor `update.mode` key for VSCode #215 | [c27172c](https://github.com/undergroundwires/privacy.sexy/commit/c27172c32e7c316b7cb0f44cab611eed89ca034e)
+* Fix wrong action path in website CI deployment | [a1f2497](https://github.com/undergroundwires/privacy.sexy/commit/a1f24973813ccbdd7e1f06c64e1912a991a6bb64)
+* Fix compiler bug with nested optional arguments | [53222fd](https://github.com/undergroundwires/privacy.sexy/commit/53222fd83c2846089746a217482195806f960d18)
+* Fix no spacing after lists in documentation text | [f810ed0](https://github.com/undergroundwires/privacy.sexy/commit/f810ed0c147c2a46cae3b70b635ed81128646fff)
+* Rewrite tooltip UI for efficiency and Vue 3.0 #230 | [8b930fc](https://github.com/undergroundwires/privacy.sexy/commit/8b930fc57c8ee6691ed6165bcb27d97e64a1a0c0)
+* win: fix uninstallation of newer Edge #236 | [60dde11](https://github.com/undergroundwires/privacy.sexy/commit/60dde11311a2409537f5965f370b0daaaec53339)
+* win: fix delivery optimization side-effects #173 | [203daeb](https://github.com/undergroundwires/privacy.sexy/commit/203daeb4a2fca0a0295cbc2a736394f9f87725e6)
+* win: fix Defender scan artifacts removal #246 | [cb21a97](https://github.com/undergroundwires/privacy.sexy/commit/cb21a970b6b867e1476a5eb8a72b9a7fdd53a744)
+* Fix outdated and broken links in README #161 | [0303ef2](https://github.com/undergroundwires/privacy.sexy/commit/0303ef2fd98b36306523e2a0c5f5ae812a4c6c99)
+* Fix loss of tree node state when switching views | [8f188ac](https://github.com/undergroundwires/privacy.sexy/commit/8f188acd3c2d93e40c89569c74bc5cff992f0052)
+* Fix slow appearance of nodes on tree view | [bd2082e](https://github.com/undergroundwires/privacy.sexy/commit/bd2082e8c574db065bb4462f30ea3ace2cb028cb)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.3...0.12.4)
+
+## 0.12.3 (2023-09-09)
+
+* linux: use user.js over prefs.js for Firefox #232 | [dae6d11](https://github.com/undergroundwires/privacy.sexy/commit/dae6d114daab6857d773071211eb57619b136281)
+* win: fix typo in Defender retention script #213 | [35be05d](https://github.com/undergroundwires/privacy.sexy/commit/35be05df2094ea8bba4ee4725e6fa4956a79493d)
+* Improve desktop runtime execution tests | [ad0576a](https://github.com/undergroundwires/privacy.sexy/commit/ad0576a752f8fd6ea2f917a59173fe61f9951246)
+* Fix Windows artifact naming in desktop packaging | [f4d86fc](https://github.com/undergroundwires/privacy.sexy/commit/f4d86fccfd0e73e94c8c6e400a33514900bc5abe)
+* Refactor and improve external URL checks | [19e42c9](https://github.com/undergroundwires/privacy.sexy/commit/19e42c9c52a18c813ded4265e687e01032cdd4c8)
+* Fix memory leaks via auto-unsubscribing and DI | [eb096d0](https://github.com/undergroundwires/privacy.sexy/commit/eb096d07e276e1b4c8040220c47f186d02841e14)
+* Refactor build configs and improve CI/CD checks | [0a2a1a0](https://github.com/undergroundwires/privacy.sexy/commit/0a2a1a026b0efb29624be82b06536c518c1ea439)
+* Introduce retry mechanism for npm install in CI/CD | [4beb1bb](https://github.com/undergroundwires/privacy.sexy/commit/4beb1bb5748a60886210187ca3cdc7f4b41067c0)
+* win: fix disable recent apps revert #211, #248 | [4ce327e](https://github.com/undergroundwires/privacy.sexy/commit/4ce327eb6af542ed2916d649553e5e1ba5833882)
+* Change license to AGPLv3 | [821cc62](https://github.com/undergroundwires/privacy.sexy/commit/821cc62c4c8347cb76d041f82f574754e4d948c5)
+* Introduce new TreeView UI component | [65f121c](https://github.com/undergroundwires/privacy.sexy/commit/65f121c451af87315e1c91df4198562e0445b2c2)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.2...0.12.3)
+
+## 0.12.2 (2023-08-25)
+
+* Add automated checks for desktop app runtime #233 | [04b3133](https://github.com/undergroundwires/privacy.sexy/commit/04b3133500485d0d278a81a177a1677134131405)
+* win: fix automatic updates revert #234 | [0873769](https://github.com/undergroundwires/privacy.sexy/commit/08737698c2283bdf535d1611a730031ebfc7c0df)
+* Migrate unit/integration tests to Vitest with Vite | [5f11c8d](https://github.com/undergroundwires/privacy.sexy/commit/5f11c8d98f782dd7c77f27649a1685fb7bd06e13)
+* Remove Vue ESLint plugin for Vite compatibility | [6e40edd](https://github.com/undergroundwires/privacy.sexy/commit/6e40edd3f8a063c1b7482c27d8368e14c2fbcfbf)
+* Migrate web builds from Vue CLI to Vite | [7365905](https://github.com/undergroundwires/privacy.sexy/commit/736590558be51a09435bb87e78b6655e8533bc2e)
+* Migrate Cypress (E2E) tests to Vite and TypeScript | [ec98d84](https://github.com/undergroundwires/privacy.sexy/commit/ec98d8417f779fa818ccdda6bb90f521e1738002)
+* Migrate to `electron-vite` and `electron-builder` | [75c9b51](https://github.com/undergroundwires/privacy.sexy/commit/75c9b51bf2d1dc7269adfd7b5ed71acfb5031299)
+* Fix searching/filtering bugs #235 | [62f8bfa](https://github.com/undergroundwires/privacy.sexy/commit/62f8bfac2f481c93598fe19a51594769f522d684)
+* Improve desktop security by isolating Electron | [e9e0001](https://github.com/undergroundwires/privacy.sexy/commit/e9e0001ef845fa6935c59a4e20a89aac9e71756a)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.1...0.12.2)
+
+## 0.12.1 (2023-08-17)
+
+* Transition to eslint-config-airbnb-with-typescript | [ff84f56](https://github.com/undergroundwires/privacy.sexy/commit/ff84f5676e496dd7ec5b3599e34ec9627d181ea2)
+* Improve user privacy with secure outbound links | [3a594ac](https://github.com/undergroundwires/privacy.sexy/commit/3a594ac7fd708dc1e98155ffb9b21acd4e1fcf2d)
+* Refactor Vue components using Composition API #230 | [1b9be8f](https://github.com/undergroundwires/privacy.sexy/commit/1b9be8fe2d72d8fb5cf1fed6dcc0b9777171aa98)
+* Fix failing security tests | [3bc8da4](https://github.com/undergroundwires/privacy.sexy/commit/3bc8da4cbf1e2bd758dc3fffe4b1e62dc3beb7b3)
+* Improve Defender scripts #201 | [061afad](https://github.com/undergroundwires/privacy.sexy/commit/061afad9673a41454c2421c318898f2b4f4cf504)
+* Fix failing tests due to failed error logging | [986ba07](https://github.com/undergroundwires/privacy.sexy/commit/986ba078a643de6acbee50fff9cf77494ca7ea7f)
+* Implement custom lightweight modal #230 | [9e5491f](https://github.com/undergroundwires/privacy.sexy/commit/9e5491fdbf2d9d40d974f5ad0e879a6d5c6d1e55)
+* Refactor usage of tooltips for flexibility | [bc91237](https://github.com/undergroundwires/privacy.sexy/commit/bc91237d7c54bdcd15c5c39a55def50d172bb659)
+* Fix revert toggle partial rendering | [39e650c](https://github.com/undergroundwires/privacy.sexy/commit/39e650cf110bee6b1b21d9b2902b36b0e2568d54)
+* Increase testability through dependency injection | [ae75059](https://github.com/undergroundwires/privacy.sexy/commit/ae75059cc14db41f55dd2056f528442c7d319dd2)
+* Refactor filter (search query) event handling | [6a20d80](https://github.com/undergroundwires/privacy.sexy/commit/6a20d804dc365d22c1248d787f9912271f508eeb)
+* Migrate to ES6 modules | [a14929a](https://github.com/undergroundwires/privacy.sexy/commit/a14929a13cc6260b514692d9b4f1cdf5fb85d8b2)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.0...0.12.1)
+
+## 0.12.0 (2023-08-03)
+
+* Improve script/category name validation | [b210aad](https://github.com/undergroundwires/privacy.sexy/commit/b210aaddf26629179f77fe19f62f65d8a0ca2b87)
+* Improve touch like hover on devices without mouse | [99e24b4](https://github.com/undergroundwires/privacy.sexy/commit/99e24b4134c461c336f6d08f49d193d853325d31)
+* Improve click/touch without unintended interaction | [3233d9b](https://github.com/undergroundwires/privacy.sexy/commit/3233d9b8024dd59600edddef6d017e0089f59a9d)
+* Align card icons vertically in cards view | [8608072](https://github.com/undergroundwires/privacy.sexy/commit/8608072bfb52d10a843a86d3d89b14e8b9776779)
+* Fix broken npm installation and builds | [924b326](https://github.com/undergroundwires/privacy.sexy/commit/924b326244a175428175e0df3a50685ee5ac2ec6)
+* Improve documentation support with markdown | [6067bdb](https://github.com/undergroundwires/privacy.sexy/commit/6067bdb24e6729d2249c9685f4f1c514c3167d91)
+* win: add more Visual Studio scripts, support 2022 | [df533ad](https://github.com/undergroundwires/privacy.sexy/commit/df533ad3b19cebdf3454895aa2182bd4184e0360)
+* win: add script to remove Widgets | [bbc6156](https://github.com/undergroundwires/privacy.sexy/commit/bbc6156281fb3fd4b66c63dec3f765780fafa855)
+* Use line endings based on script language #88 | [6b3f465](https://github.com/undergroundwires/privacy.sexy/commit/6b3f4659df0afe1c99a8af6598df44a33c1f863a)
+* win: improve OneDrive removal | [58ed7b4](https://github.com/undergroundwires/privacy.sexy/commit/58ed7b456b3cf11774c83c8c1c04db37ef3058c2)
+* Use lowercase in script names and search text | [430537f](https://github.com/undergroundwires/privacy.sexy/commit/430537f70411756bbcaae837964c0223f78581e8)
+* Improve manual execution instructions | [7d3670c](https://github.com/undergroundwires/privacy.sexy/commit/7d3670c26d0151ddc43303e8ed5e47715f0e0f00)
+* Add multiline support for with expression | [e8d06e0](https://github.com/undergroundwires/privacy.sexy/commit/e8d06e0f3e178a69861e0197f9d1cce9af3958f1)
+* Break line in inline codes in documentation | [c1c2f29](https://github.com/undergroundwires/privacy.sexy/commit/c1c2f2925fe88ec1f56bf7655b6b9a10aa3ea024)
+* win: add script to increase RSA key exchange #165 | [a2e0921](https://github.com/undergroundwires/privacy.sexy/commit/a2e092190d8eb0fc9ceb8533572f04fff52f097b)
+* win: add scripts to downloaded file handling #153 | [e7b816d](https://github.com/undergroundwires/privacy.sexy/commit/e7b816d1564afa98c63291f9d7fd6f3fee92f4ec)
+* Drop support for dead browsers | [bf0c55f](https://github.com/undergroundwires/privacy.sexy/commit/bf0c55fa60bf2be070678ba27db14baf13fec511)
+* Add support for nested templates | [68a5d69](https://github.com/undergroundwires/privacy.sexy/commit/68a5d698a2ce644ce25754016fb9e9bb642e41a7)
+* mac: add scripts to configure Parallels Desktop | [64cca1d](https://github.com/undergroundwires/privacy.sexy/commit/64cca1d9b8946b92e21e86deb6db5612570befb1)
+* Rework icon with higher quality and new color | [f4a7ca7](https://github.com/undergroundwires/privacy.sexy/commit/f4a7ca76b885b8346d8a9c32e6269eabc2d8139f)
+* Relax and improve code validation | [e819993](https://github.com/undergroundwires/privacy.sexy/commit/e8199932b462380741d9f2d8b6b55485ab16af02)
+* Add initial Linux support #150 | [c404dfe](https://github.com/undergroundwires/privacy.sexy/commit/c404dfebe2908bb165279f8279f3f5e805b647d7)
+* mac: add script to disable personalized ads | [8b374a3](https://github.com/undergroundwires/privacy.sexy/commit/8b374a37b401699d5056bfd6b735b6a26c395ae0)
+* Update dependencies and add npm setup script | [5721796](https://github.com/undergroundwires/privacy.sexy/commit/57217963787a8ab0c71d681c6b1673c484c88226)
+* Fix macOS desktop build failure in CI | [5901dc5](https://github.com/undergroundwires/privacy.sexy/commit/5901dc5f11dd29be14c2616fc0ceb45196a43224)
+* Change subtitle heading to new slogan | [1e80ee1](https://github.com/undergroundwires/privacy.sexy/commit/1e80ee1fb0208d92943619468dc427853cbe8de7)
+* win: add new scripts to disable more telemetry | [298b058](https://github.com/undergroundwires/privacy.sexy/commit/298b058e5c89397db6f759b275442ba05499ac8c)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.11.4...0.12.0)
+
 ## 0.11.4 (2022-03-08)
 
 * Improve performance of selecting scripts | [8e96c19](https://github.com/undergroundwires/privacy.sexy/commit/8e96c19126aa4cba6418de5ccaa9e2dcf8faab78)

Dockerfile

@@ -1,13 +1,16 @@
 # Build
-FROM node:lts-alpine as build-stage
+FROM node:lts-alpine AS build-stage
 WORKDIR /app
-COPY package*.json ./
-RUN npm install
 COPY . .
-RUN npm run build
+RUN npm run install-deps
+RUN npm run build \
+    && npm run check:verify-build-artifacts -- --web
+RUN mkdir /dist \
+    && dist_directory=$(node 'scripts/print-dist-dir.js' --web) \
+    && cp -a "${dist_directory}/." '/dist'
 
 # Production stage
-FROM nginx:stable-alpine as production-stage
+FROM nginx:stable-alpine AS production-stage
-COPY --from=build-stage /app/dist /usr/share/nginx/html
+COPY --from=build-stage /dist /usr/share/nginx/html
 EXPOSE 80
 CMD ["nginx", "-g", "daemon off;"]

LICENSE

@@ -1,5 +1,5 @@
-                    GNU GENERAL PUBLIC LICENSE
+                    GNU AFFERO GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+                       Version 3, 19 November 2007
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -7,17 +7,15 @@
 
                             Preamble
 
-  The GNU General Public License is a free, copyleft license for
+  The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works.
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
 
   The licenses for most software and other practical works are designed
 to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
+our General Public Licenses are intended to guarantee your freedom to
 share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
+software for all its users.
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
 
   When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
 want it, that you can change the software or use pieces of it in new
 free programs, and that you know you can do these things.
 
-  To protect your rights, we need to prevent others from denying you
+  Developers that use our General Public Licenses protect your rights
-these rights or asking you to surrender the rights.  Therefore, you have
+with two steps: (1) assert copyright on the software, and (2) offer
-certain responsibilities if you distribute copies of the software, or if
+you this License which gives you legal permission to copy, distribute
-you modify it: responsibilities to respect the freedom of others.
+and/or modify the software.
 
-  For example, if you distribute copies of such a program, whether
+  A secondary benefit of defending all users' freedom is that
-gratis or for a fee, you must pass on to the recipients the same
+improvements made in alternate versions of the program, if they
-freedoms that you received.  You must make sure that they, too, receive
+receive widespread use, become available for other developers to
-or can get the source code.  And you must show them these terms so they
+incorporate.  Many developers of free software are heartened and
-know their rights.
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
 
-  Developers that use the GNU GPL protect your rights with two steps:
+  The GNU Affero General Public License is designed specifically to
-(1) assert copyright on the software, and (2) offer you this License
+ensure that, in such cases, the modified source code becomes available
-giving you legal permission to copy, distribute and/or modify it.
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
 
-  For the developers' and authors' protection, the GPL clearly explains
+  An older license, called the Affero General Public License and
-that there is no warranty for this free software.  For both users' and
+published by Affero, was designed to accomplish similar goals.  This is
-authors' sake, the GPL requires that modified versions be marked as
+a different license, not a version of the Affero GPL, but Affero has
-changed, so that their problems will not be attributed erroneously to
+released a new version of the Affero GPL which permits relicensing under
-authors of previous versions.
+this license.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
 
   The precise terms and conditions for copying, distribution and
 modification follow.
@@ -72,7 +60,7 @@ modification follow.
 
   0. Definitions.
 
-  "This License" refers to version 3 of the GNU General Public License.
+  "This License" refers to version 3 of the GNU Affero General Public License.
 
   "Copyright" also means copyright-like laws that apply to other kinds of
 works, such as semiconductor masks.
@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
 the Program, the only way you could satisfy both those terms and this
 License would be to refrain entirely from conveying the Program.
 
-  13. Use with the GNU Affero General Public License.
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
 
   Notwithstanding any other provision of this License, you have
 permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
+under version 3 of the GNU General Public License into a single
 combined work, and to convey the resulting work.  The terms of this
 License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
+but the work with which it is combined will remain governed by version
-section 13, concerning interaction through a network will apply to the
+3 of the GNU General Public License.
-combination as such.
 
   14. Revised Versions of this License.
 
   The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
+the GNU Affero General Public License from time to time.  Such new versions
-be similar in spirit to the present version, but may differ in detail to
+will be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 
   Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
+Program specifies that a certain numbered version of the GNU Affero General
 Public License "or any later version" applies to it, you have the
 option of following the terms and conditions either of that numbered
 version or of any later version published by the Free Software
 Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
+GNU Affero General Public License, you may choose any version ever published
 by the Free Software Foundation.
 
   If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+versions of the GNU Affero General Public License can be used, that proxy's
 public statement of acceptance of a version permanently authorizes you
 to choose that version for the Program.
 
@@ -635,40 +633,29 @@ the "copyright" line and a pointer to where the full notice is found.
     Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
+    it under the terms of the GNU Affero General Public License as published by
     the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+    GNU Affero General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
+    You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
-  If the program does terminal interaction, make it output a short
+  If your software can interact with users remotely through a computer
-notice like this when it starts in an interactive mode:
+network, you should also make sure that it provides a way for users to
-
+get its source.  For example, if your program is a web application, its
-    <program>  Copyright (C) <year>  <name of author>
+interface could display a "Source" link that leads users to an archive
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+of the code.  There are many ways you could offer source, and different
-    This is free software, and you are welcome to redistribute it
+solutions will be better for different programs; see section 13 for the
-    under certain conditions; type `show c' for details.
+specific requirements.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
 
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
+For more information on this, and how to apply and follow the GNU AGPL, see
 <https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -4,27 +4,19 @@
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
-  <a href="https://undergroundwires.dev/donate?project=privacy.sexy">
+  <a href="https://undergroundwires.dev/donate?project=privacy.sexy" target="_blank" rel="noopener noreferrer">
     <img
       alt="donation badge"
       src="https://undergroundwires.dev/img/badges/donate/flat.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md">
+  <a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">
     <img
       alt="contributions are welcome"
       src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
     />
   </a>
-  <!-- Code quality -->
+  <a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability" target="_blank" rel="noopener noreferrer">
-  <br />
-  <a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript">
-    <img
-      alt="Language grade: JavaScript/TypeScript"
-      src="https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18"
-    />
-  </a>
-  <a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability">
     <img
       alt="Maintainability"
       src="https://api.codeclimate.com/v1/badges/3a70b7ef602e2264342c/maintainability"
@@ -32,59 +24,85 @@
   </a>
   <!-- Tests -->
   <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.unit.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.unit.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Unit tests status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/unit-tests/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.integration.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.integration.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Integration tests status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/integration-tests/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/tests.e2e.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="E2E tests status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
     />
   </a>
+  <!-- Security checks -->
+  <br />
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.sast.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Status of dependency security checks"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.sast/badge.svg"
+    />
+  </a>
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.dependencies.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Status of Static Analysis Security Testing (SAST)"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.dependencies/badge.svg"
+    />
+  </a>
   <!-- Checks -->
   <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Quality checks status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
     <img
-      alt="Security checks status"
+      alt="Status of build checks"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.build/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
     <img
-      alt="Build checks status"
+      alt="Status of runtime error checks for the desktop application"
-      src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.desktop-runtime-errors/badge.svg"
+    />
+  </a>
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.scripts.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Status of script checks"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.scripts/badge.svg"
+    />
+  </a>
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.external-urls.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Status of external URL checks"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.external-urls/badge.svg"
     />
   </a>
   <!-- Release -->
   <br />
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Git release status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/release-git/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Site release status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/release-site/badge.svg"
     />
   </a>
-  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml">
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml" target="_blank" rel="noopener noreferrer">
     <img
       alt="Desktop application release status"
       src="https://github.com/undergroundwires/privacy.sexy/workflows/release-desktop/badge.svg"
@@ -92,7 +110,7 @@
   </a>
   <!-- Others -->
   <br />
-  <a href="https://github.com/undergroundwires/bump-everywhere">
+  <a href="https://github.com/undergroundwires/bump-everywhere" target="_blank" rel="noopener noreferrer">
     <img
       alt="Auto-versioned by bump-everywhere"
       src="https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true"
@@ -104,7 +122,7 @@
 ## Get started
 
 - 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
-- 🖥️ **Offline**: Check [releases page](https://github.com/undergroundwires/privacy.sexy/releases), or download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-Setup-0.11.2.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.dmg), [Linux](https://github.com/undergroundwires/pr.vacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.AppImage).
+- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.4/privacy.sexy-Setup-0.12.4.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.4/privacy.sexy-0.12.4.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.4/privacy.sexy-0.12.4.AppImage). For more options, see [here](#additional-install-options).
 
 Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
 
@@ -132,6 +150,16 @@ Online version does not require to run any software on your computer. Offline ve
 
 **Contribute 👷**. Contributions of any type are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) as the starting point. It includes useful information like [how to add new scripts](./CONTRIBUTING.md#extend-scripts).
 
+## Additional Install Options
+
+- Check the [releases page](https://github.com/undergroundwires/privacy.sexy/releases) for all available versions.
+- Using [Scoop](https://scoop.sh/#/apps?q=privacy.sexy&s=2&d=1&o=true) package manager on Windows:
+
+  ```powershell
+    scoop bucket add extras
+    scoop install privacy.sexy
+  ```
+
 ## Development
 
 Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
@@ -139,3 +167,7 @@ Refer to [development.md](./docs/development.md) for Docker usage and reading mo
 Check [architecture.md](./docs/architecture.md) for an overview of design and how different parts and layers work together. You can refer to [application.md](./docs/application.md) for a closer look at application layer codebase and [presentation.md](./docs/presentation.md) for code related to GUI layer. [collection-files.md](./docs/collection-files.md) explains the YAML files that are the core of the application and [templating.md](./docs/templating.md) documents how to use templating language in those files. In [ci-cd.md](./docs/ci-cd.md), you can read more about the pipelines that automates maintenance tasks and ensures you get what see.
 
 [docs/](./docs/) folder includes all other documentation.
+
+## Security
+
+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).

SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+privacy.sexy takes security seriously. Commitment is made to address all security issues with urgency. Responsible reporting of any discovered vulnerabilities in the project is highly encouraged.
+
+## Reporting a Vulnerability
+
+Efforts to responsibly disclose findings are greatly appreciated. To report a security vulnerability, follow these steps:
+
+- For general vulnerabilities, [open an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) using the bug report template.
+- For sensitive matters, [contact the developer directly](https://undergroundwires.dev).
+
+## Security Report Handling
+
+Upon receipt of a security report, the following actions will be taken:
+
+- The report will be confirmed, identifying the affected components.
+- The impact and severity of the issue will be assessed.
+- Work on a fix and plan a release to address the vulnerability will be initiated.
+- The reporter will be kept updated about the progress.
+
+## Testing
+
+Regular and extensive testing is conducted to ensure robust security in the project. Information about testing practices can be found in the [Testing Documentation](./docs/tests.md).
+
+## Support
+
+For additional assistance or any unanswered questions, [submit a GitHub issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose). Security concerns are a priority, and necessary support to address them is assured.
+
+---
+
+Active contribution to the safety and security of privacy.sexy is thanked. This collaborative effort keeps the project resilient and trustworthy for all.

babel.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  presets: [
-    '@vue/cli-plugin-babel/preset',
-  ],
-};

cypress.config.ts

@@ -1,14 +1,15 @@
-import { defineConfig } from 'cypress'
+import { defineConfig } from 'cypress';
+import ViteConfig from './vite.config';
+
+const CYPRESS_BASE_DIR = 'tests/e2e/';
 
 export default defineConfig({
-  fixturesFolder: 'tests/e2e/fixtures',
+  fixturesFolder: `${CYPRESS_BASE_DIR}/fixtures`,
-  screenshotsFolder: 'tests/e2e/screenshots',
+  screenshotsFolder: `${CYPRESS_BASE_DIR}/screenshots`,
-  videosFolder: 'tests/e2e/videos',
+  videosFolder: `${CYPRESS_BASE_DIR}/videos`,
   e2e: {
-    setupNodeEvents(on, config) {
+    baseUrl: `http://localhost:${ViteConfig.server.port}/`,
-      return require('./tests/e2e/plugins/index.js')(on, config)
+    specPattern: `${CYPRESS_BASE_DIR}/**/*.cy.{js,jsx,ts,tsx}`, // Default: cypress/e2e/**/*.cy.{js,jsx,ts,tsx}
-    },
+    supportFile: `${CYPRESS_BASE_DIR}/support/e2e.ts`,
-    specPattern: 'tests/e2e/specs/**/*.cy.{js,jsx,ts,tsx}',
-    supportFile: 'tests/e2e/support/index.js',
   },
 });

dist-dirs.json

@@ -0,0 +1,5 @@
+{
+  "electronUnbundled": "dist-electron-unbundled",
+  "electronBundled": "dist-electron-bundled",
+  "web": "dist-web"
+}

docs/application.md

@@ -35,7 +35,7 @@ Application layer enables [data-driven programming](https://en.wikipedia.org/wik
 
 Application layer parses the application data to compile the domain object [`Application.ts`](./../src/domain/Application.ts).
 
-A webpack loader loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
+The build tool loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
 
 Application layer compiles templating syntax during parsing to create the end scripts. You can read more about templating syntax in [templating.md](./templating.md) and how application data uses them through functions in [collection-files.md | Function](./collection-files.md#function).
 

docs/architecture.md

@@ -15,11 +15,23 @@ Application is
 
 Application uses highly decoupled models & services in different DDD layers:
 
-- presentation layer (see [presentation.md](./presentation.md)),
+**Application layer** (see [application.md](./application.md)):
-- application layer (see [application.md](./application.md)),
-- and domain layer.
 
-Application layer depends on and consumes domain layer. [Presentation layer](./presentation.md) consumes and depends on application layer along with domain layer. Application and presentation layers can communicate through domain model.
+- Coordinates application activities and consumes the domain layer.
+
+**Presentation layer** (see [presentation.md](./presentation.md)):
+
+- Handles UI/UX, consumes both the application and domain layers.
+- May communicate directly with the infrastructure layer for technical needs, but avoids domain logic.
+
+**Domain layer**:
+
+- Serves as the system's core and central truth.
+- Facilitates communication between the application and presentation layers through the domain model.
+
+**Infrastructure layer**:
+
+- Manages technical implementations without dependencies on other layers or domain knowledge.
 
 ![DDD + vue.js](./../img/architecture/app-ddd.png)
 
@@ -27,6 +39,8 @@ Application layer depends on and consumes domain layer. [Presentation layer](./p
 
 State handling uses an event-driven subscription model to signal state changes and special functions to register changes. It does not depend on third party packages.
 
+The presentation layer can read and modify state through the context. State changes trigger events that components can subscribe to for reactivity.
+
 Each layer treat application layer differently.
 
 ![State](./../img/architecture/app-state.png)
@@ -45,7 +59,7 @@ Each layer treat application layer differently.
 - So state is mutable, and fires related events when mutated.
 - 📖 Read more: [application.md | Application state](./application.md#application-state).
 
-It's comparable with flux ([`redux`](https://redux.js.org/)) or flux-like ([`vuex`](https://vuex.vuejs.org/)) patterns. Flux component "view" is [presentation layer](./presentation.md) in Vue. Flux functions "dispatcher", "store" and "action creation" functions lie in the [application layer](./application.md). A difference is that application state in privacy.sexy is mutable and lies in single flux "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
+It's comparable with `flux`, `vuex`, and `pinia`. A difference is that mutable application layer state in privacy.sexy is mutable and lies in single "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
 
 ## AWS infrastructure
 

docs/collection-files.md

@@ -174,3 +174,19 @@
 - `endCode:` *`string`* (**required**)
   - Code that'll be inserted at the end of user created script.
   - Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
+
+## Naming guidelines
+
+- Prioritize consistency throughout all names.
+- Use an instruction format like "do this, do that" for clear, direct guidance. This approach reduces potential confusion and offers easy-to-follow steps. It provides specific, unambiguous instructions.
+- Ensure brand names adhere to their official casing.
+- Choose clear and uncomplicated language.
+- Favor the terms:
+  - "Disable" over "Turn off"
+  - "Configure" over "Set up"
+  - "Clear" over "Erase" or "Clean"
+  - "Minimize" over "Limit" or "Reduce" (when it enhances clarity)
+  - "Remove" over "Uninstall"
+- Structure your phrases for clarity.
+  - For instance, "Disable XX telemetry" or "Clear XX data" are preferred over "Clear data from XX", "Disable telemetry in XX", or "Clear data of XX".
+- Use sentence case rather than Title Case.

docs/development.md

@@ -5,22 +5,28 @@ Before your commit, a good practice is to:
 1. [Run unit tests](#testing)
 2. [Lint your code](#linting)
 
-You could run other types of tests as well, but they may take longer time and overkill for your changes. Automated actions executes the tests for a pull request or change in the main branch. See [ci-cd.md](./ci-cd.md) for more information.
+You could run other types of tests as well, but they may take longer time and overkill for your changes.
+Automated actions are set up to execute these tests as necessary.
+See [ci-cd.md](./ci-cd.md) for more information.
 
 ## Commands
 
 ### Prerequisites
 
-- Install node >15.x.
+- Install Node >16.x.
-- Install dependencies using `npm install`.
+- Install dependencies using `npm install` (or [`npm run install-deps`](#utility-scripts) for more options).
 
 ### Testing
 
 - Run unit tests: `npm run test:unit`
 - Run integration tests: `npm run test:integration`
-- Run e2e (end-to-end) tests
+- Run end-to-end (e2e) tests:
-  - Interactive mode with GUI: `npm run test:e2e`
+  - `npm run test:cy:open`: Run tests interactively using the development server with hot-reloading.
-  - Headless mode without GUI: `npm run test:e2e -- --headless`
+  - `npm run test:cy:run`: Run tests on the production build in a headless mode.
+- Run checks:
+  - `npm run check:desktop`: Run runtime checks for packaged desktop applications ([README.md](./../tests/checks/desktop-runtime-errors/check-desktop-runtime-errors/README.md)).
+    - You can set environment variables active its flags such as `BUILD=true SCREENSHOT=true npm run check:desktop`
+  - `npm run check:external-urls`: Test whether external URLs used in applications are alive.
 
 📖 Read more about testing in [tests](./tests.md).
 
@@ -35,11 +41,26 @@ You could run other types of tests as well, but they may take longer time and ov
 
 ### Running
 
-- Run in local server: `npm run serve`
+**Web:**
+
+- Run in local server: `npm run dev`
   - 💡 Meant for local development with features such as hot-reloading.
-- Run using Docker:
+- Preview production build: `npm run preview`
-  1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
+  - Start a local web server that serves the built solution from `./dist`.
-  2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
+  - 💡 Run `npm run build` before `npm run preview`.
+
+**Desktop apps:**
+
+- `npm run electron:dev`: The command will build the main process and preload scripts source code, and start a dev server for the renderer, and start the Electron app.
+- `npm run electron:preview`: The command will build the main process, preload scripts and renderer source code, and start the Electron app to preview.
+- `npm run electron:prebuild`: The command will build the main process, preload scripts and renderer source code. Usually before packaging the Electron application, you need to execute this command.
+- `npm run electron:build`: Prebuilds the Electron application, packages and publishes it through `electron-builder`.
+
+**Docker:**
+
+1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
+2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
+3. Application should be available at [`http://localhost:8080`](http://localhost:8080)
 
 ### Building
 
@@ -47,6 +68,27 @@ You could run other types of tests as well, but they may take longer time and ov
 - Build desktop application: `npm run electron:build`
 - (Re)create icons (see [documentation](../img/README.md)): `npm run create-icons`
 
+### Scripts
+
+📖 For detailed options and behavior for any of the following scripts, please refer to the script file itself.
+
+#### Utility scripts
+
+- [**`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.
+- [**`./scripts/configure-vscode.sh`**](../scripts/configure-vscode.sh):
+  - This script checks and sets the necessary configurations for VSCode in `settings.json` file.
+
+#### Automation scripts
+
+- [**`node scripts/print-dist-dir.js [<options>]`**](../scripts/print-dist-dir.js):
+  - Determines the absolute path of a distribution directory based on CLI arguments and outputs its absolute path.
+- [**`npm run check:verify-build-artifacts [-- <options>]`**](../scripts/verify-build-artifacts.js):
+  - Verifies the existence and content of build artifacts. Useful for ensuring that the build process is generating the expected output.
+- [**`node scripts/verify-web-server-status.js --url [URL]`**](../scripts/verify-web-server-status.js):
+  - Checks if a specified server is up with retries and returns an HTTP 200 status code.
+
 ## Recommended extensions
 
 You should use EditorConfig to follow project style.

docs/presentation.md

@@ -1,30 +1,33 @@
 # Presentation layer
 
-Presentation layer consists of UI-related code. It uses Vue.js as JavaScript framework and includes Vue.js components. It also includes [Electron](https://www.electronjs.org/) to provide functionality to desktop application.
+The presentation layer handles UI concerns using Vue as JavaScript framework and Electron to provide desktop functionality.
 
-It's designed event-driven from bottom to top. It listens user events (from top) and state events (from bottom) to update state or the GUI.
+It reflects the [application state](./application.md#application-state) and allows user interactions to modify it. Components manage their own local UI state.
+
+The presentation layer uses an event-driven architecture for bidirectional reactivity between the application state and UI. State change events flow bottom-up to trigger UI updates, while user events flow top-down through components, some ultimately modifying the application state.
 
 📖 Refer to [architecture.md (Layered Application)](./architecture.md#layered-application) to read more about the layered architecture.
 
 ## Structure
 
-- [`/src/` **`presentation/`**](./../src/presentation/): Contains all presentation related code including Vue and Electron configurations
+- [`/src/` **`presentation/`**](./../src/presentation/): Contains Vue and Electron code.
-  - [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue global objects including components and plugins.
+  - [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue components and plugins.
-  - [**`components/`**](./../src/presentation/components/): Contains all Vue components and their helper classes.
+  - [**`components/`**](./../src/presentation/components/): Contains Vue components and helpers.
-    - [**`Shared/`**](./../src/presentation/components/Shared): Contains Vue components and component helpers that other components share.
+    - [**`Shared/`**](./../src/presentation/components/Shared): Contains shared Vue components and helpers.
-  - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets that webpack will process.
+      - [**`Hooks`**](../src/presentation/components/Shared/Hooks): Hooks used by components through [dependency injection](#dependency-injections).
-    - [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts
+  - [**`/public/`**](../src/presentation/public/): Contains static assets.
-    - [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles used throughout different components.
+  - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets processed by Vite.
-      - [**`components/`**](./../src/presentation/assets/styles/components): Contains reusable styles coupled to a Vue/HTML component.
+    - [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts.
-      - [**`vendors-extensions/`**](./../src/presentation/assets/styles/third-party-extensions): Contains styles that override third-party components used.
+    - [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles.
-      - [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Primary Sass file, passes along all other styles, should be the single file used from other components.
+      - [**`components/`**](./../src/presentation/assets/styles/components): Contains styles coupled to Vue components.
-  - [**`main.ts`**](./../src/presentation/main.ts): Application entry point that mounts and starts Vue application.
+      - [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Main Sass file, imported by other components as single entrypoint.
-  - [**`electron/`**](./../src/presentation/electron/): Electron configuration for the desktop application.
+  - [**`main.ts`**](./../src/presentation/main.ts): Starts Vue app.
-    - [**`main.ts`**](./../src/presentation/main.ts): Main process of Electron, started as first thing when app starts.
+  - [**`electron/`**](./../src/presentation/electron/): Contains Electron code.
-- [**`/public/`**](./../public/): Contains static assets that are directly copied and do not go through webpack.
+    - [`/main/` **`index.ts`**](./../src/presentation/main.ts): Main entry for Electron, managing application windows and lifecycle events.
-- [**`/vue.config.js`**](./../vue.config.js): Global Vue CLI configurations loaded by `@vue/cli-service`.
+    - [`/preload/` **`index.ts`**](./../src/presentation/main.ts): Script executed before the renderer, securing Node.js features for renderer use.
-- [**`/postcss.config.js`**](./../postcss.config.js): PostCSS configurations used by Vue CLI internally.
+- [**`/vite.config.ts`**](./../vite.config.ts): Contains Vite configurations for building web application.
-- [**`/babel.config.js`**](./../babel.config.js): Babel configurations for polyfills used by `@vue/cli-plugin-babel`.
+- [**`/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
 
@@ -32,7 +35,7 @@ Add visual clues for clickable items. It should be as clear as possible that the
 
 ## Application data
 
-Components (should) use [ApplicationFactory](./../src/application/ApplicationFactory.ts) singleton to reach the application domain to avoid [parsing and compiling](./application.md#parsing-and-compiling) the application again.
+Components (should) use [`UseApplication`](./../src/presentation/components/Shared/Hooks/UseApplication.ts) to reach the application domain to avoid [parsing and compiling](./application.md#parsing-and-compiling) the application again.
 
 [Application.ts](../src/domain/Application.ts) is an immutable domain model that represents application state. It includes:
 
@@ -43,34 +46,58 @@ You can read more about how application layer provides application data to he pr
 
 ## Application state
 
-Inheritance of a Vue components marks whether it uses application state . Components that does not handle application state extends `Vue`. Stateful components mutate or/and react to state changes (such as user selection or search queries) in [ApplicationContext](./../src/application/Context/ApplicationContext.ts) extend [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) class to access the context / state.
+This project uses a singleton instance of the application state, making it available to all Vue components.
 
-[`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) functions include:
+The decision to not use third-party state management libraries like [`vuex`](https://web.archive.org/web/20230801191617/https://vuex.vuejs.org/) or [`pinia`](https://web.archive.org/web/20230801191743/https://pinia.vuejs.org/) was made to promote code independence and enhance portability.
 
-- Creating a singleton of the state and makes it available to presentation layer as single source of truth.
+Stateful components can mutate and/or react to state changes (e.g., user selection, search queries) in the [ApplicationContext](./../src/application/Context/ApplicationContext.ts). Vue components import [`CollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) to access both the application context and the state.
-- Providing virtual abstract `handleCollectionState` callback that it calls when
-  - the Vue loads the component,
-  - and also every time when state changes.
-- Providing `events` member to make lifecycling of state subscriptions events easier because it ensures that components unsubscribe from listening to state events when
-  - the component is no longer used (destroyed),
-  - an if [ApplicationContext](./../src/application/Context/ApplicationContext.ts) changes the active [collection](./collection-files.md) to a different one.
 
-📖 Refer to [architecture.md | Application State](./architecture.md#application-state) to get an overview of event handling and [application.md | Application State](./presentation.md#application-state) for deeper look into how the application layer manages state.
+[`UseCollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) provides several functionalities including:
 
-## Modals
+- **Singleton State Instance**: It creates a singleton instance of the state, which is shared across the presentation layer. The singleton instance ensures that there's a single source of truth for the application's state.
+- **State Change Callback and Lifecycle Management**: It offers a mechanism to register callbacks, which will be invoked when the state initializes or mutates. It ensures that components unsubscribe from state events when they are no longer in use or when [ApplicationContext](./../src/application/Context/ApplicationContext.ts) switches the active [collection](./collection-files.md).
+- **State Access and Modification**: It provides functions to read and mutate for accessing and modifying the state, encapsulating the details of these operations.
+- **Event Subscription Lifecycle Management**: Includes an `events` member that simplifies state subscription lifecycle events. This ensures that components unsubscribe from state events when they are no longer in use, or when [ApplicationContext](./../src/application/Context/ApplicationContext.ts) switches the active [collection](./collection-files.md).
 
-[Dialog.vue](./../src/presentation/components/Shared/Dialog.vue) is a shared component that other components used to show modal windows.
+📖 Refer to [architecture.md | Application State](./architecture.md#application-state) for an overview of event handling and [application.md | Application State](./presentation.md#application-state) for an in-depth understanding of state management in the application layer.
 
-You can use it by wrapping the content inside of its `slot` and call `.show()` function on its reference. For example:
+## Dependency injections
 
-  ```html
+The presentation layer uses Vue's native dependency injection system to increase testability and decouple components.
-    <Dialog ref="testDialog">
-      <div>Hello world</div>
-    </Dialog>
-    <div @click="$refs.testDialog.show()">Show dialog</div>
-  ```
 
-## Sass naming convention
+To add a new dependency:
+
+1. **Define its symbol**: Define an associated symbol for every dependency in [`injectionSymbols.ts`](./../src/presentation/injectionSymbols.ts). Symbols are grouped into:
+   - **Singletons**: Shared across components, instantiated once.
+   - **Transients**: Factories yielding a new instance on every access.
+2. **Provide the dependency**: Modify the [`provideDependencies`](./../src/presentation/bootstrapping/DependencyProvider.ts) function to include the new dependency. [`App.vue`](./../src/presentation/components/App.vue) calls this function within its `setup()` hook to register the dependencies.
+3. **Inject the dependency**: Use Vue's `inject` method alongside the defined symbol to incorporate the dependency into components.
+   - For singletons, invoke the factory method: `inject(symbolKey)()`.
+   - For transients, directly inject: `inject(symbolKey)`.
+
+## Shared UI components
+
+Shared UI components promote consistency and simplifies the creation of the front-end.
+
+In order to maintain portability and easy maintainability, the preference is towards using homegrown components over third-party ones or comprehensive UI frameworks like Quasar.
+
+Shared components include:
+
+- [ModalDialog.vue](./../src/presentation/components/Shared/Modal/ModalDialog.vue) is utilized for rendering modal windows.
+- [TooltipWrapper.vue](./../src/presentation/components/Shared/TooltipWrapper.vue) acts as a wrapper for rendering tooltips.
+
+## Desktop builds
+
+Desktop builds uses `electron-vite` to bundle the code, and `electron-builder` to build and publish the packages.
+
+## Styles
+
+### Style location
+
+- **Global styles**: The [`assets/styles/`](#structure) directory is reserved for styles that have a broader scope, affecting multiple components or entire layouts. They are generic and should not be tightly coupled to a specific component's functionality.
+- **Component-specific styles**: Styles closely tied to a particular component's functionality or appearance should reside near the component they are used by. This makes it easier to locate and modify styles when working on a specific component.
+
+### Sass naming convention
 
 - Use lowercase for variables/functions/mixins, e.g.:
   - Variable: `$variable: value;`

docs/tests.md

@@ -5,77 +5,84 @@ There are different types of tests executed:
 1. [Unit tests](#unit-tests)
 2. [Integration tests](#integration-tests)
 3. [End-to-end (E2E) tests](#e2e-tests)
+4. [Automated checks](#automated-checks)
 
-Common aspects for all tests:
+## Unit and integration tests
 
-- They use [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
+- They utilize [Vitest](https://vitest.dev/).
-- Their files end with `.spec.{ts|js}` suffix.
+- Test files are suffixed with `.spec.ts`.
-
-💡 You can use path/module alias `@/tests` in import statements.
-
-## Unit tests
-
-- Unit tests test each component in isolation.
-- All unit tests goes under [`./tests/unit`](./../tests/unit).
-- They rely on [stubs](./../tests/unit/shared/Stubs) for isolation.
-
-### Unit tests structure
-
-- [`./src/`](./../src/)
-  - Includes source code that unit tests will test.
-- [`./tests/unit/`](./../tests/unit/)
-  - Includes test code.
-  - Tests follow same folder structure as [`./src/`](./../src).
-    - E.g. if system under test lies in [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) then its tests would be in test would be at [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
-  - [`shared/`](./../tests/unit/shared/)
-    - Includes common functionality that's shared across unit tests.
-    - [`Assertions/`](./../tests/unit/shared/Assertions):
-      - Common assertions that extend [Chai Assertion Library](https://www.chaijs.com/).
-      - Asserting functions should start with `expect` prefix.
-    - [`TestCases/`](./../tests/unit/shared/TestCases/)
-      - Shared test cases.
-      - Functions that calls `it()` from [Mocha test framework](https://mochajs.org/) should have `it` prefix.
-        - E.g. `itEachAbsentCollectionValue()`.
-    - [`Stubs/`](./../tests/unit/shared/Stubs)
-      - Includes stubs to be able to test components in isolation.
-      - Stubs have minimal and dummy behavior to be functional, they may also have spying or mocking functions.
-
-### Unit tests naming
-
-- Each test suite first describe the system under test.
-  - E.g. tests for class `Application.ts` are all inside `Application.spec.ts`.
-- `describe` blocks tests for same function (if applicable).
-  - E.g. test for `run()` are inside `describe('run', () => ..)`.
 
 ### Act, arrange, assert
 
-- Tests use act, arrange and assert (AAA) pattern when applicable.
+- Tests implement the act, arrange, and assert (AAA) pattern.
 - **Arrange**
-  - Sets up the test case.
+  - Sets up the test scenario and environment.
-  - Starts with comment line `// arrange`.
+  - Begins with comment line `// arrange`.
 - **Act**
   - Executes the actual test.
-  - Starts with comment line `// act`.
+  - Begins with comment line `// act`.
 - **Assert**
-  - Elicit some sort of expectation.
+  - Sets an expectation for the test's outcome.
-  - Starts with comment line `// assert`.
+  - Begins with comment line `// assert`.
 
-## Integration tests
+### Unit tests
 
-- Tests functionality of a component in combination with others (not isolated).
+- Evaluate individual components in isolation.
-- Ensure dependencies to third parties work as expected.
+- Located in [`./tests/unit`](./../tests/unit).
-- Defined in [./tests/integration](./../tests/integration).
+- Achieve isolation using [stubs](./../tests/unit/shared/Stubs).
+- Include Vue component tests, enabled by `@vue/test-utils`.
+
+#### Unit tests naming
+
+- Test suites start with a description of the component or system under test.
+  - E.g., tests for `Application.ts` are contained in `Application.spec.ts`.
+- Whenever possible, `describe` blocks group tests of the same function.
+  - E.g., tests for `run()` are inside `describe('run', () => ...)`.
+
+### Integration tests
+
+- Assess the combined functionality of components.
+- They verify that third-party dependencies function as anticipated.
 
 ## E2E tests
 
-- Test the functionality and performance of a running application.
+- Examine the live web application's functionality and performance.
-- Vue CLI plugin  [`e2e-cypress`](https://github.com/vuejs/vue-cli/tree/dev/packages/@vue/cli-plugin-e2e-cypress#readme) configures E2E tests.
+- Uses Cypress to run the tests.
-- Test names and folders have logical structure based on tests executed.
+
-- The structure is following:
+## Automated checks
-  - [`cypress.config.ts`](./../cypress.config.ts): Cypress configuration file.
+
-  - [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder.
+These checks validate various qualities like runtime execution, building process, security testing, etc.
-    - [`/specs/`](./../tests/e2e/specs/): Test files named with `.spec.js` extension.
+
-    - [`/plugins/index.js`](./../tests/e2e/plugins/index.js): Plugin file executed before loading project.
+- Use [various tools](./../package.json) and [scripts](./../scripts).
-    - [`/support/index.js`](./../tests/e2e/support/index.js): Support file, runs before every single spec file.
+- Are automatically executed as [GitHub workflows](./../.github/workflows).
-    - *(Ignored)* `/videos`: Asset folder for videos taken during tests.
+
-    - *(Ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.
+### Security checks
+
+- [`checks.security.sast`](./../.github/workflows/checks.security.sast.yaml): Utilizes CodeQL to conduct Static Analysis Security Testing (SAST) to ensure the secure integrity of the codebase.
+- [`checks.security.dependencies`](./../.github/workflows/checks.security.dependencies.yaml): Performs audits on third-party dependencies to identify and mitigate potential vulnerabilities, safeguarding the project from exploitable weaknesses.
+
+## Tests structure
+
+- [`package.json`](./../package.json): Defines test commands and includes tools used in tests.
+- [`vite.config.ts`](./../vite.config.ts): Configures `vitest` for unit and integration tests.
+- [`./src/`](./../src/): Contains the code subject to testing.
+- [`./tests/shared/`](./../tests/shared/): Contains code shared by different test categories.
+  - [`bootstrap/setup.ts`](./../tests/shared/bootstrap/setup.ts): Initializes unit and integration tests.
+- [`./tests/unit/`](./../tests/unit/)
+  - Stores unit test code.
+  - The directory structure mirrors [`./src/`](./../src).
+    - E.g., tests for [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) reside in [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
+  - [`shared/`](./../tests/unit/shared/)
+    - Contains shared unit test functionalities.
+    - [`Assertions/`](./../tests/unit/shared/Assertions): Contains common assertion functions, prefixed with `expect`.
+    - [`TestCases/`](./../tests/unit/shared/TestCases/)
+      - Shared test cases.
+      - Functions that calls `it()` from [Vitest](https://vitest.dev/) should have `it` prefix.
+    - [`Stubs/`](./../tests/unit/shared/Stubs): Maintains stubs for component isolation, equipped with basic functionalities and, when necessary, spying or mocking capabilities.
+- [`./tests/integration/`](./../tests/integration/): Contains integration test files.
+- [`cypress.config.ts`](./../cypress.config.ts): Cypress (E2E tests) configuration file.
+- [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder, includes tests with `.cy.ts` extension.
+  - [`/support/e2e.ts`](./../tests/e2e/support/e2e.ts): Support file, runs before every single spec file.
+  - [`/tsconfig.json`]: TypeScript configuration for file Cypress code, improves IDE support, recommended to have by official documentation.
+  - *(git ignored)* `/videos`: Asset folder for videos taken during tests.
+  - *(git ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.

electron-builder.cjs

@@ -0,0 +1,43 @@
+/* eslint-disable no-template-curly-in-string */
+
+const { join } = require('path');
+const { electronBundled, electronUnbundled } = require('./dist-dirs.json');
+
+module.exports = {
+  // Common options
+  publish: {
+    provider: 'github',
+    vPrefixedTagName: false, // default: true
+    releaseType: 'release', // default: draft
+  },
+  directories: {
+    output: electronBundled,
+  },
+  extraMetadata: {
+    main: join(electronUnbundled, 'main/index.cjs'), // do not `path.resolve`, it expects a relative path
+  },
+
+  // Windows
+  win: {
+    target: 'nsis',
+  },
+  nsis: {
+    artifactName: '${name}-Setup-${version}.${ext}',
+  },
+
+  // Linux
+  linux: {
+    target: 'AppImage',
+  },
+  appImage: {
+    artifactName: '${name}-${version}.${ext}',
+  },
+
+  // macOS
+  mac: {
+    target: 'dmg',
+  },
+  dmg: {
+    artifactName: '${name}-${version}.${ext}',
+  },
+};

electron.vite.config.ts

@@ -0,0 +1,69 @@
+import { resolve } from 'path';
+import { mergeConfig, UserConfig } from 'vite';
+import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
+import { getAliasesFromTsConfig, getClientEnvironmentVariables } from './vite-config-helper';
+import { createVueConfig } from './vite.config';
+import distDirs from './dist-dirs.json' assert { type: 'json' };
+
+const MAIN_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/main/index.ts');
+const PRELOAD_ENTRY_FILE = resolvePathFromProjectRoot('src/presentation/electron/preload/index.ts');
+const WEB_INDEX_HTML_PATH = resolvePathFromProjectRoot('src/presentation/index.html');
+const DIST_DIR = resolvePathFromProjectRoot(distDirs.electronUnbundled);
+
+export default defineConfig({
+  main: getSharedElectronConfig({
+    distDirSubfolder: 'main',
+    entryFilePath: MAIN_ENTRY_FILE,
+  }),
+  preload: getSharedElectronConfig({
+    distDirSubfolder: 'preload',
+    entryFilePath: PRELOAD_ENTRY_FILE,
+  }),
+  renderer: mergeConfig(
+    createVueConfig({
+      supportLegacyBrowsers: false,
+    }),
+    {
+      build: {
+        outDir: resolve(DIST_DIR, 'renderer'),
+        rollupOptions: {
+          input: {
+            index: WEB_INDEX_HTML_PATH,
+          },
+        },
+      },
+    },
+  ),
+});
+
+function getSharedElectronConfig(options: {
+  readonly distDirSubfolder: string;
+  readonly entryFilePath: string;
+}): UserConfig {
+  return {
+    build: {
+      outDir: resolve(DIST_DIR, options.distDirSubfolder),
+      lib: {
+        entry: options.entryFilePath,
+      },
+      rollupOptions: {
+        output: {
+          entryFileNames: '[name].cjs', // This is needed so `type="module"` works
+        },
+      },
+    },
+    plugins: [externalizeDepsPlugin()],
+    define: {
+      ...getClientEnvironmentVariables(),
+    },
+    resolve: {
+      alias: {
+        ...getAliasesFromTsConfig(),
+      },
+    },
+  };
+}
+
+function resolvePathFromProjectRoot(pathSegment: string) {
+  return resolve(__dirname, pathSegment);
+}

fresh-npm-install.sh

@@ -1,95 +0,0 @@
-#!/usr/bin/env bash
-
-# Description:
-#   This script ensures npm is available, removes existing node modules, optionally
-#   removes package-lock.json (when -n flag is used), installs dependencies and runs unit tests.
-# Usage:
-#   ./fresh-npm-install.sh         # Regular execution
-#   ./fresh-npm-install.sh -n      # Non-deterministic mode (removes package-lock.json)
-
-declare NON_DETERMINISTIC_FLAG=0
-
-
-main() {
-  parse_args "$@"
-  ensure_npm_is_available
-  ensure_npm_root
-  remove_existing_modules
-  if [[ $NON_DETERMINISTIC_FLAG -eq 1 ]]; then
-    remove_package_lock_json
-  fi
-  install_dependencies
-  run_unit_tests
-}
-
-ensure_npm_is_available() {
-  if ! command -v npm &> /dev/null; then
-    log::fatal 'npm could not be found, please install it first.'
-  fi
-}
-
-ensure_npm_root() {
-  if [ ! -f package.json ]; then
-    log::fatal 'Current directory is not a npm root. Please run the script in a npm root directory.'
-  fi
-}
-
-remove_existing_modules() {
-  if [ -d ./node_modules ]; then
-    log::info 'Removing existing node modules...'
-    if ! rm -rf ./node_modules; then
-      log::fatal 'Could not remove existing node modules.'
-    fi
-  fi
-}
-
-install_dependencies() {
-  log::info 'Installing dependencies...'
-  if ! npm install; then
-    log::fatal 'Failed to install dependencies.'
-  fi
-}
-
-remove_package_lock_json() {
-  if [ -f ./package-lock.json ]; then
-    log::info 'Removing package-lock.json...'
-    if ! rm -rf ./package-lock.json; then
-      log::fatal 'Could not remove package-lock.json.'
-    fi
-  fi
-}
-
-run_unit_tests() {
-  log::info 'Running unit tests...'
-  if ! npm run test:unit; then
-    pwd
-    log::fatal 'Failed to run unit tests.'
-  fi
-}
-
-log::info() {
-  local -r message="$1"
-  echo "📣 ${message}"
-}
-
-log::fatal() {
-  local -r message="$1"
-  echo "❌ ${message}" >&2
-  exit 1
-}
-
-parse_args() {
-  while getopts "n" opt; do
-    case ${opt} in
-      n)
-        NON_DETERMINISTIC_FLAG=1
-        ;;
-      \?)
-        echo "Invalid option: $OPTARG" 1>&2
-        exit 1
-        ;;
-    esac
-  done
-}
-
-main "$1"

img/README.md

@@ -4,9 +4,6 @@ This folder contains image files and other resources related to images.
 
 ## logo.svg
 
-[logo.svg](./logo.svg) is the master logo from which all other icons or images are created from.
+[`logo.svg`](./logo.svg) serves as the primary logo from which all other icons and images are derived.
-It should be the only file that will be changed manually.
+Only modify this file manually.
-
+After making changes, execute `npm run build:icons` to regenerate logo files in various formats.
-[`logo-update.mjs`](./logo-update.mjs) script in this folder updates all the logo files.
-It should be executed everytime the logo is changed.
-It automates recreation of logo files in different formats.

package.json

@@ -1,67 +1,62 @@
 {
   "name": "privacy.sexy",
-  "version": "0.11.4",
+  "version": "0.12.4",
   "private": true,
   "slogan": "Now you have the choice",
   "description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
   "author": "undergroundwires",
+  "type": "module",
+  "main": "./dist-electron-unbundled/main/index.cjs",
   "scripts": {
-    "serve": "vue-cli-service serve",
+    "dev": "vite",
-    "build": "vue-cli-service build",
+    "build": "vue-tsc --noEmit && vite build",
-    "test:unit": "vue-cli-service test:unit",
+    "preview": "vite preview",
-    "test:e2e": "vue-cli-service test:e2e",
+    "test:unit": "vitest run --dir tests/unit",
+    "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",
-    "create-icons": "node img/logo-update.mjs",
+    "install-deps": "node scripts/npm-install.js",
-    "electron:build": "vue-cli-service electron:build",
+    "icons:build": "node scripts/logo-update.js",
-    "electron:serve": "vue-cli-service electron:serve",
+    "check:desktop": "vitest run --dir tests/checks/desktop-runtime-errors --environment node",
-    "lint:eslint": "vue-cli-service lint --no-fix --mode production",
+    "check:external-urls": "vitest run --dir tests/checks/external-urls --environment node",
+    "check:verify-build-artifacts": "node scripts/verify-build-artifacts",
+    "electron:dev": "electron-vite dev",
+    "electron:preview": "electron-vite preview",
+    "electron:prebuild": "electron-vite build",
+    "electron:build": "electron-builder",
+    "lint:eslint": "eslint . --ignore-path .gitignore",
     "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:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
     "postinstall": "electron-builder install-app-deps",
-    "postuninstall": "electron-builder install-app-deps",
+    "postuninstall": "electron-builder install-app-deps"
-    "test:integration": "vue-cli-service test:unit \"tests/integration/**/*.spec.ts\""
   },
-  "main": "index.js",
   "dependencies": {
-    "@fortawesome/fontawesome-svg-core": "^6.4.0",
+    "@floating-ui/vue": "^1.0.2",
-    "@fortawesome/free-brands-svg-icons": "^6.4.0",
-    "@fortawesome/free-regular-svg-icons": "^6.4.0",
-    "@fortawesome/free-solid-svg-icons": "^6.4.0",
-    "@fortawesome/vue-fontawesome": "^2.0.9",
     "@juggle/resize-observer": "^3.4.0",
     "ace-builds": "^1.23.4",
-    "core-js": "^3.32.0",
     "cross-fetch": "^4.0.0",
     "electron-progressbar": "^2.1.0",
     "file-saver": "^2.0.5",
-    "install": "^0.13.0",
-    "liquor-tree": "^0.2.70",
     "markdown-it": "^13.0.1",
     "npm": "^9.8.1",
-    "v-tooltip": "2.1.3",
+    "vue": "^2.7.14"
-    "vue": "^2.7.14",
-    "vue-class-component": "^7.2.6",
-    "vue-js-modal": "^2.0.1",
-    "vue-property-decorator": "^9.1.2"
   },
   "devDependencies": {
+    "@modyfi/vite-plugin-yaml": "^1.0.4",
+    "@rushstack/eslint-patch": "^1.3.2",
     "@types/ace": "^0.0.48",
-    "@types/chai": "^4.3.5",
     "@types/file-saver": "^2.0.5",
-    "@types/mocha": "^10.0.1",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
-    "@vue/cli-plugin-babel": "~5.0.8",
+    "@vitejs/plugin-legacy": "^4.1.1",
-    "@vue/cli-plugin-e2e-cypress": "~5.0.8",
+    "@vitejs/plugin-vue2": "^2.2.0",
-    "@vue/cli-plugin-eslint": "~5.0.8",
+    "@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
-    "@vue/cli-plugin-typescript": "~5.0.8",
-    "@vue/cli-plugin-unit-mocha": "~5.0.8",
-    "@vue/cli-service": "~5.0.8",
-    "@vue/eslint-config-airbnb": "^6.0.0",
     "@vue/eslint-config-typescript": "^11.0.3",
-    "chai": "^4.3.7",
+    "@vue/test-utils": "^1.3.6",
+    "autoprefixer": "^10.4.15",
     "cypress": "^12.17.2",
     "electron": "^25.3.2",
     "electron-builder": "^24.6.3",
@@ -69,31 +64,32 @@
     "electron-icon-builder": "^2.0.1",
     "electron-log": "^4.4.8",
     "electron-updater": "^6.1.4",
+    "electron-vite": "^1.0.27",
     "eslint": "^8.46.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-cypress": "^2.14.0",
     "eslint-plugin-vue": "^9.6.0",
     "eslint-plugin-vuejs-accessibility": "^1.2.0",
     "icon-gen": "^3.0.1",
-    "js-yaml-loader": "^1.2.2",
+    "jsdom": "^22.1.0",
     "markdownlint-cli": "^0.35.0",
+    "postcss": "^8.4.28",
     "remark-cli": "^11.0.0",
     "remark-lint-no-dead-urls": "^1.1.0",
     "remark-preset-lint-consistent": "^5.1.2",
     "remark-validate-links": "^12.1.1",
     "sass": "^1.64.1",
-    "sass-loader": "^13.3.2",
+    "start-server-and-test": "^2.0.0",
     "svgexport": "^0.4.2",
-    "ts-loader": "^9.4.4",
+    "terser": "^5.19.2",
+    "tslib": "~2.4.0",
     "typescript": "~4.6.2",
-    "vue-cli-plugin-electron-builder": "^3.0.0-alpha.4",
+    "vite": "^4.4.9",
+    "vitest": "^0.34.2",
+    "vue-tsc": "^1.8.8",
     "yaml-lint": "^1.7.0"
   },
-  "overrides": {
-    "vue-cli-plugin-electron-builder": {
-      "electron-builder": "^24.6.3"
-    }
-  },
   "//devDependencies": {
+    "terser": "Used by @vitejs/plugin-legacy for minification",
     "typescript": [
       "Cannot upgrade to 5.X.X due to unmaintained @vue/cli-plugin-typescript, https://github.com/vuejs/vue-cli/issues/7401",
       "Cannot upgrade to > 4.6.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252"

postcss.config.cjs

@@ -0,0 +1,9 @@
+const autoprefixer = require('autoprefixer');
+
+module.exports = () => {
+  return {
+    plugins: [
+      autoprefixer(),
+    ],
+  };
+};

postcss.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  plugins: {
-    autoprefixer: {},
-  },
-};

scripts/configure-vscode.sh

@@ -0,0 +1,74 @@
+#!/usr/bin/env bash
+
+# This script ensures that the '.vscode/settings.json' file exists and is configured correctly for ESLint validation on Vue and JavaScript files.
+# See https://web.archive.org/web/20230801024405/https://eslint.vuejs.org/user-guide/#visual-studio-code
+
+declare -r SETTINGS_FILE='.vscode/settings.json'
+declare -ra CONFIG_KEYS=('vue' 'javascript' 'typescript')
+declare -r TEMP_FILE="tmp.$$.json"
+
+main() {
+  ensure_vscode_directory_exists
+  create_or_update_settings
+}
+
+ensure_vscode_directory_exists() {
+  local dir_name
+  dir_name=$(dirname "${SETTINGS_FILE}")
+  if [[ ! -d ${dir_name} ]]; then
+    mkdir -p "${dir_name}"
+    echo "🎉 Created directory: ${dir_name}"
+  fi
+}
+
+create_or_update_settings() {
+  if [[ ! -f ${SETTINGS_FILE} ]]; then
+    create_default_settings
+  else
+    add_or_update_eslint_validate
+  fi
+}
+
+create_default_settings() {
+  local default_validate
+  default_validate=$(printf '%s' "${CONFIG_KEYS[*]}" | jq -R -s -c -M 'split(" ")')
+  echo "{ \"eslint.validate\": ${default_validate} }" | jq '.' > "${SETTINGS_FILE}"
+  echo "🎉 Created default ${SETTINGS_FILE}"
+}
+
+add_or_update_eslint_validate() {
+  if ! jq -e '.["eslint.validate"]' "${SETTINGS_FILE}" >/dev/null; then
+    add_default_eslint_validate
+  else
+    update_eslint_validate
+  fi
+}
+
+add_default_eslint_validate() {
+  jq --argjson keys "$(printf '%s' "${CONFIG_KEYS[*]}" \
+    | jq -R -s -c 'split(" ")')" '. += {"eslint.validate": $keys}' "${SETTINGS_FILE}" > "${TEMP_FILE}"
+  replace_and_confirm
+  echo "🎉 Added default 'eslint.validate' to ${SETTINGS_FILE}"
+}
+
+update_eslint_validate() {
+  local existing_keys
+  existing_keys=$(jq '.["eslint.validate"]' "${SETTINGS_FILE}")
+  for key in "${CONFIG_KEYS[@]}"; do
+    if ! echo "${existing_keys}" | jq 'index("'"${key}"'")' >/dev/null; then
+      jq '.["eslint.validate"] += ["'"${key}"'"]' "${SETTINGS_FILE}" > "${TEMP_FILE}"
+      mv "${TEMP_FILE}" "${SETTINGS_FILE}"
+      echo "🎉 Updated 'eslint.validate' in ${SETTINGS_FILE} for ${key}"
+    else
+        echo "⏩️ No updated needed for ${key} ${SETTINGS_FILE}."
+    fi
+  done
+}
+
+replace_and_confirm() {
+  if mv "${TEMP_FILE}" "${SETTINGS_FILE}"; then
+    echo "🎉 Updated ${SETTINGS_FILE}"
+  fi
+}
+
+main

scripts/logo-update.js

@@ -8,7 +8,7 @@ class Paths {
   constructor(selfDirectory) {
     const projectRoot = resolve(selfDirectory, '../');
     this.sourceImage = join(projectRoot, 'img/logo.svg');
-    this.publicDirectory = join(projectRoot, 'public');
+    this.publicDirectory = join(projectRoot, 'src/presentation/public');
     this.electronBuildDirectory = join(projectRoot, 'build');
   }
 
@@ -61,7 +61,7 @@ async function updateDesktopIcons(sourceImage, electronIconsDir) {
   await ensureFolderExists(electronIconsDir);
   const temporaryDir = await mkdtemp('icon-');
   const temporaryPngFile = join(temporaryDir, 'icon.png');
-  console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by icon-builder
+  console.log(`Converting from SVG (${sourceImage}) to PNG: ${temporaryPngFile}`); // required by `icon-builder`
   await runCommand(
     'npx',
     'svgexport',

scripts/npm-install.js

@@ -0,0 +1,199 @@
+/*
+Description:
+  This script manages NPM dependencies for a project.
+  It offers capabilities like doing a fresh install, retries on network errors, and other features.
+
+Usage:
+  npm run install-deps [-- <options>]
+  node scripts/npm-install.js [options]
+
+Options:
+  --root-directory <path>
+    Specifies the root directory where package.json resides
+    Defaults to the current working directory.
+    Example: npm run install-deps -- --root-directory /your/path/here
+
+  --no-errors
+    Ignores errors and continues the execution.
+    Example: npm run install-deps -- --no-errors
+
+  --ci
+    Uses 'npm ci' for dependency installation instead of 'npm install'.
+    Example: npm run install-deps -- --ci
+
+  --fresh
+    Removes the existing node_modules directory before installing dependencies.
+    Example: npm run install-deps -- --fresh
+
+  --non-deterministic
+    Removes package-lock.json for a non-deterministic installation.
+    Example: npm run install-deps -- --non-deterministic
+
+Note:
+
+  Flags can be combined as needed.
+  Example: npm run install-deps -- --fresh --non-deterministic
+*/
+
+import { exec } from 'child_process';
+import { resolve } from 'path';
+import { access, rm, unlink } from 'fs/promises';
+import { constants } from 'fs';
+
+const MAX_RETRIES = 5;
+const RETRY_DELAY_IN_MS = 5 /* seconds */ * 1000;
+const ARG_NAMES = {
+  rootDirectory: '--root-directory',
+  ignoreErrors: '--no-errors',
+  ci: '--ci',
+  fresh: '--fresh',
+  nonDeterministic: '--non-deterministic',
+};
+
+async function main() {
+  const options = getOptions();
+  console.log('Options:', options);
+  await ensureNpmRootDirectory(options.rootDirectory);
+  await ensureNpmIsAvailable();
+  if (options.fresh) {
+    await removeNodeModules(options.rootDirectory);
+  }
+  if (options.nonDeterministic) {
+    await removePackageLockJson(options.rootDirectory);
+  }
+  const command = buildCommand(options.ci, options.outputErrors);
+  console.log('Starting dependency installation...');
+  const exitCode = await executeWithRetry(
+    command,
+    options.workingDirectory,
+    MAX_RETRIES,
+    RETRY_DELAY_IN_MS,
+  );
+  if (exitCode === 0) {
+    console.log('🎊 Installed dependencies...');
+  } else {
+    console.error(`💀 Failed to install dependencies, exit code: ${exitCode}`);
+  }
+  process.exit(exitCode);
+}
+
+async function removeNodeModules(workingDirectory) {
+  const nodeModulesDirectory = resolve(workingDirectory, 'node_modules');
+  if (await exists('./node_modules')) {
+    console.log('Removing node_modules...');
+    await rm(nodeModulesDirectory, { recursive: true });
+  }
+}
+
+async function removePackageLockJson(workingDirectory) {
+  const packageLockJsonFile = resolve(workingDirectory, 'package-lock.json');
+  if (await exists(packageLockJsonFile)) {
+    console.log('Removing package-lock.json...');
+    await unlink(packageLockJsonFile);
+  }
+}
+
+async function ensureNpmIsAvailable() {
+  const exitCode = await executeCommand('npm --version');
+  if (exitCode !== 0) {
+    throw new Error('`npm` in not available!');
+  }
+}
+
+async function ensureNpmRootDirectory(workingDirectory) {
+  const packageJsonPath = resolve(workingDirectory, 'package.json');
+  if (!await exists(packageJsonPath)) {
+    throw new Error(`Not an NPM project root: ${workingDirectory}`);
+  }
+}
+
+function buildCommand(ci, outputErrors) {
+  const baseCommand = ci ? 'npm ci' : 'npm install';
+  if (!outputErrors) {
+    return `${baseCommand} --loglevel=error`;
+  }
+  return baseCommand;
+}
+
+function getOptions() {
+  const processArgs = process.argv.slice(2); // Slice off the node and script name
+  return {
+    rootDirectory: processArgs.includes('--root-directory') ? processArgs[processArgs.indexOf('--root-directory') + 1] : process.cwd(),
+    outputErrors: !processArgs.includes(ARG_NAMES.ignoreErrors),
+    ci: processArgs.includes(ARG_NAMES.ci),
+    fresh: processArgs.includes(ARG_NAMES.fresh),
+    nonDeterministic: processArgs.includes(ARG_NAMES.nonDeterministic),
+  };
+}
+
+async function executeWithRetry(
+  command,
+  workingDirectory,
+  maxRetries,
+  retryDelayInMs,
+  currentAttempt = 1,
+) {
+  const statusCode = await executeCommand(command, workingDirectory, true, true);
+  if (statusCode === 0 || currentAttempt >= maxRetries) {
+    return statusCode;
+  }
+
+  console.log(`⚠️🔄 Attempt ${currentAttempt} failed. Retrying in ${retryDelayInMs / 1000} seconds...`);
+  await sleep(retryDelayInMs);
+
+  const retryResult = await executeWithRetry(
+    command,
+    workingDirectory,
+    maxRetries,
+    retryDelayInMs,
+    currentAttempt + 1,
+  );
+  return retryResult;
+}
+
+async function executeCommand(
+  command,
+  workingDirectory = process.cwd(),
+  logStdout = false,
+  logCommand = false,
+) {
+  if (logCommand) {
+    console.log(`▶️ Executing command "${command}" at "${workingDirectory}"`);
+  }
+  const process = exec(
+    command,
+    {
+      cwd: workingDirectory,
+    },
+  );
+  if (logStdout) {
+    process.stdout.on('data', (data) => {
+      console.log(data.toString());
+    });
+  }
+  process.stderr.on('data', (data) => {
+    console.error(data.toString());
+  });
+  return new Promise((resolve) => {
+    process.on('exit', (code) => {
+      resolve(code);
+    });
+  });
+}
+
+function sleep(milliseconds) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, milliseconds);
+  });
+}
+
+async function exists(path) {
+  try {
+    await access(path, constants.F_OK);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+await main();

scripts/print-dist-dir.js

@@ -0,0 +1,58 @@
+/**
+ * Description:
+ *   This script determines the absolute path of a distribution directory based on CLI arguments
+ *   and outputs its absolute path. It is designed to be run programmatically by other scripts.
+ *
+ * Usage:
+ *   node scripts/print-dist-dir.js [options]
+ *
+ * Options:
+ *   --electron-unbundled   Path for the unbundled Electron application
+ *   --electron-bundled     Path for the bundled Electron application
+ *   --web                  Path for the web application
+ */
+
+import { resolve } from 'path';
+import { readFile } from 'fs/promises';
+
+const DIST_DIRS_JSON_FILE_PATH = resolve(process.cwd(), 'dist-dirs.json'); // cannot statically import because ESLint does not support it https://github.com/eslint/eslint/discussions/15305
+const CLI_ARGUMENTS = process.argv.slice(2);
+
+async function main() {
+  const distDirs = await readDistDirsJsonFile(DIST_DIRS_JSON_FILE_PATH);
+  const relativeDistDir = determineRelativeDistDir(distDirs, CLI_ARGUMENTS);
+  const absoluteDistDir = resolve(process.cwd(), relativeDistDir);
+  console.log(absoluteDistDir);
+}
+
+function mapCliFlagsToDistDirs(distDirs) {
+  return {
+    '--electron-unbundled': distDirs.electronUnbundled,
+    '--electron-bundled': distDirs.electronBundled,
+    '--web': distDirs.web,
+  };
+}
+
+function determineRelativeDistDir(distDirsJsonObject, cliArguments) {
+  const cliFlagDistDirMap = mapCliFlagsToDistDirs(distDirsJsonObject);
+  const availableCliFlags = Object.keys(cliFlagDistDirMap);
+  const requestedCliFlags = cliArguments.filter((arg) => {
+    return availableCliFlags.includes(arg);
+  });
+  if (!requestedCliFlags.length) {
+    throw new Error(`No distribution directory was requested. Please use one of these flags: ${availableCliFlags.join(', ')}`);
+  }
+  if (requestedCliFlags.length > 1) {
+    throw new Error(`Multiple distribution directories were requested, but this script only supports one: ${requestedCliFlags.join(', ')}`);
+  }
+  const selectedCliFlag = requestedCliFlags[0];
+  return cliFlagDistDirMap[selectedCliFlag];
+}
+
+async function readDistDirsJsonFile(absoluteConfigJsonFilePath) {
+  const fileContentAsText = await readFile(absoluteConfigJsonFilePath, 'utf8');
+  const parsedJsonData = JSON.parse(fileContentAsText);
+  return parsedJsonData;
+}
+
+await main();

scripts/verify-build-artifacts.js

@@ -0,0 +1,133 @@
+/**
+ * Description:
+ *   This script verifies the existence and content of build artifacts based on the
+ *   provided CLI flags. It exists with exit code `0` if all verifications pass, otherwise
+ *   with exit code `1`.
+ *
+ * Usage:
+ *   node scripts/verify-build-artifacts.js [options]
+ *
+ * Options:
+ *   --electron-unbundled    Verify artifacts for the unbundled Electron application.
+ *   --electron-bundled      Verify artifacts for the bundled Electron application.
+ *   --web                   Verify artifacts for the web application.
+ */
+
+import { access, readdir } from 'fs/promises';
+import { exec } from 'child_process';
+import { resolve } from 'path';
+
+const PROCESS_ARGUMENTS = process.argv.slice(2);
+const PRINT_DIST_DIR_SCRIPT_BASE_COMMAND = 'node scripts/print-dist-dir';
+
+async function main() {
+  const buildConfigs = getBuildVerificationConfigs();
+  if (!anyCommandsFound(Object.keys(buildConfigs))) {
+    die(`No valid command found in process arguments. Expected one of: ${Object.keys(buildConfigs).join(', ')}`);
+  }
+  /* eslint-disable no-await-in-loop */
+  for (const [command, config] of Object.entries(buildConfigs)) {
+    if (PROCESS_ARGUMENTS.includes(command)) {
+      const distDir = await executePrintDistDirScript(config.printDistDirScriptArgument);
+      await verifyDirectoryExists(distDir);
+      await verifyNonEmptyDirectory(distDir);
+      await verifyFilesExist(distDir, config.filePatterns);
+    }
+  }
+  /* eslint-enable no-await-in-loop */
+  console.log('✅ Build completed successfully and all expected artifacts are in place.');
+  process.exit(0);
+}
+
+function getBuildVerificationConfigs() {
+  return {
+    '--electron-unbundled': {
+      printDistDirScriptArgument: '--electron-unbundled',
+      filePatterns: [
+        /main[/\\]index\.cjs/,
+        /preload[/\\]index\.cjs/,
+        /renderer[/\\]index\.htm(l)?/,
+      ],
+    },
+    '--electron-bundled': {
+      printDistDirScriptArgument: '--electron-bundled',
+      filePatterns: [
+        /latest.*\.yml/, // generates latest.yml for auto-updates
+        /.*-\d+\.\d+\.\d+\..*/, // a file with extension and semantic version (packaged application)
+      ],
+    },
+    '--web': {
+      printDistDirScriptArgument: '--web',
+      filePatterns: [
+        /index\.htm(l)?/,
+      ],
+    },
+  };
+}
+
+function anyCommandsFound(commands) {
+  return PROCESS_ARGUMENTS.some((arg) => commands.includes(arg));
+}
+
+async function verifyDirectoryExists(directoryPath) {
+  try {
+    await access(directoryPath);
+  } catch (error) {
+    die(`Directory does not exist at \`${directoryPath}\`:\n\t${error.message}`);
+  }
+}
+
+async function verifyNonEmptyDirectory(directoryPath) {
+  const files = await readdir(directoryPath);
+  if (files.length === 0) {
+    die(`Directory is empty at \`${directoryPath}\``);
+  }
+}
+
+async function verifyFilesExist(directoryPath, filePatterns) {
+  const files = await listAllFilesRecursively(directoryPath);
+  for (const pattern of filePatterns) {
+    const match = files.some((file) => pattern.test(file));
+    if (!match) {
+      die(
+        `No file matches the pattern ${pattern.source} in directory \`${directoryPath}\``,
+        `\nFiles in directory:\n${files.map((file) => `\t- ${file}`).join('\n')}`,
+      );
+    }
+  }
+}
+
+async function listAllFilesRecursively(directoryPath) {
+  const dir = await readdir(directoryPath, { withFileTypes: true });
+  const files = await Promise.all(dir.map(async (dirent) => {
+    const absolutePath = resolve(directoryPath, dirent.name);
+    if (dirent.isDirectory()) {
+      return listAllFilesRecursively(absolutePath);
+    }
+    return absolutePath;
+  }));
+  return files.flat();
+}
+
+async function executePrintDistDirScript(flag) {
+  return new Promise((resolve, reject) => {
+    const commandToRun = `${PRINT_DIST_DIR_SCRIPT_BASE_COMMAND} ${flag}`;
+
+    exec(commandToRun, (error, stdout, stderr) => {
+      if (error) {
+        reject(new Error(`Execution failed with error: ${error}`));
+      } else if (stderr) {
+        reject(new Error(`Execution failed with stderr: ${stderr}`));
+      } else {
+        resolve(stdout.trim());
+      }
+    });
+  });
+}
+
+function die(...message) {
+  console.error(...message);
+  process.exit(1);
+}
+
+await main();

scripts/verify-web-server-status.js

@@ -0,0 +1,62 @@
+/**
+ * Description:
+ *   This script checks if a server, provided as a CLI argument, is up
+ *   and returns an HTTP 200 status code.
+ *   It is designed to provide easy verification of server availability
+ *   and will retry a specified number of times.
+ *
+ * Usage:
+ *   node ./scripts/verify-web-server-status.js --url [URL]
+ *
+ * Options:
+ *   --url   URL of the server to check
+ */
+
+import { get } from 'http';
+
+const MAX_RETRIES = 30;
+const RETRY_DELAY_IN_SECONDS = 3;
+const URL_PARAMETER_NAME = '--url';
+
+function checkServer(currentRetryCount = 1) {
+  const serverUrl = getServerUrl();
+  console.log(`Requesting ${serverUrl}...`);
+  get(serverUrl, (res) => {
+    if (res.statusCode === 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}.`);
+      retry(currentRetryCount);
+    }
+  }).on('error', (err) => {
+    console.error('Error making the request:', err);
+    retry(currentRetryCount);
+  });
+}
+
+function retry(currentRetryCount) {
+  console.log(`Attempt ${currentRetryCount}/${MAX_RETRIES}:`);
+  console.log(`Retrying in ${RETRY_DELAY_IN_SECONDS} seconds.`);
+
+  const remainingTime = (MAX_RETRIES - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
+  console.log(`Time remaining before timeout: ${remainingTime}s`);
+
+  if (currentRetryCount < MAX_RETRIES) {
+    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.');
+    process.exit(1);
+  }
+}
+
+function getServerUrl() {
+  const urlIndex = process.argv.indexOf(URL_PARAMETER_NAME);
+  if (urlIndex === -1 || urlIndex === process.argv.length - 1) {
+    console.error(`Parameter "${URL_PARAMETER_NAME}" is not provided.`);
+    process.exit(1);
+  }
+  return process.argv[urlIndex + 1];
+}
+
+checkServer();

src/TypeHelpers.ts

@@ -0,0 +1,16 @@
+export type Constructible<T, TArgs extends unknown[] = never> = {
+  prototype: T;
+  apply: (this: unknown, args: TArgs) => void;
+  readonly name: string;
+};
+
+export type PropertyKeys<T> = {
+  [K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? never : K;
+}[keyof T];
+
+export type ConstructorArguments<T> =
+  T extends new (...args: infer U) => unknown ? U : never;
+
+export type FunctionKeys<T> = {
+  [K in keyof T]: T[K] extends (...args: unknown[]) => unknown ? K : never;
+}[keyof T];

src/application/Common/CustomError.ts

@@ -0,0 +1,50 @@
+/*
+  Provides a unified and resilient way to extend errors across platforms.
+
+  Rationale:
+  - Babel:
+    > "Built-in classes cannot be properly subclassed due to limitations in ES5"
+    > https://web.archive.org/web/20230810014108/https://babeljs.io/docs/caveats#classes
+  - TypeScript:
+    > "Extending built-ins like Error, Array, and Map may no longer work"
+    > 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) {
+    super(message, options);
+
+    fixPrototype(this, new.target.prototype);
+    ensureStackTrace(this);
+
+    this.name = this.constructor.name;
+  }
+}
+
+export const Environment = {
+  getSetPrototypeOf: () => Object.setPrototypeOf,
+  getCaptureStackTrace: () => Error.captureStackTrace,
+};
+
+function fixPrototype(target: Error, prototype: CustomError) {
+  // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+  const setPrototypeOf = Environment.getSetPrototypeOf();
+  if (!functionExists(setPrototypeOf)) {
+    return;
+  }
+  setPrototypeOf(target, prototype);
+}
+
+function ensureStackTrace(target: Error) {
+  const captureStackTrace = Environment.getCaptureStackTrace();
+  if (!functionExists(captureStackTrace)) {
+    // captureStackTrace is only available on V8, if it's not available
+    // modern JS engines will usually generate a stack trace on error objects when they're thrown.
+    return;
+  }
+  captureStackTrace(target, target.constructor);
+}
+
+function functionExists(func: unknown): boolean {
+  // Not doing truthy/falsy check i.e. if(func) as most values are truthy in JS for robustness
+  return typeof func === 'function';
+}

src/application/Context/ApplicationContextFactory.ts

@@ -1,25 +1,23 @@
 import { IApplicationContext } from '@/application/Context/IApplicationContext';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { IApplication } from '@/domain/IApplication';
-import { Environment } from '../Environment/Environment';
+import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
-import { IEnvironment } from '../Environment/IEnvironment';
 import { IApplicationFactory } from '../IApplicationFactory';
 import { ApplicationFactory } from '../ApplicationFactory';
 import { ApplicationContext } from './ApplicationContext';
 
 export async function buildContext(
   factory: IApplicationFactory = ApplicationFactory.Current,
-  environment = Environment.CurrentEnvironment,
+  environment = RuntimeEnvironment.CurrentEnvironment,
 ): Promise<IApplicationContext> {
   if (!factory) { throw new Error('missing factory'); }
   if (!environment) { throw new Error('missing environment'); }
   const app = await factory.getApp();
-  const os = getInitialOs(app, environment);
+  const os = getInitialOs(app, environment.os);
   return new ApplicationContext(app, os);
 }
 
-function getInitialOs(app: IApplication, environment: IEnvironment): OperatingSystem {
+function getInitialOs(app: IApplication, currentOs: OperatingSystem): OperatingSystem {
-  const currentOs = environment.os;
   const supportedOsList = app.getSupportedOsList();
   if (supportedOsList.includes(currentOs)) {
     return currentOs;

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

@@ -0,0 +1,4 @@
+export enum FilterActionType {
+  Apply,
+  Clear,
+}

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

@@ -0,0 +1,37 @@
+import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
+import { FilterActionType } from './FilterActionType';
+import { IFilterChangeDetails, IFilterChangeDetailsVisitor } from './IFilterChangeDetails';
+
+export class FilterChange implements IFilterChangeDetails {
+  public static forApply(filter: IFilterResult) {
+    if (!filter) {
+      throw new Error('missing filter');
+    }
+    return new FilterChange(FilterActionType.Apply, filter);
+  }
+
+  public static forClear() {
+    return new FilterChange(FilterActionType.Clear);
+  }
+
+  private constructor(
+    public readonly actionType: FilterActionType,
+    public readonly filter?: IFilterResult,
+  ) { }
+
+  public visit(visitor: IFilterChangeDetailsVisitor): void {
+    if (!visitor) {
+      throw new Error('missing visitor');
+    }
+    switch (this.actionType) {
+      case FilterActionType.Apply:
+        visitor.onApply(this.filter);
+        break;
+      case FilterActionType.Clear:
+        visitor.onClear();
+        break;
+      default:
+        throw new Error(`Unknown action type: ${this.actionType}`);
+    }
+  }
+}

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

@@ -0,0 +1,14 @@
+import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
+import { FilterActionType } from './FilterActionType';
+
+export interface IFilterChangeDetails {
+  readonly actionType: FilterActionType;
+  readonly filter?: IFilterResult;
+
+  visit(visitor: IFilterChangeDetailsVisitor): void;
+}
+
+export interface IFilterChangeDetailsVisitor {
+  onClear(): void;
+  onApply(filter: IFilterResult): void;
+}

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

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

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

@@ -4,11 +4,11 @@ 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 filtered = new EventSource<IFilterResult>();
+  public readonly filterChanged = new EventSource<IFilterChangeDetails>();
-
-  public readonly filterRemoved = new EventSource<void>();
 
   public currentFilter: IFilterResult | undefined;
 
@@ -16,9 +16,9 @@ export class UserFilter implements IUserFilter {
 
   }
 
-  public setFilter(filter: string): void {
+  public applyFilter(filter: string): void {
     if (!filter) {
-      throw new Error('Filter must be defined and not empty. Use removeFilter() to remove the 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(
@@ -33,12 +33,12 @@ export class UserFilter implements IUserFilter {
       filter,
     );
     this.currentFilter = matches;
-    this.filtered.notify(matches);
+    this.filterChanged.notify(FilterChange.forApply(this.currentFilter));
   }
 
-  public removeFilter(): void {
+  public clearFilter(): void {
     this.currentFilter = undefined;
-    this.filterRemoved.notify();
+    this.filterChanged.notify(FilterChange.forClear());
   }
 }
 

src/application/Environment/Environment.ts

@@ -1,89 +0,0 @@
-import { OperatingSystem } from '@/domain/OperatingSystem';
-import { BrowserOsDetector } from './BrowserOs/BrowserOsDetector';
-import { IBrowserOsDetector } from './BrowserOs/IBrowserOsDetector';
-import { IEnvironment } from './IEnvironment';
-
-export interface IEnvironmentVariables {
-  readonly window: Window & typeof globalThis;
-  readonly process: NodeJS.Process;
-  readonly navigator: Navigator;
-}
-
-export class Environment implements IEnvironment {
-  public static readonly CurrentEnvironment: IEnvironment = new Environment({
-    window,
-    process: typeof process !== 'undefined' ? process /* electron only */ : undefined,
-    navigator,
-  });
-
-  public readonly isDesktop: boolean;
-
-  public readonly os: OperatingSystem;
-
-  protected constructor(
-    variables: IEnvironmentVariables,
-    browserOsDetector: IBrowserOsDetector = new BrowserOsDetector(),
-  ) {
-    if (!variables) {
-      throw new Error('variables is null or empty');
-    }
-    this.isDesktop = isDesktop(variables);
-    if (this.isDesktop) {
-      this.os = getDesktopOsType(getProcessPlatform(variables));
-    } else {
-      const userAgent = getUserAgent(variables);
-      this.os = !userAgent ? undefined : browserOsDetector.detect(userAgent);
-    }
-  }
-}
-
-function getUserAgent(variables: IEnvironmentVariables): string {
-  if (!variables.window || !variables.window.navigator) {
-    return undefined;
-  }
-  return variables.window.navigator.userAgent;
-}
-
-function getProcessPlatform(variables: IEnvironmentVariables): string {
-  if (!variables.process || !variables.process.platform) {
-    return undefined;
-  }
-  return variables.process.platform;
-}
-
-function getDesktopOsType(processPlatform: string): OperatingSystem | undefined {
-  // https://nodejs.org/api/process.html#process_process_platform
-  switch (processPlatform) {
-    case 'darwin':
-      return OperatingSystem.macOS;
-    case 'win32':
-      return OperatingSystem.Windows;
-    case 'linux':
-      return OperatingSystem.Linux;
-    default:
-      return undefined;
-  }
-}
-
-function isDesktop(variables: IEnvironmentVariables): boolean {
-  // More: https://github.com/electron/electron/issues/2288
-  // Renderer process
-  if (variables.window
-    && variables.window.process
-    && variables.window.process.type === 'renderer') {
-    return true;
-  }
-  // Main process
-  if (variables.process
-    && variables.process.versions
-    && Boolean(variables.process.versions.electron)) {
-    return true;
-  }
-  // Detect the user agent when the `nodeIntegration` option is set to true
-  if (variables.navigator
-    && variables.navigator.userAgent
-    && variables.navigator.userAgent.includes('Electron')) {
-    return true;
-  }
-  return false;
-}

src/application/Environment/IEnvironment.ts

@@ -1,6 +0,0 @@
-import { OperatingSystem } from '@/domain/OperatingSystem';
-
-export interface IEnvironment {
-  readonly isDesktop: boolean;
-  readonly os: OperatingSystem;
-}

src/application/Parser/ApplicationParser.ts

@@ -7,16 +7,19 @@ import MacOsData from '@/application/collections/macos.yaml';
 import LinuxData from '@/application/collections/linux.yaml';
 import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
 import { Application } from '@/domain/Application';
+import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
+import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
 import { parseCategoryCollection } from './CategoryCollectionParser';
 
 export function parseApplication(
-  parser = CategoryCollectionParser,
+  categoryParser = parseCategoryCollection,
-  processEnv: NodeJS.ProcessEnv = process.env,
+  informationParser = parseProjectInformation,
+  metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
   collectionsData = PreParsedCollections,
 ): IApplication {
   validateCollectionsData(collectionsData);
-  const information = parseProjectInformation(processEnv);
+  const information = informationParser(metadata);
-  const collections = collectionsData.map((collection) => parser(collection, information));
+  const collections = collectionsData.map((collection) => categoryParser(collection, information));
   const app = new Application(information, collections);
   return app;
 }
@@ -24,16 +27,12 @@ export function parseApplication(
 export type CategoryCollectionParserType
     = (file: CollectionData, info: IProjectInformation) => ICategoryCollection;
 
-const CategoryCollectionParser: CategoryCollectionParserType = (file, info) => {
-  return parseCategoryCollection(file, info);
-};
-
 const PreParsedCollections: readonly CollectionData [] = [
   WindowsData, MacOsData, LinuxData,
 ];
 
 function validateCollectionsData(collections: readonly CollectionData[]) {
-  if (!collections || !collections.length) {
+  if (!collections?.length) {
     throw new Error('missing collections');
   }
   if (collections.some((collection) => !collection)) {

src/application/Parser/NodeValidation/NodeDataError.ts

@@ -1,11 +1,10 @@
+import { CustomError } from '@/application/Common/CustomError';
 import { NodeType } from './NodeType';
 import { NodeData } from './NodeData';
 
-export class NodeDataError extends Error {
+export class NodeDataError extends CustomError {
   constructor(message: string, public readonly context: INodeDataErrorContext) {
     super(createMessage(message, context));
-    Object.setPrototypeOf(this, new.target.prototype); // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
-    this.name = new.target.name;
   }
 }
 

src/application/Parser/ProjectInformationParser.ts

@@ -1,28 +1,29 @@
 import { IProjectInformation } from '@/domain/IProjectInformation';
 import { ProjectInformation } from '@/domain/ProjectInformation';
+import { IAppMetadata } from '@/infrastructure/EnvironmentVariables/IAppMetadata';
 import { Version } from '@/domain/Version';
+import { EnvironmentVariablesFactory } from '@/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory';
+import { ConstructorArguments } from '@/TypeHelpers';
 
-export function parseProjectInformation(
+export function
-  environment: NodeJS.ProcessEnv | VueAppEnvironment,
+parseProjectInformation(
+  metadata: IAppMetadata = EnvironmentVariablesFactory.Current.instance,
+  createProjectInformation: ProjectInformationFactory = (
+    ...args
+  ) => new ProjectInformation(...args),
 ): IProjectInformation {
-  const version = new Version(environment[VueAppEnvironmentKeys.VUE_APP_VERSION]);
+  const version = new Version(
-  return new ProjectInformation(
+    metadata.version,
-    environment[VueAppEnvironmentKeys.VUE_APP_NAME],
+  );
+  return createProjectInformation(
+    metadata.name,
     version,
-    environment[VueAppEnvironmentKeys.VUE_APP_SLOGAN],
+    metadata.slogan,
-    environment[VueAppEnvironmentKeys.VUE_APP_REPOSITORY_URL],
+    metadata.repositoryUrl,
-    environment[VueAppEnvironmentKeys.VUE_APP_HOMEPAGE_URL],
+    metadata.homepageUrl,
   );
 }
 
-export const VueAppEnvironmentKeys = {
+export type ProjectInformationFactory = (
-  VUE_APP_VERSION: 'VUE_APP_VERSION',
+  ...args: ConstructorArguments<typeof ProjectInformation>
-  VUE_APP_NAME: 'VUE_APP_NAME',
+) => IProjectInformation;
-  VUE_APP_SLOGAN: 'VUE_APP_SLOGAN',
-  VUE_APP_REPOSITORY_URL: 'VUE_APP_REPOSITORY_URL',
-  VUE_APP_HOMEPAGE_URL: 'VUE_APP_HOMEPAGE_URL',
-} as const;
-
-export type VueAppEnvironment = {
-  [K in keyof typeof VueAppEnvironmentKeys]: string;
-};

src/application/Parser/Script/Compiler/Expressions/Pipes/PipeDefinitions/EscapeDoubleQuotes.ts

@@ -8,7 +8,7 @@ export class EscapeDoubleQuotes implements IPipe {
       return raw;
     }
     return raw.replaceAll('"', '"^""');
-    /* eslint-disable max-len */
+    /* eslint-disable vue/max-len */
     /*
       "^"" is the most robust and stable choice.
       Other options:
@@ -28,6 +28,6 @@ export class EscapeDoubleQuotes implements IPipe {
           Works when using "^"": `PowerShell -Command ""^""a&  c"^"".length"`
       A good explanation: https://stackoverflow.com/a/31413730
     */
-    /* eslint-enable max-len */
+    /* eslint-enable vue/max-len */
   }
 }

src/application/Parser/Script/Compiler/Function/Call/Compiler/CodeSegmentJoin/CodeSegmentMerger.ts

@@ -0,0 +1,5 @@
+import { CompiledCode } from '../CompiledCode';
+
+export interface CodeSegmentMerger {
+  mergeCodeParts(codeSegments: readonly CompiledCode[]): CompiledCode;
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/CodeSegmentJoin/NewlineCodeSegmentMerger.ts

@@ -0,0 +1,20 @@
+import { CompiledCode } from '../CompiledCode';
+import { CodeSegmentMerger } from './CodeSegmentMerger';
+
+export class NewlineCodeSegmentMerger implements CodeSegmentMerger {
+  public mergeCodeParts(codeSegments: readonly CompiledCode[]): CompiledCode {
+    if (!codeSegments?.length) {
+      throw new Error('missing segments');
+    }
+    return {
+      code: joinCodeParts(codeSegments.map((f) => f.code)),
+      revertCode: joinCodeParts(codeSegments.map((f) => f.revertCode)),
+    };
+  }
+}
+
+function joinCodeParts(codeSegments: readonly string[]): string {
+  return codeSegments
+    .filter((segment) => segment?.length > 0)
+    .join('\n');
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/CompiledCode.ts

@@ -1,4 +1,4 @@
-export interface ICompiledCode {
+export interface CompiledCode {
   readonly code: string;
   readonly revertCode?: string;
 }

src/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext.ts

@@ -0,0 +1,9 @@
+import { ISharedFunctionCollection } from '@/application/Parser/Script/Compiler/Function/ISharedFunctionCollection';
+import { FunctionCall } from '../FunctionCall';
+import type { SingleCallCompiler } from './SingleCall/SingleCallCompiler';
+
+export interface FunctionCallCompilationContext {
+  readonly allFunctions: ISharedFunctionCollection;
+  readonly rootCallSequence: readonly FunctionCall[];
+  readonly singleCallCompiler: SingleCallCompiler;
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompiler.ts

@@ -1,149 +1,10 @@
-import { IReadOnlyFunctionCallArgumentCollection } from '@/application/Parser/Script/Compiler/Function/Call/Argument/IFunctionCallArgumentCollection';
+import { ISharedFunctionCollection } from '@/application/Parser/Script/Compiler/Function/ISharedFunctionCollection';
-import { IFunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/IFunctionCall';
-import { FunctionCallArgument } from '@/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgument';
-import { ISharedFunctionCollection } from '../../ISharedFunctionCollection';
-import { IExpressionsCompiler } from '../../../Expressions/IExpressionsCompiler';
-import { ExpressionsCompiler } from '../../../Expressions/ExpressionsCompiler';
-import { ISharedFunction, IFunctionCode } from '../../ISharedFunction';
 import { FunctionCall } from '../FunctionCall';
-import { FunctionCallArgumentCollection } from '../Argument/FunctionCallArgumentCollection';
+import { CompiledCode } from './CompiledCode';
-import { IFunctionCallCompiler } from './IFunctionCallCompiler';
-import { ICompiledCode } from './ICompiledCode';
 
-export class FunctionCallCompiler implements IFunctionCallCompiler {
+export interface FunctionCallCompiler {
-  public static readonly instance: IFunctionCallCompiler = new FunctionCallCompiler();
+  compileFunctionCalls(
-
+    calls: readonly FunctionCall[],
-  protected constructor(
-    private readonly expressionsCompiler: IExpressionsCompiler = new ExpressionsCompiler(),
-  ) {
-  }
-
-  public compileCall(
-    calls: IFunctionCall[],
     functions: ISharedFunctionCollection,
-  ): ICompiledCode {
+  ): CompiledCode;
-    if (!functions) { throw new Error('missing functions'); }
-    if (!calls) { throw new Error('missing calls'); }
-    if (calls.some((f) => !f)) { throw new Error('missing function call'); }
-    const context: ICompilationContext = {
-      allFunctions: functions,
-      callSequence: calls,
-      expressionsCompiler: this.expressionsCompiler,
-    };
-    const code = compileCallSequence(context);
-    return code;
-  }
-}
-
-interface ICompilationContext {
-  allFunctions: ISharedFunctionCollection;
-  callSequence: readonly IFunctionCall[];
-  expressionsCompiler: IExpressionsCompiler;
-}
-
-interface ICompiledFunctionCall {
-  readonly code: string;
-  readonly revertCode: string;
-}
-
-function compileCallSequence(context: ICompilationContext): ICompiledFunctionCall {
-  const compiledFunctions = context.callSequence
-    .flatMap((call) => compileSingleCall(call, context));
-  return {
-    code: merge(compiledFunctions.map((f) => f.code)),
-    revertCode: merge(compiledFunctions.map((f) => f.revertCode)),
-  };
-}
-
-function compileSingleCall(
-  call: IFunctionCall,
-  context: ICompilationContext,
-): ICompiledFunctionCall[] {
-  const func = context.allFunctions.getFunctionByName(call.functionName);
-  ensureThatCallArgumentsExistInParameterDefinition(func, call.args);
-  if (func.body.code) { // Function with inline code
-    const compiledCode = compileCode(func.body.code, call.args, context.expressionsCompiler);
-    return [compiledCode];
-  }
-  // Function with inner calls
-  return func.body.calls
-    .map((innerCall) => {
-      const compiledArgs = compileArgs(innerCall.args, call.args, context.expressionsCompiler);
-      const compiledCall = new FunctionCall(innerCall.functionName, compiledArgs);
-      return compileSingleCall(compiledCall, context);
-    })
-    .flat();
-}
-
-function compileCode(
-  code: IFunctionCode,
-  args: IReadOnlyFunctionCallArgumentCollection,
-  compiler: IExpressionsCompiler,
-): ICompiledFunctionCall {
-  return {
-    code: compiler.compileExpressions(code.execute, args),
-    revertCode: compiler.compileExpressions(code.revert, args),
-  };
-}
-
-function compileArgs(
-  argsToCompile: IReadOnlyFunctionCallArgumentCollection,
-  args: IReadOnlyFunctionCallArgumentCollection,
-  compiler: IExpressionsCompiler,
-): IReadOnlyFunctionCallArgumentCollection {
-  return argsToCompile
-    .getAllParameterNames()
-    .map((parameterName) => {
-      const { argumentValue } = argsToCompile.getArgument(parameterName);
-      const compiledValue = compiler.compileExpressions(argumentValue, args);
-      return new FunctionCallArgument(parameterName, compiledValue);
-    })
-    .reduce((compiledArgs, arg) => {
-      compiledArgs.addArgument(arg);
-      return compiledArgs;
-    }, new FunctionCallArgumentCollection());
-}
-
-function merge(codeParts: readonly string[]): string {
-  return codeParts
-    .filter((part) => part?.length > 0)
-    .join('\n');
-}
-
-function ensureThatCallArgumentsExistInParameterDefinition(
-  func: ISharedFunction,
-  args: IReadOnlyFunctionCallArgumentCollection,
-): void {
-  const callArgumentNames = args.getAllParameterNames();
-  const functionParameterNames = func.parameters.all.map((param) => param.name) || [];
-  const unexpectedParameters = findUnexpectedParameters(callArgumentNames, functionParameterNames);
-  throwIfNotEmpty(func.name, unexpectedParameters, functionParameterNames);
-}
-
-function findUnexpectedParameters(
-  callArgumentNames: string[],
-  functionParameterNames: string[],
-): string[] {
-  if (!callArgumentNames.length && !functionParameterNames.length) {
-    return [];
-  }
-  return callArgumentNames
-    .filter((callParam) => !functionParameterNames.includes(callParam));
-}
-
-function throwIfNotEmpty(
-  functionName: string,
-  unexpectedParameters: string[],
-  expectedParameters: string[],
-) {
-  if (!unexpectedParameters.length) {
-    return;
-  }
-  throw new Error(
-    // eslint-disable-next-line prefer-template
-    `Function "${functionName}" has unexpected parameter(s) provided: `
-      + `"${unexpectedParameters.join('", "')}"`
-      + '. Expected parameter(s): '
-      + (expectedParameters.length ? `"${expectedParameters.join('", "')}"` : 'none'),
-  );
 }

src/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallSequenceCompiler.ts

@@ -0,0 +1,36 @@
+import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
+import { ISharedFunctionCollection } from '../../ISharedFunctionCollection';
+import { FunctionCallCompiler } from './FunctionCallCompiler';
+import { CompiledCode } from './CompiledCode';
+import { FunctionCallCompilationContext } from './FunctionCallCompilationContext';
+import { SingleCallCompiler } from './SingleCall/SingleCallCompiler';
+import { AdaptiveFunctionCallCompiler } from './SingleCall/AdaptiveFunctionCallCompiler';
+import { CodeSegmentMerger } from './CodeSegmentJoin/CodeSegmentMerger';
+import { NewlineCodeSegmentMerger } from './CodeSegmentJoin/NewlineCodeSegmentMerger';
+
+export class FunctionCallSequenceCompiler implements FunctionCallCompiler {
+  public static readonly instance: FunctionCallCompiler = new FunctionCallSequenceCompiler();
+
+  /* The constructor is protected to enforce the singleton pattern. */
+  protected constructor(
+    private readonly singleCallCompiler: SingleCallCompiler = new AdaptiveFunctionCallCompiler(),
+    private readonly codeSegmentMerger: CodeSegmentMerger = new NewlineCodeSegmentMerger(),
+  ) { }
+
+  public compileFunctionCalls(
+    calls: readonly FunctionCall[],
+    functions: ISharedFunctionCollection,
+  ): CompiledCode {
+    if (!functions) { throw new Error('missing functions'); }
+    if (!calls?.length) { throw new Error('missing calls'); }
+    if (calls.some((f) => !f)) { throw new Error('missing function call'); }
+    const context: FunctionCallCompilationContext = {
+      allFunctions: functions,
+      rootCallSequence: calls,
+      singleCallCompiler: this.singleCallCompiler,
+    };
+    const codeSegments = context.rootCallSequence
+      .flatMap((call) => this.singleCallCompiler.compileSingleCall(call, context));
+    return this.codeSegmentMerger.mergeCodeParts(codeSegments);
+  }
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/IFunctionCallCompiler.ts

@@ -1,9 +0,0 @@
-import { ISharedFunctionCollection } from '@/application/Parser/Script/Compiler/Function/ISharedFunctionCollection';
-import { IFunctionCall } from '../IFunctionCall';
-import { ICompiledCode } from './ICompiledCode';
-
-export interface IFunctionCallCompiler {
-  compileCall(
-    calls: IFunctionCall[],
-    functions: ISharedFunctionCollection): ICompiledCode;
-}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/AdaptiveFunctionCallCompiler.ts

@@ -0,0 +1,78 @@
+import { FunctionCall } from '../../FunctionCall';
+import { CompiledCode } from '../CompiledCode';
+import { FunctionCallCompilationContext } from '../FunctionCallCompilationContext';
+import { IReadOnlyFunctionCallArgumentCollection } from '../../Argument/IFunctionCallArgumentCollection';
+import { ISharedFunction } from '../../../ISharedFunction';
+import { SingleCallCompiler } from './SingleCallCompiler';
+import { SingleCallCompilerStrategy } from './SingleCallCompilerStrategy';
+import { InlineFunctionCallCompiler } from './Strategies/InlineFunctionCallCompiler';
+import { NestedFunctionCallCompiler } from './Strategies/NestedFunctionCallCompiler';
+
+export class AdaptiveFunctionCallCompiler implements SingleCallCompiler {
+  public constructor(
+    private readonly strategies: SingleCallCompilerStrategy[] = [
+      new InlineFunctionCallCompiler(),
+      new NestedFunctionCallCompiler(),
+    ],
+  ) {
+  }
+
+  public compileSingleCall(
+    call: FunctionCall,
+    context: FunctionCallCompilationContext,
+  ): CompiledCode[] {
+    const func = context.allFunctions.getFunctionByName(call.functionName);
+    ensureThatCallArgumentsExistInParameterDefinition(func, call.args);
+    const strategy = this.findStrategy(func);
+    return strategy.compileFunction(func, call, context);
+  }
+
+  private findStrategy(func: ISharedFunction): SingleCallCompilerStrategy {
+    const strategies = this.strategies.filter((strategy) => strategy.canCompile(func));
+    if (strategies.length > 1) {
+      throw new Error('Multiple strategies found to compile the function call.');
+    }
+    if (strategies.length === 0) {
+      throw new Error('No strategies found to compile the function call.');
+    }
+    return strategies[0];
+  }
+}
+
+function ensureThatCallArgumentsExistInParameterDefinition(
+  func: ISharedFunction,
+  callArguments: IReadOnlyFunctionCallArgumentCollection,
+): void {
+  const callArgumentNames = callArguments.getAllParameterNames();
+  const functionParameterNames = func.parameters.all.map((param) => param.name) || [];
+  const unexpectedParameters = findUnexpectedParameters(callArgumentNames, functionParameterNames);
+  throwIfUnexpectedParametersExist(func.name, unexpectedParameters, functionParameterNames);
+}
+
+function findUnexpectedParameters(
+  callArgumentNames: string[],
+  functionParameterNames: string[],
+): string[] {
+  if (!callArgumentNames.length && !functionParameterNames.length) {
+    return [];
+  }
+  return callArgumentNames
+    .filter((callParam) => !functionParameterNames.includes(callParam));
+}
+
+function throwIfUnexpectedParametersExist(
+  functionName: string,
+  unexpectedParameters: string[],
+  expectedParameters: string[],
+) {
+  if (!unexpectedParameters.length) {
+    return;
+  }
+  throw new Error(
+    // eslint-disable-next-line prefer-template
+    `Function "${functionName}" has unexpected parameter(s) provided: `
+      + `"${unexpectedParameters.join('", "')}"`
+      + '. Expected parameter(s): '
+      + (expectedParameters.length ? `"${expectedParameters.join('", "')}"` : 'none'),
+  );
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/SingleCallCompiler.ts

@@ -0,0 +1,10 @@
+import { FunctionCall } from '../../FunctionCall';
+import { CompiledCode } from '../CompiledCode';
+import { FunctionCallCompilationContext } from '../FunctionCallCompilationContext';
+
+export interface SingleCallCompiler {
+  compileSingleCall(
+    call: FunctionCall,
+    context: FunctionCallCompilationContext,
+  ): CompiledCode[];
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/SingleCallCompilerStrategy.ts

@@ -0,0 +1,13 @@
+import { ISharedFunction } from '@/application/Parser/Script/Compiler/Function/ISharedFunction';
+import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
+import { CompiledCode } from '../CompiledCode';
+import { FunctionCallCompilationContext } from '../FunctionCallCompilationContext';
+
+export interface SingleCallCompilerStrategy {
+  canCompile(func: ISharedFunction): boolean;
+  compileFunction(
+    calledFunction: ISharedFunction,
+    callToFunction: FunctionCall,
+    context: FunctionCallCompilationContext,
+  ): CompiledCode[],
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/Strategies/Argument/ArgumentCompiler.ts

@@ -0,0 +1,10 @@
+import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
+import { FunctionCallCompilationContext } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext';
+
+export interface ArgumentCompiler {
+  createCompiledNestedCall(
+    nestedFunctionCall: FunctionCall,
+    parentFunctionCall: FunctionCall,
+    context: FunctionCallCompilationContext,
+  ): FunctionCall;
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/Strategies/Argument/NestedFunctionArgumentCompiler.ts

@@ -0,0 +1,109 @@
+import { IReadOnlyFunctionCallArgumentCollection } from '@/application/Parser/Script/Compiler/Function/Call/Argument/IFunctionCallArgumentCollection';
+import { FunctionCallArgument } from '@/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgument';
+import { FunctionCallArgumentCollection } from '@/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgumentCollection';
+import { ExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler';
+import { IExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/IExpressionsCompiler';
+import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
+import { FunctionCallCompilationContext } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext';
+import { ParsedFunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/ParsedFunctionCall';
+import { ArgumentCompiler } from './ArgumentCompiler';
+
+export class NestedFunctionArgumentCompiler implements ArgumentCompiler {
+  constructor(
+    private readonly expressionsCompiler: IExpressionsCompiler = new ExpressionsCompiler(),
+  ) { }
+
+  public createCompiledNestedCall(
+    nestedFunction: FunctionCall,
+    parentFunction: FunctionCall,
+    context: FunctionCallCompilationContext,
+  ): FunctionCall {
+    const compiledArgs = compileNestedFunctionArguments(
+      nestedFunction,
+      parentFunction.args,
+      context,
+      this.expressionsCompiler,
+    );
+    const compiledCall = new ParsedFunctionCall(nestedFunction.functionName, compiledArgs);
+    return compiledCall;
+  }
+}
+
+function compileNestedFunctionArguments(
+  nestedFunction: FunctionCall,
+  parentFunctionArgs: IReadOnlyFunctionCallArgumentCollection,
+  context: FunctionCallCompilationContext,
+  expressionsCompiler: IExpressionsCompiler,
+): IReadOnlyFunctionCallArgumentCollection {
+  const requiredParameterNames = context
+    .allFunctions
+    .getRequiredParameterNames(nestedFunction.functionName);
+  const compiledArguments = nestedFunction.args
+    .getAllParameterNames()
+    // Compile each argument value
+    .map((paramName) => ({
+      parameterName: paramName,
+      compiledArgumentValue: compileArgument(
+        paramName,
+        nestedFunction,
+        parentFunctionArgs,
+        expressionsCompiler,
+      ),
+    }))
+    // Filter out arguments with absent values
+    .filter(({
+      parameterName,
+      compiledArgumentValue,
+    }) => isValidNonAbsentArgumentValue(
+      parameterName,
+      compiledArgumentValue,
+      requiredParameterNames,
+    ))
+    /*
+      Create argument object with non-absent values.
+      This is done after eliminating absent values because otherwise creating argument object
+      with absent values throws error.
+    */
+    .map(({
+      parameterName,
+      compiledArgumentValue,
+    }) => new FunctionCallArgument(parameterName, compiledArgumentValue));
+  return buildArgumentCollectionFromArguments(compiledArguments);
+}
+
+function isValidNonAbsentArgumentValue(
+  parameterName: string,
+  argumentValue: string | undefined,
+  requiredParameterNames: string[],
+): boolean {
+  if (argumentValue) {
+    return true;
+  }
+  if (!requiredParameterNames.includes(parameterName)) {
+    return false;
+  }
+  throw new Error(`Compilation resulted in empty value for required parameter: "${parameterName}"`);
+}
+
+function compileArgument(
+  parameterName: string,
+  nestedFunction: FunctionCall,
+  parentFunctionArgs: IReadOnlyFunctionCallArgumentCollection,
+  expressionsCompiler: IExpressionsCompiler,
+): string {
+  try {
+    const { argumentValue: codeInArgument } = nestedFunction.args.getArgument(parameterName);
+    return expressionsCompiler.compileExpressions(codeInArgument, parentFunctionArgs);
+  } catch (err) {
+    throw new AggregateError([err], `Error when compiling argument for "${parameterName}"`);
+  }
+}
+
+function buildArgumentCollectionFromArguments(
+  args: FunctionCallArgument[],
+): FunctionCallArgumentCollection {
+  return args.reduce((compiledArgs, arg) => {
+    compiledArgs.addArgument(arg);
+    return compiledArgs;
+  }, new FunctionCallArgumentCollection());
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/Strategies/InlineFunctionCallCompiler.ts

@@ -0,0 +1,31 @@
+import { ExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler';
+import { IExpressionsCompiler } from '@/application/Parser/Script/Compiler/Expressions/IExpressionsCompiler';
+import { ISharedFunction } from '@/application/Parser/Script/Compiler/Function/ISharedFunction';
+import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
+import { CompiledCode } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/CompiledCode';
+import { SingleCallCompilerStrategy } from '../SingleCallCompilerStrategy';
+
+export class InlineFunctionCallCompiler implements SingleCallCompilerStrategy {
+  public constructor(
+    private readonly expressionsCompiler: IExpressionsCompiler = new ExpressionsCompiler(),
+  ) {
+  }
+
+  public canCompile(func: ISharedFunction): boolean {
+    return func.body.code !== undefined;
+  }
+
+  public compileFunction(
+    calledFunction: ISharedFunction,
+    callToFunction: FunctionCall,
+  ): CompiledCode[] {
+    const { code } = calledFunction.body;
+    const { args } = callToFunction;
+    return [
+      {
+        code: this.expressionsCompiler.compileExpressions(code.execute, args),
+        revertCode: this.expressionsCompiler.compileExpressions(code.revert, args),
+      },
+    ];
+  }
+}

src/application/Parser/Script/Compiler/Function/Call/Compiler/SingleCall/Strategies/NestedFunctionCallCompiler.ts

@@ -0,0 +1,37 @@
+import { ISharedFunction } from '@/application/Parser/Script/Compiler/Function/ISharedFunction';
+import { FunctionCall } from '@/application/Parser/Script/Compiler/Function/Call/FunctionCall';
+import { FunctionCallCompilationContext } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/FunctionCallCompilationContext';
+import { CompiledCode } from '@/application/Parser/Script/Compiler/Function/Call/Compiler/CompiledCode';
+import { SingleCallCompilerStrategy } from '../SingleCallCompilerStrategy';
+import { ArgumentCompiler } from './Argument/ArgumentCompiler';
+import { NestedFunctionArgumentCompiler } from './Argument/NestedFunctionArgumentCompiler';
+
+export class NestedFunctionCallCompiler implements SingleCallCompilerStrategy {
+  public constructor(
+    private readonly argumentCompiler: ArgumentCompiler = new NestedFunctionArgumentCompiler(),
+  ) {
+  }
+
+  public canCompile(func: ISharedFunction): boolean {
+    return func.body.calls !== undefined;
+  }
+
+  public compileFunction(
+    calledFunction: ISharedFunction,
+    callToFunction: FunctionCall,
+    context: FunctionCallCompilationContext,
+  ): CompiledCode[] {
+    const nestedCalls = calledFunction.body.calls;
+    return nestedCalls.map((nestedCall) => {
+      try {
+        const compiledParentCall = this.argumentCompiler
+          .createCompiledNestedCall(nestedCall, callToFunction, context);
+        const compiledNestedCall = context.singleCallCompiler
+          .compileSingleCall(compiledParentCall, context);
+        return compiledNestedCall;
+      } catch (err) {
+        throw new AggregateError([err], `Error with call to "${nestedCall.functionName}" function from "${callToFunction.functionName}" function`);
+      }
+    }).flat();
+  }
+}

src/application/Parser/Script/Compiler/Function/Call/FunctionCall.ts

@@ -1,16 +1,6 @@
 import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
-import { IFunctionCall } from './IFunctionCall';
 
-export class FunctionCall implements IFunctionCall {
+export interface FunctionCall {
-  constructor(
+  readonly functionName: string;
-    public readonly functionName: string,
+  readonly args: IReadOnlyFunctionCallArgumentCollection;
-    public readonly args: IReadOnlyFunctionCallArgumentCollection,
-  ) {
-    if (!functionName) {
-      throw new Error('missing function name in function call');
-    }
-    if (!args) {
-      throw new Error('missing args');
-    }
-  }
 }

src/application/Parser/Script/Compiler/Function/Call/FunctionCallParser.ts

@@ -1,10 +1,10 @@
 import type { FunctionCallData, FunctionCallsData, FunctionCallParametersData } from '@/application/collections/';
-import { IFunctionCall } from './IFunctionCall';
+import { FunctionCall } from './FunctionCall';
 import { FunctionCallArgumentCollection } from './Argument/FunctionCallArgumentCollection';
 import { FunctionCallArgument } from './Argument/FunctionCallArgument';
-import { FunctionCall } from './FunctionCall';
+import { ParsedFunctionCall } from './ParsedFunctionCall';
 
-export function parseFunctionCalls(calls: FunctionCallsData): IFunctionCall[] {
+export function parseFunctionCalls(calls: FunctionCallsData): FunctionCall[] {
   if (calls === undefined) {
     throw new Error('missing call data');
   }
@@ -22,12 +22,12 @@ function getCallSequence(calls: FunctionCallsData): FunctionCallData[] {
   return [calls as FunctionCallData];
 }
 
-function parseFunctionCall(call: FunctionCallData): IFunctionCall {
+function parseFunctionCall(call: FunctionCallData): FunctionCall {
   if (!call) {
     throw new Error('missing call data');
   }
   const callArgs = parseArgs(call.parameters);
-  return new FunctionCall(call.function, callArgs);
+  return new ParsedFunctionCall(call.function, callArgs);
 }
 
 function parseArgs(

src/application/Parser/Script/Compiler/Function/Call/IFunctionCall.ts

@@ -1,6 +0,0 @@
-import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
-
-export interface IFunctionCall {
-  readonly functionName: string;
-  readonly args: IReadOnlyFunctionCallArgumentCollection;
-}

src/application/Parser/Script/Compiler/Function/Call/ParsedFunctionCall.ts

@@ -0,0 +1,16 @@
+import { IReadOnlyFunctionCallArgumentCollection } from './Argument/IFunctionCallArgumentCollection';
+import { FunctionCall } from './FunctionCall';
+
+export class ParsedFunctionCall implements FunctionCall {
+  constructor(
+    public readonly functionName: string,
+    public readonly args: IReadOnlyFunctionCallArgumentCollection,
+  ) {
+    if (!functionName) {
+      throw new Error('missing function name in function call');
+    }
+    if (!args) {
+      throw new Error('missing args');
+    }
+  }
+}

src/application/Parser/Script/Compiler/Function/ISharedFunction.ts

@@ -1,5 +1,5 @@
 import { IReadOnlyFunctionParameterCollection } from './Parameter/IFunctionParameterCollection';
-import { IFunctionCall } from './Call/IFunctionCall';
+import { FunctionCall } from './Call/FunctionCall';
 
 export interface ISharedFunction {
   readonly name: string;
@@ -9,8 +9,8 @@ export interface ISharedFunction {
 
 export interface ISharedFunctionBody {
   readonly type: FunctionBodyType;
-  readonly code: IFunctionCode;
+  readonly code: IFunctionCode | undefined;
-  readonly calls: readonly IFunctionCall[];
+  readonly calls: readonly FunctionCall[] | undefined;
 }
 
 export enum FunctionBodyType {

src/application/Parser/Script/Compiler/Function/ISharedFunctionCollection.ts

@@ -2,4 +2,5 @@ import { ISharedFunction } from './ISharedFunction';
 
 export interface ISharedFunctionCollection {
   getFunctionByName(name: string): ISharedFunction;
+  getRequiredParameterNames(functionName: string): string[];
 }

src/application/Parser/Script/Compiler/Function/SharedFunction.ts

@@ -1,4 +1,4 @@
-import { IFunctionCall } from './Call/IFunctionCall';
+import { FunctionCall } from './Call/FunctionCall';
 
 import {
   FunctionBodyType, IFunctionCode, ISharedFunction, ISharedFunctionBody,
@@ -8,7 +8,7 @@ import { IReadOnlyFunctionParameterCollection } from './Parameter/IFunctionParam
 export function createCallerFunction(
   name: string,
   parameters: IReadOnlyFunctionParameterCollection,
-  callSequence: readonly IFunctionCall[],
+  callSequence: readonly FunctionCall[],
 ): ISharedFunction {
   if (!callSequence || !callSequence.length) {
     throw new Error(`missing call sequence in function "${name}"`);
@@ -38,7 +38,7 @@ class SharedFunction implements ISharedFunction {
   constructor(
     public readonly name: string,
     public readonly parameters: IReadOnlyFunctionParameterCollection,
-    content: IFunctionCode | readonly IFunctionCall[],
+    content: IFunctionCode | readonly FunctionCall[],
     bodyType: FunctionBodyType,
   ) {
     if (!name) { throw new Error('missing function name'); }
@@ -46,7 +46,7 @@ class SharedFunction implements ISharedFunction {
     this.body = {
       type: bodyType,
       code: bodyType === FunctionBodyType.Code ? content as IFunctionCode : undefined,
-      calls: bodyType === FunctionBodyType.Calls ? content as readonly IFunctionCall[] : undefined,
+      calls: bodyType === FunctionBodyType.Calls ? content as readonly FunctionCall[] : undefined,
     };
   }
 }

src/application/Parser/Script/Compiler/Function/SharedFunctionCollection.ts

@@ -21,6 +21,15 @@ export class SharedFunctionCollection implements ISharedFunctionCollection {
     return func;
   }
 
+  public getRequiredParameterNames(functionName: string): string[] {
+    return this
+      .getFunctionByName(functionName)
+      .parameters
+      .all
+      .filter((parameter) => !parameter.isOptional)
+      .map((parameter) => parameter.name);
+  }
+
   private has(functionName: string) {
     return this.functionsByName.has(functionName);
   }

src/application/Parser/Script/Compiler/ScriptCompiler.ts

@@ -7,12 +7,12 @@ import { NoEmptyLines } from '@/application/Parser/Script/Validation/Rules/NoEmp
 import { ICodeValidator } from '@/application/Parser/Script/Validation/ICodeValidator';
 import { IScriptCompiler } from './IScriptCompiler';
 import { ISharedFunctionCollection } from './Function/ISharedFunctionCollection';
-import { IFunctionCallCompiler } from './Function/Call/Compiler/IFunctionCallCompiler';
+import { FunctionCallSequenceCompiler } from './Function/Call/Compiler/FunctionCallSequenceCompiler';
 import { FunctionCallCompiler } from './Function/Call/Compiler/FunctionCallCompiler';
 import { ISharedFunctionsParser } from './Function/ISharedFunctionsParser';
 import { SharedFunctionsParser } from './Function/SharedFunctionsParser';
 import { parseFunctionCalls } from './Function/Call/FunctionCallParser';
-import { ICompiledCode } from './Function/Call/Compiler/ICompiledCode';
+import { CompiledCode } from './Function/Call/Compiler/CompiledCode';
 
 export class ScriptCompiler implements IScriptCompiler {
   private readonly functions: ISharedFunctionCollection;
@@ -21,7 +21,7 @@ export class ScriptCompiler implements IScriptCompiler {
     functions: readonly FunctionData[] | undefined,
     syntax: ILanguageSyntax,
     sharedFunctionsParser: ISharedFunctionsParser = SharedFunctionsParser.instance,
-    private readonly callCompiler: IFunctionCallCompiler = FunctionCallCompiler.instance,
+    private readonly callCompiler: FunctionCallCompiler = FunctionCallSequenceCompiler.instance,
     private readonly codeValidator: ICodeValidator = CodeValidator.instance,
   ) {
     if (!syntax) { throw new Error('missing syntax'); }
@@ -40,7 +40,7 @@ export class ScriptCompiler implements IScriptCompiler {
     if (!script) { throw new Error('missing script'); }
     try {
       const calls = parseFunctionCalls(script.call);
-      const compiledCode = this.callCompiler.compileCall(calls, this.functions);
+      const compiledCode = this.callCompiler.compileFunctionCalls(calls, this.functions);
       validateCompiledCode(compiledCode, this.codeValidator);
       return new ScriptCode(
         compiledCode.code,
@@ -52,7 +52,7 @@ export class ScriptCompiler implements IScriptCompiler {
   }
 }
 
-function validateCompiledCode(compiledCode: ICompiledCode, validator: ICodeValidator): void {
+function validateCompiledCode(compiledCode: CompiledCode, validator: ICodeValidator): void {
   [compiledCode.code, compiledCode.revertCode].forEach(
     (code) => validator.throwIfInvalid(code, [new NoEmptyLines()]),
   );

src/application/collections/macos.yaml

@@ -1,4 +1,4 @@
-# Structure documented in "docs/collection-files.md"
+# Structure is documented in "docs/collection-files.md"
 os: macos
 scripting:
     language: shellscript
@@ -48,18 +48,18 @@ actions:
                     # on main HDD
                     sudo rm -rfv ~/.Trash/* &>/dev/null
             -
-                name: Clear system cache files
+                name: Clear system cache
                 recommend: strict
                 code: |-
                     sudo rm -rfv /Library/Caches/* &>/dev/null
                     sudo rm -rfv /System/Library/Caches/* &>/dev/null
                     sudo rm -rfv ~/Library/Caches/* &>/dev/null
             -
-                category: Clear OS logs
+                category: Clear operating system logs
                 recommend: strict
                 children:
                     -
-                        category: Clear unified logs (diagnostics)
+                        category: Clear unified diagnostic logs
                         docs: https://developer.apple.com/documentation/os/logging
                         children:
                             -
@@ -69,7 +69,7 @@ actions:
                                     sudo rm -rfv /private/var/db/diagnostics/*
                                     sudo rm -rfv /var/db/diagnostics/*
                             -
-                                name: Clear shared-cache strings data
+                                name: Clear shared cache strings data
                                 docs:
                                     - https://eclecticlight.co/2017/09/23/sierras-unified-log-evolves-more-persistent-and-a-valuable-log-log/
                                     - https://github.com/privacysexy-forks/dtformats/blob/main/documentation/Apple%20Unified%20Logging%20and%20Activity%20Tracing%20formats.asciidoc
@@ -77,7 +77,7 @@ actions:
                                     sudo rm -rfv /private/var/db/uuidtext/
                                     sudo rm -rfv /var/db/uuidtext/
                     -
-                        category: Clear system logs (/var/log/)
+                        category: Clear system logs
                         children:
                             -
                                 name: Clear Apple System Logs (ASL)
@@ -94,7 +94,7 @@ actions:
                                 docs: https://discussions.apple.com/thread/1829842
                                 code: sudo rm -fv /var/log/install.log
                             -
-                                name: Clear all system logs
+                                name: Clear all system logs in `/var/log/` directory
                                 docs: https://www.howtogeek.com/356942/how-to-view-the-system-log-on-a-mac/
                                 code: sudo rm -rfv /var/log/* # Clears including /var/log/system.log
                     -
@@ -105,7 +105,7 @@ actions:
                         name: Clear Mail logs
                         code: rm -rfv ~/Library/Containers/com.apple.mail/Data/Library/Logs/Mail/*
                     -
-                        name: Clear audit logs (login, logout, authentication and other user activity)
+                        name: Clear user activity audit logs (login, logout, authentication, etc.)
                         docs:
                             - https://papers.put.as/papers/macosx/2012/Mac_Log_Analysis_Sarah_Edwards_DFIRSummit2012.pdf
                             - http://macadmins.psu.edu/wp-content/uploads/sites/24696/2016/06/psumac2016-19-osxlogs_macadmins_2016.pdf
@@ -113,7 +113,7 @@ actions:
                             sudo rm -rfv /var/audit/*
                             sudo rm -rfv /private/var/audit/*
                     -
-                        name: Clear user logs (user reports)
+                        name: Clear user report logs
                         docs:
                             - https://www.howtogeek.com/356942/how-to-view-the-system-log-on-a-mac/
                             - https://apple.stackexchange.com/questions/272929/is-it-safe-to-delete-the-content-of-library-logs
@@ -134,15 +134,15 @@ actions:
                 category: Clear browser history
                 children:
                     -
-                        category: Clear Google Chrome history
+                        category: Clear Chrome history
                         children:
                             -
-                                name: Clear Google Chrome browsing history
+                                name: Clear Chrome browsing history
                                 code: |-
                                     rm -rfv ~/Library/Application\ Support/Google/Chrome/Default/History &>/dev/null
                                     rm -rfv ~/Library/Application\ Support/Google/Chrome/Default/History-journal &>/dev/null
                             -
-                                name: Google Chrome Cache Files
+                                name: Clear Chrome cache
                                 code: sudo rm -rfv ~/Library/Application\ Support/Google/Chrome/Default/Application\ Cache/* &>/dev/null
                     -
                         category: Clear Safari history
@@ -165,7 +165,7 @@ actions:
                                 docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
                                 code: rm -f ~/Library/Safari/Downloads.plist
                             -
-                                name: Clear Safari top sites
+                                name: Clear Safari frequently visited sites
                                 docs: https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
                                 code: rm -f ~/Library/Safari/TopSites.plist
                             -
@@ -182,7 +182,7 @@ actions:
                                         docs: https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
                                         code: rm -f ~/Library/Caches/com.apple.Safari/Cache.db
                                     -
-                                        name: Clear Safari web page icons displayed on URL bar
+                                        name: Clear Safari URL bar web page icons
                                         docs:
                                           - https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
                                           - https://lifehacker.com/safaris-private-browsing-mode-saves-urls-in-an-easily-a-1691944343
@@ -194,11 +194,11 @@ actions:
                                           - https://www.reddit.com/r/apple/comments/18lp92/your_apple_computer_keeps_a_screen_shot_of_nearly/
                                         code: rm -rfv ~/Library/Caches/com.apple.Safari/Webpage\ Previews
                             -
-                                name: Clear copy of the Safari history
+                                name: Clear Safari history copy
                                 docs: https://forensicsfromthesausagefactory.blogspot.com/2010/06/safari-history-spotlight-webhistory.html
                                 code: rm -rfv ~/Library/Caches/Metadata/Safari/History
                             -
-                                name: Clear search history embedded in Safari preferences
+                                name: Clear search term history embedded in Safari preferences
                                 docs: https://krypted.com/tag/recentsearchstrings/
                                 code: defaults write ~/Library/Preferences/com.apple.Safari RecentSearchStrings '( )'
                             -
@@ -215,11 +215,11 @@ actions:
                                 docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
                                 code: rm -f ~/Library/Safari/PerSiteZoomPreferences.plist
                             -
-                                name: Clear URLs that are allowed to display notifications in Safari
+                                name: Clear allowed URLs for Safari notifications
                                 docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
                                 code: rm -f ~/Library/Safari/UserNotificationPreferences.plist
                             -
-                                name: Clear Safari per-site preferences for Downloads, Geolocation, PopUps, and Autoplays
+                                name: Clear Safari preferences for downloads, geolocation, pop-ups, and autoplay per site
                                 docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
                                 code: rm -f ~/Library/Safari/PerSitePreferences.db
                     -
@@ -231,15 +231,15 @@ actions:
                                     sudo rm -rf ~/Library/Caches/Mozilla/
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/netpredictions.sqlite
                             -
-                                name: Delete Firefox form history
+                                name: Clear Firefox form history
                                 code: |-
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/formhistory.sqlite
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/formhistory.dat
                             -
-                                name: Delete Firefox site preferences
+                                name: Clear Firefox site preferences
                                 code: rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/content-prefs.sqlite
                             -
-                                name: Delete Firefox session restore data (loads after the browser closes or crashes)
+                                name: Clear Firefox session restore data (loads after the browser closes or crashes)
                                 code: |-
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionCheckpoints.json
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionstore*.js*
@@ -250,7 +250,7 @@ actions:
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionstore-backups/previous.bak*
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionstore-backups/upgrade.js*-20*
                             -
-                                name: Delete Firefox passwords
+                                name: Clear Firefox passwords
                                 docs: https://web.archive.org/web/20210425202923/http://kb.mozillazine.org/Password_Manager
                                 code: |-
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/signons.txt
@@ -259,20 +259,20 @@ actions:
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/signons.sqlite
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/logins.json
                             -
-                                name: Delete Firefox HTML5 cookies
+                                name: Clear Firefox HTML5 cookies
                                 code: rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/webappsstore.sqlite
                             -
-                                name: Delete Firefox crash reports
+                                name: Clear Firefox crash reports
                                 code: |-
                                     rm -rfv ~/Library/Application\ Support/Firefox/Crash\ Reports/
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/minidumps/*.dmp
                             -
-                                name: Delete Firefox backup files
+                                name: Clear Firefox backup files
                                 code: |-
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/bookmarkbackups/*.json
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/bookmarkbackups/*.jsonlz4
                             -
-                                name: Delete Firefox cookies
+                                name: Clear Firefox cookies
                                 code: |-
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/cookies.txt
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/cookies.sqlite
@@ -280,7 +280,7 @@ actions:
                                     rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/cookies.sqlite-wal
                                     rm -rfv ~/Library/Application\ Support/Firefox/Profiles/*/storage/default/http*
             -
-                category: Clear third party application data
+                category: Clear third-party application data
                 children:
                     -
                         name: Clear Adobe cache
@@ -290,18 +290,18 @@ actions:
                         name: Clear Gradle cache
                         recommend: strict
                         code: |-
-                            if [ -d "/Users/${HOST}/.gradle/caches" ]; then
+                            if [ -d "~/.gradle/caches" ]; then
                                 rm -rfv ~/.gradle/caches/ &> /dev/null
                             fi
                     -
                         name: Clear Dropbox cache
                         recommend: standard
                         code: |-
-                            if [ -d "/Users/${HOST}/Dropbox" ]; then
+                            if [ -d "~/Dropbox/.dropbox.cache" ]; then
                                 sudo rm -rfv ~/Dropbox/.dropbox.cache/* &>/dev/null
                             fi
                     -
-                        name: Clear Google Drive file stream cache
+                        name: Clear Google Drive File Stream cache
                         recommend: standard
                         code: |-
                             killall "Google Drive File Stream"
@@ -323,21 +323,54 @@ actions:
                                 brew tap --repair &>/dev/null
                             fi
                     -
-                        name: Clear any old versions of Ruby gems
+                        name: Clear old Ruby gem versions
                         recommend: strict
                         code: |-
                             if type "gem" &> /dev/null; then
                                 gem cleanup &>/dev/null
                             fi
                     -
-                        name: Clear Docker
+                        name: Clear unused Docker data
                         recommend: strict
+                        docs: |-
+                            This script frees up disk space, but also improves user privacy by:
+
+                            1. **Removal of stopped containers**: Containers often run applications or services that might process sensitive
+                            or personal data. Even if a container is stopped, its filesystem remains intact, and potentially sensitive data inside
+                            it can be accessed. By removing stopped containers, we eliminate this potential privacy risk.
+
+                            2. **Deletion of unused images**: Images can sometimes contain sensitive information, especially if they were built
+                            from `Dockerfile`s that copied local files or were used in scenarios where sensitive data was processed. Deleting unused
+                            images ensures that any inadvertent sensitive information embedded in those images is eradicated.
+
+                            3. **Cleanup of network configurations**: Networks, especially custom ones, can contain configurations that reveal details
+                            about system architecture, inter-container communication, or even hardcoded secrets. Removing unused networks mitigates
+                            risks associated with lingering, outdated, or insecure configurations.
+
+                            4. **Elimination of build cache**: The Docker build process uses a cache to speed up image creation. This cache can contain
+                            remnants of previous builds, including potentially sensitive data or files. Pruning the build cache ensures that these remnants
+                            are deleted, further safeguarding privacy.
+
+                            5. **Footprint reduction**: By consistently pruning unused Docker objects, the overall footprint of Docker on the system is
+                            reduced. This makes it harder for malicious actors to exploit any lingering or overlooked vulnerabilities in the system or Docker
+                            itself.
+
+                            This script runs `docker system prune -af` command to clean up unused Docker data [1].
+
+                            Specifically, the command will [1]:
+
+                            - Remove all stopped containers.
+                            - Remove all networks not used by at least one container.
+                            - Remove all images not used by any container.
+                            - Remove all build cache.
+
+                            [1]: https://web.archive.org/web/20230810171526/https://docs.docker.com/engine/reference/commandline/system_prune/ "docker system prune | Docker Documentation"
                         code: |-
                             if type "docker" &> /dev/null; then
                                 docker system prune -af
                             fi
                     -
-                        name: Clear Pyenv-VirtualEnv cache
+                        name: Clear Pyenv-Virtualenv cache
                         recommend: strict
                         code: |-
                             if [ "$PYENV_VIRTUALENV_CACHE_PATH" ]; then
@@ -359,22 +392,22 @@ actions:
                                 yarn cache clean --force
                             fi
             -
-                category: iOS Cleanup
+                category: Clear iOS usage data
                 children:
                     -
-                        name: Clear iOS applications
+                        name: Clear iOS app copies from iTunes
                         recommend: strict
                         code: rm -rfv ~/Music/iTunes/iTunes\ Media/Mobile\ Applications/* &>/dev/null
                     -
-                        name: Clear iOS photo caches
+                        name: Clear iOS photo cache
                         recommend: standard
                         code: rm -rf ~/Pictures/iPhoto\ Library/iPod\ Photo\ Cache/*
                     -
-                        name: Remove iOS Device Backups
+                        name: Clear iOS Device Backups
                         recommend: strict
                         code: rm -rfv ~/Library/Application\ Support/MobileSync/Backup/* &>/dev/null
                     -
-                        name: Clear iOS Simulators
+                        name: Clear iOS simulators
                         recommend: strict
                         code: |-
                             if type "xcrun" &>/dev/null; then
@@ -385,7 +418,7 @@ actions:
                                 xcrun simctl erase all
                             fi
                     -
-                        name: Clear the list of iOS devices connected
+                        name: Clear list of connected iOS devices
                         recommend: strict
                         code: |-
                             sudo defaults delete /Users/$USER/Library/Preferences/com.apple.iPod.plist "conn:128:Last Connect"
@@ -394,7 +427,7 @@ actions:
                             sudo defaults delete /Library/Preferences/com.apple.iPod.plist Devices
                             sudo rm -rfv /var/db/lockdown/*
             -
-                name: Clear XCode Derived Data and Archives
+                name: Clear Xcode's derived data and archives
                 recommend: strict
                 code: |-
                     rm -rfv ~/Library/Developer/Xcode/DerivedData/* &>/dev/null
@@ -407,50 +440,50 @@ actions:
                     sudo dscacheutil -flushcache
                     sudo killall -HUP mDNSResponder
             -
-                name: Purge inactive memory
+                name: Clear inactive memory
                 recommend: standard
                 code: sudo purge
             -
-                category: Reset privacy permissions for all applications
+                category: Clear all privacy permissions for applications
                 children:
                     -
-                        name: Reset camera permissions
+                        name: Clear "camera" permissions
                         code: tccutil reset Camera
                     -
-                        name: Reset microphone permissions
+                        name: Clear "microphone" permissions
                         code: tccutil reset Microphone
                     -
-                        name: Reset accessibility permissions
+                        name: Clear "accessibility" permissions
                         code: tccutil reset Accessibility
                     -
-                        name: Reset screen capture permissions
+                        name: Clear "screen capture" permissions
                         code: tccutil reset ScreenCapture
                     -
-                        name: Reset reminders permissions
+                        name: Clear "reminders" permissions
                         code: tccutil reset Reminders
                     -
-                        name: Reset photos permissions
+                        name: Clear "photos" permissions
                         code: tccutil reset Photos
                     -
-                        name: Reset calendar permissions
+                        name: Clear "calendar" permissions
                         code: tccutil reset Calendar
                     -
-                        name: Reset full disk access permissions
+                        name: Clear "full disk access" permissions
                         code: tccutil reset SystemPolicyAllFiles
                     -
-                        name: Reset contacts permissions
+                        name: Clear "contacts" permissions
                         code: tccutil reset SystemPolicyAllFiles
                     -
-                        name: Reset desktop folder permissions
+                        name: Clear "desktop folder" permissions
                         code: tccutil reset SystemPolicyDesktopFolder
                     -
-                        name: Reset documents folder permissions
+                        name: Clear "documents folder" permissions
                         code: tccutil reset SystemPolicyDocumentsFolder
                     -
-                        name: Reset downloads permissions
+                        name: Clear "downloads" permissions
                         code: tccutil reset SystemPolicyDownloadsFolder
                     -
-                        name: Reset all app permissions
+                        name: Clear all app permissions
                         code: tccutil reset All
     -
         category: Configure programs
@@ -468,20 +501,20 @@ actions:
                     sudo defaults delete /Library/Preferences/org.mozilla.firefox EnterprisePoliciesEnabled
                     sudo defaults delete /Library/Preferences/org.mozilla.firefox DisableTelemetry
             -
-                name: Disable Microsoft Office diagnostics data sending
+                name: Disable Microsoft Office telemetry
                 recommend: standard
                 code: defaults write com.microsoft.office DiagnosticDataTypePreference -string ZeroDiagnosticData
                 revertCode: defaults delete com.microsoft.office DiagnosticDataTypePreference
             -
-                name: Uninstall Google update
+                name: Remove Google Software Update service
                 recommend: strict
                 code: |-
                     googleUpdateFile=~/Library/Google/GoogleSoftwareUpdate/GoogleSoftwareUpdate.bundle/Contents/Resources/ksinstall
                     if [ -f "$googleUpdateFile" ]; then
                         $googleUpdateFile --nuke
-                        echo Uninstalled google update
+                        echo 'Uninstalled Google update'
                     else
-                        echo Google update file does not exist
+                        echo 'Google update file does not exist'
                     fi
             -
                 name: Disable Homebrew user behavior analytics
@@ -514,12 +547,12 @@ actions:
                 docs: |-
                     Parallels Desktop for Mac is software providing hardware virtualization for macOS [1].
 
-                    When you use it, it collects and share your personal data to third parties [2]. Personal
+                    When you use it, it collects and shares your personal data to third parties [2]. Personal
                     data include IP address of your device, your broad geographical location (country, state
                     (if applicable), and city) and used product [2].
 
-                    It includes third-party ads [3] and automatic check for updates [4] by default. Both of these
+                    It includes third-party advertisements [3] and automatic check for updates [4] by default.
-                    behaviors communicate with online services that reveal data about you.
+                    Both of these behaviors communicate with online services that reveal personal data about you.
 
                     [1]: https://web.archive.org/web/20221012155943/https://en.wikipedia.org/wiki/Parallels_Desktop_for_Mac "Parallels Desktop for Mac - Wikipedia | en.wikipedia.org"
                     [2]: https://web.archive.org/web/20221012155829/https://www.parallels.com/about/legal/privacy/ "Privacy Statement | parallels.com"
@@ -527,7 +560,7 @@ actions:
                     [4]: https://web.archive.org/web/20221012151953/http://download.parallels.com/stm/docs/en/Parallels_Desktop_Users_Guide/22220.htm "Automatic Updating | Parallels Desktop Users Guide | download.parallels.com"
                 children:
                     -
-                        name: Turn off ads in Parallels Desktop
+                        name: Disable Parallels Desktop advertisements
                         recommend: standard
                         docs: |-
                             Parallels Desktop in-product notifications to show ads from Parallels or other third
@@ -544,7 +577,7 @@ actions:
                             default). It's undocumented but still kept disabled by this script.
 
                             [1]: https://web.archive.org/save/https://forum.parallels.com/threads/unable-to-process-the-upgrade-request.345603/ "Unable to process the upgrade request | Parallels Forums | forum.parallels.com"
-                            [2]: https://web.archive.org/web/20221012151800/https://kb.parallels.com/114422  "How do I turn off notifications in Parallels Desktop and Parallels Access? | Knowledge Base | parallels.com"
+                            [2]: https://web.archive.org/web/20221012151800/https://kb.parallels.com/114422 "How do I turn off notifications in Parallels Desktop and Parallels Access? | Knowledge Base | parallels.com"
                         code: |-
                             defaults write 'com.parallels.Parallels Desktop' 'ProductPromo.ForcePromoOff' -bool yes
                             defaults write 'com.parallels.Parallels Desktop' 'WelcomeScreenPromo.PromoOff' -bool yes
@@ -552,16 +585,16 @@ actions:
                             defaults write 'com.parallels.Parallels Desktop' 'ProductPromo.ForcePromoOff' -bool no
                             defaults write 'com.parallels.Parallels Desktop' 'WelcomeScreenPromo.PromoOff' -bool yes
                     -
-                        category: Disable Parallels Desktop auto-updates
+                        category: Disable Parallels Desktop automatic updates
                         docs: |-
                             Parallels Desktop by default checks for updates frequently and automatically downloads them [1].
-                            This reveal personal data about [2] you without your control.
+                            This reveal personal data about you [2] without your control.
 
                             [1]: https://web.archive.org/web/20221012151953/http://download.parallels.com/stm/docs/en/Parallels_Desktop_Users_Guide/22220.htm "Automatic Updating | Parallels Desktop Users Guide | download.parallels.com"
                             [2]: https://web.archive.org/web/20221012155829/https://www.parallels.com/about/legal/privacy/ "Privacy Statement | parallels.com"
                         children:
                             -
-                                name: Disable automatically downloading Parallels Desktop updates
+                                name: Disable automatic downloads for Parallels Desktop updates
                                 docs: |-
                                     Automatic downloads are enabled by default, and this script disables automatic downloads.
 
@@ -570,11 +603,11 @@ actions:
                                     - Check: `defaults read 'com.parallels.Parallels Desktop' 'Application preferences.Download updates automatically'`
                                     - Values: 0 - Disabled, 1 - Enabled (default)
 
-                                    [1]: https://web.archive.org/web/20221012153810/https://download.parallels.com/desktop/v18/docs/en_US/Parallels-Desktop-Business-Edition-Administrators-Guide/37744.htm  "Parallels Desktop Business Edition Administrator's Guide v18 - Configuring individual Macs | download.parallels.com"
+                                    [1]: https://web.archive.org/web/20221012153810/https://download.parallels.com/desktop/v18/docs/en_US/Parallels-Desktop-Business-Edition-Administrators-Guide/37744.htm "Parallels Desktop Business Edition Administrator's Guide v18 - Configuring individual Macs | download.parallels.com"
                                 code: defaults write 'com.parallels.Parallels Desktop' 'Application preferences.Download updates automatically' -bool no
                                 revertCode: defaults write 'com.parallels.Parallels Desktop' 'Application preferences.Download updates automatically' -bool yes
                             -
-                                name: Disable automatically checking for Parallels Desktop updates
+                                name: Disable automatic checks for Parallels Desktop updates
                                 docs: |-
                                     Automatic checks are weekly by default, and this script disables the checks completely.
 
@@ -593,7 +626,7 @@ actions:
                 category: Configure Apple Remote Desktop
                 children:
                     -
-                        name: Deactivate the Remote Management Service
+                        name: Disable remote management service
                         recommend: strict
                         code: sudo /System/Library/CoreServices/RemoteManagement/ARDAgent.app/Contents/Resources/kickstart -deactivate -stop
                         revertCode: sudo /System/Library/CoreServices/RemoteManagement/ARDAgent.app/Contents/Resources/kickstart -activate -restart -agent -console
@@ -604,26 +637,26 @@ actions:
                             sudo rm -rf /var/db/RemoteManagement
                             sudo defaults delete /Library/Preferences/com.apple.RemoteDesktop.plist
                             defaults delete ~/Library/Preferences/com.apple.RemoteDesktop.plist
-                            sudo rm -r /Library/Application\ Support/Apple/Remote\ Desktop/ 
+                            sudo rm -rf /Library/Application\ Support/Apple/Remote\ Desktop/
                             rm -r ~/Library/Application\ Support/Remote\ Desktop/
                             rm -r ~/Library/Containers/com.apple.RemoteDesktop
             -
-                name: Disable Internet based spell correction
+                name: Disable online spell correction
                 code: defaults write NSGlobalDomain WebAutomaticSpellingCorrectionEnabled -bool false
                 revertCode: defaults delete NSGlobalDomain WebAutomaticSpellingCorrectionEnabled
             -
-                name: Disable Remote Apple Events
+                name: Disable remote Apple events
                 recommend: strict
                 code: sudo systemsetup -setremoteappleevents off
                 revertCode: sudo systemsetup -setremoteappleevents on
             -
-                name: Do not store documents to iCloud Drive by default
+                name: Disable automatic storage of documents in iCloud Drive
                 docs: https://macos-defaults.com/finder/nsdocumentsavenewdocumentstocloud.html
                 recommend: standard
                 code: defaults write NSGlobalDomain NSDocumentSaveNewDocumentsToCloud -bool false
                 revertCode: defaults delete NSGlobalDomain NSDocumentSaveNewDocumentsToCloud
             -
-                name: Do not show recent items on dock
+                name: Disable display of recent applications on Dock
                 docs: https://developer.apple.com/documentation/devicemanagement/dock
                 code: defaults write com.apple.dock show-recents -bool false
                 revertCode: defaults delete com.apple.dock show-recents
@@ -636,7 +669,7 @@ actions:
                 category: Configure Siri
                 children:
                     -
-                        name: Opt-out from Siri data collection
+                        name: Disable participation in Siri data collection
                         recommend: standard
                         code: defaults write com.apple.assistant.support 'Siri Data Sharing Opt-In Status' -int 2
                         revertCode: defaults delete com.apple.assistant.support 'Siri Data Sharing Opt-In Status'
@@ -683,7 +716,7 @@ actions:
                                     launchctl enable "gui/$UID/com.apple.Siri.agent"
                                     sudo launchctl enable 'system/com.apple.Siri.agent'
                                     if [ $(/usr/bin/csrutil status | awk '/status/ {print $5}' | sed 's/\.$//') = "enabled" ]; then
-                                        >&2 echo 'This script requires SIP to be disabled. Read more: https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection''
+                                        >&2 echo 'This script requires SIP to be disabled. Read more: https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection'
                                     fi
                             -
                                 name: Disable "Do you want to enable Siri?" pop-up
@@ -694,15 +727,15 @@ actions:
                                 code: defaults write com.apple.SetupAssistant 'DidSeeSiriSetup' -bool True
                                 revertCode: defaults delete com.apple.SetupAssistant 'DidSeeSiriSetup'
                     -
-                        category: Hide Siri
+                        category: Remove Siri from user interface
                         children:
                             -
-                                name: Hide Siri from menu bar
+                                name: Remove Siri from menu bar
                                 recommend: strict
                                 code: defaults write com.apple.systemuiserver 'NSStatusItem Visible Siri' 0
                                 revertCode: defaults write com.apple.systemuiserver 'NSStatusItem Visible Siri' 1
                             -
-                                name: Hide Siri from status menu
+                                name: Remove Siri from status menu
                                 recommend: strict
                                 docs: https://derflounder.wordpress.com/2016/09/20/blocking-siri-on-macos-sierra/
                                 code: |-
@@ -716,7 +749,7 @@ actions:
                 code: sudo mdutil -i off -d /
                 revertCode: sudo mdutil -i on /
             -
-                name: Disable Personalized advertisements and identifier collection
+                name: Disable personalized advertisements and identifier tracking
                 recommend: standard
                 docs: |-
                     This script enhances your privacy by deactivating Personalized Ads and disabling the collection
@@ -746,7 +779,7 @@ actions:
 
                     Please note: The `forceLimitAdTracking` key limits ad tracking [3] [4] and is found in CIS
                     benchmarks for macOS [4]. However, the official macOS documentation specifies that it is
-                    applicable only to iOS 7 and later versions, not to macOS [3]. The key does not exist on the OS
+                    applicable only to iOS 7 and newer versions, not to macOS [3]. The key does not exist on the OS
                     by default.
 
                     [1]: https://web.archive.org/web/20230731152633/https://www.apple.com/legal/privacy/data/en/apple-advertising/ "Legal - Apple Advertising & Privacy - Apple"
@@ -789,7 +822,7 @@ actions:
                             sudo defaults write /Library/Preferences/com.apple.alf globalstate -bool false
                             defaults write com.apple.security.firewall EnableFirewall -bool false
                     -
-                        name: Turn on firewall logging
+                        name: Enable firewall logging
                         recommend: standard
                         docs:
                             - https://www.stigviewer.com/stig/apple_os_x_10.13/2018-10-01/finding/V-81671
@@ -801,7 +834,7 @@ actions:
                             /usr/libexec/ApplicationFirewall/socketfilterfw --setloggingmode off
                             sudo defaults write /Library/Preferences/com.apple.alf loggingenabled -bool false
                     -
-                        name: Turn on stealth mode
+                        name: Enable stealth mode
                         recommend: standard
                         docs:
                             - https://www.stigviewer.com/stig/apple_os_x_10.8_mountain_lion_workstation/2015-02-10/finding/V-51327
@@ -816,16 +849,16 @@ actions:
                             sudo defaults write /Library/Preferences/com.apple.alf stealthenabled -bool false
                             defaults write com.apple.security.firewall EnableStealthMode -bool false
                     -
-                        category: Disable auto-permitting incoming traffic for apps
+                        category: Disable automatic permission for incoming traffic in applications
                         children:
                             -
-                                name: Prevent automatically allowing incoming connections to signed apps
+                                name: Disable automatic incoming connections for signed apps
                                 docs: https://daiderd.com/nix-darwin/manual/index.html
                                 recommend: strict
                                 code: sudo defaults write /Library/Preferences/com.apple.alf allowsignedenabled -bool false
                                 revertCode: sudo defaults write /Library/Preferences/com.apple.alf allowsignedenabled -bool true
                             -
-                                name: Prevent automatically allowing incoming connections to downloaded signed apps
+                                name: Disable automatic incoming connections for downloaded signed apps
                                 docs: https://daiderd.com/nix-darwin/manual/index.html
                                 recommend: strict
                                 code: sudo defaults write /Library/Preferences/com.apple.alf allowdownloadsignedenabled -bool false
@@ -845,16 +878,16 @@ actions:
                 code: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.captive.control.plist Active -bool false
                 revertCode: sudo defaults delete /Library/Preferences/SystemConfiguration/com.apple.captive.control.plist Active
             -
-                category: Use screen saver for protection
+                category: Enable protective screen saver
                 children:
                     -
-                        name: Require a password to wake the computer from sleep or screen saver
+                        name: Enable password requirement for waking from sleep or screen saver
                         # The screen saver acts as a session lock and prevents unauthorized users from accessing the current user's account.
                         docs: https://www.stigviewer.com/stig/apple_macos_11_big_sur/2020-11-27/finding/V-230744
                         code: sudo defaults write /Library/Preferences/com.apple.screensaver askForPassword -bool true
                         revertCode: sudo defaults delete /Library/Preferences/com.apple.screensaver askForPassword
                     -
-                        name: Initiate session lock five seconds after screen saver is started
+                        name: Enable session lock five seconds after screen saver initiation
                         docs: https://www.stigviewer.com/stig/apple_macos_11_big_sur/2020-11-27/finding/V-230745
                         # An unattended system with an excessive grace period is vulnerable to a malicious user.
                         code: sudo defaults write /Library/Preferences/com.apple.screensaver 'askForPasswordDelay' -int 5
@@ -866,29 +899,29 @@ actions:
                     - https://www.stigviewer.com/stig/apple_os_x_10.13/2018-10-01/finding/V-81615
                 children:
                     -
-                        name: Disables signing in as Guest from the login screen
+                        name: Disable guest sign-in from login screen
                         code: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool NO
-                        revetCode: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool YES
+                        revertCode: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool YES
                     -
-                        name: Disables Guest access to file shares over AF
+                        name: Disable guest access to file shares over AF
                         code: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool NO
-                        revetCode: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool YES
+                        revertCode: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool YES
                     -
-                        name: Disables Guest access to file shares over SMB
+                        name: Disable guest access to file shares over SMB
                         code: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool NO
-                        revetCode: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool YES
+                        revertCode: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool YES
             -
-                category: Prevent unauthorized connections
+                category: Disable unauthorized connections
                 children:
                     -
-                        name: Disable remote login (incoming SSH and SFTP connections)
+                        name: Disable incoming SSH and SFTP remote logins
                         recommend: standard
                         docs: https://osxdaily.com/2016/08/16/enable-ssh-mac-command-line/
                         # Check if enabled: sudo systemsetup -getremotelogin, returns "Remote Login: On" or "Off"
                         code: echo 'yes' | sudo systemsetup -setremotelogin off
                         revertCode: sudo systemsetup -setremotelogin on
                     -
-                        name: Disable insecure TFTP service
+                        name: Disable the insecure TFTP service
                         recommend: standard
                         # If the system does not require Trivial File Transfer Protocol (TFTP), then support for
                         # it is non-essential and should be disabled. The information system should be configured to
@@ -921,13 +954,13 @@ actions:
                     - https://www.cups.org/doc/security.html # Security risks
                 children:
                     -
-                        name: Disable sharing of local printers with other computers
+                        name: Disable local printer sharing with other computers
                         recommend: standard
                         docs: https://www.cups.org/doc/man-cupsctl.html
                         code: cupsctl --no-share-printers
                         revertCode: cupsctl --share-printers
                     -
-                        name: Disable printing from any address including the Internet
+                        name: Disable printing from external addresses, including the internet
                         recommend: standard
                         docs: https://www.cups.org/doc/man-cupsctl.html
                         code: cupsctl --no-remote-any
@@ -952,7 +985,7 @@ actions:
                         category: Clean File Quarantine from downloaded files
                         children:
                             -
-                                name: Clear File Quarantine logs of all downloaded files
+                                name: Clear logs of all downloaded files from File Quarantine
                                 recommend: strict
                                 docs:
                                     - https://www.macobserver.com/tips/how-to/your-mac-remembers-everything-you-download-heres-how-to-clear-download-history/
@@ -969,7 +1002,7 @@ actions:
                                         if ls -lO "$db_file" | grep --silent 'schg'; then
                                             sudo chflags noschg "$db_file"
                                             echo "Found and removed system immutable flag"
-                                            has_sytem_immutable_flag=true
+                                            has_system_immutable_flag=true
                                         fi
                                         if ls -lO "$db_file" | grep --silent 'uchg'; then
                                             sudo chflags nouchg "$db_file"
@@ -978,7 +1011,7 @@ actions:
                                         fi
                                         sqlite3 "$db_file" "$db_query"
                                         echo "Executed the query \"$db_query\""
-                                        if [ "$has_sytem_immutable_flag" = true ] ; then
+                                        if [ "$has_system_immutable_flag" = true ] ; then
                                             sudo chflags schg "$db_file"
                                             echo "Added system immutable flag back"
                                         fi
@@ -1012,10 +1045,10 @@ actions:
                                                     '       \
                                                 {} \;
                     -
-                        category: Disable File Quarantine from tracking downloaded files
+                        category: Disable macOS File Quarantine tracking for downloaded files
                         children:
                             -
-                                name: Prevent quarantine from logging downloaded files
+                                name: Disable downloaded file logging in quarantine
                                 docs:
                                     - https://eclecticlight.co/2019/04/25/%F0%9F%8E%97-quarantine-apps/
                                     - https://eclecticlight.co/2017/12/11/xattr-com-apple-quarantine-the-quarantine-flag/
@@ -1038,7 +1071,7 @@ actions:
                                         >&2 echo "Cannot revert immutability, file does not exist at\"$file_to_lock\""
                                     fi
                             -
-                                name: Disable using extended quarantine attribute on downloaded files (disables warning)
+                                name: Disable extended quarantine attribute for downloaded files (disables warning)
                                 # Disables dialogs shown when opening an application for the first time
                                 # i.e. "Application Downloaded from Internet" quarantine warning.
                                 docs:
@@ -1054,7 +1087,7 @@ actions:
                 # Can protect against unknown threats.
                 children:
                     -
-                        name: Prevent Gatekeeper from automatically reactivating itself
+                        name: Disable Gatekeeper's automatic reactivation
                         docs:
                             - https://osxdaily.com/2015/11/05/stop-gatekeeper-auto-rearm-mac-os-x/
                             - https://www.cnet.com/tech/computing/how-to-disable-gatekeeper-permanently-on-os-x/
@@ -1071,8 +1104,8 @@ actions:
                         code: |-
                             os_major_ver=$(sw_vers -productVersion | awk -F "." '{print $1}')
                             os_minor_ver=$(sw_vers -productVersion | awk -F "." '{print $2}')
-                            if  [[  $os_major_ver -le 10 \
+                            if [[ $os_major_ver -le 10 \
-                                    || ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 )  \
+                                    || ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 ) \
                                 ]]; then
                                 echo "No action needed, Gatekeeper is not available this OS version"
                             else
@@ -1090,8 +1123,8 @@ actions:
                         revertCode: |-
                             os_major_ver=$(sw_vers -productVersion | awk -F "." '{print $1}')
                             os_minor_ver=$(sw_vers -productVersion | awk -F "." '{print $2}')
-                            if  [[  $os_major_ver -le 10 \
+                            if [[ $os_major_ver -le 10 \
-                                    || ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 )  \
+                                    || ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 ) \
                                 ]]; then
                                 >&2 echo "Gatekeeper is not available in this OS version"
                             else
@@ -1107,7 +1140,7 @@ actions:
                                 fi
                             fi
             -
-                name: Disable Library Validation Entitlement (checks signature of libraries)
+                name: Disable library validation entitlement (library signature validation)
                 docs:
                     - https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_disable-library-validation
                     - https://www.macenhance.com/docs/general/sip-library-validation.html
@@ -1121,25 +1154,25 @@ actions:
                     - https://macadminsdoc.readthedocs.io/en/master/Profiles-and-Settings/OS-X-Updates.html
                 children:
                     -
-                        name: Disable automatically checking for updates
+                        name: Disable automatic checks for updates
                         docs: https://developer.apple.com/documentation/devicemanagement/softwareupdate
                         code: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticCheckEnabled' -bool false
                         revertCode: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticCheckEnabled' -bool true
                     -
-                        name: Disable automatically downloading new updates when available
+                        name: Disable automatic downloads for updates
                         docs: https://developer.apple.com/documentation/devicemanagement/softwareupdate
                         code: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticDownload' -bool false
                         revertCode: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticDownload' -bool true
                     -
-                        name: Disable automatically installing macOS updates
+                        name: Disable automatic installation of macOS updates
                         docs:
                             # References for AutoUpdateRestartRequired
                                 - https://kb.vmware.com/s/article/2960635
@@ -1149,48 +1182,48 @@ actions:
                         code: |-
                             # For OS X Yosemite through macOS High Sierra (>= 10.10 && < 10.14)
                             sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdateRestartRequired' -bool false
-                            # For Mojave and later (>= 10.14)
+                            # For Mojave and newer (>= 10.14)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallMacOSUpdates' -bool false
                         revertCode: |-
                             # For OS X Yosemite through macOS High Sierra (>= 10.10 && < 10.14)
                             sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdateRestartRequired' -bool true
-                            # For Mojave and later (>= 10.14)
+                            # For Mojave and newer (>= 10.14)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallMacOSUpdates' -bool true
                     -
-                        name: Disable automatically updating app from the App Store
+                        name: Disable automatic app updates from the App Store
                         docs:
                             - https://kb.vmware.com/s/article/2960635
                             - https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
                         code: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdate' -bool false
-                            # For Mojave and later (>= 10.14)
+                            # For Mojave and newer (>= 10.14)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallAppUpdates' -bool false
                         revertCode: |-
-                            # For OS X Yosemite and later
+                            # For OS X Yosemite and newer
                             sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdate' -bool true
-                            # For Mojave and later (>= 10.14)
+                            # For Mojave and newer (>= 10.14)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallAppUpdates' -bool true
                     -
-                        name: Disable installation of macOS beta releases
+                        name: Disable macOS beta release installation
                         docs: https://support.apple.com/en-gb/HT203018
                         code: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AllowPreReleaseInstallation' -bool false
                         revertCode: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AllowPreReleaseInstallation' -bool true
                     -
-                        name: Disable automatically installing configuration data (e.g. XProtect, Gatekeeper, MRT)
+                        name: Disable automatic installation for configuration data (e.g. XProtect, Gatekeeper, MRT)
                         docs: https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
                         code: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'ConfigDataInstall' -bool false
                         revertCode: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'ConfigDataInstall' -bool true
                     -
-                        name: Disable automatically installing system data files and security updates
+                        name: Disable automatic installation for system data files and security updates
                         docs:
                             # References for CriticalUpdateInstall
                                 - https://derflounder.wordpress.com/2014/12/24/managing-os-xs-automatic-security-updates/
@@ -1198,10 +1231,10 @@ actions:
                             # References for softwareupdate --background-critical
                                 - https://managingosx.wordpress.com/2013/04/30/undocumented-options/
                         code: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'CriticalUpdateInstall' -bool false
                         revertCode: |-
-                            # For OS X Yosemite and later (>= 10.10)
+                            # For OS X Yosemite and newer (>= 10.10)
                             sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'CriticalUpdateInstall' -bool true
                             # Trigger background check with normal scan (critical updates only)
                             sudo softwareupdate --background-critical

src/infrastructure/CodeRunner.ts

@@ -1,31 +1,37 @@
-import os from 'os';
+import { RuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/RuntimeEnvironment';
-import path from 'path';
-import fs from 'fs';
-// eslint-disable-next-line camelcase
-import child_process from 'child_process';
-import { Environment } from '@/application/Environment/Environment';
 import { OperatingSystem } from '@/domain/OperatingSystem';
+import { getWindowInjectedSystemOperations } from './SystemOperations/WindowInjectedSystemOperations';
 
 export class CodeRunner {
   constructor(
-    private readonly node = getNodeJs(),
+    private readonly system = getWindowInjectedSystemOperations(),
-    private readonly environment = Environment.CurrentEnvironment,
+    private readonly environment = RuntimeEnvironment.CurrentEnvironment,
   ) {
+    if (!system) {
+      throw new Error('missing system operations');
+    }
   }
 
   public async runCode(code: string, folderName: string, fileExtension: string): Promise<void> {
-    const dir = this.node.path.join(this.node.os.tmpdir(), folderName);
+    const { os } = this.environment;
-    await this.node.fs.promises.mkdir(dir, { recursive: true });
+    const dir = this.system.location.combinePaths(
-    const filePath = this.node.path.join(dir, `run.${fileExtension}`);
+      this.system.operatingSystem.getTempDirectory(),
-    await this.node.fs.promises.writeFile(filePath, code);
+      folderName,
-    await this.node.fs.promises.chmod(filePath, '755');
+    );
-    const command = getExecuteCommand(filePath, this.environment);
+    await this.system.fileSystem.createDirectory(dir, true);
-    this.node.child_process.exec(command);
+    const filePath = this.system.location.combinePaths(dir, `run.${fileExtension}`);
+    await this.system.fileSystem.writeToFile(filePath, code);
+    await this.system.fileSystem.setFilePermissions(filePath, '755');
+    const command = getExecuteCommand(filePath, os);
+    this.system.command.execute(command);
   }
 }
 
-function getExecuteCommand(scriptPath: string, environment: Environment): string {
+function getExecuteCommand(
-  switch (environment.os) {
+  scriptPath: string,
+  currentOperatingSystem: OperatingSystem,
+): string {
+  switch (currentOperatingSystem) {
     case OperatingSystem.Linux:
       return `x-terminal-emulator -e '${scriptPath}'`;
     case OperatingSystem.macOS:
@@ -36,46 +42,6 @@ function getExecuteCommand(scriptPath: string, environment: Environment): string
     case OperatingSystem.Windows:
       return scriptPath;
     default:
-      throw Error(`unsupported os: ${OperatingSystem[environment.os]}`);
+      throw Error(`unsupported os: ${OperatingSystem[currentOperatingSystem]}`);
   }
 }
-
-function getNodeJs(): INodeJs {
-  return {
-    os, path, fs, child_process,
-  };
-}
-
-export interface INodeJs {
-  os: INodeOs;
-  path: INodePath;
-  fs: INodeFs;
-  // eslint-disable-next-line camelcase
-  child_process: INodeChildProcess;
-}
-
-export interface INodeOs {
-  tmpdir(): string;
-}
-
-export interface INodePath {
-  join(...paths: string[]): string;
-}
-
-export interface INodeChildProcess {
-  exec(command: string): void;
-}
-
-export interface INodeFs {
-  readonly promises: INodeFsPromises;
-}
-
-interface INodeFsPromisesMakeDirectoryOptions {
-  recursive?: boolean;
-}
-
-interface INodeFsPromises { // https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/v13/fs.d.ts
-  chmod(path: string, mode: string | number): Promise<void>;
-  mkdir(path: string, options: INodeFsPromisesMakeDirectoryOptions): Promise<string>;
-  writeFile(path: string, data: string): Promise<void>;
-}

src/infrastructure/EnvironmentVariables/EnvironmentVariablesFactory.ts

@@ -0,0 +1,18 @@
+import { IEnvironmentVariablesFactory } from './IEnvironmentVariablesFactory';
+import { validateEnvironmentVariables } from './EnvironmentVariablesValidator';
+import { ViteEnvironmentVariables } from './Vite/ViteEnvironmentVariables';
+import { IEnvironmentVariables } from './IEnvironmentVariables';
+
+export class EnvironmentVariablesFactory implements IEnvironmentVariablesFactory {
+  public static readonly Current = new EnvironmentVariablesFactory();
+
+  public readonly instance: IEnvironmentVariables;
+
+  protected constructor(validator: EnvironmentVariablesValidator = validateEnvironmentVariables) {
+    const environment = new ViteEnvironmentVariables();
+    validator(environment);
+    this.instance = environment;
+  }
+}
+
+export type EnvironmentVariablesValidator = typeof validateEnvironmentVariables;

src/infrastructure/EnvironmentVariables/EnvironmentVariablesValidator.ts

@@ -0,0 +1,50 @@
+import { IEnvironmentVariables } from './IEnvironmentVariables';
+
+/* Validation is externalized to keep the environment objects simple */
+export function validateEnvironmentVariables(environment: IEnvironmentVariables): void {
+  if (!environment) {
+    throw new Error('missing environment');
+  }
+  const keyValues = capturePropertyValues(environment);
+  if (!Object.keys(keyValues).length) {
+    throw new Error('Unable to capture key/value pairs');
+  }
+  const keysMissingValue = getKeysMissingValues(keyValues);
+  if (keysMissingValue.length > 0) {
+    throw new Error(`Environment keys missing: ${keysMissingValue.join(', ')}`);
+  }
+}
+
+function getKeysMissingValues(keyValuePairs: Record<string, unknown>): string[] {
+  return Object.entries(keyValuePairs)
+    .reduce((acc, [key, value]) => {
+      if (!value && typeof value !== 'boolean') {
+        acc.push(key);
+      }
+      return acc;
+    }, new Array<string>());
+}
+
+/**
+ * Captures values of properties and getters from the provided instance.
+ * Necessary because code transformations can make class getters non-enumerable during bundling.
+ * This ensures that even if getters are non-enumerable, their values are still captured and used.
+ */
+function capturePropertyValues(instance: unknown): Record<string, unknown> {
+  const obj: Record<string, unknown> = {};
+  const descriptors = Object.getOwnPropertyDescriptors(instance.constructor.prototype);
+
+  // Capture regular properties from the instance
+  for (const [key, value] of Object.entries(instance)) {
+    obj[key] = value;
+  }
+
+  // Capture getter properties from the instance's prototype
+  for (const [key, descriptor] of Object.entries(descriptors)) {
+    if (typeof descriptor.get === 'function') {
+      obj[key] = descriptor.get.call(instance);
+    }
+  }
+
+  return obj;
+}

src/infrastructure/EnvironmentVariables/IAppMetadata.ts

@@ -0,0 +1,10 @@
+/**
+ * Represents essential metadata about the application.
+ */
+export interface IAppMetadata {
+  readonly version: string;
+  readonly name: string;
+  readonly slogan: string;
+  readonly repositoryUrl: string;
+  readonly homepageUrl: string;
+}

src/infrastructure/EnvironmentVariables/IEnvironmentVariables.ts

@@ -0,0 +1,9 @@
+import { IAppMetadata } from './IAppMetadata';
+
+/**
+ * Designed to decouple the process of retrieving environment variables
+ * (e.g., from the build environment) from the rest of the application.
+ */
+export interface IEnvironmentVariables extends IAppMetadata {
+  readonly isNonProduction: boolean;
+}

src/infrastructure/EnvironmentVariables/IEnvironmentVariablesFactory.ts

@@ -0,0 +1,5 @@
+import { IEnvironmentVariables } from './IEnvironmentVariables';
+
+export interface IEnvironmentVariablesFactory {
+  readonly instance: IEnvironmentVariables;
+}

src/infrastructure/EnvironmentVariables/Vite/ViteEnvironmentKeys.ts

@@ -0,0 +1,13 @@
+// Only variables prefixed with VITE_ are exposed to Vite-processed code
+export const VITE_USER_DEFINED_ENVIRONMENT_KEYS = {
+  VERSION: 'VITE_APP_VERSION',
+  NAME: 'VITE_APP_NAME',
+  SLOGAN: 'VITE_APP_SLOGAN',
+  REPOSITORY_URL: 'VITE_APP_REPOSITORY_URL',
+  HOMEPAGE_URL: 'VITE_APP_HOMEPAGE_URL',
+} as const;
+
+export const VITE_ENVIRONMENT_KEYS = {
+  ...VITE_USER_DEFINED_ENVIRONMENT_KEYS,
+  DEV: 'DEV',
+} as const;

src/infrastructure/EnvironmentVariables/Vite/ViteEnvironmentVariables.ts

@@ -0,0 +1,33 @@
+import { IEnvironmentVariables } from '../IEnvironmentVariables';
+
+/**
+ * Provides the application's environment variables.
+ */
+export class ViteEnvironmentVariables implements IEnvironmentVariables {
+  // Ensure the use of import.meta.env prefix for the following properties.
+  // Vue will replace these statically during production builds.
+
+  public get version(): string {
+    return import.meta.env.VITE_APP_VERSION;
+  }
+
+  public get name(): string {
+    return import.meta.env.VITE_APP_NAME;
+  }
+
+  public get slogan(): string {
+    return import.meta.env.VITE_APP_SLOGAN;
+  }
+
+  public get repositoryUrl(): string {
+    return import.meta.env.VITE_APP_REPOSITORY_URL;
+  }
+
+  public get homepageUrl(): string {
+    return import.meta.env.VITE_APP_HOMEPAGE_URL;
+  }
+
+  public get isNonProduction(): boolean {
+    return import.meta.env.DEV;
+  }
+}

src/infrastructure/EnvironmentVariables/Vite/vite-env.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="vite/client" />
+
+import { VITE_ENVIRONMENT_KEYS } from './ViteEnvironmentKeys';
+
+export type ViteEnvironmentVariables = {
+  readonly [K in keyof typeof VITE_ENVIRONMENT_KEYS]: string;
+};
+
+interface ImportMeta {
+  readonly env: ViteEnvironmentVariables
+}

src/infrastructure/Events/EventSubscriptionCollection.ts

@@ -1,9 +1,20 @@
+import { IEventSubscriptionCollection } from './IEventSubscriptionCollection';
 import { IEventSubscription } from './IEventSource';
 
-export class EventSubscriptionCollection {
+export class EventSubscriptionCollection implements IEventSubscriptionCollection {
   private readonly subscriptions = new Array<IEventSubscription>();
 
-  public register(...subscriptions: IEventSubscription[]) {
+  public get subscriptionCount() {
+    return this.subscriptions.length;
+  }
+
+  public register(subscriptions: IEventSubscription[]) {
+    if (!subscriptions || subscriptions.length === 0) {
+      throw new Error('missing subscriptions');
+    }
+    if (subscriptions.some((subscription) => !subscription)) {
+      throw new Error('missing subscription in list');
+    }
     this.subscriptions.push(...subscriptions);
   }
 
@@ -11,4 +22,9 @@ export class EventSubscriptionCollection {
     this.subscriptions.forEach((listener) => listener.unsubscribe());
     this.subscriptions.splice(0, this.subscriptions.length);
   }
+
+  public unsubscribeAllAndRegister(subscriptions: IEventSubscription[]) {
+    this.unsubscribeAll();
+    this.register(subscriptions);
+  }
 }

src/infrastructure/Events/IEventSubscriptionCollection.ts

@@ -0,0 +1,9 @@
+import { IEventSubscription } from '@/infrastructure/Events/IEventSource';
+
+export interface IEventSubscriptionCollection {
+  readonly subscriptionCount: number;
+
+  register(subscriptions: IEventSubscription[]): void;
+  unsubscribeAll(): void;
+  unsubscribeAllAndRegister(subscriptions: IEventSubscription[]);
+}

src/infrastructure/Log/ConsoleLogger.ts

@@ -0,0 +1,13 @@
+import { ILogger } from './ILogger';
+
+export class ConsoleLogger implements ILogger {
+  constructor(private readonly globalConsole: Partial<Console> = console) {
+    if (!globalConsole) {
+      throw new Error('missing console');
+    }
+  }
+
+  public info(...params: unknown[]): void {
+    this.globalConsole.info(...params);
+  }
+}

src/infrastructure/Log/ElectronLogger.ts

@@ -0,0 +1,12 @@
+import { ElectronLog } from 'electron-log';
+import { ILogger } from './ILogger';
+
+// Using plain-function rather than class so it can be used in Electron's context-bridging.
+export function createElectronLogger(logger: Partial<ElectronLog>): ILogger {
+  if (!logger) {
+    throw new Error('missing logger');
+  }
+  return {
+    info: (...params) => logger.info(...params),
+  };
+}