Migrate to ES6 modules

Configure project to use ES6 modules to enable top-level await
capabilities. This change helps project to align well with modern JS
standards.

- Set `type` to `module` in `package.json`.
- Use import/export syntax in Cypress configuration files.
- Rename configurations files that do not support modules to use
  the `.cjs` extension:
  - `vue.config.js` to `vue.config.cjs` (vuejs/vue-cli#4477).
  - `babel.config.js` to `babel.config.cjs (babel/babel-loader#894)
  - `.eslintrc.js` to `.eslintrc.cjs` (eslint/eslint#13440,
    eslint/eslint#14137)
  - `postcss.config.js` to `postcss.config.cjs` (postcss/postcss#1771)
- Provide a workaround for Vue CLI & Mocha ES6 modules conflict in
  Vue configuration file (vuejs/vue-cli#7417).

.browserslistrc

@@ -1,2 +1,3 @@
 > 1%
 last 2 versions
+not dead

.editorconfig

@@ -0,0 +1,7 @@
+[*.{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

.eslintignore

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

.eslintrc.cjs

@@ -0,0 +1,123 @@
+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,
+  },
+  extends: [
+    // Vue specific rules, eslint-plugin-vue
+    // Added by Vue CLI
+    '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
+    // 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: ['**/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',
+    '@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}*`);
+}

.gitattributes

@@ -0,0 +1,6 @@
+# Prevent Git from auto-converting to CRLF on Windows, and convert to LF on checkin.
+#   *           : All files
+#   text=auto   : If Git decides content it text, it converts CRLF to LF on checkin.
+#   eol=lf      : forces Git to normalize line endings to LF on checkin and prevents conversion
+#                 to CRLF when the file is checked out.
+* text=auto eol=lf

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: undergroundwires

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

@@ -21,8 +21,9 @@ A clear and concise description of what the bug is.
 
 <!--
 Which OS are you using? What version of OS you were using?
-On Windows you can find it using "Start button" > "Settings" > "System" > "About".
+On Windows: Open "Start button" > "Settings" > "System" > "About".
-On macOS you can find it using "Apple menu (top left corner)" > "About This Mac".
+On macOS: Open "Apple menu (top left corner)" > "About This Mac".
+On Linux: Open terminal > type: lsb_release -a > copy paste the result.
 -->
 
 ### Reproduction steps

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

@@ -14,7 +14,7 @@ You could alternatively send a PR directly (see CONTRIBUTING.md).
 
 <!--
 Which OS will the new script configure?
-Either "Windows" or "macOS".
+One of the supported OSes: "Windows", "macOS" or "Linux".
 -->
 
 ### Name
@@ -30,10 +30,12 @@ E.g. "Disable webcam telemetry"
 <!--
 Code that will be executed when script is selected.
 Try to keep it as simple and backwards-compatible as possible.
-Allowed languages: 
+Allowed languages:
-  - macOS: bash (sh)
   - Windows: PowerShell (ps1) or batchfile
     - 💡 Prioritize the one that's simpler, batchfile if similar.
+  - macOS: bash (sh)
+  - Linux: bash (sh) or Python 3
+    - 💡 Prioritize the one that's simpler, bash if similar.
 -->
 
 ### Revert code

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

@@ -0,0 +1,8 @@
+runs:
+  using: composite
+  steps:
+    -
+      name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: 16.x

.github/workflows/checks.build.yaml

@@ -0,0 +1,75 @@
+name: build-checks
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-web:
+    strategy:
+      matrix:
+        os: [ macos, ubuntu, windows ]
+        mode: [ development, test, production ]
+      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
+        run: npm ci
+      -
+        name: Build
+        run: npm run build -- --mode ${{ matrix.mode }}
+
+  # 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
+      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
+        run: npm ci
+      -
+        name: Install cross-env
+        # Used to set NODE_ENV due to https://github.com/nklayman/vue-cli-plugin-electron-builder/issues/1626
+        run: npm install --global cross-env
+      -
+        name: Build
+        run: |-  
+          cross-env-shell NODE_ENV=${{ matrix.mode }}
+          npm run electron:build -- --publish never --mode ${{ matrix.mode }}
+
+  create-icons:
+    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
+        run: npm ci
+      -
+        name: Create icons
+        run: npm run create-icons

.github/workflows/checks.quality.yaml

@@ -1,4 +1,4 @@
-name: Quality checks
+name: quality-checks
 
 on: [ push, pull_request ]
 
@@ -8,19 +8,18 @@ jobs:
     strategy:
       matrix:
         lint-command:
-          - npm run lint:vue
+          - npm run lint:eslint
           - npm run lint:yaml
           - npm run lint:md
           - npm run lint:md:relative-urls
           - npm run lint:md:consistency
-      fail-fast: false # So it continues with other commands if one fails
+        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: actions/setup-node@v1
+        uses: ./.github/actions/setup-node
-        with:
-          node-version: 15.x
       - name: Install dependencies
         run: npm ci
       - name: Lint

.github/workflows/checks.security.yaml

@@ -1,4 +1,4 @@
-name: Security checks
+name: security-checks
 
 on:
   push:
@@ -16,9 +16,7 @@ jobs:
         uses: actions/checkout@v2
       -
         name: Setup node
-        uses: actions/setup-node@v1
+        uses: ./.github/actions/setup-node
-        with:
-          node-version: 15.x
       -
         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/release.desktop.yaml

@@ -1,4 +1,4 @@
-name: Deploy desktop
+name: release-desktop
 
 on:
  release:
@@ -20,9 +20,7 @@ jobs:
       - name: Checkout to bump commit
         run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: ./.github/actions/setup-node
-        with:
-          node-version: 15.x
       - name: Install dependencies
         run: npm ci
       - name: Run unit tests
@@ -31,4 +29,4 @@ jobs:
         run: npm run electron:build -- -p always # https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/recipes.html#upload-release-to-github
         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
+          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.git.yaml

@@ -1,4 +1,4 @@
-name: Bump & release
+name: release-git
 
 on:
   push: # Ensure a new release is created for each new tag

.github/workflows/release.site.yaml

@@ -1,8 +1,8 @@
-name: Deploy site
+name: release-site
 
 on:
- release:
+  release:
-   types: [created] # will be triggered when a NON-draft release is created and published.
+    types: [created] # will be triggered when a NON-draft release is created and published.
 
 jobs:
   aws-deploy: # see: https://github.com/undergroundwires/aws-static-site-with-cd
@@ -77,30 +77,28 @@ jobs:
         name: "App: Checkout"
         uses: actions/checkout@v2
         with:
-          path: site
+          path: app
           ref: master # otherwise we don't get version bump commit
       -
         name: "App: Setup node"
-        uses: actions/setup-node@v1
+        uses: ./app/.github/actions/setup-node
-        with:
-          node-version: 15.x
       -
         name: "App: Install dependencies"
         run: npm ci
-        working-directory: site
+        working-directory: app
       -
         name: "App: Run unit tests"
         run: npm run test:unit
-        working-directory: site
+        working-directory: app
       - 
         name: "App: Build"
         run: npm run build
-        working-directory: site
+        working-directory: app
       -
         name: "App: Deploy to S3"
         run: >-
           bash "aws/scripts/deploy/deploy-to-s3.sh" \
-            --folder site/dist \
+            --folder app/dist \
             --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

@@ -0,0 +1,26 @@
+name: e2e-tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  run-tests:
+    strategy:
+      matrix:
+        os: [macos, ubuntu, windows]
+      fail-fast: false # So it still runs on other OSes if one of them fails
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Setup node
+        uses: ./.github/actions/setup-node
+      -
+        name: Install dependencies
+        run: npm ci
+      -
+        name: Run e2e tests
+        run: npm run test:e2e -- --headless

.github/workflows/tests.integration.yaml

@@ -1,9 +1,9 @@
-name: Test
+name: integration-tests
 
 on:
   push:
   pull_request:
-  schedule: # for integration tests
+  schedule: # To get notified about problems from third party dependencies
     - cron: '0 0 * * 0' # at 00:00 on every Sunday
 
 jobs:
@@ -19,15 +19,10 @@ jobs:
         uses: actions/checkout@v2
       -
         name: Setup node
-        uses: actions/setup-node@v1
+        uses: ./.github/actions/setup-node
-        with:
-          node-version: 15.x
       -
         name: Install dependencies
         run: npm ci
-      -
-        name: Run unit tests
-        run: npm run test:unit
       -
         name: Run integration tests
         run: npm run test:integration

.github/workflows/tests.unit.yaml

@@ -0,0 +1,26 @@
+name: unit-tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  run-tests:
+    strategy:
+      matrix:
+        os: [macos, ubuntu, windows]
+      fail-fast: false # So it still runs on other OSes if one of them fails
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Set-up node
+        uses: ./.github/actions/setup-node
+      -
+        name: Install dependencies
+        run: npm ci
+      -
+        name: Run unit tests
+        run: npm run test:unit

.gitignore

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

.vscode/extensions.json

@@ -0,0 +1,23 @@
+{
+  "recommendations": [
+    // Common
+    "editorconfig.editorconfig",        // Applies .editorconfig to follow project style.
+    "wengerk.highlight-bad-chars",      // Highlights bad chars.
+    "wayou.vscode-todo-highlight",      // Highlights TODO.
+    "wix.vscode-import-cost",           // Shows in KB how much a require include in code.
+    // Documentation
+    "davidanson.vscode-markdownlint",   // Lints markdown.
+    // TypeScript / JavaScript
+    "dbaeumer.vscode-eslint",           // Lints JavaScript/TypeScript.
+    "pmneo.tsimporter",                 // Provides better auto-complete for TypeScripts imports.
+    // Vue
+    "jcbuisson.vue",                    // Highlights syntax.
+    "octref.vetur",                     // Adds Vetur, Vue tooling support.
+    // Scripting
+    "timonwong.shellcheck",             // Lints bash files.
+    "ms-vscode.powershell",             // Lints PowerShell files.
+    "ms-python.python",                 // Lints Python files.
+    // Distribution
+    "ms-azuretools.vscode-docker"       // Adds Docker support.
+  ]
+}

CHANGELOG.md

@@ -1,5 +1,99 @@
 # Changelog
 
+## 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)
+* Fix reverting of Windows NVIDIA telemetry service | [2354f0b](https://github.com/undergroundwires/privacy.sexy/commit/2354f0ba9fed3aa23569b5ea6391a7119fe1ab53)
+* Add AirBnb TypeScript overrides for linting | [834ce8c](https://github.com/undergroundwires/privacy.sexy/commit/834ce8cf9e8e46934dfa604526360870d109765b)
+* Transpile dependencies for wider browser support | [0e52a99](https://github.com/undergroundwires/privacy.sexy/commit/0e52a99efa2b02d1aba10885a76e03aa6f9be7f8)
+* Add more and unify tests for absent object cases | [44d79e2](https://github.com/undergroundwires/privacy.sexy/commit/44d79e2c9a97639bbd188a8fdfd740f1a5a1d6ee)
+* Fix Windows DoSvc not being disabled #115 | [43ce834](https://github.com/undergroundwires/privacy.sexy/commit/43ce834750ddf471636d1ece4324d02357947f9f)
+* Move stubs from `./stubs` to `./shared/Stubs` | [803ef2b](https://github.com/undergroundwires/privacy.sexy/commit/803ef2bb3eea68306377e40e326c791402998650)
+* Improve documentation for developing | [3c3ec80](https://github.com/undergroundwires/privacy.sexy/commit/3c3ec80525b97e8a24db4c44bbf42a7b4e089056)
+* Improve documentation for architecture | [1bcc6c8](https://github.com/undergroundwires/privacy.sexy/commit/1bcc6c8b2b923b4d4b1662f990d86b190ce73342)
+* Improve existing documentation | [db47440](https://github.com/undergroundwires/privacy.sexy/commit/db47440d470ea6a6e100b620b10d078c01314992)
+* Refactor to remove code coupling with Webpack | [5bbbb9c](https://github.com/undergroundwires/privacy.sexy/commit/5bbbb9cecca0a3828036e7fc34dcd66970ce334a)
+* Refactor to remove hardcoding of aliases | [481a02a](https://github.com/undergroundwires/privacy.sexy/commit/481a02afd5190eb77a37fa450e50816b2268e99c)
+* Document WpnService breaking on Windows 10 #110 | [3785e41](https://github.com/undergroundwires/privacy.sexy/commit/3785e410db461f667a834e0b388d81e4baa028e4)
+* Fix error when reverting Windows Defender setting | [956052c](https://github.com/undergroundwires/privacy.sexy/commit/956052c8fff042812fe84fe4d7fa5c579365ff9b)
+* Fix Windows 11 being detected as Windows 10 | [d6bc33e](https://github.com/undergroundwires/privacy.sexy/commit/d6bc33ec865d50efc6b8d4ccc2f789edd874fcee)
+* Refactor to use version object #59 | [eeb1d5b](https://github.com/undergroundwires/privacy.sexy/commit/eeb1d5b0c40a55675921af3f67f366b2ff658acf)
+* Fix Microsoft Defender alert for uninstaller #114 | [112e79a](https://github.com/undergroundwires/privacy.sexy/commit/112e79a64c6153f4ce3b48c27a09639e7647aebc)
+* Add donation information | [05a6a84](https://github.com/undergroundwires/privacy.sexy/commit/05a6a84c3739ec900343591ac1f7a9f310cd73f2)
+* Bump node environment to 16.x | [242a497](https://github.com/undergroundwires/privacy.sexy/commit/242a497e7debb351da19b20b63a3554f0cca4b5c)
+* Bump dependencies to latest | [efd63ff](https://github.com/undergroundwires/privacy.sexy/commit/efd63ff85dea4c9a9c033c54bc1be378742de351)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.11.3...0.11.4)
+
+## 0.11.3 (2022-01-05)
+
+* Fix double backlashes in Windows vscode scripts | [5f091bb](https://github.com/undergroundwires/privacy.sexy/commit/5f091bb6abed878271e2321cd784f34436c677bd)
+* Fix OS desktop detection tests and edge cases | [a8358b8](https://github.com/undergroundwires/privacy.sexy/commit/a8358b8e7a93214f3d22a4488007ded5f623d845)
+* Fix clearing Windows product key showing dialog | [9b6636e](https://github.com/undergroundwires/privacy.sexy/commit/9b6636e21a922a4750dc19f4854f8ae679187926)
+* Document and unrecommend Cloud Experience Host | [9b5e0b0](https://github.com/undergroundwires/privacy.sexy/commit/9b5e0b0591fee56af52d83334a1f19180a49516f)
+* Add initial e2e testing with cypress | [ddd2e70](https://github.com/undergroundwires/privacy.sexy/commit/ddd2e704dbd361cbd219f3dfe644b983ad254095)
+* Restructure pipelines and badges | [5a2c263](https://github.com/undergroundwires/privacy.sexy/commit/5a2c263af35b8785e75ead6c43c3f17186dc15c8)
+* Fix failing of functions without revert code | [87de017](https://github.com/undergroundwires/privacy.sexy/commit/87de017afd6e08acbd2deea150c6af9c7ee778fc)
+* Fix typos in privacy modal #109 | [a1871a2](https://github.com/undergroundwires/privacy.sexy/commit/a1871a2982c9e3192193f836b97b1a6ccda5a2ab)
+* Refactor to add readonly interfaces | [c3c5b89](https://github.com/undergroundwires/privacy.sexy/commit/c3c5b897f308f613c252182a02cdd4cfa7150fa3)
+* Document and unrecommend AAD app removal #24, #54 | [455084c](https://github.com/undergroundwires/privacy.sexy/commit/455084c17b32d11d046515e8dc1447adf4bea4c3)
+* Migrate from TSLint to ESLint | [61b475f](https://github.com/undergroundwires/privacy.sexy/commit/61b475fa8de433cdada2efa7eac197683aacd956)
+* Add build checks and improve existing CI/CD checks | [17298f0](https://github.com/undergroundwires/privacy.sexy/commit/17298f0b2c51cb9becc0eb2ffe0d93d6a4c503a6)
+* Upgrade to Vue CLI 5 (and webpack 5) | [96265b7](https://github.com/undergroundwires/privacy.sexy/commit/96265b75deafb85978b16460138fb4a814c07cfe)
+* Refactor code to comply with ESLint rules | [5b1fbe1](https://github.com/undergroundwires/privacy.sexy/commit/5b1fbe1e2fb1354a5f060f8c8e3794ce756e16a7)
+* Fix mutated line endings on Windows | [bd23faa](https://github.com/undergroundwires/privacy.sexy/commit/bd23faa28f6d781581a33d5b780f4b33f7e2cd8b)
+* Refactor to improve iterations | [31f7091](https://github.com/undergroundwires/privacy.sexy/commit/31f70913a2f30baf5a9d6690f192e6a63da50114)
+* win: unrecommend and document Live ID service #100 | [d11a674](https://github.com/undergroundwires/privacy.sexy/commit/d11a674a3c4ad8f4972a870c2f0977ac53297273)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.11.2...0.11.3)
+
+## 0.11.2 (2021-12-03)
+
+* Fix Windows TrustedInstaller session errors | [20a0071](https://github.com/undergroundwires/privacy.sexy/commit/20a0071c0d3d769a8f31218abdbfc4cafa25c6ff)
+* Improve tests for `UserSelection` | [2f90cac](https://github.com/undergroundwires/privacy.sexy/commit/2f90cac52ab9e57615aeec41f9daa842bce770a5)
+* Fix disabling/enabling Defender on Windows #104 | [2e08293](https://github.com/undergroundwires/privacy.sexy/commit/2e082932c952b0849ab2b8709ff0c75293b88e95)
+* Refactor Saas naming, structure and modules | [bf83c58](https://github.com/undergroundwires/privacy.sexy/commit/bf83c58982ffa178facc6d35e50c7f1eac7ff236)
+* Fix Defender features errors in Windows #104 | [d7761ab](https://github.com/undergroundwires/privacy.sexy/commit/d7761ab30e7f1e10a2919c196804d67511d6163a)
+* Fix unintendedly inlined Windows scripts | [f2d9881](https://github.com/undergroundwires/privacy.sexy/commit/f2d988138257ff184884e4adc83c39e3bc247e9b)
+* Fix Defender error due to non-english Windows #104 | [7c02ffb](https://github.com/undergroundwires/privacy.sexy/commit/7c02ffb6c95382b94f0b05e6f259cc418ec91c93)
+* Improve and unify disabling of Windows services | [70cdf38](https://github.com/undergroundwires/privacy.sexy/commit/70cdf3865a0de3214fc9e26fbdada4b0cb413c46)
+* Improve Windows defender docs and errors #104 | [d2518b1](https://github.com/undergroundwires/privacy.sexy/commit/d2518b11a7774ec58b9b46a691e2f013855bf0f9)
+* Unrecommend and complete Windows Push Notif. #101 | [c65209e](https://github.com/undergroundwires/privacy.sexy/commit/c65209e6a99230f15ace8955e8d5a6f3333d146b)
+
+[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.11.1...0.11.2)
+
 ## 0.11.1 (2021-11-04)
 
 * Update dependencies | [64631a4](https://github.com/undergroundwires/privacy.sexy/commit/64631a4552fad7f7b06286aba8d3ca2d731f9342)

CONTRIBUTING.md

@@ -1,34 +1,51 @@
 # Contributing
 
-- Love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
+Love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
-  - Reporting a bug
+
-  - Discussing the current state of the code
+- reporting a bug,
-  - Submitting a fix
+- discussing the current state of the code,
-  - Proposing new features
+- submitting a fix,
-  - Becoming a maintainer
+- proposing new features,
+- or becoming a maintainer.
+
+As a small open source project with small community, it can sometimes take a long time to address the issues so please be patient.
 
 ## Pull request process
 
-- [GitHub flow](https://guides.github.com/introduction/flow/index.html) with [GitOps](./img/architecture/gitops.png) is used
+Your pull requests are actively welcomed. We collaborate using [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow).
-- Your pull requests are actively welcomed.
+
-- The steps:
+The steps:
-  1. Fork the repo and create your branch from master.
+
-  2. If you've added code that should be tested, add tests.
+1. Fork the repo and create your branch from master.
-  3. If you've changed APIs, update the documentation.
+2. If you've added code that requires testing, add tests. See [tests.md](./docs/tests.md).
-  4. Ensure the test suite passes.
+3. If you've done a major change, update the documentation. See [docs/](./docs/).
-  5. Make sure your code lints.
+4. Ensure the test suite passes. See [development.md | Testing](./docs/development.md#testing) for commands.
-  6. Issue that pull request!
+5. Make sure your code lints.See [development.md | Linting](./docs/development.md#linting) for commands.
-- 🙏 DO
+6. Issue that pull request!
-  - Document your changes in the pull request
+
-- ❗ DON'T
+**🙏 DO:**
-  - Do not update the versions, current version is only [set by the maintainer](./img/architecture/gitops.png) and updated automatically by [bump-everywhere](https://github.com/undergroundwires/bump-everywhere)
+
+- Document why (what you're trying to solve) rather than what in the pull request.
+
+**❗ DON'T:**
+
+- Do not update the versions, current version is [set by the maintainer](./docs/ci-cd.md#gitops) and updated automatically by [bump-everywhere](https://github.com/undergroundwires/bump-everywhere).
+
+Automated pipelines will run to control your PR and they will publish your code once the maintainer merges your PR.
+
+📖 You can read more in [ci-cd.md](./docs/ci-cd.md).
+
+## Extend scripts
+
+Here's quick information for you who want to add more scripts.
+
+You have two alternatives:
+
+1. [Create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) and ask for someone else to add the script for you.
+2. Or send a PR yourself. This would make it faster to get your code into the project. You need to add scripts to related OS in [collections](src/application/collections/) folder. Then you'd sent a pull request, see [pull request process](#pull-request-process).
+   - 📖 If you're unsure about the syntax, check [collection-files.md](docs/collection-files.md).
+   - 📖 If you wish to use templates, use [templating.md](./docs/templating.md).
 
 ## License
 
-By contributing, you agree that your contributions will be licensed under its [GNU General Public License v3.0](./LICENSE).
+By contributing, you agree that your [GNU General Public License v3.0](./LICENSE) will be the license for your contributions.
-
-## Read more
-
-- See [tests](./docs/tests.md) for testing
-- See [extend script](./README.md#extend-scripts) for quick steps to extend scripts
-- See [architecture overview](./README.md#architecture-overview) to deep dive into privacy.sexy codebase

README.md

@@ -1,88 +1,141 @@
-# privacy.sexy
+# privacy.sexy — Now you have the choice
 
-> Enforce privacy & security best-practices on Windows and macOS, because privacy is sexy 🍑🍆
+> Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆
 
-[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](./CONTRIBUTING.md)
+<!-- markdownlint-disable MD033 -->
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript)
+<p align="center">
-[![Maintainability](https://api.codeclimate.com/v1/badges/3a70b7ef602e2264342c/maintainability)](https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability)
+  <a href="https://undergroundwires.dev/donate?project=privacy.sexy" target="_blank" rel="noopener noreferrer">
-[![Tests status](https://github.com/undergroundwires/privacy.sexy/workflows/Test/badge.svg)](https://github.com/undergroundwires/privacy.sexy/actions)
+    <img
-[![Quality checks status](https://github.com/undergroundwires/privacy.sexy/workflows/Quality%20checks/badge.svg)](https://github.com/undergroundwires/privacy.sexy/actions)
+      alt="donation badge"
-[![Security checks status](https://github.com/undergroundwires/privacy.sexy/workflows/Security%20checks/badge.svg)](https://github.com/undergroundwires/privacy.sexy/actions)
+      src="https://undergroundwires.dev/img/badges/donate/flat.svg"
-[![Bump & release status](https://github.com/undergroundwires/privacy.sexy/workflows/Bump%20&%20release/badge.svg)](https://github.com/undergroundwires/privacy.sexy/actions)
+    />
-[![Deploy status](https://github.com/undergroundwires/privacy.sexy/workflows/Build%20&%20deploy/badge.svg)](https://github.com/undergroundwires/privacy.sexy/actions)
+  </a>
-[![Auto-versioned by bump-everywhere](https://github.com/undergroundwires/bump-everywhere/blob/master/badge.svg?raw=true)](https://github.com/undergroundwires/bump-everywhere)
+  <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 -->
+  <br />
+  <a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript" target="_blank" rel="noopener noreferrer">
+    <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" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Maintainability"
+      src="https://api.codeclimate.com/v1/badges/3a70b7ef602e2264342c/maintainability"
+    />
+  </a>
+  <!-- Tests -->
+  <br />
+  <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" 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" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="E2E tests status"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
+    />
+  </a>
+  <!-- Checks -->
+  <br />
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="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" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Security checks status"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
+    />
+  </a>
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Build checks status"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
+    />
+  </a>
+  <!-- Release -->
+  <br />
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.git.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Git release status"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/release-git/badge.svg"
+    />
+  </a>
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.site.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Site release status"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/release-site/badge.svg"
+    />
+  </a>
+  <a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/release.desktop.yaml" target="_blank" rel="noopener noreferrer">
+    <img
+      alt="Desktop application release status"
+      src="https://github.com/undergroundwires/privacy.sexy/workflows/release-desktop/badge.svg"
+    />
+  </a>
+  <!-- Others -->
+  <br />
+  <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"
+    />
+  </a>
+</p>
+<!-- markdownlint-restore -->
 
 ## Get started
 
-- Online version at [https://privacy.sexy](https://privacy.sexy)
+- 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
-  - 💡 No need to run any compiled software on your computer.
+- 🖥️ **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).
-- Alternatively download offline version for [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.1/privacy.sexy-Setup-0.11.1.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.1/privacy.sexy-0.11.1.dmg) or [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.1/privacy.sexy-0.11.1.AppImage).
-  - 💡 Single click to execute your script.
-- ❗ Come back regularly to apply latest version for stronger privacy and security.
 
-[![privacy.sexy application](img/screenshot.png?raw=true)](https://privacy.sexy)
+Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
 
-## Why
+💡 You should apply your configuration from time to time (more than once). It would strengthen your privacy and security control because privacy.sexy and its scripts get better and stronger in every new version.
 
-- Rich tweak pool to harden security & privacy of the OS and other software on it
+[![privacy.sexy application](img/screenshot.png?raw=true )](https://privacy.sexy)
-- Free (both free as in beer and free as in speech)
-- No need to run any compiled software that has access to your system, just run the generated scripts
-- Have full visibility into what the tweaks do as you enable them
-- Ability to revert (undo) applied scripts
-- Everything is transparent: both application and its infrastructure are open-source and automated
-- Easily extendable with [own powerful templating language](./docs/templating.md)
-- Each script is independently executable without cross-dependencies
 
-## Extend scripts
+## Features
 
-- You can either [create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose)
+- **Rich**: Hundreds of scripts that aims to give you control of your data.
-- Or send a PR:
+- **Free**: Both free as in "beer" and free as in "speech".
-  1. Fork the repository
+- **Transparent**. Have full visibility into what the tweaks do as you enable them.
-  2. Add more scripts in respective script collection in [collections](src/application/collections/) folder.
+- **Reversible**. Revert if something feels wrong.
-     - 📖 If you're unsure about the syntax you can refer to the [collection files | documentation](docs/collection-files.md).
+- **Accessible**. No need to run any compiled software on your computer with web version.
-     - 🙏 For any new script, please add `revertCode` and `docs` values if possible.
+- **Open**. What you see as code in this repository is what you get. The application itself, its infrastructure and deployments are open-source and automated thanks to [bump-everywhere](https://github.com/undergroundwires/bump-everywhere).
-  3. Send a pull request 👌
+- **Tested**. A lot of tests. Automated and manual. Community-testing and verification. Stability improvements comes before new features.
+- **Extensible**. Effortlessly [extend scripts](./CONTRIBUTING.md#extend-scripts) with a custom designed [templating language](./docs/templating.md).
+- **Portable and simple**. Every script is independently executable without cross-dependencies.
 
-## Commands
+## Support
 
-- Project setup: `npm install`
+**Sponsor 💕**. Consider sponsoring on [GitHub Sponsors](https://github.com/sponsors/undergroundwires), or you can donate using [other ways such as crypto or a coffee](https://undergroundwires.dev/donate).
-- Testing
-  - Run unit tests: `npm run test:unit`
-  - Run integration tests: `npm run test:integration`
-  - Lint: `npm run lint`
-- **Desktop app**
-  - Development: `npm run electron:serve`
-  - Production: `npm run electron:build` to build an executable
-- **Webpage**
-  - Development: `npm run serve` to compile & hot-reload for development.
-  - Production: `npm run build` to prepare files for distribution.
-  - Or run using Docker:
-    1. Build: `docker build -t undergroundwires/privacy.sexy:0.11.1 .`
-    2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy-0.11.1 undergroundwires/privacy.sexy:0.11.1`
 
-## Architecture overview
+**Star 🤩**. Feel free to give it a star ⭐ .
 
-### Application
+**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).
 
-- Powered by **TypeScript**, **Vue.js** and **Electron** 💪
+## Development
-  - and driven by **Domain-driven design**, **Event-driven architecture**, **Data-driven programming** concepts.
-- Application uses highly decoupled models & services in different DDD layers.
-- 📖 Read more on • [Presentation](./docs/presentation.md) • [Application](./docs/application.md)
 
-![DDD + vue.js](img/architecture/app-ddd.png)
+Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
 
-### AWS Infrastructure
+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.
 
-[![AWS solution](img/architecture/aws-solution.png)](https://github.com/undergroundwires/aws-static-site-with-cd)
+[docs/](./docs/) folder includes all other documentation.
-
-- It uses infrastructure from the following repository: [aws-static-site-with-cd](https://github.com/undergroundwires/aws-static-site-with-cd)
-  - Runs on AWS 100% serverless and automatically provisioned using [GitHub Actions](.github/workflows/).
-  - Maximum security & automation and minimum AWS costs are the highest priorities of the design.
-
-#### GitOps: CI/CD to AWS
-
-- CI/CD is fully automated for this repo using different GIT events & GitHub actions.
-  - Versioning, tagging, creation of `CHANGELOG.md` and releasing is automated using [bump-everywhere](https://github.com/undergroundwires/bump-everywhere) action
-- Everything that's merged in the master goes directly to production.
-
-[![CI/CD to AWS with GitHub Actions](img/architecture/gitops.png)](.github/workflows/)

babel.config.cjs

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

babel.config.js

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

build/README.md

@@ -1,5 +1,5 @@
 # build
 
-- These are the file that are used by electron.
+This folder contains files that are used by Electron to serve the desktop version.
-- Logos are created by from the [PNG icon](./../public/icon.png)
+
-  - by running `npx electron-icon-builder --input=./public/icon.png --output=build --flatten`
+Icons are created from the main logo file and should not be changed manually, see [related documentation](./../img/README.md).

cypress.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'cypress';
+import setupPlugins from './tests/e2e/plugins/index.js';
+
+export default defineConfig({
+  fixturesFolder: 'tests/e2e/fixtures',
+  screenshotsFolder: 'tests/e2e/screenshots',
+  videosFolder: 'tests/e2e/videos',
+  e2e: {
+    setupNodeEvents(on, config) {
+      return setupPlugins(on, config);
+    },
+    specPattern: 'tests/e2e/specs/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'tests/e2e/support/index.js',
+  },
+});

docs/application.md

@@ -1,44 +1,45 @@
 # Application
 
-- It's mainly responsible for
+Application layer is mainly responsible for:
-  - creating and event based [application state](#application-state)
+
-  - [parsing](#parsing) and [compiling](#compiling) [application data](#application-data)
+- creating an event-based and mutable [application state](#application-state),
-- Consumed by [presentation layer](./presentation.md)
+- [parsing and compiling](#parsing-and-compiling) the [application data](#application-data).
+
+📖 Refer to [architecture.md | Layered Application](./architecture.md#layered-application) to read more about the layered architecture.
 
 ## Structure
 
-- [`/src/` **`application/`**](./../src/application/): Contains all application related code.
+Application layer code exists in [`/src/application`](./../src/application/) and includes following structure:
-  - [**`collections/`**](./../src/application/collections/): Holds [collection files](./collection-files.md)
+
-  - [**`Common/`**](./../src/application/Common/): Contains common functionality that is shared in application layer.
+- [**`collections/`**](./../src/application/collections/): Holds [collection files](./collection-files.md).
-  - `..`: other classes are categorized using folders-by-feature structure
+- [**`Common/`**](./../src/application/Common/): Contains common functionality in application layer.
+- `...`: rest of the application layer source code organized using folders-by-feature structure.
 
 ## Application state
 
-- [ApplicationContext.ts](./../src/application/Context/ApplicationContext.ts) holds the [CategoryCollectionState](./../src/application/Context/State/CategoryCollectionState.ts) for each OS
+It uses [state pattern](https://en.wikipedia.org/wiki/State_pattern) with context and state objects. [`ApplicationContext.ts`](./../src/application/Context/ApplicationContext.ts) the "Context" of state pattern provides an instance of [`CategoryCollectionState.ts`](./../src/application/Context/State/CategoryCollectionState.ts) (the "State" of the state pattern) for every supported collection.
-- Uses [state pattern](https://en.wikipedia.org/wiki/State_pattern)
+
-- Same instance is shared throughout the application to ensure consistent state
+Presentation layer uses a singleton (same instance of) [`ApplicationContext.ts`](./../src/application/Context/ApplicationContext.ts) throughout the application to ensure consistent state.
-- 📖 See [Application State | Presentation layer](./presentation.md#application-state) to read more about how the state should be managed by the presentation layer.
+
-- 📖 See [ApplicationContext.ts](./../src/application/Context/ApplicationContext.ts) to start diving into the state code.
+📖 Refer to [architecture.md | Application State](./architecture.md#application-state) to get an overview of event handling and [presentation.md | Application State](./presentation.md#application-state) for deeper look into how the presentation layer manages state.
 
 ## Application data
 
-- Compiled to [`Application`](./../src/domain/Application.ts) domain object.
+Application data is collection files using YAML. You can refer to [collection-files.md](./collection-files.md) to read more about the scheme and structure of application data files. You can also check the source code [collection yaml files](./../src/application/collections/) to directly see the application data using that scheme.
-- The scripts are defined and controlled in different data files per OS
-- Enables [data-driven programming](https://en.wikipedia.org/wiki/Data-driven_programming) and easier contributions
-- Application data is defined in collection files and
-- 📖 See [Application data | Presentation layer](./presentation.md#application-data) to read how the application data is read by the presentation layer.
-- 📖 See [collection files documentation](./collection-files.md) to read more about how the data files are structured/defined and see [collection yaml files](./../src/application/collections/) to directly check the code.
 
-## Parsing
+Application layer [parses and compiles](#parsing-and-compiling) application data into [`Application`](./../src/domain/Application.ts)). Once parsed, application layer provides the necessary functionality to presentation layer based on the application data. You can read more about how presentation layer consumes the application data in [presentation.md | Application Data](./presentation.md#application-data).
 
-- Application data is parsed to domain object [`Application.ts`](./../src/domain/Application.ts)
+Application layer enables [data-driven programming](https://en.wikipedia.org/wiki/Data-driven_programming) by leveraging the data to the rest of the source code. It makes it easy for community to contribute on the project by using a declarative language used in collection files.
-- Steps
-  1. (Compile time) Load application data from [collection yaml files](./../src/application/collections/) using webpack loader
-  2. (Runtime) Parse and compile application and make it available to presentation layer by [`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)
 
-### Compiling
+### Parsing and compiling
 
-- Parsing the application files includes compiling scripts using [collection file defined functions](./collection-files.md#function)
+Application layer parses the application data to compile the domain object [`Application.ts`](./../src/domain/Application.ts).
-- To extend the syntax:
+
-  1. Add a new parser under [SyntaxParsers](./../src/application/Parser/Script/Compiler/Expressions/SyntaxParsers) where you can look at other parsers to understand more.
+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.
-  2. Register your in [CompositeExpressionParser](./../src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts)
+
+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).
+
+The steps to extend the templating syntax:
+
+1. Add a new parser under [SyntaxParsers](./../src/application/Parser/Script/Compiler/Expressions/SyntaxParsers) where you can look at other parsers to understand more.
+2. Register your in [CompositeExpressionParser](./../src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts).

docs/architecture.md

@@ -0,0 +1,68 @@
+# Architecture overview
+
+This repository consists of:
+
+- A [layered application](#layered-application).
+- [AWS infrastructure](#aws-infrastructure) as code and instructions to host the website.
+- [GitOps](#gitops) practices for development, maintenance and deployment.
+
+## Layered application
+
+Application is
+
+- powered by **TypeScript**, **Vue.js** and **Electron** 💪,
+- and driven by **Domain-driven design**, **Event-driven architecture**, **Data-driven programming** concepts.
+
+Application uses highly decoupled models & services in different DDD layers:
+
+- presentation layer (see [presentation.md](./presentation.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.
+
+![DDD + vue.js](./../img/architecture/app-ddd.png)
+
+### Application state
+
+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)
+
+*[Presentation layer](./presentation.md)*:
+
+- Each component holds their own state about presentation-related data.
+- Components register shared state changes into application state using functions.
+- Components listen to shared state changes using event subscriptions.
+- 📖 Read more: [presentation.md | Application state](./presentation.md#application-state).
+
+*[Application layer](./application.md)*:
+
+- Stores the application-specific state.
+- The state it exposed for read with getter functions and set using setter functions, setter functions also fire application events that allows other parts of application and the view in presentation layer to react.
+- 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`, `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
+
+The web-site runs on serverless AWS infrastructure. Infrastructure is open-source and deployed as code. [aws-static-site-with-cd](https://github.com/undergroundwires/aws-static-site-with-cd) project includes the source code.
+
+[![AWS solution](../img/architecture/aws-solution.png)](https://github.com/undergroundwires/aws-static-site-with-cd)
+
+The design priorities highest security then minimizing cloud infrastructure costs.
+
+This project includes [GitHub Actions](../.github/workflows/) to automatically provision the infrastructure with zero-touch and without any "hidden" steps, ensuring everything is open-source and transparent. Git repositories includes all necessary instructions and automation with [GitOps](#gitops) practices.
+
+## GitOps
+
+CI/CD pipelines automate operational tasks based on different Git events. [bump-everywhere](https://github.com/undergroundwires/bump-everywhere) enables this automation.
+
+📖 Read more in [`ci-cd.md`](./ci-cd.md#gitops).
+
+[![CI/CD using GitHub Actions](../img/architecture/gitops.png)](../.github/workflows/)

docs/ci-cd.md

@@ -0,0 +1,45 @@
+# CI/CD overview
+
+## GitOps
+
+CI/CD is fully automated using different Git events and GitHub actions. This repository uses [bump-everywhere](https://github.com/undergroundwires/bump-everywhere) to automate versioning, tagging, creation of `CHANGELOG.md` and GitHub releases. A dedicated workflow [release.desktop.yaml](./../.github/workflows/release.desktop.yaml) creates desktop installers and executables and attaches them into GitHub releases.
+
+Everything that's merged in the master goes directly to production.
+
+[![CI/CD using GitHub Actions](./../img/architecture/gitops.png)](../.github/workflows/)
+
+## Pipeline files
+
+privacy.sexy uses [GitHub actions](https://github.com/features/actions) to define and run pipelines as code.
+
+GitHub workflows i.e. pipelines exist in [`/.github/workflows/`](./../.github/workflows/) folder without any subfolders due to GitHub actions requirements [1] .
+
+Local GitHub actions are defined in [`/.github/actions/`](./../.github/actions/) and used to reuse same workflow steps.
+
+## Pipeline types
+
+We categorize pipelines into different categories. We use these names in convention when naming files and actions, see [naming conventions](#naming-conventions).
+
+The categories consist of:
+
+- `tests`: Different types of tests to verify functionality.
+- `checks`: Other controls such as vulnerability scans or styling checks.
+- `release`: Pipelines used for release of deployment such as building and testing.
+
+## Naming conventions
+
+Convention for naming pipeline files: **`<type>.<name>.yaml`**.
+
+**`type`**:
+
+- Sub-folders do not work for GitHub workflows [1] so we use `<type>.` prefix to organize them.
+- See also [pipeline types](#pipeline-types) for list of all usable types.
+
+**`name`**:
+
+- We name workflows using kebab-case.
+- E.g. file name `tests.unit.yaml`, pipeline file should set the naem as: `name: unit-tests`.
+- Kebab-case allows to have better URL references to them.
+  - [README.md](./../README.md) uses URL references to show status badges for actions.
+
+[1]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows

docs/collection-files.md

@@ -2,8 +2,8 @@
 
 - privacy.sexy is a data-driven application where it reads the necessary OS-specific logic from yaml files in [`application/collections`](./../src/application/collections/)
 - 💡 Best practices
-  - If you repeat yourself, try to utilize [YAML-defined functions](#Function)
+  - If you repeat yourself, try to utilize [YAML-defined functions](#function)
-  - Always try to add documentation and a way to revert a tweak in [scripts](#Script)
+  - Always try to add documentation and a way to revert a tweak in [scripts](#script)
 - 📖 Types in code: [`collection.yaml.d.ts`](./../src/application/collections/collection.yaml.d.ts)
 
 ## Objects
@@ -13,19 +13,19 @@
 - A collection simply defines:
   - different categories and their scripts in a tree structure
   - OS specific details
-- Also allows defining common [function](#Function)s to be used throughout the collection if you'd like different scripts to share same code.
+- Also allows defining common [function](#function)s to be used throughout the collection if you'd like different scripts to share same code.
 
 #### `Collection` syntax
 
 - `os:` *`string`*  (**required**)
   - Operating system that the [Collection](#collection) is written for.
   - 📖 See [OperatingSystem.ts](./../src/domain/OperatingSystem.ts) enumeration for allowed values.
-- `actions: [` ***[`Category`](#Category)*** `, ... ]` **(required)**
+- `actions: [` ***[`Category`](#category)*** `, ... ]` **(required)**
   - Each [category](#category) is rendered as different cards in card presentation.
   - ❗ A [Collection](#collection) must consist of at least one category.
-- `functions: [` ***[`Function`](#Function)*** `, ... ]`
+- `functions: [` ***[`Function`](#function)*** `, ... ]`
   - Functions are optionally defined to re-use the same code throughout different scripts.
-- `scripting:` ***[`ScriptingDefinition`](#ScriptingDefinition)*** **(required)**
+- `scripting:` ***[`ScriptingDefinition`](#scriptingdefinition)*** **(required)**
   - Defines the scripting language that the code of other action uses.
 
 ### `Category`
@@ -38,9 +38,12 @@
 - `category:` *`string`*  (**required**)
   - Name of the category
   - ❗ Must be unique throughout the [Collection](#collection)
-- `children: [` ***[`Category`](#Category)*** `|` [***`Script`***](#Script) `, ... ]`  (**required**)
+- `children: [` ***[`Category`](#category)*** `|` [***`Script`***](#script) `, ... ]`  (**required**)
   - ❗ Category must consist of at least one subcategory or script.
   - Children can be combination of scripts and subcategories.
+- `docs`: *`string`* | `[`*`string`*`, ... ]`
+  - Documentation pieces related to the category.
+  - Rendered as markdown.
 
 ### `Script`
 
@@ -67,12 +70,12 @@
   - E.g. let's say `code` sets an environment variable as `setx POWERSHELL_TELEMETRY_OPTOUT 1`
     - then `revertCode` should be doing `setx POWERSHELL_TELEMETRY_OPTOUT 0`
   - ❗ Do not define if `call` is defined.
-- `call`: ***[`FunctionCall`](#FunctionCall)*** | `[` ***[`FunctionCall`](#FunctionCall)*** `, ... ]` (may be **required**)
+- `call`: ***[`FunctionCall`](#functioncall)*** | `[` ***[`FunctionCall`](#functioncall)*** `, ... ]` (may be **required**)
   - A shared function or sequence of functions to call (called in order)
   - ❗ If not defined `code` must be defined
 - `docs`: *`string`* | `[`*`string`*`, ... ]`
-  - Single documentation URL or list of URLs for those who wants to learn more about the script
+  - Documentation pieces related to the script.
-  - E.g. `https://docs.microsoft.com/en-us/windows-server/`
+  - Rendered as markdown.
 - `recommend`: `"standard"` | `"strict"` | `undefined` (default)
   - If not defined then the script will not be recommended
   - If defined it can be either
@@ -120,7 +123,7 @@
   - Convention is to use camelCase, and be verbs.
   - E.g. `uninstallStoreApp`
   - ❗ Function names must be unique
-- `parameters`: `[` ***[`FunctionParameter`](#FunctionParameter)*** `, ... ]`
+- `parameters`: `[` ***[`FunctionParameter`](#functionparameter)*** `, ... ]`
   - List of parameters that function code refers to.
   - ❗ Must be defined to be able use in [`FunctionCall`](#functioncall) or [expressions (templating)](./templating.md#expressions)
  `code`: *`string`* (**required** if `call` is undefined)
@@ -133,7 +136,7 @@
   - E.g. let's say `code` sets an environment variable as `setx POWERSHELL_TELEMETRY_OPTOUT 1`
     - then `revertCode` should be doing `setx POWERSHELL_TELEMETRY_OPTOUT 0`
   - 💡 [Expressions (templating)](./templating.md#expressions) can be used in code
-- `call`: ***[`FunctionCall`](#FunctionCall)*** | `[` ***[`FunctionCall`](#FunctionCall)*** `, ... ]` (may be **required**)
+- `call`: ***[`FunctionCall`](#functioncall)*** | `[` ***[`FunctionCall`](#functioncall)*** `, ... ]` (may be **required**)
   - A shared function or sequence of functions to call (called in order)
   - The parameter values that are sent can use [expressions (templating)](./templating.md#expressions)
   - ❗ If not defined `code` must be defined
@@ -141,7 +144,7 @@
 ### `FunctionParameter`
 
 - Defines a parameter that function requires optionally or mandatory.
-- Its arguments are provided by a [Script](#script) through a [FunctionCall](#FunctionCall).
+- Its arguments are provided by a [Script](#script) through a [FunctionCall](#functioncall).
 
 #### `FunctionParameter` syntax
 

docs/development.md

@@ -0,0 +1,61 @@
+# Development
+
+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.
+
+## Commands
+
+### Prerequisites
+
+- Install node >15.x.
+- Install dependencies using `npm install`.
+
+### Testing
+
+- Run unit tests: `npm run test:unit`
+- Run integration tests: `npm run test:integration`
+- Run e2e (end-to-end) tests
+  - Interactive mode with GUI: `npm run test:e2e`
+  - Headless mode without GUI: `npm run test:e2e -- --headless`
+
+📖 Read more about testing in [tests](./tests.md).
+
+### Linting
+
+- Lint all (recommended 💡): `npm run lint`
+- Markdown: `npm run lint:md`
+- Markdown consistency `npm run lint:md:consistency`
+- Markdown relative URLs: `npm run lint:md:relative-urls`
+- JavaScript/TypeScript: `npm run lint:eslint`
+- Yaml: `npm run lint:yaml`
+
+### Running
+
+- Run in local server: `npm run serve`
+  - 💡 Meant for local development with features such as hot-reloading.
+- Run using 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`
+
+### Building
+
+- Build web application: `npm run build`
+- Build desktop application: `npm run electron:build`
+- (Re)create icons (see [documentation](../img/README.md)): `npm run create-icons`
+
+### Utility Scripts
+
+- Run fresh NPM install: [`./scripts/fresh-npm-install.sh`](../scripts/fresh-npm-install.sh)
+  - This script provides a clean NPM install, removing existing node modules and optionally the package-lock.json (when run with -n), then installs dependencies and runs unit tests.
+- Configure VSCode: [`./scripts/configure-vscode.sh`](../scripts/configure-vscode.sh)
+  - This script checks and sets the necessary configurations for VSCode in `settings.json` file.
+
+## Recommended extensions
+
+You should use EditorConfig to follow project style.
+
+For Visual Studio Code, [`.vscode/extensions.json`](./../.vscode/extensions.json) includes list of recommended extensions.

docs/presentation.md

@@ -1,72 +1,102 @@
 # Presentation layer
 
-- Consists of Vue.js components and other UI-related code.
+The presentation layer handles UI concerns using Vue as JavaScript framework and Electron to provide desktop functionality.
-- Desktop application is created using [Electron](https://www.electronjs.org/).
+
-- Event driven as in components simply listens to events from the state and act accordingly.
+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
   - [**`bootstrapping/`**](./../src/presentation/bootstrapping/): Registers Vue global objects including components and plugins.
   - [**`components/`**](./../src/presentation/components/): Contains all Vue components and their helper classes.
-    - [**`Shared/`**](./../src/presentation/components/Shared): Contains Vue components and component helpers that are shared across other components.
+    - [**`Shared/`**](./../src/presentation/components/Shared): Contains Vue components and component helpers that other components share.
-  - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets that will be processed by webpack.
+      - [**`hooks`**](../src/presentation/components/Shared/Hooks): Shared hooks for state access
+  - [**`assets/`**](./../src/presentation/assets/styles/): Contains assets that webpack will process.
     - [**`fonts/`**](./../src/presentation/assets/fonts/): Contains fonts
     - [**`styles/`**](./../src/presentation/assets/styles/): Contains shared styles used throughout different components.
-      - [**`components/`**](./../src/presentation/assets/styles/components): Contains styles that are reusable and tightly coupled a Vue/HTML component.
+      - [**`components/`**](./../src/presentation/assets/styles/components): Contains reusable styles coupled to a Vue/HTML component.
       - [**`vendors-extensions/`**](./../src/presentation/assets/styles/third-party-extensions): Contains styles that override third-party components used.
-      - [**`main.scss`**](./../src/presentation/assets/styles/main.scss): Primary Sass file, passes along all other styles, should be the only file used from other components.
+      - [**`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.
   - [**`main.ts`**](./../src/presentation/main.ts): Application entry point that mounts and starts Vue application.
   - [**`electron/`**](./../src/presentation/electron/): Electron configuration for the desktop application.
     - [**`main.ts`**](./../src/presentation/main.ts): Main process of Electron, started as first thing when app starts.
-- [**`/public/`**](./../public/): Contains static assets that will directly be copied and not go through webpack.
+- [**`/public/`**](./../public/): Contains static assets that are directly copied and do not go through webpack.
-- [**`/vue.config.js`**](./../vue.config.js): Global Vue CLI configurations loaded by `@vue/cli-service`
+- [**`/vue.config.cjs`**](./../vue.config.cjs): Global Vue CLI configurations loaded by `@vue/cli-service`.
-- [**`/postcss.config.js`**](./../postcss.config.js): PostCSS configurations that are used by Vue CLI internally
+- [**`/postcss.config.cjs`**](./../postcss.config.cjs): PostCSS configurations used by Vue CLI internally.
-- [**`/babel.config.js`**](./../babel.config.js): Babel configurations for polyfills used by `@vue/cli-plugin-babel`
+- [**`/babel.config.cjs`**](./../babel.config.cjs): Babel configurations for polyfills used by `@vue/cli-plugin-babel`.
+
+## Visual design best-practices
+
+Add visual clues for clickable items. It should be as clear as possible that they're interactable at first look without hovering. They should also have different visual state when hovering/touching on them that indicates that they are being clicked, which helps with accessibility.
 
 ## Application data
 
-- Components and should use [ApplicationFactory](./../src/application/ApplicationFactory.ts) singleton to reach the application domain.
+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) domain model is the stateless application representation including
+
-  - available scripts, collections as defined in [collection files](./collection-files.md)
+[Application.ts](../src/domain/Application.ts) is an immutable domain model that represents application state. It includes:
-  - package information as defined in [`package.json`](./../package.json)
+
-- 📖 See [Application data | Application layer](./presentation.md#application-data) where application data is parsed and compiled.
+- available scripts, collections as defined in [collection files](./collection-files.md),
+- package information as defined in [`package.json`](./../package.json).
+
+You can read more about how application layer provides application data to he presentation in [application.md | Application data](./application.md#application-data).
 
 ## Application state
 
-- Stateful components mutate or/and react to state changes in [ApplicationContext](./../src/application/Context/ApplicationContext.ts).
+This project uses a singleton instance of the application state, making it available to all Vue components.
-- Stateless components that does not handle state extends `Vue`
-- Stateful components that depends on the collection state such as user selection, search queries and more extends [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts)
-- The single source of truth is a singleton of the state created and made available to presentation layer by [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts)
-- `StatefulVue` includes abstract `handleCollectionState` that is fired once the component is loaded and also each time [collection](./collection-files.md) is changed.
-- Do not forget to subscribe from events when component is destroyed or if needed [collection](./collection-files.md) is changed.
-  - 💡 `events` in base class [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) makes lifecycling easier
-- 📖 See [Application state | Application layer](./presentation.md#application-state) where the state is implemented using using state pattern.
 
-## Modals
+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.
 
-- [Dialog.vue](./../src/presentation/components/Shared/Dialog.vue) is a shared component that can be used to show modal windows
+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.
-- Simply wrap the content inside of its slot and call `.show()` method on its reference.
-- Example:
 
-  ```html
+[`UseCollectionState.ts`](./../src/presentation/components/Shared/Hooks/UseCollectionState.ts) provides several functionalities including:
-    <Dialog ref="testDialog">
+
-      <div>Hello world</div>
+- **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.
-    </Dialog>
+- **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).
-    <div @click="$refs.testDialog.show()">Show dialog</div>
+- **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).
+
+📖 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.
+
+## Dependency injections
+
+The presentation layer uses Vue's native dependency injection system to increase testability and decouple components.
+
+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.
 
 ## Sass naming convention
 
-- Use lowercase for variables/functions/mixins e.g.
+- Use lowercase for variables/functions/mixins, e.g.:
   - Variable: `$variable: value;`
   - Function: `@function function() {}`
   - Mixin: `@mixin mixin() {}`
-- Use - for a phrase/compound word e.g.
+- Use - for a phrase/compound word, e.g.:
   - Variable: `$some-variable: value;`
   - Function: `@function some-function() {}`
   - Mixin: `@mixin some-mixin() {}`
-- Grouping and name variables from generic to specific e.g.
+- Grouping and name variables from generic to specific, e.g.:
   - ✅ `$border-blue`, `$border-blue-light`, `$border-blue-lightest`, `$border-red`
   - ❌ `$blue-border`, `$light-blue-border`, `$lightest-blue-border`, `$red-border`
   

docs/templating.md

@@ -3,16 +3,26 @@
 ## Benefits of templating
 
 - Generating scripts by sharing code to increase best-practice usage and maintainability.
-- Creating self-contained scripts without depending on each other that can be easily shared.
+- Creating self-contained scripts without cross-dependencies.
 - Use of pipes for writing cleaner code and letting pipes do dirty work.
 
 ## Expressions
 
-- Expressions in the language are defined inside mustaches (double brackets, `{{` and `}}`).
+- Expressions start and end with mustaches (double brackets, `{{` and `}}`).
-- Expression syntax is inspired mainly by [Go Templates](https://pkg.go.dev/text/template).
+  - E.g. `Hello {{ $name }} !`
-- Expressions are used in and enabled by functions where they can be used.
+- Syntax is close to [Go Templates ❤️](https://pkg.go.dev/text/template) but not the same.
+- Functions enables usage of expressions.
   - In script definition parts of a function, see [`Function`](./collection-files.md#Function).
   - When doing a call as argument values, see [`FunctionCall`](./collection-files.md#Function).
+- Expressions inside expressions (nested templates) are supported.
+  - An expression can output another expression that will also be compiled.
+  - E.g. following would compile first [with expression](#with), and then [parameter substitution](#parameter-substitution) in its output.
+
+    ```go
+      {{ with $condition }}
+        echo {{ $text }}
+      {{ end }}
+    ```
 
 ### Parameter substitution
 
@@ -55,34 +65,58 @@ A function can call other functions such as:
 
 ### with
 
-- Skips the block if the variable is absent or empty.
+Skips its "block" if the variable is absent or empty. Its "block" is between `with` start (`{{ with .. }}`) and end (`{{ end }`}) expressions.
-- Binds its context (`.`) value of provided argument for the parameter if provided one.
+E.g. `{{ with $parameterName }} Hi, I'm a block! {{ end }}` would only output `Hi, I'm a block!` if `parameterName` has any value..
-- A block is defined as `{{ with $parameterName }} Parameter value is {{ . }} here {{ end }}`.
-- The parameters used for `with` condition should be declared as optional, otherwise `with` block becomes redundant.
-- Example:
 
-  ```yaml
+It binds its context (value of the provided parameter value) as arbitrary `.` value. It allows you to use the argument value of the given parameter when it is provided and not empty such as:
-    function: FunctionThatOutputsConditionally
+
-    parameters:
+```go
-      - name: 'argument'
+  {{ with $parameterName }}Parameter value is {{ . }} here {{ end }}
-        optional: true
+```
-    code: |- 
+
-      {{ with $argument }}
+It supports multiline text inside the block. You can have something like:
-        Value is: {{ . }}
+
-      {{ end }}
+```go
-  ```
+  {{ with $argument }}
+    First line
+    Second line
+  {{ end }}
+```
+
+You can also use other expressions inside its block, such as [parameter substitution](#parameter-substitution):
+
+```go
+  {{ with $condition }}
+    This is a different parameter: {{ $text }}
+  {{ end }}
+```
+
+💡 Declare parameters used for `with` condition as optional. Set `optional: true` for the argument if you use it like `{{ with $argument }} .. {{ end }}`.
+
+Example:
+
+```yaml
+  function: FunctionThatOutputsConditionally
+  parameters:
+    - name: 'argument'
+      optional: true
+  code: |- 
+    {{ with $argument }}
+      Value is: {{ . }}
+    {{ end }}
+```
 
 ### Pipes
 
-- Pipes are set of functions available for handling text in privacy.sexy.
+- Pipes are functions available for handling text.
 - Allows stacking actions one after another also known as "chaining".
-- Just like [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)), the concept is simple: each pipeline's output becomes the input of the following pipe.
+- Like [Unix pipelines](https://en.wikipedia.org/wiki/Pipeline_(Unix)), the concept is simple: each pipeline's output becomes the input of the following pipe.
-- Pipes are provided and defined by the compiler and consumed by collection files.
+- You cannot create pipes. [A dedicated compiler](./application.md#parsing-and-compiling) provides pre-defined pipes to consume in collection files.
-- Pipes can be combined with [parameter substitution](#parameter-substitution) and [with](#with).
+- You can combine pipes with other expressions such as [parameter substitution](#parameter-substitution) and [with](#with) syntax.
 - ❗ Pipe names must be camelCase without any space or special characters.
 - **Existing pipes**
   - `inlinePowerShell`: Converts a multi-lined PowerShell script to a single line.
-  - `escapeDoubleQuotes`: Escapes `"` characters to be used inside double quotes (`"`)
+  - `escapeDoubleQuotes`: Escapes `"` characters, allows you to use them inside double quotes (`"`).
 - **Example usages**
   - `{{ with $code }} echo "{{ . | inlinePowerShell }}" {{ end }}`
   - `{{ with $code }} echo "{{ . | inlinePowerShell | escapeDoubleQuotes }}" {{ end }}`

docs/tests.md

@@ -1,43 +1,82 @@
 # Tests
 
-- There are two different types of tests executed:
+There are different types of tests executed:
-  1. [Unit tests](#unit-tests)
+
-  2. [Integration tests](#integration-tests)
+1. [Unit tests](#unit-tests)
-- 💡 You can use path/module alias `@/tests` in import statements.
+2. [Integration tests](#integration-tests)
+3. [End-to-end (E2E) tests](#e2e-tests)
+
+Common aspects for all tests:
+
+- They use [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
+- Their files end with `.spec.{ts|js}` suffix.
+
+💡 You can use path/module alias `@/tests` in import statements.
 
 ## Unit tests
 
-- Tests each component in isolation
+- Unit tests test each component in isolation.
-- Defined in [`./tests/unit`](./../tests/unit)
+- All unit tests goes under [`./tests/unit`](./../tests/unit).
-- They follow same folder structure as [`./src`](./../src)
+- They rely on [stubs](./../tests/unit/shared/Stubs) for isolation.
+- Unit tests include also Vue component tests using `@vue/test-utils`.
 
-### Naming
+### Unit tests structure
 
-- Each test suite first describe the system under test
+- [`./src/`](./../src/)
-  - E.g. tests for class `Application` is categorized under `Application`
+  - Includes source code that unit tests will test.
-- Tests for specific methods are categorized under method name (if applicable)
+- [`./tests/unit/`](./../tests/unit/)
-  - E.g. test for `run()` is categorized under `run`
+  - 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 use act, arrange and assert (AAA) pattern when applicable.
 - **Arrange**
-  - Should set up the test case
+  - Sets up the test case.
-  - Starts with comment line `// arrange`
+  - Starts with comment line `// arrange`.
 - **Act**
-  - Should cover the main thing to be tested
+  - Executes the actual test.
-  - Starts with comment line `// act`
+  - Starts with comment line `// act`.
 - **Assert**
-  - Should elicit some sort of response
+  - Elicit some sort of expectation.
-  - Starts with comment line `// assert`
+  - Starts with comment line `// assert`.
-
-### Stubs
-
-- Stubs are defined in [`./tests/stubs`](./../tests/unit/stubs)
-- They implement dummy behavior to be functional
 
 ## Integration tests
 
-- Tests functionality of a component in combination with others (not isolated)
+- Tests functionality of a component in combination with others (not isolated).
-- Ensure dependencies to third parties work as expected
+- Ensure dependencies to third parties work as expected.
-- Defined in [`./tests/integration`](./../tests/integration)
+- Defined in [./tests/integration](./../tests/integration).
+
+## E2E tests
+
+- Test the functionality and performance of a running application.
+- Vue CLI plugin  [`e2e-cypress`](https://github.com/vuejs/vue-cli/tree/dev/packages/@vue/cli-plugin-e2e-cypress#readme) configures E2E tests.
+- Test names and folders have logical structure based on tests executed.
+- The structure is following:
+  - [`cypress.config.ts`](./../cypress.config.ts): Cypress configuration file.
+  - [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder.
+    - [`/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.
+    - [`/support/index.js`](./../tests/e2e/support/index.js): Support file, runs before every single spec file.
+    - *(Ignored)* `/videos`: Asset folder for videos taken during tests.
+    - *(Ignored)* `/screenshots`: Asset folder for Screenshots taken during tests.

img/README.md

@@ -0,0 +1,12 @@
+# img
+
+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.
+It should be the only file that will be changed manually.
+
+[`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.

img/logo-update.mjs

@@ -0,0 +1,127 @@
+#!/usr/bin/env bash
+import { resolve, join } from 'path';
+import { rm, mkdtemp, stat } from 'fs/promises';
+import { spawn } from 'child_process';
+import { URL, fileURLToPath } from 'url';
+
+class Paths {
+  constructor(selfDirectory) {
+    const projectRoot = resolve(selfDirectory, '../');
+    this.sourceImage = join(projectRoot, 'img/logo.svg');
+    this.publicDirectory = join(projectRoot, 'public');
+    this.electronBuildDirectory = join(projectRoot, 'build');
+  }
+
+  toString() {
+    return `Source image: ${this.sourceImage}\n`
+      + `Public directory: ${this.publicDirectory}\n`
+      + `Electron build directory: ${this.electronBuildDirectory}`;
+  }
+}
+
+async function main() {
+  const paths = new Paths(getCurrentScriptDirectory());
+  console.log(`Paths:\n\t${paths.toString().replaceAll('\n', '\n\t')}`);
+  await updateDesktopLauncherAndTrayIcon(paths.sourceImage, paths.publicDirectory);
+  await updateWebFavicon(paths.sourceImage, paths.publicDirectory);
+  await updateDesktopIcons(paths.sourceImage, paths.electronBuildDirectory);
+  console.log('🎉 (Re)created icons successfully.');
+}
+
+async function updateDesktopLauncherAndTrayIcon(sourceImage, publicFolder) {
+  await ensureFileExists(sourceImage);
+  await ensureFolderExists(publicFolder);
+  const electronTrayIconFile = join(publicFolder, 'icon.png');
+  console.log(`Updating desktop launcher and tray icon at ${electronTrayIconFile}.`);
+  await runCommand(
+    'npx',
+    'svgexport',
+    sourceImage,
+    electronTrayIconFile,
+  );
+}
+
+async function updateWebFavicon(sourceImage, faviconFolder) {
+  console.log('Updating favicon');
+  await ensureFileExists(sourceImage);
+  await ensureFolderExists(faviconFolder);
+  await runCommand(
+    'npx',
+    'icon-gen',
+    `--input ${sourceImage}`,
+    `--output ${faviconFolder}`,
+    '--ico',
+    '--ico-name \'favicon\'',
+    '--report',
+  );
+}
+
+async function updateDesktopIcons(sourceImage, electronIconsDir) {
+  await ensureFileExists(sourceImage);
+  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
+  await runCommand(
+    'npx',
+    'svgexport',
+    sourceImage,
+    temporaryPngFile,
+    '1024:1024',
+  );
+  console.log(`Creating electron icons to ${electronIconsDir}.`);
+  await runCommand(
+    'npx',
+    'electron-icon-builder',
+    `--input="${temporaryPngFile}"`,
+    `--output="${electronIconsDir}"`,
+    '--flatten',
+  );
+  console.log('Cleaning up temporary directory.');
+  await rm(temporaryDir, { recursive: true, force: true });
+}
+
+async function ensureFileExists(filePath) {
+  const path = await stat(filePath);
+  if (!path.isFile()) {
+    throw new Error(`Not a file: ${filePath}`);
+  }
+}
+
+async function ensureFolderExists(folderPath) {
+  const path = await stat(folderPath);
+  if (!path.isDirectory()) {
+    throw new Error(`Not a directory: ${folderPath}`);
+  }
+}
+
+async function runCommand(...args) {
+  const command = args.join(' ');
+  console.log(`Running command: ${command}`);
+  await new Promise((resolve, reject) => {
+    const process = spawn(command, { shell: true });
+    process.stdout.on('data', (stdout) => {
+      console.log(stdout.toString());
+    });
+    process.stderr.on('data', (stderr) => {
+      console.error(stderr.toString());
+    });
+    process.on('error', (err) => {
+      reject(err);
+    });
+    process.on('close', (exitCode) => {
+      if (exitCode !== 0) {
+        reject(new Error(`Process exited with non-zero exit code: ${exitCode}`));
+      } else {
+        resolve();
+      }
+      process.stdin.end();
+    });
+  });
+}
+
+function getCurrentScriptDirectory() {
+  return fileURLToPath(new URL('.', import.meta.url));
+}
+
+await main();

img/logo.svg

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+              "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+
+<svg xmlns="http://www.w3.org/2000/svg"
+     width="90.2998mm" height="90.2998mm"
+     viewBox="0 0 256 256">
+  <path id="logo"
+        fill="#3a65ab" stroke="#3a65ab" stroke-width="1"
+        d="M 128.00,173.00
+           C 128.00,173.00 102.00,175.00 102.00,175.00
+             85.39,174.97 64.02,170.31 49.00,163.22
+             38.46,158.24 28.39,152.17 20.01,143.96
+             14.88,138.93 10.72,133.32 7.31,127.00
+             3.36,119.66 1.10,112.37 1.00,104.00
+             1.00,104.00 1.00,98.00 1.00,98.00
+             1.29,73.92 24.76,53.44 44.00,42.43
+             84.66,19.15 129.75,23.12 169.00,47.00
+             188.74,59.02 207.93,76.23 208.00,101.00
+             208.00,101.00 188.00,101.00 188.00,101.00
+             186.46,86.48 168.72,71.84 157.00,64.61
+             140.76,54.59 121.33,46.78 102.00,47.00
+             88.42,47.16 72.20,52.52 60.00,58.32
+             45.30,65.30 19.83,84.81 21.10,103.00
+             21.39,107.16 22.92,110.33 24.76,114.00
+             32.70,129.78 48.16,140.02 64.00,146.72
+             75.16,151.44 92.90,155.26 105.00,154.99
+             113.45,154.79 121.81,152.84 130.00,151.00
+             130.00,151.00 128.00,173.00 128.00,173.00 Z
+           M 136.00,79.00
+           C 142.71,81.35 144.84,93.60 144.99,100.00
+             145.51,122.74 130.31,140.73 107.00,141.00
+             83.63,141.26 67.43,126.52 66.09,103.00
+             64.82,80.73 85.85,58.90 104.00,64.00
+             100.18,69.73 95.45,74.53 96.20,82.00
+             97.29,92.87 110.06,102.98 121.00,99.03
+             129.92,95.81 134.61,87.96 136.00,79.00 Z
+           M 186.00,113.46
+           C 206.11,110.69 225.57,114.92 239.91,130.01
+             252.85,143.63 255.21,157.09 255.00,175.00
+             254.76,195.49 241.26,214.25 223.00,222.88
+             213.06,227.58 204.72,228.12 194.00,228.00
+             150.34,227.49 126.71,178.85 146.32,142.00
+             154.93,125.82 168.55,117.23 186.00,113.46 Z
+           M 233.00,181.00
+           C 242.24,158.78 221.84,133.54 199.00,133.01
+             188.40,132.77 182.75,135.31 174.00,141.00
+             178.60,146.85 195.92,157.24 203.00,161.86
+             209.82,166.32 226.61,178.55 233.00,181.00 Z
+           M 221.00,200.00
+           C 216.39,194.15 206.42,188.61 200.00,184.33
+             192.31,179.21 168.77,162.59 162.00,160.00
+             159.67,165.03 159.94,166.57 160.00,172.00
+             160.23,190.99 177.11,207.55 196.00,207.99
+             206.60,208.23 212.25,205.69 221.00,200.00 Z" />
+</svg>

package.json

@@ -1,76 +1,107 @@
 {
   "name": "privacy.sexy",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "private": true,
-  "description": "Enforce privacy & security best-practices on Windows and macOS, because privacy is sexy 🍑🍆",
+  "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",
   "scripts": {
     "serve": "vue-cli-service serve",
     "build": "vue-cli-service build",
-    "test:unit": "vue-cli-service test:unit",
+    "test:unit": "vue-cli-service test:unit --include ./tests/bootstrap/setup.ts",
-    "test:integration": "vue-cli-service test:unit \"tests/integration/**/*.spec.ts\"",
+    "test:e2e": "vue-cli-service test:e2e",
-    "lint": "npm run lint:vue && npm run lint:yaml && npm run lint:md && npm run lint:md:relative-urls && npm run lint:md:consistency",
+    "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",
     "electron:build": "vue-cli-service electron:build",
     "electron:serve": "vue-cli-service electron:serve",
+    "lint:eslint": "vue-cli-service lint --no-fix --mode production",
     "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:vue": "vue-cli-service lint --no-fix",
     "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\" --include ./tests/bootstrap/setup.ts"
   },
-  "main": "background.js",
+  "main": "index.js",
   "dependencies": {
-    "@fortawesome/fontawesome-svg-core": "^1.2.36",
+    "@fortawesome/fontawesome-svg-core": "^6.4.0",
-    "@fortawesome/free-brands-svg-icons": "^5.15.4",
+    "@fortawesome/free-brands-svg-icons": "^6.4.0",
-    "@fortawesome/free-regular-svg-icons": "^5.15.4",
+    "@fortawesome/free-regular-svg-icons": "^6.4.0",
-    "@fortawesome/free-solid-svg-icons": "^5.15.4",
+    "@fortawesome/free-solid-svg-icons": "^6.4.0",
-    "@fortawesome/vue-fontawesome": "^2.0.6",
+    "@fortawesome/vue-fontawesome": "^2.0.9",
-    "@juggle/resize-observer": "^3.3.1",
+    "@juggle/resize-observer": "^3.4.0",
-    "ace-builds": "^1.4.13",
+    "ace-builds": "^1.23.4",
-    "core-js": "^3.18.3",
+    "core-js": "^3.32.0",
-    "cross-fetch": "^3.1.4",
+    "cross-fetch": "^4.0.0",
-    "electron-progressbar": "^2.0.1",
+    "electron-progressbar": "^2.1.0",
     "file-saver": "^2.0.5",
     "install": "^0.13.0",
     "liquor-tree": "^0.2.70",
-    "npm": "^8.1.1",
+    "markdown-it": "^13.0.1",
+    "npm": "^9.8.1",
     "v-tooltip": "2.1.3",
-    "vue": "^2.6.14",
+    "vue": "^2.7.14"
-    "vue-class-component": "^7.2.6",
-    "vue-js-modal": "^2.0.1",
-    "vue-property-decorator": "^9.1.2"
   },
   "devDependencies": {
-    "@types/ace": "0.0.47",
+    "@rushstack/eslint-patch": "^1.3.2",
-    "@types/chai": "^4.2.22",
+    "@types/ace": "^0.0.48",
-    "@types/file-saver": "^2.0.3",
+    "@types/chai": "^4.3.5",
-    "@types/mocha": "^9.0.0",
+    "@types/file-saver": "^2.0.5",
-    "@vue/cli-plugin-babel": "^4.5.14",
+    "@types/mocha": "^10.0.1",
-    "@vue/cli-plugin-typescript": "^4.5.14",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@vue/cli-plugin-unit-mocha": "^4.5.14",
+    "@typescript-eslint/parser": "^5.62.0",
-    "@vue/cli-service": "^4.5.14",
+    "@vue/cli-plugin-babel": "~5.0.8",
-    "@vue/test-utils": "1.2.2",
+    "@vue/cli-plugin-e2e-cypress": "~5.0.8",
-    "chai": "^4.3.4",
+    "@vue/cli-plugin-eslint": "~5.0.8",
-    "electron": "^15.3.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-with-typescript": "^7.0.0",
+    "@vue/eslint-config-typescript": "^11.0.3",
+    "@vue/test-utils": "^1.3.6",
+    "chai": "^4.3.7",
+    "cypress": "^12.17.2",
+    "electron": "^25.3.2",
+    "electron-builder": "^24.6.3",
     "electron-devtools-installer": "^3.2.0",
-    "electron-log": "^4.4.1",
+    "electron-icon-builder": "^2.0.1",
-    "electron-updater": "^4.3.9",
+    "electron-log": "^4.4.8",
+    "electron-updater": "^6.1.4",
+    "eslint": "^8.46.0",
+    "eslint-plugin-import": "^2.26.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",
-    "markdownlint-cli": "^0.29.0",
+    "markdownlint-cli": "^0.35.0",
-    "raw-loader": "^4.0.2",
+    "remark-cli": "^11.0.0",
-    "remark-cli": "^10.0.0",
     "remark-lint-no-dead-urls": "^1.1.0",
-    "remark-preset-lint-consistent": "^5.1.0",
+    "remark-preset-lint-consistent": "^5.1.2",
-    "remark-validate-links": "^11.0.1",
+    "remark-validate-links": "^12.1.1",
-    "sass": "^1.43.3",
+    "sass": "^1.64.1",
-    "sass-loader": "10.2.0",
+    "sass-loader": "^13.3.2",
-    "tslib": "^2.3.1",
+    "svgexport": "^0.4.2",
-    "typescript": "^4.4.4",
+    "ts-loader": "^9.4.4",
-    "vue-cli-plugin-electron-builder": "^2.1.1",
+    "tslib": "~2.4.0",
-    "vue-template-compiler": "^2.6.14",
+    "typescript": "~4.6.2",
-    "yaml-lint": "^1.2.4"
+    "vue-cli-plugin-electron-builder": "^3.0.0-alpha.4",
+    "yaml-lint": "^1.7.0"
+  },
+  "overrides": {
+    "vue-cli-plugin-electron-builder": {
+      "electron-builder": "^24.6.3"
+    }
+  },
+  "//devDependencies": {
+    "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"
+    ],
+    "tslib": "Cannot upgrade to > 2.4.X otherwise unit tests do not work, https://github.com/evanw/node-source-map-support/issues/252",
+    "@typescript-eslint/eslint-plugin": "Cannot upgrade to 6.X.X due to @vue/eslint-config-typescript, https://github.com/vuejs/eslint-config-typescript/pull/60",
+    "@typescript-eslint/parser": "Cannot upgrade to 6.X.X due to @vue/eslint-config-typescript, https://github.com/vuejs/eslint-config-typescript/pull/60"
   },
   "homepage": "https://privacy.sexy",
   "repository": {

postcss.config.cjs

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

public/index.html

@@ -2,9 +2,8 @@
 <html lang="en">
   <head>
     <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width,initial-scale=1.0">
-    <title>Privacy is sexy 🍑🍆 - Enforce privacy & security on Windows and macOS</title>
+    <title>Privacy is sexy 🍑🍆 - Enforce privacy & security on Windows, macOS and Linux</title>
     <meta name="robots" content="index,follow" />
     <meta name="description" content="Web tool to generate scripts for enforcing privacy & security best-practices such as stopping data collection of Windows and different softwares on it."/>
     <link rel="icon" href="<%= BASE_URL %>favicon.ico">

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/fresh-npm-install.sh

@@ -0,0 +1,95 @@
+#!/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"

src/application/ApplicationFactory.ts

@@ -3,19 +3,22 @@ import { AsyncLazy } from '@/infrastructure/Threading/AsyncLazy';
 import { IApplicationFactory } from './IApplicationFactory';
 import { parseApplication } from './Parser/ApplicationParser';
 
-export type ApplicationGetter = () => IApplication;
+export type ApplicationGetterType = () => IApplication;
-const ApplicationGetter: ApplicationGetter = parseApplication;
+const ApplicationGetter: ApplicationGetterType = parseApplication;
 
 export class ApplicationFactory implements IApplicationFactory {
-    public static readonly Current: IApplicationFactory = new ApplicationFactory(ApplicationGetter);
+  public static readonly Current: IApplicationFactory = new ApplicationFactory(ApplicationGetter);
-    private readonly getter: AsyncLazy<IApplication>;
+
-    protected constructor(costlyGetter: ApplicationGetter) {
+  private readonly getter: AsyncLazy<IApplication>;
-        if (!costlyGetter) {
+
-            throw new Error('undefined getter');
+  protected constructor(costlyGetter: ApplicationGetterType) {
-        }
+    if (!costlyGetter) {
-        this.getter = new AsyncLazy<IApplication>(() => Promise.resolve(costlyGetter()));
+      throw new Error('missing getter');
-    }
-    public getApp(): Promise<IApplication> {
-        return this.getter.getValue();
     }
+    this.getter = new AsyncLazy<IApplication>(() => Promise.resolve(costlyGetter()));
+  }
+
+  public getApp(): Promise<IApplication> {
+    return this.getter.getValue();
+  }
 }

src/application/Common/Array.ts

@@ -1,21 +1,21 @@
 // Compares to Array<T> objects for equality, ignoring order
 export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
-    if (!array1) { throw new Error('undefined first array'); }
+  if (!array1) { throw new Error('missing first array'); }
-    if (!array2) { throw new Error('undefined second array'); }
+  if (!array2) { throw new Error('missing second array'); }
-    const sortedArray1 = sort(array1);
+  const sortedArray1 = sort(array1);
-    const sortedArray2 = sort(array2);
+  const sortedArray2 = sort(array2);
-    return sequenceEqual(sortedArray1, sortedArray2);
+  return sequenceEqual(sortedArray1, sortedArray2);
-    function sort(array: readonly T[]) {
+  function sort(array: readonly T[]) {
-        return array.slice().sort();
+    return array.slice().sort();
-    }
+  }
 }
 
 // Compares to Array<T> objects for equality in same order
 export function sequenceEqual<T>(array1: readonly T[], array2: readonly T[]) {
-    if (!array1) { throw new Error('undefined first array'); }
+  if (!array1) { throw new Error('missing first array'); }
-    if (!array2) { throw new Error('undefined second array'); }
+  if (!array2) { throw new Error('missing second array'); }
-    if (array1.length !== array2.length) {
+  if (array1.length !== array2.length) {
-        return false;
+    return false;
-    }
+  }
-    return array1.every((val, index) => val === array2[index]);
+  return array1.every((val, index) => val === array2[index]);
 }

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/Common/Enum.ts

@@ -1,54 +1,63 @@
 // Because we cannot do "T extends enum" 😞 https://github.com/microsoft/TypeScript/issues/30611
 export type EnumType = number | string;
-export type EnumVariable<T extends EnumType, TEnumValue extends EnumType> = { [key in T]: TEnumValue };
+export type EnumVariable<T extends EnumType, TEnumValue extends EnumType>
+  = { [key in T]: TEnumValue };
 
 export interface IEnumParser<TEnum> {
-    parseEnum(value: string, propertyName: string): TEnum;
+  parseEnum(value: string, propertyName: string): TEnum;
-}
-export function createEnumParser<T extends EnumType, TEnumValue extends EnumType>(
-    enumVariable: EnumVariable<T, TEnumValue>): IEnumParser<TEnumValue> {
-    return {
-        parseEnum: (value, propertyName) => parseEnumValue(value, propertyName, enumVariable),
-    };
-}
-function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
-    value: string,
-    enumName: string,
-    enumVariable: EnumVariable<T, TEnumValue>): TEnumValue {
-    if (!value) {
-        throw new Error(`undefined ${enumName}`);
-    }
-    if (typeof value !== 'string') {
-        throw new Error(`unexpected type of ${enumName}: "${typeof value}"`);
-    }
-    const casedValue = getEnumNames(enumVariable)
-        .find((enumValue) => enumValue.toLowerCase() === value.toLowerCase());
-    if (!casedValue) {
-        throw new Error(`unknown ${enumName}: "${value}"`);
-    }
-    return enumVariable[casedValue as keyof typeof enumVariable];
 }
 
-export function getEnumNames<T extends EnumType, TEnumValue extends EnumType>(
+export function createEnumParser<T extends EnumType, TEnumValue extends EnumType>(
-    enumVariable: EnumVariable<T, TEnumValue>): string[] {
+  enumVariable: EnumVariable<T, TEnumValue>,
-    return Object
+): IEnumParser<TEnumValue> {
-        .values(enumVariable)
+  return {
-        .filter((enumMember) => typeof enumMember === 'string') as string[];
+    parseEnum: (value, propertyName) => parseEnumValue(value, propertyName, enumVariable),
+  };
+}
+
+function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
+  value: string,
+  enumName: string,
+  enumVariable: EnumVariable<T, TEnumValue>,
+): TEnumValue {
+  if (!value) {
+    throw new Error(`missing ${enumName}`);
+  }
+  if (typeof value !== 'string') {
+    throw new Error(`unexpected type of ${enumName}: "${typeof value}"`);
+  }
+  const casedValue = getEnumNames(enumVariable)
+    .find((enumValue) => enumValue.toLowerCase() === value.toLowerCase());
+  if (!casedValue) {
+    throw new Error(`unknown ${enumName}: "${value}"`);
+  }
+  return enumVariable[casedValue as keyof typeof enumVariable];
+}
+
+export function getEnumNames
+<T extends EnumType, TEnumValue extends EnumType>(
+  enumVariable: EnumVariable<T, TEnumValue>,
+): string[] {
+  return Object
+    .values(enumVariable)
+    .filter((enumMember) => typeof enumMember === 'string') as string[];
 }
 
 export function getEnumValues<T extends EnumType, TEnumValue extends EnumType>(
-    enumVariable: EnumVariable<T, TEnumValue>): TEnumValue[] {
+  enumVariable: EnumVariable<T, TEnumValue>,
-    return getEnumNames(enumVariable)
+): TEnumValue[] {
-        .map((level) => enumVariable[level]) as TEnumValue[];
+  return getEnumNames(enumVariable)
+    .map((level) => enumVariable[level]) as TEnumValue[];
 }
 
 export function assertInRange<T extends EnumType, TEnumValue extends EnumType>(
-    value: TEnumValue,
+  value: TEnumValue,
-    enumVariable: EnumVariable<T, TEnumValue>) {
+  enumVariable: EnumVariable<T, TEnumValue>,
-    if (value === undefined) {
+) {
-        throw new Error('undefined enum value');
+  if (value === undefined || value === null) {
-    }
+    throw new Error('absent enum value');
-    if (!(value in enumVariable)) {
+  }
-        throw new RangeError(`enum value "${value}" is out of range`);
+  if (!(value in enumVariable)) {
-    }
+    throw new RangeError(`enum value "${value}" is out of range`);
+  }
 }

src/application/Common/ScriptingLanguage/IScriptingLanguageFactory.ts

@@ -1,5 +1,5 @@
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
 
 export interface IScriptingLanguageFactory<T> {
-    create(language: ScriptingLanguage): T;
+  create(language: ScriptingLanguage): T;
 }

src/application/Common/ScriptingLanguage/ScriptingLanguageFactory.ts

@@ -1,31 +1,30 @@
 import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
-import { IScriptingLanguageFactory } from './IScriptingLanguageFactory';
 import { assertInRange } from '@/application/Common/Enum';
+import { IScriptingLanguageFactory } from './IScriptingLanguageFactory';
 
 type Getter<T> = () => T;
 
 export abstract class ScriptingLanguageFactory<T> implements IScriptingLanguageFactory<T> {
-    private readonly getters = new Map<ScriptingLanguage, Getter<T>>();
+  private readonly getters = new Map<ScriptingLanguage, Getter<T>>();
 
-    public create(language: ScriptingLanguage): T {
+  public create(language: ScriptingLanguage): T {
-        assertInRange(language, ScriptingLanguage);
+    assertInRange(language, ScriptingLanguage);
-        if (!this.getters.has(language)) {
+    if (!this.getters.has(language)) {
-            throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
+      throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
-        }
-        const getter = this.getters.get(language);
-        const instance = getter();
-        return instance;
     }
+    const getter = this.getters.get(language);
+    const instance = getter();
+    return instance;
+  }
 
-    protected registerGetter(language: ScriptingLanguage, getter: Getter<T>) {
+  protected registerGetter(language: ScriptingLanguage, getter: Getter<T>) {
-        assertInRange(language, ScriptingLanguage);
+    assertInRange(language, ScriptingLanguage);
-        if (!getter)  {
+    if (!getter) {
-            throw new Error('undefined getter');
+      throw new Error('missing getter');
-        }
-        if (this.getters.has(language)) {
-            throw new Error(`${ScriptingLanguage[language]} is already registered`);
-        }
-        this.getters.set(language, getter);
     }
-
+    if (this.getters.has(language)) {
+      throw new Error(`${ScriptingLanguage[language]} is already registered`);
+    }
+    this.getters.set(language, getter);
+  }
 }

src/application/Context/ApplicationContext.ts

@@ -1,60 +1,64 @@
-import { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
-import { ICategoryCollectionState } from './State/ICategoryCollectionState';
-import { CategoryCollectionState } from './State/CategoryCollectionState';
 import { IApplication } from '@/domain/IApplication';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { EventSource } from '@/infrastructure/Events/EventSource';
 import { assertInRange } from '@/application/Common/Enum';
+import { CategoryCollectionState } from './State/CategoryCollectionState';
+import { ICategoryCollectionState } from './State/ICategoryCollectionState';
+import { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
 
 type StateMachine = Map<OperatingSystem, ICategoryCollectionState>;
 
 export class ApplicationContext implements IApplicationContext {
-    public readonly contextChanged = new EventSource<IApplicationContextChangedEvent>();
+  public readonly contextChanged = new EventSource<IApplicationContextChangedEvent>();
-    public collection: ICategoryCollection;
-    public currentOs: OperatingSystem;
 
-    public get state(): ICategoryCollectionState {
+  public collection: ICategoryCollection;
-        return this.states[this.collection.os];
-    }
 
-    private readonly states: StateMachine;
+  public currentOs: OperatingSystem;
-    public constructor(
-        public readonly app: IApplication,
-        initialContext: OperatingSystem) {
-        validateApp(app);
-        assertInRange(initialContext, OperatingSystem);
-        this.states = initializeStates(app);
-        this.changeContext(initialContext);
-    }
 
-    public changeContext(os: OperatingSystem): void {
+  public get state(): ICategoryCollectionState {
-        if (this.currentOs === os) {
+    return this.states[this.collection.os];
-            return;
+  }
-        }
+
-        this.collection = this.app.getCollection(os);
+  private readonly states: StateMachine;
-        if (!this.collection) {
+
-            throw new Error(`os "${OperatingSystem[os]}" is not defined in application`);
+  public constructor(
-        }
+    public readonly app: IApplication,
-        const event: IApplicationContextChangedEvent = {
+    initialContext: OperatingSystem,
-            newState: this.states[os],
+  ) {
-            oldState: this.states[this.currentOs],
+    validateApp(app);
-        };
+    this.states = initializeStates(app);
-        this.contextChanged.notify(event);
+    this.changeContext(initialContext);
-        this.currentOs = os;
+  }
+
+  public changeContext(os: OperatingSystem): void {
+    assertInRange(os, OperatingSystem);
+    if (this.currentOs === os) {
+      return;
     }
+    this.collection = this.app.getCollection(os);
+    if (!this.collection) {
+      throw new Error(`os "${OperatingSystem[os]}" is not defined in application`);
+    }
+    const event: IApplicationContextChangedEvent = {
+      newState: this.states[os],
+      oldState: this.states[this.currentOs],
+    };
+    this.contextChanged.notify(event);
+    this.currentOs = os;
+  }
 }
 
 function validateApp(app: IApplication) {
-    if (!app) {
+  if (!app) {
-        throw new Error('undefined app');
+    throw new Error('missing app');
-    }
+  }
 }
 
 function initializeStates(app: IApplication): StateMachine {
-    const machine = new Map<OperatingSystem, ICategoryCollectionState>();
+  const machine = new Map<OperatingSystem, ICategoryCollectionState>();
-    for (const collection of app.collections) {
+  for (const collection of app.collections) {
-        machine[collection.os] = new CategoryCollectionState(collection);
+    machine[collection.os] = new CategoryCollectionState(collection);
-    }
+  }
-    return machine;
+  return machine;
 }

src/application/Context/ApplicationContextFactory.ts

@@ -1,31 +1,32 @@
-import { ApplicationContext } from './ApplicationContext';
 import { IApplicationContext } from '@/application/Context/IApplicationContext';
 import { OperatingSystem } from '@/domain/OperatingSystem';
-import { Environment } from '../Environment/Environment';
 import { IApplication } from '@/domain/IApplication';
+import { Environment } from '../Environment/Environment';
 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,
+  factory: IApplicationFactory = ApplicationFactory.Current,
-    environment = Environment.CurrentEnvironment): Promise<IApplicationContext> {
+  environment = Environment.CurrentEnvironment,
-    if (!factory) { throw new Error('undefined factory'); }
+): Promise<IApplicationContext> {
-    if (!environment) { throw new Error('undefined environment'); }
+  if (!factory) { throw new Error('missing factory'); }
-    const app = await factory.getApp();
+  if (!environment) { throw new Error('missing environment'); }
-    const os = getInitialOs(app, environment);
+  const app = await factory.getApp();
-    return new ApplicationContext(app, os);
+  const os = getInitialOs(app, environment);
+  return new ApplicationContext(app, os);
 }
 
 function getInitialOs(app: IApplication, environment: IEnvironment): OperatingSystem {
-    const currentOs = environment.os;
+  const currentOs = environment.os;
-    const supportedOsList = app.getSupportedOsList();
+  const supportedOsList = app.getSupportedOsList();
-    if (supportedOsList.includes(currentOs)) {
+  if (supportedOsList.includes(currentOs)) {
-        return currentOs;
+    return currentOs;
-    }
+  }
-    supportedOsList.sort((os1, os2) => {
+  supportedOsList.sort((os1, os2) => {
-        const getPriority = (os: OperatingSystem) => app.getCollection(os).totalScripts;
+    const getPriority = (os: OperatingSystem) => app.getCollection(os).totalScripts;
-        return getPriority(os2) - getPriority(os1);
+    return getPriority(os2) - getPriority(os1);
-    });
+  });
-    return supportedOsList[0];
+  return supportedOsList[0];
 }

src/application/Context/IApplicationContext.ts

@@ -1,16 +1,20 @@
-import { ICategoryCollectionState } from './State/ICategoryCollectionState';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { IEventSource } from '@/infrastructure/Events/IEventSource';
 import { IApplication } from '@/domain/IApplication';
+import { ICategoryCollectionState, IReadOnlyCategoryCollectionState } from './State/ICategoryCollectionState';
 
-export interface IApplicationContext {
+export interface IReadOnlyApplicationContext {
-    readonly app: IApplication;
+  readonly app: IApplication;
-    readonly state: ICategoryCollectionState;
+  readonly state: IReadOnlyCategoryCollectionState;
-    readonly contextChanged: IEventSource<IApplicationContextChangedEvent>;
+  readonly contextChanged: IEventSource<IApplicationContextChangedEvent>;
-    changeContext(os: OperatingSystem): void;
+}
+
+export interface IApplicationContext extends IReadOnlyApplicationContext {
+  readonly state: ICategoryCollectionState;
+  changeContext(os: OperatingSystem): void;
 }
 
 export interface IApplicationContextChangedEvent {
-    readonly newState: ICategoryCollectionState;
+  readonly newState: ICategoryCollectionState;
-    readonly oldState: ICategoryCollectionState;
+  readonly oldState: ICategoryCollectionState;
 }

src/application/Context/State/CategoryCollectionState.ts

@@ -1,3 +1,5 @@
+import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import { OperatingSystem } from '@/domain/OperatingSystem';
 import { UserFilter } from './Filter/UserFilter';
 import { IUserFilter } from './Filter/IUserFilter';
 import { ApplicationCode } from './Code/ApplicationCode';
@@ -5,19 +7,20 @@ import { UserSelection } from './Selection/UserSelection';
 import { IUserSelection } from './Selection/IUserSelection';
 import { ICategoryCollectionState } from './ICategoryCollectionState';
 import { IApplicationCode } from './Code/IApplicationCode';
-import { ICategoryCollection } from '../../../domain/ICategoryCollection';
-import { OperatingSystem } from '@/domain/OperatingSystem';
 
 export class CategoryCollectionState implements ICategoryCollectionState {
-    public readonly os: OperatingSystem;
+  public readonly os: OperatingSystem;
-    public readonly code: IApplicationCode;
-    public readonly selection: IUserSelection;
-    public readonly filter: IUserFilter;
 
-    public constructor(readonly collection: ICategoryCollection) {
+  public readonly code: IApplicationCode;
-        this.selection = new UserSelection(collection, []);
+
-        this.code = new ApplicationCode(this.selection, collection.scripting);
+  public readonly selection: IUserSelection;
-        this.filter = new UserFilter(collection);
+
-        this.os = collection.os;
+  public readonly filter: IUserFilter;
-    }
+
+  public constructor(readonly collection: ICategoryCollection) {
+    this.selection = new UserSelection(collection, []);
+    this.code = new ApplicationCode(this.selection, collection.scripting);
+    this.filter = new UserFilter(collection);
+    this.os = collection.os;
+  }
 }

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

@@ -1,39 +1,41 @@
+import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
+import { IReadOnlyUserSelection } from '@/application/Context/State/Selection/IUserSelection';
+import { EventSource } from '@/infrastructure/Events/EventSource';
+import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
 import { CodeChangedEvent } from './Event/CodeChangedEvent';
 import { CodePosition } from './Position/CodePosition';
 import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
-import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
-import { IUserSelection } from '@/application/Context/State/Selection/IUserSelection';
 import { UserScriptGenerator } from './Generation/UserScriptGenerator';
-import { EventSource } from '@/infrastructure/Events/EventSource';
 import { IApplicationCode } from './IApplicationCode';
 import { IUserScriptGenerator } from './Generation/IUserScriptGenerator';
-import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
 
 export class ApplicationCode implements IApplicationCode {
-    public readonly changed = new EventSource<ICodeChangedEvent>();
+  public readonly changed = new EventSource<ICodeChangedEvent>();
-    public current: string;
 
-    private scriptPositions = new Map<SelectedScript, CodePosition>();
+  public current: string;
 
-    constructor(
+  private scriptPositions = new Map<SelectedScript, CodePosition>();
-        userSelection: IUserSelection,
-        private readonly scriptingDefinition: IScriptingDefinition,
-        private readonly generator: IUserScriptGenerator = new UserScriptGenerator()) {
-        if (!userSelection) { throw new Error('userSelection is null or undefined'); }
-        if (!scriptingDefinition) { throw new Error('scriptingDefinition is null or undefined'); }
-        if (!generator) { throw new Error('generator is null or undefined'); }
-        this.setCode(userSelection.selectedScripts);
-        userSelection.changed.on((scripts) => {
-            this.setCode(scripts);
-        });
-    }
 
-    private setCode(scripts: ReadonlyArray<SelectedScript>): void {
+  constructor(
-        const oldScripts = Array.from(this.scriptPositions.keys());
+    userSelection: IReadOnlyUserSelection,
-        const code = this.generator.buildCode(scripts, this.scriptingDefinition);
+    private readonly scriptingDefinition: IScriptingDefinition,
-        this.current = code.code;
+    private readonly generator: IUserScriptGenerator = new UserScriptGenerator(),
-        this.scriptPositions = code.scriptPositions;
+  ) {
-        const event = new CodeChangedEvent(code.code, oldScripts, code.scriptPositions);
+    if (!userSelection) { throw new Error('missing userSelection'); }
-        this.changed.notify(event);
+    if (!scriptingDefinition) { throw new Error('missing scriptingDefinition'); }
-    }
+    if (!generator) { throw new Error('missing generator'); }
+    this.setCode(userSelection.selectedScripts);
+    userSelection.changed.on((scripts) => {
+      this.setCode(scripts);
+    });
+  }
+
+  private setCode(scripts: ReadonlyArray<SelectedScript>): void {
+    const oldScripts = Array.from(this.scriptPositions.keys());
+    const code = this.generator.buildCode(scripts, this.scriptingDefinition);
+    this.current = code.code;
+    this.scriptPositions = code.scriptPositions;
+    const event = new CodeChangedEvent(code.code, oldScripts, code.scriptPositions);
+    this.changed.notify(event);
+  }
 }

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

@@ -1,64 +1,71 @@
-import { ICodeChangedEvent } from './ICodeChangedEvent';
-import { SelectedScript } from '../../Selection/SelectedScript';
 import { IScript } from '@/domain/IScript';
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
+import { SelectedScript } from '../../Selection/SelectedScript';
+import { ICodeChangedEvent } from './ICodeChangedEvent';
 
 export class CodeChangedEvent implements ICodeChangedEvent {
-    public readonly code: string;
+  public readonly code: string;
-    public readonly addedScripts: ReadonlyArray<IScript>;
-    public readonly removedScripts: ReadonlyArray<IScript>;
-    public readonly changedScripts: ReadonlyArray<IScript>;
 
-    private readonly scripts: Map<IScript, ICodePosition>;
+  public readonly addedScripts: ReadonlyArray<IScript>;
 
-    constructor(
+  public readonly removedScripts: ReadonlyArray<IScript>;
-        code: string,
-        oldScripts: ReadonlyArray<SelectedScript>,
-        scripts: Map<SelectedScript, ICodePosition>) {
-        ensureAllPositionsExist(code, Array.from(scripts.values()));
-        this.code = code;
-        const newScripts = Array.from(scripts.keys());
-        this.addedScripts = selectIfNotExists(newScripts, oldScripts);
-        this.removedScripts = selectIfNotExists(oldScripts, newScripts);
-        this.changedScripts = getChangedScripts(oldScripts, newScripts);
-        this.scripts = new Map<IScript, ICodePosition>();
-        scripts.forEach((position, selection) => {
-            this.scripts.set(selection.script, position);
-        });
-    }
 
-    public isEmpty(): boolean {
+  public readonly changedScripts: ReadonlyArray<IScript>;
-        return this.scripts.size === 0;
-    }
 
-    public getScriptPositionInCode(script: IScript): ICodePosition {
+  private readonly scripts: Map<IScript, ICodePosition>;
-       return this.scripts.get(script);
+
-    }
+  constructor(
+    code: string,
+    oldScripts: ReadonlyArray<SelectedScript>,
+    scripts: Map<SelectedScript, ICodePosition>,
+  ) {
+    ensureAllPositionsExist(code, Array.from(scripts.values()));
+    this.code = code;
+    const newScripts = Array.from(scripts.keys());
+    this.addedScripts = selectIfNotExists(newScripts, oldScripts);
+    this.removedScripts = selectIfNotExists(oldScripts, newScripts);
+    this.changedScripts = getChangedScripts(oldScripts, newScripts);
+    this.scripts = new Map<IScript, ICodePosition>();
+    scripts.forEach((position, selection) => {
+      this.scripts.set(selection.script, position);
+    });
+  }
+
+  public isEmpty(): boolean {
+    return this.scripts.size === 0;
+  }
+
+  public getScriptPositionInCode(script: IScript): ICodePosition {
+    return this.scripts.get(script);
+  }
 }
 
 function ensureAllPositionsExist(script: string, positions: ReadonlyArray<ICodePosition>) {
-    const totalLines = script.split(/\r\n|\r|\n/).length;
+  const totalLines = script.split(/\r\n|\r|\n/).length;
-    for (const position of positions) {
+  const missingPositions = positions.filter((position) => position.endLine > totalLines);
-        if (position.endLine > totalLines) {
+  if (missingPositions.length > 0) {
-            throw new Error(`script end line (${position.endLine}) is out of range.` +
+    throw new Error(
-                            `(total code lines: ${totalLines}`);
+      `Out of range script end line: "${missingPositions.map((pos) => pos.endLine).join('", "')}"`
-        }
+        + `(total code lines: ${totalLines}).`,
-    }
+    );
+  }
 }
 
 function getChangedScripts(
-    oldScripts: ReadonlyArray<SelectedScript>,
+  oldScripts: ReadonlyArray<SelectedScript>,
-    newScripts: ReadonlyArray<SelectedScript>): ReadonlyArray<IScript> {
+  newScripts: ReadonlyArray<SelectedScript>,
-    return newScripts
+): ReadonlyArray<IScript> {
-        .filter((newScript) => oldScripts.find((oldScript) => oldScript.id === newScript.id
+  return newScripts
-                               && oldScript.revert !== newScript.revert ))
+    .filter((newScript) => oldScripts.find((oldScript) => oldScript.id === newScript.id
-        .map((selection) => selection.script);
+      && oldScript.revert !== newScript.revert))
+    .map((selection) => selection.script);
 }
 
 function selectIfNotExists(
-    selectableContainer: ReadonlyArray<SelectedScript>,
+  selectableContainer: ReadonlyArray<SelectedScript>,
-    test: ReadonlyArray<SelectedScript>) {
+  test: ReadonlyArray<SelectedScript>,
-    return selectableContainer
+) {
-        .filter((script) => !test.find((oldScript) => oldScript.id === script.id))
+  return selectableContainer
-        .map((selection) => selection.script);
+    .filter((script) => !test.find((oldScript) => oldScript.id === script.id))
+    .map((selection) => selection.script);
 }

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

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

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

@@ -1,67 +1,69 @@
 import { ICodeBuilder } from './ICodeBuilder';
 
-const NewLine = '\n';
 const TotalFunctionSeparatorChars = 58;
 
 export abstract class CodeBuilder implements ICodeBuilder {
-    private readonly lines = new Array<string>();
+  private readonly lines = new Array<string>();
 
-    // Returns current line starting from 0 (no lines), or 1 (have single line)
+  // Returns current line starting from 0 (no lines), or 1 (have single line)
-    public get currentLine(): number {
+  public get currentLine(): number {
-        return this.lines.length;
+    return this.lines.length;
+  }
+
+  public appendLine(code?: string): CodeBuilder {
+    if (!code) {
+      this.lines.push('');
+      return this;
     }
+    const lines = code.match(/[^\r\n]+/g);
+    this.lines.push(...lines);
+    return this;
+  }
 
-    public appendLine(code?: string): CodeBuilder {
+  public appendTrailingHyphensCommentLine(
-        if (!code) {
+    totalRepeatHyphens: number = TotalFunctionSeparatorChars,
-            this.lines.push('');
+  ): CodeBuilder {
-            return this;
+    return this.appendCommentLine('-'.repeat(totalRepeatHyphens));
-        }
+  }
-        const lines = code.match(/[^\r\n]+/g);
+
-        for (const line of lines) {
+  public appendCommentLine(commentLine?: string): CodeBuilder {
-            this.lines.push(line);
+    this.lines.push(`${this.getCommentDelimiter()} ${commentLine}`);
-        }
+    return this;
-        return this;
+  }
+
+  public appendFunction(name: string, code: string): CodeBuilder {
+    if (!name) { throw new Error('name cannot be empty or null'); }
+    if (!code) { throw new Error('code cannot be empty or null'); }
+    return this
+      .appendCommentLineWithHyphensAround(name)
+      .appendLine(this.writeStandardOut(`--- ${name}`))
+      .appendLine(code)
+      .appendTrailingHyphensCommentLine();
+  }
+
+  public appendCommentLineWithHyphensAround(
+    sectionName: string,
+    totalRepeatHyphens: number = TotalFunctionSeparatorChars,
+  ): CodeBuilder {
+    if (!sectionName) { throw new Error('sectionName cannot be empty or null'); }
+    if (sectionName.length >= totalRepeatHyphens) {
+      return this.appendCommentLine(sectionName);
     }
+    const firstHyphens = '-'.repeat(Math.floor((totalRepeatHyphens - sectionName.length) / 2));
+    const secondHyphens = '-'.repeat(Math.ceil((totalRepeatHyphens - sectionName.length) / 2));
+    return this
+      .appendTrailingHyphensCommentLine()
+      .appendCommentLine(firstHyphens + sectionName + secondHyphens)
+      .appendTrailingHyphensCommentLine(TotalFunctionSeparatorChars);
+  }
 
-    public appendTrailingHyphensCommentLine(
+  public toString(): string {
-        totalRepeatHyphens: number = TotalFunctionSeparatorChars): CodeBuilder {
+    return this.lines.join(this.getNewLineTerminator());
-        return this.appendCommentLine('-'.repeat(totalRepeatHyphens));
+  }
-    }
 
-    public appendCommentLine(commentLine?: string): CodeBuilder {
+  protected abstract getCommentDelimiter(): string;
-        this.lines.push(`${this.getCommentDelimiter()} ${commentLine}`);
-        return this;
-    }
 
-    public appendFunction(name: string, code: string): CodeBuilder {
+  protected abstract writeStandardOut(text: string): string;
-        if (!name)  { throw new Error('name cannot be empty or null'); }
-        if (!code)  { throw new Error('code cannot be empty or null'); }
-        return this
-            .appendCommentLineWithHyphensAround(name)
-            .appendLine(this.writeStandardOut(`--- ${name}`))
-            .appendLine(code)
-            .appendTrailingHyphensCommentLine();
-    }
 
-    public appendCommentLineWithHyphensAround(
+  protected abstract getNewLineTerminator(): string;
-        sectionName: string,
-        totalRepeatHyphens: number = TotalFunctionSeparatorChars): CodeBuilder {
-        if (!sectionName)  { throw new Error('sectionName cannot be empty or null'); }
-        if (sectionName.length >= totalRepeatHyphens) {
-            return this.appendCommentLine(sectionName);
-        }
-        const firstHyphens = '-'.repeat(Math.floor((totalRepeatHyphens - sectionName.length) / 2));
-        const secondHyphens = '-'.repeat(Math.ceil((totalRepeatHyphens - sectionName.length) / 2));
-        return this
-            .appendTrailingHyphensCommentLine()
-            .appendCommentLine(firstHyphens + sectionName + secondHyphens)
-            .appendTrailingHyphensCommentLine(TotalFunctionSeparatorChars);
-    }
-
-    public toString(): string {
-        return this.lines.join(NewLine);
-    }
-
-    protected abstract getCommentDelimiter(): string;
-    protected abstract writeStandardOut(text: string): string;
 }

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

@@ -5,10 +5,12 @@ import { BatchBuilder } from './Languages/BatchBuilder';
 import { ShellBuilder } from './Languages/ShellBuilder';
 import { ICodeBuilderFactory } from './ICodeBuilderFactory';
 
-export class CodeBuilderFactory extends ScriptingLanguageFactory<ICodeBuilder> implements ICodeBuilderFactory {
+export class CodeBuilderFactory
-    constructor() {
+  extends ScriptingLanguageFactory<ICodeBuilder>
-        super();
+  implements ICodeBuilderFactory {
-        this.registerGetter(ScriptingLanguage.shellscript, () => new ShellBuilder());
+  constructor() {
-        this.registerGetter(ScriptingLanguage.batchfile, () => new BatchBuilder());
+    super();
-    }
+    this.registerGetter(ScriptingLanguage.shellscript, () => new ShellBuilder());
+    this.registerGetter(ScriptingLanguage.batchfile, () => new BatchBuilder());
+  }
 }

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

@@ -1,9 +1,9 @@
 export interface ICodeBuilder {
-    currentLine: number;
+  currentLine: number;
-    appendLine(code?: string): ICodeBuilder;
+  appendLine(code?: string): ICodeBuilder;
-    appendTrailingHyphensCommentLine(totalRepeatHyphens: number): ICodeBuilder;
+  appendTrailingHyphensCommentLine(totalRepeatHyphens: number): ICodeBuilder;
-    appendCommentLine(commentLine?: string): ICodeBuilder;
+  appendCommentLine(commentLine?: string): ICodeBuilder;
-    appendCommentLineWithHyphensAround(sectionName: string, totalRepeatHyphens: number): ICodeBuilder;
+  appendCommentLineWithHyphensAround(sectionName: string, totalRepeatHyphens: number): ICodeBuilder;
-    appendFunction(name: string, code: string): ICodeBuilder;
+  appendFunction(name: string, code: string): ICodeBuilder;
-    toString(): string;
+  toString(): string;
 }

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

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

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

@@ -2,6 +2,6 @@ import { SelectedScript } from '@/application/Context/State/Selection/SelectedSc
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
 
 export interface IUserScript {
-    code: string;
+  code: string;
-    scriptPositions: Map<SelectedScript, ICodePosition>;
+  scriptPositions: Map<SelectedScript, ICodePosition>;
 }

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

@@ -1,9 +1,9 @@
 import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
-import { IUserScript } from './IUserScript';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
+import { IUserScript } from './IUserScript';
 
 export interface IUserScriptGenerator {
-    buildCode(
+  buildCode(
-        selectedScripts: ReadonlyArray<SelectedScript>,
+    selectedScripts: ReadonlyArray<SelectedScript>,
-        scriptingDefinition: IScriptingDefinition): IUserScript;
+    scriptingDefinition: IScriptingDefinition): IUserScript;
 }

src/application/Context/State/Code/Generation/Languages/BatchBuilder.ts

@@ -1,16 +1,21 @@
 import { CodeBuilder } from '@/application/Context/State/Code/Generation/CodeBuilder';
 
 export class BatchBuilder extends CodeBuilder {
-    protected getCommentDelimiter(): string {
+  protected getCommentDelimiter(): string {
-        return '::';
+    return '::';
-    }
+  }
-    protected writeStandardOut(text: string): string {
+
-        return `echo ${escapeForEcho(text)}`;
+  protected writeStandardOut(text: string): string {
-    }
+    return `echo ${escapeForEcho(text)}`;
+  }
+
+  protected getNewLineTerminator(): string {
+    return '\r\n';
+  }
 }
 
 function escapeForEcho(text: string) {
-    return text
+  return text
-        .replace(/&/g, '^&')
+    .replace(/&/g, '^&')
-        .replace(/%/g, '%%');
+    .replace(/%/g, '%%');
 }

src/application/Context/State/Code/Generation/Languages/ShellBuilder.ts

@@ -1,15 +1,20 @@
 import { CodeBuilder } from '@/application/Context/State/Code/Generation/CodeBuilder';
 
 export class ShellBuilder extends CodeBuilder {
-    protected getCommentDelimiter(): string {
+  protected getCommentDelimiter(): string {
-        return '#';
+    return '#';
-    }
+  }
-    protected writeStandardOut(text: string): string {
+
-        return `echo '${escapeForEcho(text)}'`;
+  protected writeStandardOut(text: string): string {
-    }
+    return `echo '${escapeForEcho(text)}'`;
+  }
+
+  protected getNewLineTerminator(): string {
+    return '\n';
+  }
 }
 
 function escapeForEcho(text: string) {
-    return text
+  return text
-        .replace(/'/g, '\'\\\'\'');
+    .replace(/'/g, '\'\\\'\'');
 }

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

@@ -1,71 +1,75 @@
 import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
-import { IUserScriptGenerator } from './IUserScriptGenerator';
 import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
-import { CodePosition } from '../Position/CodePosition';
-import { IUserScript } from './IUserScript';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
+import { CodePosition } from '../Position/CodePosition';
+import { IUserScriptGenerator } from './IUserScriptGenerator';
+import { IUserScript } from './IUserScript';
 import { ICodeBuilder } from './ICodeBuilder';
 import { ICodeBuilderFactory } from './ICodeBuilderFactory';
 import { CodeBuilderFactory } from './CodeBuilderFactory';
 
 export class UserScriptGenerator implements IUserScriptGenerator {
-    constructor(private readonly codeBuilderFactory: ICodeBuilderFactory = new CodeBuilderFactory()) {
+  constructor(private readonly codeBuilderFactory: ICodeBuilderFactory = new CodeBuilderFactory()) {
 
+  }
+
+  public buildCode(
+    selectedScripts: ReadonlyArray<SelectedScript>,
+    scriptingDefinition: IScriptingDefinition,
+  ): IUserScript {
+    if (!selectedScripts) { throw new Error('missing scripts'); }
+    if (!scriptingDefinition) { throw new Error('missing definition'); }
+    if (!selectedScripts.length) {
+      return { code: '', scriptPositions: new Map<SelectedScript, ICodePosition>() };
     }
-    public buildCode(
+    let builder = this.codeBuilderFactory.create(scriptingDefinition.language);
-        selectedScripts: ReadonlyArray<SelectedScript>,
+    builder = initializeCode(scriptingDefinition.startCode, builder);
-        scriptingDefinition: IScriptingDefinition): IUserScript {
+    const scriptPositions = selectedScripts.reduce((result, selection) => {
-        if (!selectedScripts) { throw new Error('undefined scripts'); }
+      return appendSelection(selection, result, builder);
-        if (!scriptingDefinition) { throw new Error('undefined definition'); }
+    }, new Map<SelectedScript, ICodePosition>());
-        let scriptPositions = new Map<SelectedScript, ICodePosition>();
+    const code = finalizeCode(builder, scriptingDefinition.endCode);
-        if (!selectedScripts.length) {
+    return { code, scriptPositions };
-            return { code: '', scriptPositions };
+  }
-        }
-        let builder = this.codeBuilderFactory.create(scriptingDefinition.language);
-        builder = initializeCode(scriptingDefinition.startCode, builder);
-        for (const selection of selectedScripts) {
-            scriptPositions = appendSelection(selection, scriptPositions, builder);
-        }
-        const code = finalizeCode(builder, scriptingDefinition.endCode);
-        return { code, scriptPositions };
-    }
 }
 
 function initializeCode(startCode: string, builder: ICodeBuilder): ICodeBuilder {
-    if (!startCode) {
+  if (!startCode) {
-        return builder;
+    return builder;
-    }
+  }
-    return builder
+  return builder
-        .appendLine(startCode)
+    .appendLine(startCode)
-        .appendLine();
+    .appendLine();
 }
 
 function finalizeCode(builder: ICodeBuilder, endCode: string): string {
-    if (!endCode) {
+  if (!endCode) {
-        return builder.toString();
+    return builder.toString();
-    }
+  }
-    return builder.appendLine()
+  return builder.appendLine()
-        .appendLine(endCode)
+    .appendLine(endCode)
-        .toString();
+    .toString();
 }
 
 function appendSelection(
-    selection: SelectedScript,
+  selection: SelectedScript,
-    scriptPositions: Map<SelectedScript, ICodePosition>,
+  scriptPositions: Map<SelectedScript, ICodePosition>,
-    builder: ICodeBuilder): Map<SelectedScript, ICodePosition> {
+  builder: ICodeBuilder,
-    const startPosition = builder.currentLine + 1; // Because first line will be empty to separate scripts
+): Map<SelectedScript, ICodePosition> {
-    builder = appendCode(selection, builder);
+  // Start from next line because first line will be empty to separate scripts
-    const endPosition = builder.currentLine - 1;
+  const startPosition = builder.currentLine + 1;
-    builder.appendLine();
+  appendCode(selection, builder);
-    const position = new CodePosition(startPosition, endPosition);
+  const endPosition = builder.currentLine - 1;
-    scriptPositions.set(selection, position);
+  builder.appendLine();
-    return scriptPositions;
+  const position = new CodePosition(startPosition, endPosition);
+  scriptPositions.set(selection, position);
+  return scriptPositions;
 }
 
 function appendCode(selection: SelectedScript, builder: ICodeBuilder): ICodeBuilder {
-    const name = selection.revert ? `${selection.script.name} (revert)` : selection.script.name;
+  const { script } = selection;
-    const scriptCode = selection.revert ? selection.script.code.revert : selection.script.code.execute;
+  const name = selection.revert ? `${script.name} (revert)` : script.name;
-    return builder
+  const scriptCode = selection.revert ? script.code.revert : script.code.execute;
-        .appendLine()
+  return builder
-        .appendFunction(name, scriptCode);
+    .appendLine()
+    .appendFunction(name, scriptCode);
 }

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

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

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

@@ -1,24 +1,25 @@
 import { ICodePosition } from './ICodePosition';
 
 export class CodePosition implements ICodePosition {
-    public get totalLines(): number {
+  public get totalLines(): number {
-        return this.endLine - this.startLine;
+    return this.endLine - this.startLine;
-    }
+  }
 
-    constructor(
+  constructor(
-        public readonly startLine: number,
+    public readonly startLine: number,
-        public readonly endLine: number) {
+    public readonly endLine: number,
-        if (startLine < 0) {
+  ) {
-            throw new Error('Code cannot start in a negative line');
+    if (startLine < 0) {
-        }
+      throw new Error('Code cannot start in a negative line');
-        if (endLine < 0) {
-            throw new Error('Code cannot end in a negative line');
-        }
-        if (endLine === startLine) {
-            throw new Error('Empty code');
-        }
-        if (endLine < startLine) {
-            throw new Error('End line cannot be less than start line');
-        }
     }
+    if (endLine < 0) {
+      throw new Error('Code cannot end in a negative line');
+    }
+    if (endLine === startLine) {
+      throw new Error('Empty code');
+    }
+    if (endLine < startLine) {
+      throw new Error('End line cannot be less than start line');
+    }
+  }
 }

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

@@ -1,5 +1,5 @@
 export interface ICodePosition {
-    readonly startLine: number;
+  readonly startLine: number;
-    readonly endLine: number;
+  readonly endLine: number;
-    readonly totalLines: number;
+  readonly totalLines: number;
 }

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/FilterResult.ts

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

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

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

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

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

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

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

src/application/Context/State/ICategoryCollectionState.ts

@@ -1,13 +1,18 @@
-import { IUserFilter } from './Filter/IUserFilter';
-import { IUserSelection } from './Selection/IUserSelection';
-import { IApplicationCode } from './Code/IApplicationCode';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { OperatingSystem } from '@/domain/OperatingSystem';
+import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter';
+import { IReadOnlyUserSelection, IUserSelection } from './Selection/IUserSelection';
+import { IApplicationCode } from './Code/IApplicationCode';
 
-export interface ICategoryCollectionState {
+export interface IReadOnlyCategoryCollectionState {
-    readonly code: IApplicationCode;
+  readonly code: IApplicationCode;
-    readonly filter: IUserFilter;
+  readonly os: OperatingSystem;
-    readonly selection: IUserSelection;
+  readonly filter: IReadOnlyUserFilter;
-    readonly collection: ICategoryCollection;
+  readonly selection: IReadOnlyUserSelection;
-    readonly os: OperatingSystem;
+  readonly collection: ICategoryCollection;
+}
+
+export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState {
+  readonly filter: IUserFilter;
+  readonly selection: IUserSelection;
 }

src/application/Context/State/Selection/IUserSelection.ts

@@ -1,20 +1,23 @@
-import { SelectedScript } from './SelectedScript';
 import { IScript } from '@/domain/IScript';
 import { ICategory } from '@/domain/ICategory';
 import { IEventSource } from '@/infrastructure/Events/IEventSource';
+import { SelectedScript } from './SelectedScript';
 
-export interface IUserSelection {
+export interface IReadOnlyUserSelection {
-    readonly changed: IEventSource<ReadonlyArray<SelectedScript>>;
+  readonly changed: IEventSource<ReadonlyArray<SelectedScript>>;
-    readonly selectedScripts: ReadonlyArray<SelectedScript>;
+  readonly selectedScripts: ReadonlyArray<SelectedScript>;
-    areAllSelected(category: ICategory): boolean;
+  isSelected(scriptId: string): boolean;
-    isAnySelected(category: ICategory): boolean;
+  areAllSelected(category: ICategory): boolean;
-    removeAllInCategory(categoryId: number): void;
+  isAnySelected(category: ICategory): boolean;
-    addOrUpdateAllInCategory(categoryId: number, revert: boolean): void;
+}
-    addSelectedScript(scriptId: string, revert: boolean): void;
+
-    addOrUpdateSelectedScript(scriptId: string, revert: boolean): void;
+export interface IUserSelection extends IReadOnlyUserSelection {
-    removeSelectedScript(scriptId: string): void;
+  removeAllInCategory(categoryId: number): void;
-    selectOnly(scripts: ReadonlyArray<IScript>): void;
+  addOrUpdateAllInCategory(categoryId: number, revert: boolean): void;
-    isSelected(scriptId: string): boolean;
+  addSelectedScript(scriptId: string, revert: boolean): void;
-    selectAll(): void;
+  addOrUpdateSelectedScript(scriptId: string, revert: boolean): void;
-    deselectAll(): void;
+  removeSelectedScript(scriptId: string): void;
+  selectOnly(scripts: ReadonlyArray<IScript>): void;
+  selectAll(): void;
+  deselectAll(): void;
 }

src/application/Context/State/Selection/SelectedScript.ts

@@ -2,13 +2,13 @@ import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
 import { IScript } from '@/domain/IScript';
 
 export class SelectedScript extends BaseEntity<string> {
-    constructor(
+  constructor(
-        public readonly script: IScript,
+    public readonly script: IScript,
-        public readonly revert: boolean,
+    public readonly revert: boolean,
-        ) {
+  ) {
-        super(script.id);
+    super(script.id);
-        if (revert && !script.canRevert()) {
+    if (revert && !script.canRevert()) {
-            throw new Error('cannot revert an irreversible script');
+      throw new Error('cannot revert an irreversible script');
-        }
     }
+  }
 }

src/application/Context/State/Selection/UserSelection.ts

@@ -1,141 +1,167 @@
-import { SelectedScript } from './SelectedScript';
-import { IUserSelection } from './IUserSelection';
 import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
 import { IScript } from '@/domain/IScript';
 import { EventSource } from '@/infrastructure/Events/EventSource';
 import { IRepository } from '@/infrastructure/Repository/IRepository';
 import { ICategory } from '@/domain/ICategory';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import { IUserSelection } from './IUserSelection';
+import { SelectedScript } from './SelectedScript';
 
 export class UserSelection implements IUserSelection {
-    public readonly changed = new EventSource<ReadonlyArray<SelectedScript>>();
+  public readonly changed = new EventSource<ReadonlyArray<SelectedScript>>();
-    private readonly scripts: IRepository<string, SelectedScript>;
 
-    constructor(
+  private readonly scripts: IRepository<string, SelectedScript>;
-        private readonly collection: ICategoryCollection,
-        selectedScripts: ReadonlyArray<SelectedScript>) {
-        this.scripts =  new InMemoryRepository<string, SelectedScript>();
-        if (selectedScripts && selectedScripts.length > 0) {
-            for (const script of selectedScripts) {
-                this.scripts.addItem(script);
-            }
-        }
-    }
 
-    public areAllSelected(category: ICategory): boolean {
+  constructor(
-        if (this.selectedScripts.length === 0) {
+    private readonly collection: ICategoryCollection,
-            return false;
+    selectedScripts: ReadonlyArray<SelectedScript>,
-        }
+  ) {
-        const scripts = category.getAllScriptsRecursively();
+    this.scripts = new InMemoryRepository<string, SelectedScript>();
-        if (this.selectedScripts.length < scripts.length) {
+    for (const script of selectedScripts) {
-            return false;
+      this.scripts.addItem(script);
-        }
-        return scripts.every((script) => this.selectedScripts.some((selected) => selected.id === script.id));
     }
+  }
 
-    public isAnySelected(category: ICategory): boolean {
+  public areAllSelected(category: ICategory): boolean {
-        if (this.selectedScripts.length === 0) {
+    if (this.selectedScripts.length === 0) {
-            return false;
+      return false;
-        }
-        return this.selectedScripts.some((s) => category.includes(s.script));
     }
+    const scripts = category.getAllScriptsRecursively();
+    if (this.selectedScripts.length < scripts.length) {
+      return false;
+    }
+    return scripts.every(
+      (script) => this.selectedScripts.some((selected) => selected.id === script.id),
+    );
+  }
 
-    public removeAllInCategory(categoryId: number): void {
+  public isAnySelected(category: ICategory): boolean {
-        const category = this.collection.findCategory(categoryId);
+    if (this.selectedScripts.length === 0) {
-        const scriptsToRemove = category.getAllScriptsRecursively()
+      return false;
-            .filter((script) => this.scripts.exists(script.id));
-        if (!scriptsToRemove.length) {
-            return;
-        }
-        for (const script of scriptsToRemove) {
-            this.scripts.removeItem(script.id);
-        }
-        this.changed.notify(this.scripts.getItems());
     }
+    return this.selectedScripts.some((s) => category.includes(s.script));
+  }
 
-    public addOrUpdateAllInCategory(categoryId: number, revert: boolean = false): void {
+  public removeAllInCategory(categoryId: number): void {
-        const category = this.collection.findCategory(categoryId);
+    const category = this.collection.findCategory(categoryId);
-        const scriptsToAddOrUpdate = category.getAllScriptsRecursively()
+    const scriptsToRemove = category.getAllScriptsRecursively()
-            .filter((script) =>
+      .filter((script) => this.scripts.exists(script.id));
-                !this.scripts.exists(script.id)
+    if (!scriptsToRemove.length) {
-                    || this.scripts.getById(script.id).revert !== revert,
+      return;
-            );
-        if (!scriptsToAddOrUpdate.length) {
-            return;
-        }
-        for (const script of scriptsToAddOrUpdate) {
-            const selectedScript = new SelectedScript(script, revert);
-            this.scripts.addOrUpdateItem(selectedScript);
-        }
-        this.changed.notify(this.scripts.getItems());
     }
+    for (const script of scriptsToRemove) {
+      this.scripts.removeItem(script.id);
+    }
+    this.changed.notify(this.scripts.getItems());
+  }
 
-    public addSelectedScript(scriptId: string, revert: boolean): void {
+  public addOrUpdateAllInCategory(categoryId: number, revert = false): void {
-        const script = this.collection.findScript(scriptId);
+    const scriptsToAddOrUpdate = this.collection
-        if (!script) {
+      .findCategory(categoryId)
-            throw new Error(`Cannot add (id: ${scriptId}) as it is unknown`);
+      .getAllScriptsRecursively()
-        }
+      .filter(
-        const selectedScript = new SelectedScript(script, revert);
+        (script) => !this.scripts.exists(script.id)
-        this.scripts.addItem(selectedScript);
+          || this.scripts.getById(script.id).revert !== revert,
-        this.changed.notify(this.scripts.getItems());
+      )
+      .map((script) => new SelectedScript(script, revert));
+    if (!scriptsToAddOrUpdate.length) {
+      return;
     }
+    for (const script of scriptsToAddOrUpdate) {
+      this.scripts.addOrUpdateItem(script);
+    }
+    this.changed.notify(this.scripts.getItems());
+  }
 
-    public addOrUpdateSelectedScript(scriptId: string, revert: boolean): void {
+  public addSelectedScript(scriptId: string, revert: boolean): void {
-        const script = this.collection.findScript(scriptId);
+    const script = this.collection.findScript(scriptId);
-        const selectedScript = new SelectedScript(script, revert);
+    if (!script) {
-        this.scripts.addOrUpdateItem(selectedScript);
+      throw new Error(`Cannot add (id: ${scriptId}) as it is unknown`);
-        this.changed.notify(this.scripts.getItems());
     }
+    const selectedScript = new SelectedScript(script, revert);
+    this.scripts.addItem(selectedScript);
+    this.changed.notify(this.scripts.getItems());
+  }
 
-    public removeSelectedScript(scriptId: string): void {
+  public addOrUpdateSelectedScript(scriptId: string, revert: boolean): void {
-        this.scripts.removeItem(scriptId);
+    const script = this.collection.findScript(scriptId);
-        this.changed.notify(this.scripts.getItems());
+    const selectedScript = new SelectedScript(script, revert);
-    }
+    this.scripts.addOrUpdateItem(selectedScript);
+    this.changed.notify(this.scripts.getItems());
+  }
 
-    public isSelected(scriptId: string): boolean {
+  public removeSelectedScript(scriptId: string): void {
-        return this.scripts.exists(scriptId);
+    this.scripts.removeItem(scriptId);
-    }
+    this.changed.notify(this.scripts.getItems());
+  }
 
-    /** Get users scripts based on his/her selections */
+  public isSelected(scriptId: string): boolean {
-    public get selectedScripts(): ReadonlyArray<SelectedScript> {
+    return this.scripts.exists(scriptId);
-        return this.scripts.getItems();
+  }
-    }
 
-    public selectAll(): void {
+  /** Get users scripts based on his/her selections */
-        for (const script of this.collection.getAllScripts()) {
+  public get selectedScripts(): ReadonlyArray<SelectedScript> {
-            if (!this.scripts.exists(script.id)) {
+    return this.scripts.getItems();
-                const selection = new SelectedScript(script, false);
+  }
-                this.scripts.addItem(selection);
-            }
-        }
-        this.changed.notify(this.scripts.getItems());
-    }
 
-    public deselectAll(): void {
+  public selectAll(): void {
-        const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
+    const scriptsToSelect = this.collection
-        for (const scriptId of selectedScriptIds) {
+      .getAllScripts()
-            this.scripts.removeItem(scriptId);
+      .filter((script) => !this.scripts.exists(script.id))
-        }
+      .map((script) => new SelectedScript(script, false));
-        this.changed.notify([]);
+    if (scriptsToSelect.length === 0) {
+      return;
     }
+    for (const script of scriptsToSelect) {
+      this.scripts.addItem(script);
+    }
+    this.changed.notify(this.scripts.getItems());
+  }
 
-    public selectOnly(scripts: readonly IScript[]): void {
+  public deselectAll(): void {
-        if (!scripts || scripts.length === 0) {
+    if (this.scripts.length === 0) {
-            throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
+      return;
-        }
-        // Unselect from selected scripts
-        if (this.scripts.length !== 0) {
-            this.scripts.getItems()
-                .filter((existing) => !scripts.some((script) => existing.id === script.id))
-                .map((script) => script.id)
-                .forEach((scriptId) => this.scripts.removeItem(scriptId));
-        }
-        // Select from unselected scripts
-        const unselectedScripts = scripts.filter((script) => !this.scripts.exists(script.id));
-        for (const toSelect of unselectedScripts) {
-            const selection = new SelectedScript(toSelect, false);
-            this.scripts.addItem(selection);
-        }
-        this.changed.notify(this.scripts.getItems());
     }
+    const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
+    for (const scriptId of selectedScriptIds) {
+      this.scripts.removeItem(scriptId);
+    }
+    this.changed.notify([]);
+  }
+
+  public selectOnly(scripts: readonly IScript[]): void {
+    if (!scripts || scripts.length === 0) {
+      throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
+    }
+    let totalChanged = 0;
+    totalChanged += this.unselectMissingWithoutNotifying(scripts);
+    totalChanged += this.selectNewWithoutNotifying(scripts);
+    if (totalChanged > 0) {
+      this.changed.notify(this.scripts.getItems());
+    }
+  }
+
+  private unselectMissingWithoutNotifying(scripts: readonly IScript[]): number {
+    if (this.scripts.length === 0 || scripts.length === 0) {
+      return 0;
+    }
+    const existingItems = this.scripts.getItems();
+    const missingIds = existingItems
+      .filter((existing) => !scripts.some((script) => existing.id === script.id))
+      .map((script) => script.id);
+    for (const id of missingIds) {
+      this.scripts.removeItem(id);
+    }
+    return missingIds.length;
+  }
+
+  private selectNewWithoutNotifying(scripts: readonly IScript[]): number {
+    const unselectedScripts = scripts
+      .filter((script) => !this.scripts.exists(script.id))
+      .map((script) => new SelectedScript(script, false));
+    for (const newScript of unselectedScripts) {
+      this.scripts.addItem(newScript);
+    }
+    return unselectedScripts.length;
+  }
 }

src/application/Environment/BrowserOs/BrowserOsDetector.ts

@@ -3,52 +3,55 @@ import { DetectorBuilder } from './DetectorBuilder';
 import { IBrowserOsDetector } from './IBrowserOsDetector';
 
 export class BrowserOsDetector implements IBrowserOsDetector {
-    private readonly detectors = BrowserDetectors;
+  private readonly detectors = BrowserDetectors;
-    public detect(userAgent: string): OperatingSystem | undefined {
+
-        if (!userAgent) {
+  public detect(userAgent: string): OperatingSystem | undefined {
-            return undefined;
+    if (!userAgent) {
-        }
+      return undefined;
-        for (const detector of this.detectors) {
-            const os = detector.detect(userAgent);
-            if (os !== undefined) {
-                return os;
-            }
-        }
-        return undefined;
     }
+    for (const detector of this.detectors) {
+      const os = detector.detect(userAgent);
+      if (os !== undefined) {
+        return os;
+      }
+    }
+    return undefined;
+  }
 }
 
 // Reference: https://github.com/keithws/browser-report/blob/master/index.js#L304
-const BrowserDetectors =
+const BrowserDetectors = [
-[
+  define(OperatingSystem.KaiOS, (b) => b
-    define(OperatingSystem.KaiOS, (b) =>
+    .mustInclude('KAIOS')),
-        b.mustInclude('KAIOS')),
+  define(OperatingSystem.ChromeOS, (b) => b
-    define(OperatingSystem.ChromeOS, (b) =>
+    .mustInclude('CrOS')),
-        b.mustInclude('CrOS')),
+  define(OperatingSystem.BlackBerryOS, (b) => b
-    define(OperatingSystem.BlackBerryOS, (b) =>
+    .mustInclude('BlackBerry')),
-        b.mustInclude('BlackBerry')),
+  define(OperatingSystem.BlackBerryTabletOS, (b) => b
-    define(OperatingSystem.BlackBerryTabletOS, (b) =>
+    .mustInclude('RIM Tablet OS')),
-        b.mustInclude('RIM Tablet OS')),
+  define(OperatingSystem.BlackBerry, (b) => b
-    define(OperatingSystem.BlackBerry, (b) =>
+    .mustInclude('BB10')),
-        b.mustInclude('BB10')),
+  define(OperatingSystem.Android, (b) => b
-    define(OperatingSystem.Android, (b) =>
+    .mustInclude('Android').mustNotInclude('Windows Phone')),
-        b.mustInclude('Android').mustNotInclude('Windows Phone')),
+  define(OperatingSystem.Android, (b) => b
-    define(OperatingSystem.Android, (b) =>
+    .mustInclude('Adr').mustNotInclude('Windows Phone')),
-        b.mustInclude('Adr').mustNotInclude('Windows Phone')),
+  define(OperatingSystem.iOS, (b) => b
-    define(OperatingSystem.iOS, (b) =>
+    .mustInclude('like Mac OS X')),
-        b.mustInclude('like Mac OS X')),
+  define(OperatingSystem.Linux, (b) => b
-    define(OperatingSystem.Linux, (b) =>
+    .mustInclude('Linux').mustNotInclude('Android').mustNotInclude('Adr')),
-        b.mustInclude('Linux').mustNotInclude('Android').mustNotInclude('Adr')),
+  define(OperatingSystem.Windows, (b) => b
-    define(OperatingSystem.Windows, (b) =>
+    .mustInclude('Windows').mustNotInclude('Windows Phone')),
-        b.mustInclude('Windows').mustNotInclude('Windows Phone')),
+  define(OperatingSystem.WindowsPhone, (b) => b
-    define(OperatingSystem.WindowsPhone, (b) =>
+    .mustInclude('Windows Phone')),
-        b.mustInclude('Windows Phone')),
+  define(OperatingSystem.macOS, (b) => b
-    define(OperatingSystem.macOS, (b) =>
+    .mustInclude('OS X').mustNotInclude('Android').mustNotInclude('like Mac OS X')),
-        b.mustInclude('OS X').mustNotInclude('Android').mustNotInclude('like Mac OS X')),
 ];
 
-function define(os: OperatingSystem, applyRules: (builder: DetectorBuilder) => DetectorBuilder): IBrowserOsDetector {
+function define(
-    const builder = new DetectorBuilder(os);
+  os: OperatingSystem,
-    applyRules(builder);
+  applyRules: (builder: DetectorBuilder) => DetectorBuilder,
-    return builder.build();
+): IBrowserOsDetector {
+  const builder = new DetectorBuilder(os);
+  applyRules(builder);
+  return builder.build();
 }

src/application/Environment/BrowserOs/DetectorBuilder.ts

@@ -1,53 +1,54 @@
-import { IBrowserOsDetector } from './IBrowserOsDetector';
 import { OperatingSystem } from '@/domain/OperatingSystem';
+import { IBrowserOsDetector } from './IBrowserOsDetector';
 
 export class DetectorBuilder {
-    private readonly existingPartsInUserAgent = new Array<string>();
+  private readonly existingPartsInUserAgent = new Array<string>();
-    private readonly notExistingPartsInUserAgent = new Array<string>();
 
-    constructor(private readonly os: OperatingSystem) { }
+  private readonly notExistingPartsInUserAgent = new Array<string>();
 
-    public mustInclude(str: string): DetectorBuilder {
+  constructor(private readonly os: OperatingSystem) { }
-        return this.add(str, this.existingPartsInUserAgent);
+
+  public mustInclude(str: string): DetectorBuilder {
+    return this.add(str, this.existingPartsInUserAgent);
+  }
+
+  public mustNotInclude(str: string): DetectorBuilder {
+    return this.add(str, this.notExistingPartsInUserAgent);
+  }
+
+  public build(): IBrowserOsDetector {
+    if (!this.existingPartsInUserAgent.length) {
+      throw new Error('Must include at least a part');
     }
+    return {
+      detect: (agent) => this.detect(agent),
+    };
+  }
 
-    public mustNotInclude(str: string): DetectorBuilder {
+  private detect(userAgent: string): OperatingSystem {
-        return this.add(str, this.notExistingPartsInUserAgent);
+    if (!userAgent) {
+      throw new Error('missing userAgent');
     }
+    if (this.existingPartsInUserAgent.some((part) => !userAgent.includes(part))) {
+      return undefined;
+    }
+    if (this.notExistingPartsInUserAgent.some((part) => userAgent.includes(part))) {
+      return undefined;
+    }
+    return this.os;
+  }
 
-    public build(): IBrowserOsDetector {
+  private add(part: string, array: string[]): DetectorBuilder {
-        if (!this.existingPartsInUserAgent.length) {
+    if (!part) {
-            throw new Error('Must include at least a part');
+      throw new Error('part is empty or undefined');
-        }
-        return {
-            detect: (agent) => this.detect(agent),
-        };
     }
-
+    if (this.existingPartsInUserAgent.includes(part)) {
-    private detect(userAgent: string): OperatingSystem {
+      throw new Error(`part ${part} is already included as existing part`);
-        if (!userAgent) {
-            throw new Error('User agent is null or undefined');
-        }
-        if (this.existingPartsInUserAgent.some((part) => !userAgent.includes(part))) {
-            return undefined;
-        }
-        if (this.notExistingPartsInUserAgent.some((part) => userAgent.includes(part))) {
-            return undefined;
-        }
-        return this.os;
     }
-
+    if (this.notExistingPartsInUserAgent.includes(part)) {
-    private add(part: string, array: string[]): DetectorBuilder {
+      throw new Error(`part ${part} is already included as not existing part`);
-        if (!part) {
-            throw new Error('part is empty or undefined');
-        }
-        if (this.existingPartsInUserAgent.includes(part)) {
-            throw new Error(`part ${part} is already included as existing part`);
-        }
-        if (this.notExistingPartsInUserAgent.includes(part)) {
-            throw new Error(`part ${part} is already included as not existing part`);
-        }
-        array.push(part);
-        return this;
     }
+    array.push(part);
+    return this;
+  }
 }

src/application/Environment/BrowserOs/IBrowserOsDetector.ts

@@ -1,5 +1,5 @@
 import { OperatingSystem } from '@/domain/OperatingSystem';
 
 export interface IBrowserOsDetector {
-    detect(userAgent: string): OperatingSystem | undefined;
+  detect(userAgent: string): OperatingSystem | undefined;
 }