win: improve output/user feedback capabilities

- Improve error handling.
- Provide more detailed user feedback with meaningful messages.
- Check if capability exists before performing operations.
- Inform system restart is needed.

.browserslistrc

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

.editorconfig

@@ -1,4 +1,4 @@
-[*.{js,jsx,ts,tsx,vue}]
+[*.{js,jsx,ts,tsx,vue,sh}]
 indent_style = space
 indent_size = 2
 end_of_line = lf

.eslintignore

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

.eslintrc.js

@@ -1,4 +1,6 @@
 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,
@@ -11,9 +13,7 @@ module.exports = {
     'plugin:vue/essential',
 
     // Extends eslint-config-airbnb
-    // Added by Vue CLI
+    '@vue/eslint-config-airbnb-with-typescript',
-    // Here until https://github.com/vuejs/eslint-config-airbnb/issues/23 is done
-    '@vue/airbnb',
 
     // Extends @typescript-eslint/recommended
     // Uses the recommended rules from the @typescript-eslint/eslint-plugin
@@ -21,7 +21,14 @@ module.exports = {
     '@vue/typescript/recommended',
   ],
   parserOptions: {
-    ecmaVersion: 'latest',
+    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(),
@@ -59,9 +66,8 @@ function getOwnRules() {
         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(),
-          '@tests/**', // @tests/.. (not matching anything after @** because there can be third parties as well)
+          'js-yaml-loader!@/**',
-          'js-yaml-loader!@/**', // E.g. js-yaml-loader!@/..
         ].map((pattern) => ({ pattern, group: 'internal' })),
       },
     ],
@@ -71,10 +77,6 @@ function getOwnRules() {
 function getTodoRules() { // Should be worked on separate future commits
   return {
     'import/no-extraneous-dependencies': 'off',
-    // Requires webpack configuration change with import '..yaml' files.
-    'import/no-webpack-loader-syntax': 'off',
-    'import/extensions': 'off',
-    'import/no-unresolved': 'off',
     // Accessibility improvements:
     'vuejs-accessibility/form-control-has-label': 'off',
     'vuejs-accessibility/click-events-have-key-events': 'off',
@@ -95,6 +97,7 @@ 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
@@ -113,3 +116,8 @@ function getOpinionatedRuleOverrides() {
     ],
   };
 }
+
+function getAliasesFromTsConfig() {
+  return Object.keys(tsconfigJson.compilerOptions.paths)
+    .map((path) => `${path}*`);
+}

.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
@@ -31,9 +31,11 @@ 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:
-  - 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

@@ -18,9 +18,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: Install dependencies
         run: npm ci
@@ -42,9 +40,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: Install dependencies
         run: npm ci
@@ -57,3 +53,23 @@ jobs:
         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

@@ -19,9 +19,7 @@ jobs:
       - 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

@@ -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

.github/workflows/release.desktop.yaml

@@ -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

.github/workflows/release.site.yaml

@@ -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

@@ -17,9 +17,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: Install dependencies
         run: npm ci

.github/workflows/tests.integration.yaml

@@ -19,9 +19,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: Install dependencies
         run: npm ci

.github/workflows/tests.unit.yaml

@@ -16,10 +16,8 @@ jobs:
         name: Checkout
         uses: actions/checkout@v2
       -
-        name: Setup node
+        name: Set-up node
-        uses: actions/setup-node@v1
+        uses: ./.github/actions/setup-node
-        with:
-          node-version: 15.x
       -
         name: Install dependencies
         run: npm ci

.gitignore

@@ -1,7 +1,8 @@
 node_modules
 dist/
 .vs
-.vscode
+.vscode/**/*
+!.vscode/extensions.json
 #Electron-builder output
 /dist_electron
 # Cypress

.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,84 @@
 # 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)

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.
+2. If you've added code that requires testing, add tests. See [tests.md](./docs/tests.md).
-  3. If you've changed APIs, update the documentation.
+3. If you've done a major change, update the documentation. See [docs/](./docs/).
-  4. Ensure the test suite passes.
+4. Ensure the test suite passes. See [development.md | Testing](./docs/development.md#testing) for commands.
-  5. Make sure your code lints.
+5. Make sure your code lints.See [development.md | Linting](./docs/development.md#linting) for commands.
 6. Issue that pull request!
-- 🙏 DO
+
-  - Document your changes in the pull request
+**🙏 DO:**
-- ❗ DON'T
+
-  - 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,9 +1,15 @@
-# 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 🍑🍆
 
 <!-- markdownlint-disable MD033 -->
 <p align="center">
+  <a href="https://undergroundwires.dev/donate?project=privacy.sexy">
+    <img
+      alt="donation badge"
+      src="https://undergroundwires.dev/img/badges/donate/flat.svg"
+    />
+  </a>
   <a href="https://github.com/undergroundwires/privacy.sexy/blob/master/CONTRIBUTING.md">
     <img
       alt="contributions are welcome"
@@ -97,79 +103,39 @@
 
 ## 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.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) or [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.11.2/privacy.sexy-0.11.2.AppImage).
+
-  - 💡 Single click to execute your script.
+Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
-- ❗ Come back regularly to apply latest version for stronger privacy and security.
+
+💡 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.
 
 [![privacy.sexy application](img/screenshot.png?raw=true )](https://privacy.sexy)
 
-## Why
+## Features
 
-- Rich tweak pool to harden security & privacy of the OS and other software on it
+- **Rich**: Hundreds of scripts that aims to give you control of your data.
-- Free (both free as in beer and free as in speech)
+- **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
+- **Transparent**. Have full visibility into what the tweaks do as you enable them.
-- Have full visibility into what the tweaks do as you enable them
+- **Reversible**. Revert if something feels wrong.
-- Ability to revert (undo) applied scripts
+- **Accessible**. No need to run any compiled software on your computer with web version.
-- Everything is transparent: both application and its infrastructure are open-source and automated
+- **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).
-- Easily extendable with [own powerful templating language](./docs/templating.md)
+- **Tested**. A lot of tests. Automated and manual. Community-testing and verification. Stability improvements comes before new features.
-- Each script is independently executable without cross-dependencies
+- **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.
 
-## Extend scripts
+## Support
 
-- You can either [create an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose)
+**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).
-- Or send a PR:
-  1. Fork the repository
-  2. Add more scripts in respective script collection in [collections](src/application/collections/) folder.
-     - 📖 If you're unsure about the syntax you can refer to the [collection files | documentation](docs/collection-files.md).
-     - 🙏 For any new script, please add `revertCode` and `docs` values if possible.
-  3. Send a pull request 👌
 
-## Commands
+**Star 🤩**. Feel free to give it a star ⭐ .
 
-- Project setup: `npm install`
+**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).
-- 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`
-  - 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.2 .`
-    2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy-0.11.2 undergroundwires/privacy.sexy:0.11.2`
 
-## Architecture overview
+## Development
 
-### Application
+Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
 
-- Powered by **TypeScript**, **Vue.js** and **Electron** 💪
+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.
-  - 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)
+[docs/](./docs/) folder includes all other documentation.
-
-### AWS Infrastructure
-
-[![AWS solution](img/architecture/aws-solution.png)](https://github.com/undergroundwires/aws-static-site-with-cd)
-
-- 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.
-- 📖 Read more on [CI/CD pipelines](./docs/ci-cd.md)
-
-[![CI/CD to AWS with GitHub Actions](img/architecture/gitops.png)](.github/workflows/)

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,14 @@
+import { defineConfig } from 'cypress'
+
+export default defineConfig({
+  fixturesFolder: 'tests/e2e/fixtures',
+  screenshotsFolder: 'tests/e2e/screenshots',
+  videosFolder: 'tests/e2e/videos',
+  e2e: {
+    setupNodeEvents(on, config) {
+      return require('./tests/e2e/plugins/index.js')(on, config)
+    },
+    specPattern: 'tests/e2e/specs/**/*.cy.{js,jsx,ts,tsx}',
+    supportFile: 'tests/e2e/support/index.js',
+  },
+});

cypress.json

@@ -1,3 +0,0 @@
-{
-  "pluginsFile": "tests/e2e/plugins/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
+
+Application layer parses the application data to compile the domain object [`Application.ts`](./../src/domain/Application.ts).
+
+A webpack loader loads (or injects) application data ([collection yaml files](./../src/application/collections/)) into the application layer in compile time. Application layer ([`ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts)) parses and compiles this data in runtime.
+
+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:
 
-- Parsing the application files includes compiling scripts using [collection file defined functions](./collection-files.md#function)
-- 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.
-  2. Register your in [CompositeExpressionParser](./../src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts)
+2. Register your in [CompositeExpressionParser](./../src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts).

docs/architecture.md

@@ -0,0 +1,66 @@
+# 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.
+
+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 ([`redux`](https://redux.js.org/)) or flux-like ([`vuex`](https://vuex.vuejs.org/)) patterns. Flux component "view" is [presentation layer](./presentation.md) in Vue. Flux functions "dispatcher", "store" and "action creation" functions lie in the [application layer](./application.md). A difference is that application state in privacy.sexy is mutable and lies in single flux "store" that holds app state and logic. The "actions" mutate the state directly which in turns act as dispatcher to notify its own event subscriptions (callbacks).
+
+## 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

@@ -1,10 +1,26 @@
-# Pipelines
+# CI/CD overview
 
-Pipelines are found under [`.github/workflows`](./../.github/workflows).
+## 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
 
-They are categorized based on their type:
+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.
@@ -12,8 +28,18 @@ They are categorized based on their type:
 
 ## Naming conventions
 
-Pipeline files are named using: **`<type>.<name>.yaml`**.
+Convention for naming pipeline files: **`<type>.<name>.yaml`**.
 
-**`type`**: Sub-folders do not work for GitHub workflows so that's why `<type>.` prefix is used. See also [pipeline types](#pipeline-types).
+**`type`**:
 
-**`name`**: Pipeline themselves are named using kebab case. It allows for easier URL references for their status badges. E.g. file name `tests.unit.yaml`, pipeline name: `name: unit-tests`
+- 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,53 +1,67 @@
 # Presentation layer
 
-- Consists of Vue.js components and other UI-related code.
+Presentation layer consists of UI-related code. It uses Vue.js as JavaScript framework and includes Vue.js components. It also includes [Electron](https://www.electronjs.org/) to provide functionality to desktop application.
-- 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's designed event-driven from bottom to top. It listens user events (from top) and state events (from bottom) to update state or the GUI.
+
+📖 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.
+  - [**`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.js`**](./../vue.config.js): 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.js`**](./../postcss.config.js): 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.js`**](./../babel.config.js): 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 [ApplicationFactory](./../src/application/ApplicationFactory.ts) singleton 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).
+Inheritance of a Vue components marks whether it uses application state . Components that does not handle application state extends `Vue`. Stateful components mutate or/and react to state changes (such as user selection or search queries) in [ApplicationContext](./../src/application/Context/ApplicationContext.ts) extend [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) class to access the context / state.
-- 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)
+[`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) functions include:
-- 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.
+- Creating a singleton of the state and makes it available to presentation layer as single source of truth.
-- Do not forget to subscribe from events when component is destroyed or if needed [collection](./collection-files.md) is changed.
+- Providing virtual abstract `handleCollectionState` callback that it calls when
-  - 💡 `events` in base class [`StatefulVue`](./../src/presentation/components/Shared/StatefulVue.ts) makes lifecycling easier
+  - the Vue loads the component,
-- 📖 See [Application state | Application layer](./presentation.md#application-state) where the state is implemented using using state pattern.
+  - and also every time when state changes.
+- Providing `events` member to make lifecycling of state subscriptions events easier because it ensures that components unsubscribe from listening to state events when
+  - the component is no longer used (destroyed),
+  - an if [ApplicationContext](./../src/application/Context/ApplicationContext.ts) changes the active [collection](./collection-files.md) to a different one.
+
+📖 Refer to [architecture.md | Application State](./architecture.md#application-state) to get an overview of event handling and [application.md | Application State](./presentation.md#application-state) for deeper look into how the application layer manages state.
 
 ## Modals
 
-- [Dialog.vue](./../src/presentation/components/Shared/Dialog.vue) is a shared component that can be used to show modal windows
+[Dialog.vue](./../src/presentation/components/Shared/Dialog.vue) is a shared component that other components used to show modal windows.
-- Simply wrap the content inside of its slot and call `.show()` method on its reference.
+
-- Example:
+You can use it by wrapping the content inside of its `slot` and call `.show()` function on its reference. For example:
 
   ```html
     <Dialog ref="testDialog">
@@ -58,15 +72,15 @@
 
 ## 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,11 +65,35 @@ 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.
+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:
-- Example:
+
+```go
+  {{ with $parameterName }}Parameter value is {{ . }} here {{ end }}
+```
+
+It supports multiline text inside the block. You can have something like:
+
+```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
@@ -74,15 +108,15 @@ A function can call other functions such as:
 
 ### 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,61 +1,81 @@
 # 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)
 3. [End-to-end (E2E) tests](#e2e-tests)
-- All tests
+
-  - Uses [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/).
+Common aspects for all tests:
-  - Are written in files that includes `.spec` extension.
+
-- 💡 You can use path/module alias `@/tests` in import statements.
+- 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.
 
-### Naming
+### Unit tests structure
+
+- [`./src/`](./../src/)
+  - Includes source code that unit tests will test.
+- [`./tests/unit/`](./../tests/unit/)
+  - Includes test code.
+  - Tests follow same folder structure as [`./src/`](./../src).
+    - E.g. if system under test lies in [`./src/application/ApplicationFactory.ts`](./../src/application/ApplicationFactory.ts) then its tests would be in test would be at [`./tests/unit/application/ApplicationFactory.spec.ts`](./../tests/unit/application/ApplicationFactory.spec.ts).
+  - [`shared/`](./../tests/unit/shared/)
+    - Includes common functionality that's shared across unit tests.
+    - [`Assertions/`](./../tests/unit/shared/Assertions):
+      - Common assertions that extend [Chai Assertion Library](https://www.chaijs.com/).
+      - Asserting functions should start with `expect` prefix.
+    - [`TestCases/`](./../tests/unit/shared/TestCases/)
+      - Shared test cases.
+      - Functions that calls `it()` from [Mocha test framework](https://mochajs.org/) should have `it` prefix.
+        - E.g. `itEachAbsentCollectionValue()`.
+    - [`Stubs/`](./../tests/unit/shared/Stubs)
+      - Includes stubs to be able to test components in isolation.
+      - Stubs have minimal and dummy behavior to be functional, they may also have spying or mocking functions.
+
+### Unit tests naming
 
 - Each test suite first describe the system under test.
-  - E.g. tests for class `Application` is categorized under `Application`.
+  - E.g. tests for class `Application.ts` are all inside `Application.spec.ts`.
-- Tests for specific methods are categorized under method name (if applicable).
+- `describe` blocks tests for same function (if applicable).
-  - E.g. test for `run()` is categorized under `run`.
+  - E.g. test for `run()` are inside `describe('run', () => ..)`.
 
 ### Act, arrange, assert
 
 - 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`.
 - **Act**
-  - Should cover the main thing to be tested.
+  - Executes the actual test.
   - Starts with comment line `// act`.
 - **Assert**
-  - Should elicit some sort of response.
+  - Elicit some sort of expectation.
   - 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).
 - 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.
-- E2E tests are configured by vue plugin [`e2e-cypress`](https://github.com/vuejs/vue-cli/tree/dev/packages/@vue/cli-plugin-e2e-cypress#readme) for Vue CLI.
+- Vue CLI plugin  [`e2e-cypress`](https://github.com/vuejs/vue-cli/tree/dev/packages/@vue/cli-plugin-e2e-cypress#readme) configures E2E tests.
-- Names and folders are structured logically based on tests.
+- Test names and folders have logical structure based on tests executed.
 - The structure is following:
-  - [`cypress.json`](./../cypress.json): Cypress configuration file.
+  - [`cypress.config.ts`](./../cypress.config.ts): Cypress configuration file.
   - [`./tests/e2e/`](./../tests/e2e/): Base Cypress folder.
-    - [`/specs/`](./../tests/e2e/specs/): Test files, test are named with `.spec.js` extension.
+    - [`/specs/`](./../tests/e2e/specs/): Test files named with `.spec.js` extension.
-    - [`/plugins/index.js`](./../tests/e2e/plugins/index.js): Plugin file executed before project is loaded.
+    - [`/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,8 +1,9 @@
 {
   "name": "privacy.sexy",
-  "version": "0.11.2",
+  "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",
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -10,83 +11,98 @@
     "test:unit": "vue-cli-service test:unit",
     "test:e2e": "vue-cli-service test:e2e",
     "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:eslint": "vue-cli-service lint --no-fix --mode production",
     "lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
     "postinstall": "electron-builder install-app-deps",
     "postuninstall": "electron-builder install-app-deps",
     "test:integration": "vue-cli-service test:unit \"tests/integration/**/*.spec.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",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@types/mocha": "^10.0.1",
-    "@typescript-eslint/parser": "^5.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@vue/cli-plugin-babel": "~5.0.0-rc.1",
+    "@typescript-eslint/parser": "^5.62.0",
-    "@vue/cli-plugin-e2e-cypress": "~5.0.0-rc.1",
+    "@vue/cli-plugin-babel": "~5.0.8",
-    "@vue/cli-plugin-eslint": "~5.0.0-rc.1",
+    "@vue/cli-plugin-e2e-cypress": "~5.0.8",
-    "@vue/cli-plugin-typescript": "~5.0.0-rc.1",
+    "@vue/cli-plugin-eslint": "~5.0.8",
-    "@vue/cli-plugin-unit-mocha": "~5.0.0-rc.1",
+    "@vue/cli-plugin-typescript": "~5.0.8",
-    "@vue/cli-service": "~5.0.0-rc.1",
+    "@vue/cli-plugin-unit-mocha": "~5.0.8",
-    "@vue/eslint-config-airbnb": "^6.0.0",
+    "@vue/cli-service": "~5.0.8",
-    "@vue/eslint-config-typescript": "^9.1.0",
+    "@vue/eslint-config-airbnb-with-typescript": "^7.0.0",
-    "@vue/test-utils": "1.2.2",
+    "@vue/eslint-config-typescript": "^11.0.3",
-    "chai": "^4.3.4",
+    "chai": "^4.3.7",
-    "cypress": "^8.3.0",
+    "cypress": "^12.17.2",
-    "electron": "^15.3.0",
+    "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",
-    "eslint": "^7.32.0",
+    "electron-updater": "^6.1.4",
-    "eslint-plugin-import": "^2.25.3",
+    "eslint": "^8.46.0",
-    "eslint-plugin-vue": "^8.0.3",
+    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-vuejs-accessibility": "^1.1.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",
-    "ts-loader": "9.0.1",
+    "svgexport": "^0.4.2",
-    "tslib": "^2.3.1",
+    "ts-loader": "^9.4.4",
-    "typescript": "^4.4.4",
+    "typescript": "~4.6.2",
-    "vue-cli-plugin-electron-builder": "^2.1.1",
+    "vue-cli-plugin-electron-builder": "^3.0.0-alpha.4",
-    "vue-template-compiler": "^2.6.14",
+    "yaml-lint": "^1.7.0",
-    "yaml-lint": "^1.2.4"
+    "tslib": "~2.4.0"
+  },
+  "overrides": {
+    "vue-cli-plugin-electron-builder": {
+      "electron-builder": "^24.6.3"
+    }
   },
   "//devDependencies": {
-    "ts-loader": "Here as workaround for vue-cli-plugin-electron-builder using older webpack 4"
+    "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": {

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,17 +3,17 @@ 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);
 
   private readonly getter: AsyncLazy<IApplication>;
 
-  protected constructor(costlyGetter: ApplicationGetter) {
+  protected constructor(costlyGetter: ApplicationGetterType) {
     if (!costlyGetter) {
-      throw new Error('undefined getter');
+      throw new Error('missing getter');
     }
     this.getter = new AsyncLazy<IApplication>(() => Promise.resolve(costlyGetter()));
   }

src/application/Common/Array.ts

@@ -1,7 +1,7 @@
 // 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 sortedArray2 = sort(array2);
   return sequenceEqual(sortedArray1, sortedArray2);
@@ -12,8 +12,8 @@ export function scrambledEqual<T>(array1: readonly T[], array2: readonly T[]) {
 
 // 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) {
     return false;
   }

src/application/Common/Enum.ts

@@ -21,7 +21,7 @@ function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
   enumVariable: EnumVariable<T, TEnumValue>,
 ): TEnumValue {
   if (!value) {
-    throw new Error(`undefined ${enumName}`);
+    throw new Error(`missing ${enumName}`);
   }
   if (typeof value !== 'string') {
     throw new Error(`unexpected type of ${enumName}: "${typeof value}"`);
@@ -54,8 +54,8 @@ export function assertInRange<T extends EnumType, TEnumValue extends EnumType>(
   value: TEnumValue,
   enumVariable: EnumVariable<T, TEnumValue>,
 ) {
-  if (value === undefined) {
+  if (value === undefined || value === null) {
-    throw new Error('undefined enum value');
+    throw new Error('absent enum value');
   }
   if (!(value in enumVariable)) {
     throw new RangeError(`enum value "${value}" is out of range`);

src/application/Common/ScriptingLanguage/ScriptingLanguageFactory.ts

@@ -20,7 +20,7 @@ export abstract class ScriptingLanguageFactory<T> implements IScriptingLanguageF
   protected registerGetter(language: ScriptingLanguage, getter: Getter<T>) {
     assertInRange(language, ScriptingLanguage);
     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`);

src/application/Context/ApplicationContext.ts

@@ -27,12 +27,12 @@ export class ApplicationContext implements IApplicationContext {
     initialContext: OperatingSystem,
   ) {
     validateApp(app);
-    assertInRange(initialContext, OperatingSystem);
     this.states = initializeStates(app);
     this.changeContext(initialContext);
   }
 
   public changeContext(os: OperatingSystem): void {
+    assertInRange(os, OperatingSystem);
     if (this.currentOs === os) {
       return;
     }
@@ -51,7 +51,7 @@ export class ApplicationContext implements IApplicationContext {
 
 function validateApp(app: IApplication) {
   if (!app) {
-    throw new Error('undefined app');
+    throw new Error('missing app');
   }
 }
 

src/application/Context/ApplicationContextFactory.ts

@@ -11,8 +11,8 @@ export async function buildContext(
   factory: IApplicationFactory = ApplicationFactory.Current,
   environment = Environment.CurrentEnvironment,
 ): Promise<IApplicationContext> {
-  if (!factory) { throw new Error('undefined factory'); }
+  if (!factory) { throw new Error('missing factory'); }
-  if (!environment) { throw new Error('undefined environment'); }
+  if (!environment) { throw new Error('missing environment'); }
   const app = await factory.getApp();
   const os = getInitialOs(app, environment);
   return new ApplicationContext(app, os);

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

@@ -21,9 +21,9 @@ export class ApplicationCode implements IApplicationCode {
     private readonly scriptingDefinition: IScriptingDefinition,
     private readonly generator: IUserScriptGenerator = new UserScriptGenerator(),
   ) {
-    if (!userSelection) { throw new Error('userSelection is null or undefined'); }
+    if (!userSelection) { throw new Error('missing userSelection'); }
-    if (!scriptingDefinition) { throw new Error('scriptingDefinition is null or undefined'); }
+    if (!scriptingDefinition) { throw new Error('missing scriptingDefinition'); }
-    if (!generator) { throw new Error('generator is null or undefined'); }
+    if (!generator) { throw new Error('missing generator'); }
     this.setCode(userSelection.selectedScripts);
     userSelection.changed.on((scripts) => {
       this.setCode(scripts);

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

@@ -1,6 +1,5 @@
 import { ICodeBuilder } from './ICodeBuilder';
 
-const NewLine = '\n';
 const TotalFunctionSeparatorChars = 58;
 
 export abstract class CodeBuilder implements ICodeBuilder {
@@ -59,10 +58,12 @@ export abstract class CodeBuilder implements ICodeBuilder {
   }
 
   public toString(): string {
-    return this.lines.join(NewLine);
+    return this.lines.join(this.getNewLineTerminator());
   }
 
   protected abstract getCommentDelimiter(): string;
 
   protected abstract writeStandardOut(text: string): string;
+
+  protected abstract getNewLineTerminator(): string;
 }

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

@@ -8,6 +8,10 @@ export class BatchBuilder extends CodeBuilder {
   protected writeStandardOut(text: string): string {
     return `echo ${escapeForEcho(text)}`;
   }
+
+  protected getNewLineTerminator(): string {
+    return '\r\n';
+  }
 }
 
 function escapeForEcho(text: string) {

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

@@ -8,6 +8,10 @@ export class ShellBuilder extends CodeBuilder {
   protected writeStandardOut(text: string): string {
     return `echo '${escapeForEcho(text)}'`;
   }
+
+  protected getNewLineTerminator(): string {
+    return '\n';
+  }
 }
 
 function escapeForEcho(text: string) {

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

@@ -17,8 +17,8 @@ export class UserScriptGenerator implements IUserScriptGenerator {
     selectedScripts: ReadonlyArray<SelectedScript>,
     scriptingDefinition: IScriptingDefinition,
   ): IUserScript {
-    if (!selectedScripts) { throw new Error('undefined scripts'); }
+    if (!selectedScripts) { throw new Error('missing scripts'); }
-    if (!scriptingDefinition) { throw new Error('undefined definition'); }
+    if (!scriptingDefinition) { throw new Error('missing definition'); }
     if (!selectedScripts.length) {
       return { code: '', scriptPositions: new Map<SelectedScript, ICodePosition>() };
     }

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

@@ -109,6 +109,9 @@ export class UserSelection implements IUserSelection {
       .getAllScripts()
       .filter((script) => !this.scripts.exists(script.id))
       .map((script) => new SelectedScript(script, false));
+    if (scriptsToSelect.length === 0) {
+      return;
+    }
     for (const script of scriptsToSelect) {
       this.scripts.addItem(script);
     }
@@ -116,6 +119,9 @@ export class UserSelection implements IUserSelection {
   }
 
   public deselectAll(): void {
+    if (this.scripts.length === 0) {
+      return;
+    }
     const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
     for (const scriptId of selectedScriptIds) {
       this.scripts.removeItem(scriptId);
@@ -127,20 +133,35 @@ export class UserSelection implements IUserSelection {
     if (!scripts || scripts.length === 0) {
       throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
     }
-    // Unselect from selected scripts
+    let totalChanged = 0;
-    if (this.scripts.length !== 0) {
+    totalChanged += this.unselectMissingWithoutNotifying(scripts);
-      this.scripts.getItems()
+    totalChanged += this.selectNewWithoutNotifying(scripts);
-        .filter((existing) => !scripts.some((script) => existing.id === script.id))
+    if (totalChanged > 0) {
-        .map((script) => script.id)
-        .forEach((scriptId) => this.scripts.removeItem(scriptId));
-    }
-    // Select from unselected scripts
-    const unselectedScripts = scripts
-      .filter((script) => !this.scripts.exists(script.id))
-      .map((script) => new SelectedScript(script, false));
-    for (const toSelect of unselectedScripts) {
-      this.scripts.addItem(toSelect);
-    }
       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/DetectorBuilder.ts

@@ -27,7 +27,7 @@ export class DetectorBuilder {
 
   private detect(userAgent: string): OperatingSystem {
     if (!userAgent) {
-      throw new Error('User agent is null or undefined');
+      throw new Error('missing userAgent');
     }
     if (this.existingPartsInUserAgent.some((part) => !userAgent.includes(part))) {
       return undefined;

src/application/Parser/ApplicationParser.ts

@@ -1,9 +1,10 @@
-import { CollectionData } from 'js-yaml-loader!@/*';
+import type { CollectionData } from '@/application/collections/';
 import { IApplication } from '@/domain/IApplication';
 import { IProjectInformation } from '@/domain/IProjectInformation';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
-import WindowsData from 'js-yaml-loader!@/application/collections/windows.yaml';
+import WindowsData from '@/application/collections/windows.yaml';
-import MacOsData from 'js-yaml-loader!@/application/collections/macos.yaml';
+import MacOsData from '@/application/collections/macos.yaml';
+import LinuxData from '@/application/collections/linux.yaml';
 import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
 import { Application } from '@/domain/Application';
 import { parseCategoryCollection } from './CategoryCollectionParser';
@@ -28,14 +29,14 @@ const CategoryCollectionParser: CategoryCollectionParserType = (file, info) => {
 };
 
 const PreParsedCollections: readonly CollectionData [] = [
-  WindowsData, MacOsData,
+  WindowsData, MacOsData, LinuxData,
 ];
 
 function validateCollectionsData(collections: readonly CollectionData[]) {
-  if (!collections.length) {
+  if (!collections || !collections.length) {
-    throw new Error('no collection provided');
+    throw new Error('missing collections');
   }
   if (collections.some((collection) => !collection)) {
-    throw new Error('undefined collection provided');
+    throw new Error('missing collection provided');
   }
 }

src/application/Parser/CategoryCollectionParser.ts

@@ -1,4 +1,4 @@
-import { CollectionData } from 'js-yaml-loader!@/*';
+import type { CollectionData } from '@/application/collections/';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { CategoryCollection } from '@/domain/CategoryCollection';
@@ -29,7 +29,7 @@ export function parseCategoryCollection(
 
 function validate(content: CollectionData): void {
   if (!content) {
-    throw new Error('content is null or undefined');
+    throw new Error('missing content');
   }
   if (!content.actions || content.actions.length <= 0) {
     throw new Error('content does not define any action');

src/application/Parser/CategoryParser.ts

@@ -1,9 +1,11 @@
-import {
+import type {
   CategoryData, ScriptData, CategoryOrScriptData, InstructionHolder,
-} from 'js-yaml-loader!@/*';
+} from '@/application/collections/';
 import { Script } from '@/domain/Script';
 import { Category } from '@/domain/Category';
-import { parseDocUrls } from './DocumentationParser';
+import { NodeValidator } from '@/application/Parser/NodeValidation/NodeValidator';
+import { NodeType } from '@/application/Parser/NodeValidation/NodeType';
+import { parseDocs } from './DocumentationParser';
 import { ICategoryCollectionParseContext } from './Script/ICategoryCollectionParseContext';
 import { parseScript } from './Script/ScriptParser';
 
@@ -12,35 +14,67 @@ let categoryIdCounter = 0;
 export function parseCategory(
   category: CategoryData,
   context: ICategoryCollectionParseContext,
+  factory: CategoryFactoryType = CategoryFactory,
 ): Category {
-  if (!context) { throw new Error('undefined context'); }
+  if (!context) { throw new Error('missing context'); }
-  ensureValid(category);
+  return parseCategoryRecursively({
+    categoryData: category,
+    context,
+    factory,
+  });
+}
+
+interface ICategoryParseContext {
+  readonly categoryData: CategoryData,
+  readonly context: ICategoryCollectionParseContext,
+  readonly factory: CategoryFactoryType,
+  readonly parentCategory?: CategoryData,
+}
+// eslint-disable-next-line consistent-return
+function parseCategoryRecursively(context: ICategoryParseContext): Category {
+  ensureValidCategory(context.categoryData, context.parentCategory);
   const children: ICategoryChildren = {
     subCategories: new Array<Category>(),
     subScripts: new Array<Script>(),
   };
-  for (const data of category.children) {
+  for (const data of context.categoryData.children) {
-    parseCategoryChild(data, children, category, context);
+    parseNode({
+      nodeData: data,
+      children,
+      parent: context.categoryData,
+      factory: context.factory,
+      context: context.context,
+    });
   }
-  return new Category(
+  try {
+    return context.factory(
       /* id: */ categoryIdCounter++,
-    /* name: */ category.category,
+      /* name: */ context.categoryData.category,
-    /* docs: */ parseDocUrls(category),
+      /* docs: */ parseDocs(context.categoryData),
       /* categories: */ children.subCategories,
       /* scripts: */ children.subScripts,
     );
+  } catch (err) {
+    new NodeValidator({
+      type: NodeType.Category,
+      selfNode: context.categoryData,
+      parentNode: context.parentCategory,
+    }).throw(err.message);
+  }
 }
 
-function ensureValid(category: CategoryData) {
+function ensureValidCategory(category: CategoryData, parentCategory?: CategoryData) {
-  if (!category) {
+  new NodeValidator({
-    throw Error('category is null or undefined');
+    type: NodeType.Category,
-  }
+    selfNode: category,
-  if (!category.children || category.children.length === 0) {
+    parentNode: parentCategory,
-    throw Error(`category has no children: "${category.category}"`);
+  })
-  }
+    .assertDefined(category)
-  if (!category.category || category.category.length === 0) {
+    .assertValidName(category.category)
-    throw Error('category has no name');
+    .assert(
-  }
+      () => category.children && category.children.length > 0,
+      `"${category.category}" has no children.`,
+    );
 }
 
 interface ICategoryChildren {
@@ -48,22 +82,29 @@ interface ICategoryChildren {
   subScripts: Script[];
 }
 
-function parseCategoryChild(
+interface INodeParseContext {
-  data: CategoryOrScriptData,
+  readonly nodeData: CategoryOrScriptData;
-  children: ICategoryChildren,
+  readonly children: ICategoryChildren;
-  parent: CategoryData,
+  readonly parent: CategoryData;
-  context: ICategoryCollectionParseContext,
+  readonly factory: CategoryFactoryType;
-) {
+  readonly context: ICategoryCollectionParseContext;
-  if (isCategory(data)) {
+}
-    const subCategory = parseCategory(data as CategoryData, context);
+function parseNode(context: INodeParseContext) {
-    children.subCategories.push(subCategory);
+  const validator = new NodeValidator({ selfNode: context.nodeData, parentNode: context.parent });
-  } else if (isScript(data)) {
+  validator.assertDefined(context.nodeData);
-    const scriptData = data as ScriptData;
+  if (isCategory(context.nodeData)) {
-    const script = parseScript(scriptData, context);
+    const subCategory = parseCategoryRecursively({
-    children.subScripts.push(script);
+      categoryData: context.nodeData as CategoryData,
+      context: context.context,
+      factory: context.factory,
+      parentCategory: context.parent,
+    });
+    context.children.subCategories.push(subCategory);
+  } else if (isScript(context.nodeData)) {
+    const script = parseScript(context.nodeData as ScriptData, context.context);
+    context.children.subScripts.push(script);
   } else {
-    throw new Error(`Child element is neither a category or a script.
+    validator.throw('Node is neither a category or a script.');
-                Parent: ${parent.category}, element: ${JSON.stringify(data)}`);
   }
 }
 
@@ -73,14 +114,22 @@ function isScript(data: CategoryOrScriptData): data is ScriptData {
 }
 
 function isCategory(data: CategoryOrScriptData): data is CategoryData {
-  const { category } = data as CategoryData;
+  return hasProperty(data, 'category');
-  return category && category.length > 0;
 }
 
-function hasCode(holder: InstructionHolder): boolean {
+function hasCode(data: InstructionHolder): boolean {
-  return holder.code && holder.code.length > 0;
+  return hasProperty(data, 'code');
 }
 
-function hasCall(holder: InstructionHolder) {
+function hasCall(data: InstructionHolder) {
-  return holder.call !== undefined;
+  return hasProperty(data, 'call');
 }
+
+function hasProperty(object: unknown, propertyName: string) {
+  return Object.prototype.hasOwnProperty.call(object, propertyName);
+}
+
+export type CategoryFactoryType = (
+  ...parameters: ConstructorParameters<typeof Category>) => Category;
+
+const CategoryFactory: CategoryFactoryType = (...parameters) => new Category(...parameters);

src/application/Parser/DocumentationParser.ts

@@ -1,64 +1,58 @@
-import { DocumentableData, DocumentationUrlsData } from 'js-yaml-loader!@/*';
+import type { DocumentableData, DocumentationData } from '@/application/collections/';
 
-export function parseDocUrls(documentable: DocumentableData): ReadonlyArray<string> {
+export function parseDocs(documentable: DocumentableData): readonly string[] {
   if (!documentable) {
-    throw new Error('documentable is null or undefined');
+    throw new Error('missing documentable');
   }
   const { docs } = documentable;
-  if (!docs || !docs.length) {
+  if (!docs) {
     return [];
   }
-  let result = new DocumentationUrlContainer();
+  let result = new DocumentationContainer();
   result = addDocs(docs, result);
   return result.getAll();
 }
 
 function addDocs(
-  docs: DocumentationUrlsData,
+  docs: DocumentationData,
-  urls: DocumentationUrlContainer,
+  container: DocumentationContainer,
-): DocumentationUrlContainer {
+): DocumentationContainer {
   if (docs instanceof Array) {
-    urls.addUrls(docs);
+    if (docs.length > 0) {
+      container.addParts(docs);
+    }
   } else if (typeof docs === 'string') {
-    urls.addUrl(docs);
+    container.addPart(docs);
   } else {
-    throw new Error('Docs field (documentation url) must a string or array of strings');
+    throwInvalidType();
   }
-  return urls;
+  return container;
 }
 
-class DocumentationUrlContainer {
+class DocumentationContainer {
-  private readonly urls = new Array<string>();
+  private readonly parts = new Array<string>();
 
-  public addUrl(url: string) {
+  public addPart(documentation: string) {
-    validateUrl(url);
+    if (!documentation) {
-    this.urls.push(url);
+      throw Error('missing documentation');
+    }
+    if (typeof documentation !== 'string') {
+      throwInvalidType();
+    }
+    this.parts.push(documentation);
   }
 
-  public addUrls(urls: readonly string[]) {
+  public addParts(parts: readonly string[]) {
-    for (const url of urls) {
+    for (const part of parts) {
-      if (typeof url !== 'string') {
+      this.addPart(part);
-        throw new Error('Docs field (documentation url) must be an array of strings');
-      }
-      this.addUrl(url);
     }
   }
 
   public getAll(): ReadonlyArray<string> {
-    return this.urls;
+    return this.parts;
   }
 }
 
-function validateUrl(docUrl: string): void {
+function throwInvalidType() {
-  if (!docUrl) {
+  throw new Error('docs field (documentation) must be an array of strings');
-    throw new Error('Documentation url is null or empty');
-  }
-  if (docUrl.includes('\n')) {
-    throw new Error('Documentation url cannot be multi-lined.');
-  }
-  const validUrlRegex = /(http(s)?:\/\/.)?(www\.)?[-a-zA-Z0-9@:%._+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_+.~#?&//=]*)/g;
-  const res = docUrl.match(validUrlRegex);
-  if (res == null) {
-    throw new Error(`Invalid documentation url: ${docUrl}`);
-  }
 }

src/application/Parser/NodeValidation/NodeData.ts

@@ -0,0 +1,3 @@
+import type { ScriptData, CategoryData } from '@/application/collections/';
+
+export type NodeData = CategoryData | ScriptData;

src/application/Parser/NodeValidation/NodeDataError.ts

@@ -0,0 +1,35 @@
+import { NodeType } from './NodeType';
+import { NodeData } from './NodeData';
+
+export class NodeDataError extends Error {
+  constructor(message: string, public readonly context: INodeDataErrorContext) {
+    super(createMessage(message, context));
+    Object.setPrototypeOf(this, new.target.prototype); // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-2.html#support-for-newtarget
+    this.name = new.target.name;
+  }
+}
+
+export interface INodeDataErrorContext {
+  readonly type?: NodeType;
+  readonly selfNode: NodeData;
+  readonly parentNode?: NodeData;
+}
+
+function createMessage(errorMessage: string, context: INodeDataErrorContext) {
+  let message = '';
+  if (context.type !== undefined) {
+    message += `${NodeType[context.type]}: `;
+  }
+  message += errorMessage;
+  message += `\n${dump(context)}`;
+  return message;
+}
+
+function dump(context: INodeDataErrorContext): string {
+  const printJson = (obj: unknown) => JSON.stringify(obj, undefined, 2);
+  let output = `Self: ${printJson(context.selfNode)}`;
+  if (context.parentNode) {
+    output += `\nParent: ${printJson(context.parentNode)}`;
+  }
+  return output;
+}

src/application/Parser/NodeValidation/NodeType.ts

@@ -0,0 +1,4 @@
+export enum NodeType {
+  Script,
+  Category,
+}

src/application/Parser/NodeValidation/NodeValidator.ts

@@ -0,0 +1,38 @@
+import { INodeDataErrorContext, NodeDataError } from './NodeDataError';
+import { NodeData } from './NodeData';
+
+export class NodeValidator {
+  constructor(private readonly context: INodeDataErrorContext) {
+
+  }
+
+  public assertValidName(nameValue: string) {
+    return this
+      .assert(
+        () => Boolean(nameValue),
+        'missing name',
+      )
+      .assert(
+        () => typeof nameValue === 'string',
+        `Name (${JSON.stringify(nameValue)}) is not a string but ${typeof nameValue}.`,
+      );
+  }
+
+  public assertDefined(node: NodeData) {
+    return this.assert(
+      () => node !== undefined && node !== null && Object.keys(node).length > 0,
+      'missing node data',
+    );
+  }
+
+  public assert(validationPredicate: () => boolean, errorMessage: string) {
+    if (!validationPredicate()) {
+      this.throw(errorMessage);
+    }
+    return this;
+  }
+
+  public throw(errorMessage: string) {
+    throw new NodeDataError(errorMessage, this.context);
+  }
+}

src/application/Parser/ProjectInformationParser.ts

@@ -1,13 +1,28 @@
 import { IProjectInformation } from '@/domain/IProjectInformation';
 import { ProjectInformation } from '@/domain/ProjectInformation';
+import { Version } from '@/domain/Version';
 
 export function parseProjectInformation(
-  environment: NodeJS.ProcessEnv,
+  environment: NodeJS.ProcessEnv | VueAppEnvironment,
 ): IProjectInformation {
+  const version = new Version(environment[VueAppEnvironmentKeys.VUE_APP_VERSION]);
   return new ProjectInformation(
-    environment.VUE_APP_NAME,
+    environment[VueAppEnvironmentKeys.VUE_APP_NAME],
-    environment.VUE_APP_VERSION,
+    version,
-    environment.VUE_APP_REPOSITORY_URL,
+    environment[VueAppEnvironmentKeys.VUE_APP_SLOGAN],
-    environment.VUE_APP_HOMEPAGE_URL,
+    environment[VueAppEnvironmentKeys.VUE_APP_REPOSITORY_URL],
+    environment[VueAppEnvironmentKeys.VUE_APP_HOMEPAGE_URL],
   );
 }
+
+export const VueAppEnvironmentKeys = {
+  VUE_APP_VERSION: 'VUE_APP_VERSION',
+  VUE_APP_NAME: 'VUE_APP_NAME',
+  VUE_APP_SLOGAN: 'VUE_APP_SLOGAN',
+  VUE_APP_REPOSITORY_URL: 'VUE_APP_REPOSITORY_URL',
+  VUE_APP_HOMEPAGE_URL: 'VUE_APP_HOMEPAGE_URL',
+} as const;
+
+export type VueAppEnvironment = {
+  [K in keyof typeof VueAppEnvironmentKeys]: string;
+};

src/application/Parser/Script/CategoryCollectionParseContext.ts

@@ -1,11 +1,11 @@
-import { FunctionData } from 'js-yaml-loader!@/*';
+import type { FunctionData } from '@/application/collections/';
 import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
-import { ILanguageSyntax } from '@/domain/ScriptCode';
 import { IScriptCompiler } from './Compiler/IScriptCompiler';
 import { ScriptCompiler } from './Compiler/ScriptCompiler';
 import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
-import { SyntaxFactory } from './Syntax/SyntaxFactory';
+import { SyntaxFactory } from './Validation/Syntax/SyntaxFactory';
-import { ISyntaxFactory } from './Syntax/ISyntaxFactory';
+import { ISyntaxFactory } from './Validation/Syntax/ISyntaxFactory';
+import { ILanguageSyntax } from './Validation/Syntax/ILanguageSyntax';
 
 export class CategoryCollectionParseContext implements ICategoryCollectionParseContext {
   public readonly compiler: IScriptCompiler;
@@ -17,7 +17,7 @@ export class CategoryCollectionParseContext implements ICategoryCollectionParseC
     scripting: IScriptingDefinition,
     syntaxFactory: ISyntaxFactory = new SyntaxFactory(),
   ) {
-    if (!scripting) { throw new Error('undefined scripting'); }
+    if (!scripting) { throw new Error('missing scripting'); }
     this.syntax = syntaxFactory.create(scripting.language);
     this.compiler = new ScriptCompiler(functionsData, this.syntax);
   }

src/application/Parser/Script/Compiler/Expressions/Expression/Expression.ts

@@ -8,23 +8,25 @@ import { ExpressionEvaluationContext, IExpressionEvaluationContext } from './Exp
 
 export type ExpressionEvaluator = (context: IExpressionEvaluationContext) => string;
 export class Expression implements IExpression {
+  public readonly parameters: IReadOnlyFunctionParameterCollection;
+
   constructor(
     public readonly position: ExpressionPosition,
     public readonly evaluator: ExpressionEvaluator,
-    public readonly parameters
+    parameters?: IReadOnlyFunctionParameterCollection,
-      : IReadOnlyFunctionParameterCollection = new FunctionParameterCollection(),
   ) {
     if (!position) {
-      throw new Error('undefined position');
+      throw new Error('missing position');
     }
     if (!evaluator) {
-      throw new Error('undefined evaluator');
+      throw new Error('missing evaluator');
     }
+    this.parameters = parameters ?? new FunctionParameterCollection();
   }
 
   public evaluate(context: IExpressionEvaluationContext): string {
     if (!context) {
-      throw new Error('undefined context');
+      throw new Error('missing context');
     }
     validateThatAllRequiredParametersAreSatisfied(this.parameters, context.args);
     const args = filterUnusedArguments(this.parameters, context.args);

src/application/Parser/Script/Compiler/Expressions/Expression/ExpressionEvaluationContext.ts

@@ -13,7 +13,7 @@ export class ExpressionEvaluationContext implements IExpressionEvaluationContext
     public readonly pipelineCompiler: IPipelineCompiler = new PipelineCompiler(),
   ) {
     if (!args) {
-      throw new Error('undefined args, send empty collection instead');
+      throw new Error('missing args, send empty collection instead.');
     }
   }
 }

src/application/Parser/Script/Compiler/Expressions/Expression/ExpressionPosition.ts

@@ -13,4 +13,22 @@ export class ExpressionPosition {
       throw Error(`negative start position: ${start}`);
     }
   }
+
+  public isInInsideOf(potentialParent: ExpressionPosition): boolean {
+    if (this.isSame(potentialParent)) {
+      return false;
+    }
+    return potentialParent.start <= this.start
+      && potentialParent.end >= this.end;
+  }
+
+  public isSame(other: ExpressionPosition): boolean {
+    return other.start === this.start
+      && other.end === this.end;
+  }
+
+  public isIntersecting(other: ExpressionPosition): boolean {
+    return (other.start < this.end && other.end > this.start)
+      || (this.end > other.start && other.start >= this.start);
+  }
 }

src/application/Parser/Script/Compiler/Expressions/ExpressionsCompiler.ts

@@ -15,26 +15,64 @@ export class ExpressionsCompiler implements IExpressionsCompiler {
     args: IReadOnlyFunctionCallArgumentCollection,
   ): string {
     if (!args) {
-      throw new Error('undefined args, send empty collection instead');
+      throw new Error('missing args, send empty collection instead.');
     }
     if (!code) {
       return code;
     }
-    const expressions = this.extractor.findExpressions(code);
-    ensureParamsUsedInCodeHasArgsProvided(expressions, args);
     const context = new ExpressionEvaluationContext(args);
-    const compiledCode = compileExpressions(expressions, code, context);
+    const compiledCode = compileRecursively(code, context, this.extractor);
     return compiledCode;
   }
 }
 
+function compileRecursively(
+  code: string,
+  context: IExpressionEvaluationContext,
+  extractor: IExpressionParser,
+): string {
+  /*
+    Instead of compiling code at once and returning we compile expressions from the code.
+    And recompile expressions from resulting code recursively.
+    This allows using expressions inside expressions blocks. E.g.:
+    ```
+      {{ with $condition }}
+        echo '{{ $text }}'
+      {{ end }}
+    ```
+    Without recursing parameter substitution for '{{ $text }}' is skipped once the outer
+    {{ with $condition }} is rendered.
+    A more optimized alternative to recursion would be to a parse an expression tree
+    instead of linear expression lists.
+  */
+  if (!code) {
+    return code;
+  }
+  const expressions = extractor.findExpressions(code);
+  if (expressions.length === 0) {
+    return code;
+  }
+  const compiledCode = compileExpressions(expressions, code, context);
+  return compileRecursively(compiledCode, context, extractor);
+}
+
 function compileExpressions(
   expressions: readonly IExpression[],
   code: string,
   context: IExpressionEvaluationContext,
 ) {
+  ensureValidExpressions(expressions, code, context);
   let compiledCode = '';
-  const sortedExpressions = expressions
+  const outerExpressions = expressions.filter(
+    (expression) => expressions
+      .filter((otherExpression) => otherExpression !== expression)
+      .every((otherExpression) => !expression.position.isInInsideOf(otherExpression.position)),
+  );
+  /*
+    This logic will only compile outer expressions if there were nested expressions.
+    So the output of this compilation may result in new uncompiled expressions.
+  */
+  const sortedExpressions = outerExpressions
     .slice() // copy the array to not mutate the parameter
     .sort((a, b) => b.position.start - a.position.start);
   let index = 0;
@@ -65,6 +103,43 @@ function extractRequiredParameterNames(
     .filter((name, index, array) => array.indexOf(name) === index); // Remove duplicates
 }
 
+function printList(list: readonly string[]): string {
+  return `"${list.join('", "')}"`;
+}
+
+function ensureValidExpressions(
+  expressions: readonly IExpression[],
+  code: string,
+  context: IExpressionEvaluationContext,
+) {
+  ensureParamsUsedInCodeHasArgsProvided(expressions, context.args);
+  ensureExpressionsDoesNotExtendCodeLength(expressions, code);
+  ensureNoExpressionsAtSamePosition(expressions);
+  ensureNoInvalidIntersections(expressions);
+}
+
+function ensureExpressionsDoesNotExtendCodeLength(
+  expressions: readonly IExpression[],
+  code: string,
+) {
+  const expectedMax = code.length;
+  const expressionsOutOfRange = expressions
+    .filter((expression) => expression.position.end > expectedMax);
+  if (expressionsOutOfRange.length > 0) {
+    throw new Error(`Expressions out of range:\n${JSON.stringify(expressionsOutOfRange)}`);
+  }
+}
+
+function ensureNoExpressionsAtSamePosition(expressions: readonly IExpression[]) {
+  const instructionsAtSamePosition = expressions.filter(
+    (expression) => expressions
+      .filter((other) => expression.position.isSame(other.position)).length > 1,
+  );
+  if (instructionsAtSamePosition.length > 0) {
+    throw new Error(`Instructions at same position:\n${JSON.stringify(instructionsAtSamePosition)}`);
+  }
+}
+
 function ensureParamsUsedInCodeHasArgsProvided(
   expressions: readonly IExpression[],
   providedArgs: IReadOnlyFunctionCallArgumentCollection,
@@ -80,6 +155,16 @@ function ensureParamsUsedInCodeHasArgsProvided(
   }
 }
 
-function printList(list: readonly string[]): string {
+function ensureNoInvalidIntersections(expressions: readonly IExpression[]) {
-  return `"${list.join('", "')}"`;
+  const intersectingInstructions = expressions.filter(
+    (expression) => expressions
+      .filter((other) => expression.position.isIntersecting(other.position))
+      .filter((other) => !expression.position.isSame(other.position))
+      .filter((other) => !expression.position.isInInsideOf(other.position))
+      .filter((other) => !other.position.isInInsideOf(expression.position))
+      .length > 0,
+  );
+  if (intersectingInstructions.length > 0) {
+    throw new Error(`Instructions intersecting unexpectedly:\n${JSON.stringify(intersectingInstructions)}`);
+  }
 }

src/application/Parser/Script/Compiler/Expressions/Parser/CompositeExpressionParser.ts

@@ -10,8 +10,11 @@ const Parsers = [
 
 export class CompositeExpressionParser implements IExpressionParser {
   public constructor(private readonly leafs: readonly IExpressionParser[] = Parsers) {
+    if (!leafs) {
+      throw new Error('missing leafs');
+    }
     if (leafs.some((leaf) => !leaf)) {
-      throw new Error('undefined leaf');
+      throw new Error('missing leaf');
     }
   }
 

src/application/Parser/Script/Compiler/Expressions/Parser/Regex/ExpressionRegexBuilder.ts

@@ -25,10 +25,10 @@ export class ExpressionRegexBuilder {
       .addRawRegex('([^|\\s]+)');
   }
 
-  public matchAnythingExceptSurroundingWhitespaces() {
+  public matchMultilineAnythingExceptSurroundingWhitespaces() {
     return this
       .expectZeroOrMoreWhitespaces()
-      .addRawRegex('(.+?)')
+      .addRawRegex('([\\S\\s]+?)')
       .expectZeroOrMoreWhitespaces();
   }
 

src/application/Parser/Script/Compiler/Expressions/Parser/Regex/RegexParser.ts

@@ -16,7 +16,7 @@ export abstract class RegexParser implements IExpressionParser {
 
   private* findRegexExpressions(code: string): Iterable<IExpression> {
     if (!code) {
-      throw new Error('undefined code');
+      throw new Error('missing code');
     }
     const matches = code.matchAll(this.regex);
     for (const match of matches) {

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

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

src/application/Parser/Script/Compiler/Expressions/Pipes/PipeFactory.ts

@@ -15,8 +15,11 @@ export class PipeFactory implements IPipeFactory {
   private readonly pipes = new Map<string, IPipe>();
 
   constructor(pipes: readonly IPipe[] = RegisteredPipes) {
+    if (!pipes) {
+      throw new Error('missing pipes');
+    }
     if (pipes.some((pipe) => !pipe)) {
-      throw new Error('undefined pipe in list');
+      throw new Error('missing pipe in list');
     }
     for (const pipe of pipes) {
       this.registerPipe(pipe);

src/application/Parser/Script/Compiler/Expressions/Pipes/PipelineCompiler.ts

@@ -23,8 +23,8 @@ function extractPipeNames(pipeline: string): string[] {
 }
 
 function ensureValidArguments(value: string, pipeline: string) {
-  if (!value) { throw new Error('undefined value'); }
+  if (!value) { throw new Error('missing value'); }
-  if (!pipeline) { throw new Error('undefined pipeline'); }
+  if (!pipeline) { throw new Error('missing pipeline'); }
   if (!pipeline.trimStart().startsWith('|')) {
     throw new Error('pipeline does not start with pipe');
   }

src/application/Parser/Script/Compiler/Expressions/SyntaxParsers/WithParser.ts

@@ -12,7 +12,7 @@ export class WithParser extends RegexParser {
     .matchUntilFirstWhitespace() // First match: parameter name
     .expectExpressionEnd()
   // ...
-    .matchAnythingExceptSurroundingWhitespaces() // Second match: Scope text
+    .matchMultilineAnythingExceptSurroundingWhitespaces() // Second match: Scope text
   // {{ end }}
     .expectExpressionStart()
     .expectCharacters('end')

src/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgument.ts

@@ -8,7 +8,7 @@ export class FunctionCallArgument implements IFunctionCallArgument {
   ) {
     ensureValidParameterName(parameterName);
     if (!argumentValue) {
-      throw new Error(`undefined argument value for "${parameterName}"`);
+      throw new Error(`missing argument value for "${parameterName}"`);
     }
   }
 }

src/application/Parser/Script/Compiler/Function/Call/Argument/FunctionCallArgumentCollection.ts

@@ -6,7 +6,7 @@ export class FunctionCallArgumentCollection implements IFunctionCallArgumentColl
 
   public addArgument(argument: IFunctionCallArgument): void {
     if (!argument) {
-      throw new Error('undefined argument');
+      throw new Error('missing argument');
     }
     if (this.hasArgument(argument.parameterName)) {
       throw new Error(`argument value for parameter ${argument.parameterName} is already provided`);
@@ -20,14 +20,14 @@ export class FunctionCallArgumentCollection implements IFunctionCallArgumentColl
 
   public hasArgument(parameterName: string): boolean {
     if (!parameterName) {
-      throw new Error('undefined parameter name');
+      throw new Error('missing parameter name');
     }
     return this.arguments.has(parameterName);
   }
 
   public getArgument(parameterName: string): IFunctionCallArgument {
     if (!parameterName) {
-      throw new Error('undefined parameter name');
+      throw new Error('missing parameter name');
     }
     const arg = this.arguments.get(parameterName);
     if (!arg) {

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

@@ -22,9 +22,9 @@ export class FunctionCallCompiler implements IFunctionCallCompiler {
     calls: IFunctionCall[],
     functions: ISharedFunctionCollection,
   ): ICompiledCode {
-    if (!functions) { throw new Error('undefined functions'); }
+    if (!functions) { throw new Error('missing functions'); }
-    if (!calls) { throw new Error('undefined calls'); }
+    if (!calls) { throw new Error('missing calls'); }
-    if (calls.some((f) => !f)) { throw new Error('undefined function call'); }
+    if (calls.some((f) => !f)) { throw new Error('missing function call'); }
     const context: ICompilationContext = {
       allFunctions: functions,
       callSequence: calls,
@@ -81,7 +81,7 @@ function compileCode(
   compiler: IExpressionsCompiler,
 ): ICompiledFunctionCall {
   return {
-    code: compiler.compileExpressions(code.do, args),
+    code: compiler.compileExpressions(code.execute, args),
     revertCode: compiler.compileExpressions(code.revert, args),
   };
 }

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

@@ -7,10 +7,10 @@ export class FunctionCall implements IFunctionCall {
     public readonly args: IReadOnlyFunctionCallArgumentCollection,
   ) {
     if (!functionName) {
-      throw new Error('empty function name in function call');
+      throw new Error('missing function name in function call');
     }
     if (!args) {
-      throw new Error('undefined args');
+      throw new Error('missing args');
     }
   }
 }

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

@@ -1,4 +1,4 @@
-import { FunctionCallData, FunctionCallsData, FunctionCallParametersData } from 'js-yaml-loader!@/*';
+import type { FunctionCallData, FunctionCallsData, FunctionCallParametersData } from '@/application/collections/';
 import { IFunctionCall } from './IFunctionCall';
 import { FunctionCallArgumentCollection } from './Argument/FunctionCallArgumentCollection';
 import { FunctionCallArgument } from './Argument/FunctionCallArgument';
@@ -6,7 +6,7 @@ import { FunctionCall } from './FunctionCall';
 
 export function parseFunctionCalls(calls: FunctionCallsData): IFunctionCall[] {
   if (calls === undefined) {
-    throw new Error('undefined call data');
+    throw new Error('missing call data');
   }
   const sequence = getCallSequence(calls);
   return sequence.map((call) => parseFunctionCall(call));
@@ -24,7 +24,7 @@ function getCallSequence(calls: FunctionCallsData): FunctionCallData[] {
 
 function parseFunctionCall(call: FunctionCallData): IFunctionCall {
   if (!call) {
-    throw new Error('undefined function call');
+    throw new Error('missing call data');
   }
   const callArgs = parseArgs(call.parameters);
   return new FunctionCall(call.function, callArgs);

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

@@ -19,6 +19,6 @@ export enum FunctionBodyType {
 }
 
 export interface IFunctionCode {
-  readonly do: string;
+  readonly execute: string;
   readonly revert?: string;
 }

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

@@ -1,6 +1,10 @@
-import { FunctionData } from 'js-yaml-loader!@/*';
+import type { FunctionData } from '@/application/collections/';
+import { ILanguageSyntax } from '@/application/Parser/Script/Validation/Syntax/ILanguageSyntax';
 import { ISharedFunctionCollection } from './ISharedFunctionCollection';
 
 export interface ISharedFunctionsParser {
-  parseFunctions(functions: readonly FunctionData[]): ISharedFunctionCollection;
+  parseFunctions(
+    functions: readonly FunctionData[],
+    syntax: ILanguageSyntax,
+  ): ISharedFunctionCollection;
 }

src/application/Parser/Script/Compiler/Function/Parameter/FunctionParameterCollection.ts

@@ -19,7 +19,7 @@ export class FunctionParameterCollection implements IFunctionParameterCollection
 
   private ensureValidParameter(parameter: IFunctionParameter) {
     if (!parameter) {
-      throw new Error('undefined parameter');
+      throw new Error('missing parameter');
     }
     if (this.includesName(parameter.name)) {
       throw new Error(`duplicate parameter name: "${parameter.name}"`);

src/application/Parser/Script/Compiler/Function/Shared/ParameterNameValidator.ts

@@ -1,6 +1,6 @@
 export function ensureValidParameterName(parameterName: string) {
   if (!parameterName) {
-    throw new Error('undefined parameter name');
+    throw new Error('missing parameter name');
   }
   if (!parameterName.match(/^[0-9a-zA-Z]+$/)) {
     throw new Error(`parameter name must be alphanumeric but it was "${parameterName}"`);

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

@@ -1,4 +1,5 @@
 import { IFunctionCall } from './Call/IFunctionCall';
+
 import {
   FunctionBodyType, IFunctionCode, ISharedFunction, ISharedFunctionBody,
 } from './ISharedFunction';
@@ -9,11 +10,8 @@ export function createCallerFunction(
   parameters: IReadOnlyFunctionParameterCollection,
   callSequence: readonly IFunctionCall[],
 ): ISharedFunction {
-  if (!callSequence) {
+  if (!callSequence || !callSequence.length) {
-    throw new Error(`undefined call sequence in function "${name}"`);
+    throw new Error(`missing call sequence in function "${name}"`);
-  }
-  if (!callSequence.length) {
-    throw new Error(`empty call sequence in function "${name}"`);
   }
   return new SharedFunction(name, parameters, callSequence, FunctionBodyType.Calls);
 }
@@ -28,7 +26,7 @@ export function createFunctionWithInlineCode(
     throw new Error(`undefined code in function "${name}"`);
   }
   const content: IFunctionCode = {
-    do: code,
+    execute: code,
     revert: revertCode,
   };
   return new SharedFunction(name, parameters, content, FunctionBodyType.Code);
@@ -43,8 +41,8 @@ class SharedFunction implements ISharedFunction {
     content: IFunctionCode | readonly IFunctionCall[],
     bodyType: FunctionBodyType,
   ) {
-    if (!name) { throw new Error('undefined function name'); }
+    if (!name) { throw new Error('missing function name'); }
-    if (!parameters) { throw new Error('undefined parameters'); }
+    if (!parameters) { throw new Error('missing parameters'); }
     this.body = {
       type: bodyType,
       code: bodyType === FunctionBodyType.Code ? content as IFunctionCode : undefined,

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

@@ -5,7 +5,7 @@ export class SharedFunctionCollection implements ISharedFunctionCollection {
   private readonly functionsByName = new Map<string, ISharedFunction>();
 
   public addFunction(func: ISharedFunction): void {
-    if (!func) { throw new Error('undefined function'); }
+    if (!func) { throw new Error('missing function'); }
     if (this.has(func.name)) {
       throw new Error(`function with name ${func.name} already exists`);
     }
@@ -13,7 +13,7 @@ export class SharedFunctionCollection implements ISharedFunctionCollection {
   }
 
   public getFunctionByName(name: string): ISharedFunction {
-    if (!name) { throw Error('undefined function name'); }
+    if (!name) { throw Error('missing function name'); }
     const func = this.functionsByName.get(name);
     if (!func) {
       throw new Error(`called function is not defined "${name}"`);