Compare commits
177 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c318bd301a | ||
|
|
86a2b2fda0 | ||
|
|
8a8b7319d5 | ||
|
|
2428de23ee | ||
|
|
7ec889e759 | ||
|
|
9d009c40dd | ||
|
|
663d63bde0 | ||
|
|
6b83dcbf8f | ||
|
|
72e925fb6f | ||
|
|
c299e95bc6 | ||
|
|
2e40605d59 | ||
|
|
3455a2ca6c | ||
|
|
6fe858d86a | ||
|
|
7cc161c828 | ||
|
|
e14bf2bfa0 | ||
|
|
34672414c3 | ||
|
|
f7557bcc0f | ||
|
|
e4b6cdfb18 | ||
|
|
8cd3352017 | ||
|
|
c4ec6a1445 | ||
|
|
b3117c27f2 | ||
|
|
54ba4dbb0b | ||
|
|
a744415eb2 | ||
|
|
55f936fee9 | ||
|
|
d9e44e2574 | ||
|
|
52d4313156 | ||
|
|
c2b531e968 | ||
|
|
ab7d617886 | ||
|
|
b247b12c3f | ||
|
|
c26bc209eb | ||
|
|
ad1872e7cd | ||
|
|
29c7704e0b | ||
|
|
e41e40c5bf | ||
|
|
31e08d231d | ||
|
|
45b8dd972b | ||
|
|
4e72673373 | ||
|
|
92c3dd9232 | ||
|
|
2c5ab3ea7d | ||
|
|
ffa279f3df | ||
|
|
89dddfbb23 | ||
|
|
cfedcd724c | ||
|
|
fd28eaad06 | ||
|
|
8ce06facbd | ||
|
|
1a9db31c77 | ||
|
|
ac70b063b8 | ||
|
|
d0019c2c9b | ||
|
|
4c68408f1e | ||
|
|
1072505219 | ||
|
|
07fc555324 | ||
|
|
50fb29038a | ||
|
|
3785c623f8 | ||
|
|
14be3017c5 | ||
|
|
978bab0b81 | ||
|
|
d9d7f62d81 | ||
|
|
11e0613165 | ||
|
|
77c3d2bbb8 | ||
|
|
784a67afff | ||
|
|
19a092dd31 | ||
|
|
4c2f74949b | ||
|
|
a3fc3782ef | ||
|
|
cdc93f032a | ||
|
|
7dd15ed064 | ||
|
|
d169434157 | ||
|
|
6efed72bf2 | ||
|
|
15db311801 | ||
|
|
82d509129b | ||
|
|
939d838e35 | ||
|
|
6de4ce58c4 | ||
|
|
ee66196d9a | ||
|
|
3c13a9e837 | ||
|
|
22b23a9ece | ||
|
|
4ae385b7fc | ||
|
|
d9abc7f0b2 | ||
|
|
1f19b2528a | ||
|
|
1f11c39773 | ||
|
|
b6ccb5927a | ||
|
|
1d465ee318 | ||
|
|
3ab48b1cf5 | ||
|
|
de4ac978bd | ||
|
|
8df5faf4ef | ||
|
|
99a2035fdb | ||
|
|
a0d61728ea | ||
|
|
312bf6102c | ||
|
|
f4885b6f1c | ||
|
|
ca63a0979e | ||
|
|
1f266c3353 | ||
|
|
c7b2a70312 | ||
|
|
255133af4d | ||
|
|
db74531cd4 | ||
|
|
f36d8bfc78 | ||
|
|
3b31ace726 | ||
|
|
6badfef9da | ||
|
|
8c38dd73d8 | ||
|
|
b8682a852a | ||
|
|
8c17929151 | ||
|
|
bb92c9ec28 | ||
|
|
b4aacea2a3 | ||
|
|
8bbe6ebf75 | ||
|
|
a23d28f2cf | ||
|
|
f51e8859ee | ||
|
|
d235dee955 | ||
|
|
2afef4ea3d | ||
|
|
f709d6a566 | ||
|
|
532915b95d | ||
|
|
456e40bedf | ||
|
|
018b7e270f | ||
|
|
f8b8b4c97a | ||
|
|
978d7d0863 | ||
|
|
594a14d6ca | ||
|
|
c628aa9aef | ||
|
|
3060ebf79c | ||
|
|
1a34c7374b | ||
|
|
c262681011 | ||
|
|
f8ba5c46e4 | ||
|
|
b789250cb8 | ||
|
|
5df458739d | ||
|
|
d6fa9a2a03 | ||
|
|
ec15af01dd | ||
|
|
7073336f81 | ||
|
|
3d3380f27e | ||
|
|
c69998c7cb | ||
|
|
1663bfeac7 | ||
|
|
afc3bfb3b8 | ||
|
|
b6bfc25727 | ||
|
|
7fac0fe79f | ||
|
|
5967347b80 | ||
|
|
855a445c1a | ||
|
|
1cc12195a3 | ||
|
|
66d4d39d5b | ||
|
|
a5dbe66fc1 | ||
|
|
4c8be45e28 | ||
|
|
6049a2b834 | ||
|
|
831c014f97 | ||
|
|
5c15a7a64a | ||
|
|
e43992b278 | ||
|
|
5963d2bac5 | ||
|
|
45816a2bcc | ||
|
|
60a5a2aa40 | ||
|
|
04b9b59e14 | ||
|
|
4ff4b52202 | ||
|
|
73c426844a | ||
|
|
25ce236a77 | ||
|
|
9b20175545 | ||
|
|
92a7118d1c | ||
|
|
a9f9e90443 | ||
|
|
31d2067f07 | ||
|
|
dd7e1416b4 | ||
|
|
1d5225de07 | ||
|
|
9c063d59de | ||
|
|
57028987f1 | ||
|
|
9e722ddfb3 | ||
|
|
646a8e0b9f | ||
|
|
f27a2871d7 | ||
|
|
909c44d72a | ||
|
|
53cf595e17 | ||
|
|
2c4eb78c3f | ||
|
|
d7a1325c0b | ||
|
|
30efbcc621 | ||
|
|
628c16eb95 | ||
|
|
d8552c62ff | ||
|
|
df84083536 | ||
|
|
461a4f122b | ||
|
|
c937af8ee7 | ||
|
|
636d4279c8 | ||
|
|
019b838925 | ||
|
|
0fc18459cd | ||
|
|
583c5660d6 | ||
|
|
52d5713a99 | ||
|
|
b34a66f270 | ||
|
|
eed996f608 | ||
|
|
b96c5d0557 | ||
|
|
aab8f21a8d | ||
|
|
c668a97950 | ||
|
|
bb98d20637 | ||
|
|
e2ab124fb7 | ||
|
|
0d2efe5b05 | ||
|
|
156a6554ef |
9
.dockerignore
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
node_modules
|
||||||
|
dist
|
||||||
|
dist_electron
|
||||||
|
.vs
|
||||||
|
.vscode
|
||||||
|
.github
|
||||||
|
.git
|
||||||
|
docs
|
||||||
|
docker
|
||||||
14
.github/workflows/bump-and-release.yaml
vendored
@@ -1,23 +1,17 @@
|
|||||||
name: Bump & release
|
name: Bump & release
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
|
||||||
types: [closed]
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
push: # Ensure a new release is created for each new tag
|
push: # Ensure a new release is created for each new tag
|
||||||
tags:
|
tags:
|
||||||
- '[0-9]+.[0-9]+.[0-9]+'
|
- '[0-9]+.[0-9]+.[0-9]+'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
bump-version-and-release:
|
bump-version-and-release:
|
||||||
if: > # Push => Ensure only changes from master. PR => to not trigger when closing PR without merging
|
if: github.event.base_ref == 'refs/heads/master'
|
||||||
(github.event_name == 'push' && github.event.base_ref == 'refs/heads/master')
|
|
||||||
|| github.event.pull_request.merged == true
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
-
|
- uses: undergroundwires/bump-everywhere@master
|
||||||
uses: undergroundwires/bump-everywhere@master
|
|
||||||
with:
|
with:
|
||||||
user: undergroundwires-bot
|
user: undergroundwires-bot
|
||||||
release-token: ${{secrets.BUMP_GITHUB_PAT}} # Does not trigger release pipeline if we use default token: https://github.community/t5/GitHub-Actions/Github-Action-trigger-on-release-not-working-if-releases-was/td-p/34559
|
release-token: ${{ secrets.BUMP_GITHUB_PAT }} # Does not trigger release pipeline if we use default token: https://github.community/t5/GitHub-Actions/Github-Action-trigger-on-release-not-working-if-releases-was/td-p/34559
|
||||||
|
# GitHub does not inject secrets if pipeline runs from fork or a fork is merged to main repo.
|
||||||
|
|||||||
32
.github/workflows/deploy-desktop.yaml
vendored
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
name: Deploy desktop
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [created] # will be triggered when a NON-draft release is created and published.
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish-desktop-app:
|
||||||
|
name: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [macos, ubuntu, windows]
|
||||||
|
runs-on: ${{ matrix.os }}-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
ref: master # otherwise it defaults to the version tag missing bump commit
|
||||||
|
fetch-depth: 0 # fetch all history
|
||||||
|
- name: Checkout to bump commit
|
||||||
|
run: git checkout "$(git rev-list "${{ github.event.release.tag_name }}"..master | tail -1)"
|
||||||
|
- name: Setup node
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: '14.x'
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
- name: Run tests
|
||||||
|
run: npm run test:unit
|
||||||
|
- name: Publish desktop app
|
||||||
|
run: npm run electron:build -- -p always # https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/recipes.html#upload-release-to-github
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
name: Build & deploy
|
name: Deploy site
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
types: [created] # will be triggered when a NON-draft release is created and published.
|
types: [created] # will be triggered when a NON-draft release is created and published.
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-and-deploy:
|
aws-deploy: # see: https://github.com/undergroundwires/aws-static-site-with-cd
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
@@ -23,7 +23,7 @@ jobs:
|
|||||||
--secret-access-key ${{secrets.AWS_DEPLOYMENT_USER_SECRET_ACCESS_KEY}} \
|
--secret-access-key ${{secrets.AWS_DEPLOYMENT_USER_SECRET_ACCESS_KEY}} \
|
||||||
--region us-east-1 \
|
--region us-east-1 \
|
||||||
&& \
|
&& \
|
||||||
echo "::set-env name=SESSION_NAME::${{github.actor}}-${{github.event_name}}-$(echo ${{github.sha}} | cut -c1-8)"
|
echo "SESSION_NAME=${{github.actor}}-${{github.event_name}}-$(echo ${{github.sha}} | cut -c1-8)" >> $GITHUB_ENV
|
||||||
working-directory: aws
|
working-directory: aws
|
||||||
-
|
-
|
||||||
name: "Infrastructure: Deploy IAM stack"
|
name: "Infrastructure: Deploy IAM stack"
|
||||||
@@ -86,7 +86,7 @@ jobs:
|
|||||||
node-version: '14.x'
|
node-version: '14.x'
|
||||||
-
|
-
|
||||||
name: "App: Install dependencies"
|
name: "App: Install dependencies"
|
||||||
run: npm install
|
run: npm ci
|
||||||
working-directory: site
|
working-directory: site
|
||||||
-
|
-
|
||||||
name: "App: Run tests"
|
name: "App: Run tests"
|
||||||
@@ -114,4 +114,4 @@ jobs:
|
|||||||
--web-stack-name privacysexy-web-stack --web-stack-cloudfront-arn-output-name CloudFrontDistributionArn \
|
--web-stack-name privacysexy-web-stack --web-stack-cloudfront-arn-output-name CloudFrontDistributionArn \
|
||||||
--role-arn ${{secrets.AWS_CLOUDFRONT_SITE_DEPLOYMENT_ROLE_ARN}} \
|
--role-arn ${{secrets.AWS_CLOUDFRONT_SITE_DEPLOYMENT_ROLE_ARN}} \
|
||||||
--region us-east-1 \
|
--region us-east-1 \
|
||||||
--profile user --session ${{ env.SESSION_NAME }}
|
--profile user --session ${{ env.SESSION_NAME }}
|
||||||
39
.github/workflows/quality-checks.yaml
vendored
@@ -1,37 +1,26 @@
|
|||||||
name: Quality checks
|
name: Quality checks
|
||||||
|
|
||||||
on:
|
on: [ push, pull_request ]
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
lint-command:
|
||||||
|
- npm run lint:vue
|
||||||
|
- npm run lint:yaml
|
||||||
|
- npm run lint:md
|
||||||
|
- npm run lint:md:relative-urls
|
||||||
|
- npm run lint:md:consistency
|
||||||
steps:
|
steps:
|
||||||
-
|
- name: Checkout
|
||||||
name: Checkout
|
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
-
|
- name: Setup node
|
||||||
name: Setup node
|
|
||||||
uses: actions/setup-node@v1
|
uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
node-version: 14.x
|
node-version: 14.x
|
||||||
-
|
- name: Install dependencies
|
||||||
name: Install dependencies
|
|
||||||
run: npm ci
|
run: npm ci
|
||||||
-
|
- name: Lint
|
||||||
name: Lint vue
|
run: ${{ matrix.lint-command }}
|
||||||
run: npm run lint:vue
|
|
||||||
-
|
|
||||||
name: Lint yaml
|
|
||||||
run: npm run lint:yaml
|
|
||||||
-
|
|
||||||
name: 'Validate md: Relative URLs'
|
|
||||||
run: npm run lint:md:relative-urls
|
|
||||||
-
|
|
||||||
name: 'Validate md: Enforce standards'
|
|
||||||
run: npm run lint:md
|
|
||||||
-
|
|
||||||
name: 'Validate md: Ensure consistency'
|
|
||||||
run: npm run lint:md:consistency
|
|
||||||
|
|||||||
4
.github/workflows/security-checks.yaml
vendored
@@ -1,9 +1,9 @@
|
|||||||
name: Security checks
|
name: Security checks
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
push:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
paths: [ '/package.json', '/package-lock.json' ] # Allow PRs to be green if they do not introduce dependency change
|
||||||
- master
|
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '0 0 * * 0'
|
- cron: '0 0 * * 0'
|
||||||
|
|
||||||
|
|||||||
10
.github/workflows/test.yaml
vendored
@@ -1,13 +1,13 @@
|
|||||||
name: Test
|
name: Test
|
||||||
|
|
||||||
on:
|
on: [ push, pull_request ]
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
run-tests:
|
run-tests:
|
||||||
runs-on: ubuntu-latest
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [macos, ubuntu, windows]
|
||||||
|
runs-on: ${{ matrix.os }}-latest
|
||||||
steps:
|
steps:
|
||||||
-
|
-
|
||||||
name: Checkout
|
name: Checkout
|
||||||
|
|||||||
6
.gitignore
vendored
@@ -1,4 +1,6 @@
|
|||||||
node_modules
|
node_modules
|
||||||
/dist
|
dist/
|
||||||
.vs
|
.vs
|
||||||
.vscode
|
.vscode
|
||||||
|
#Electron-builder output
|
||||||
|
/dist_electron
|
||||||
327
CHANGELOG.md
Normal file
@@ -0,0 +1,327 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 0.8.2 (2020-12-26)
|
||||||
|
|
||||||
|
* replace ampersand in "Movies & TV app" with "and" to prevent batch file from misinterpreting it (#45) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/52d4313156d2dcbc508b7271e7d9dfd45723d7bc)
|
||||||
|
* update dependencies to latest #46 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d9e44e25744e5d0aa01b8fc0f0af74c48027aea3)
|
||||||
|
* fix type assignment error after typescript upgrade | [commit](https://github.com/undergroundwires/privacy.sexy/commit/55f936fee9f86757f63fa8952d89711feb247e5b)
|
||||||
|
* correct typos (#48) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a744415eb2ab65ee4f519f863fdd6a43953377bb)
|
||||||
|
* in ci/cd, do not run security checks if PRs do not change dependencies #48 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/54ba4dbb0bf8f08f9479f8facb2e12c786c1bc51)
|
||||||
|
* rename app launch tracking tweak to make it more clear #44 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b3117c27f283c2d5a25fd94021a9f628a272cda6)
|
||||||
|
* refactor capabilities to use a shared function #41 #47 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c4ec6a1445d2fd5eb923c97b54aee01e272e13a8)
|
||||||
|
* rename "disable" to "uninstall" for removing capabilities #47 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8cd3352017f9dc85f8efcd7b450d90f555d3e92e)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.8.1...0.8.2)
|
||||||
|
|
||||||
|
## 0.8.1 (2020-11-16)
|
||||||
|
|
||||||
|
* refactor removing bloatware to use functions #41 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ffa279f3dfe51db564f0a3859543eb212170e173)
|
||||||
|
* fix reinstalling store apps by searching appx for all users | [commit](https://github.com/undergroundwires/privacy.sexy/commit/2c5ab3ea7da159cfb9fbfbbb7cdd28afbee965ea)
|
||||||
|
* fix clearing jump lists causing os to break and user pin removal #37 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/92c3dd923257ac940eab6cbab858698ed55a09b7)
|
||||||
|
* fix reinstalling store apps by searching appx for all users | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4e7267337301fe4a0480ba0603218fca25c2d096)
|
||||||
|
* refactor unused imports | [commit](https://github.com/undergroundwires/privacy.sexy/commit/45b8dd972b1edf9e263858c23b27e7a1d2e07077)
|
||||||
|
* fix not being able to uninstall system apps | [commit](https://github.com/undergroundwires/privacy.sexy/commit/31e08d231d52e2a691400468b7c599c142a29448)
|
||||||
|
* fix wrong app names caused by wrong Microsoft docs | [commit](https://github.com/undergroundwires/privacy.sexy/commit/e41e40c5bf01e2971d3054fcd3a48f8465a96622)
|
||||||
|
* unrecommend some system apps and document more | [commit](https://github.com/undergroundwires/privacy.sexy/commit/29c7704e0bd38f6e9923cde84accb569b02d2dd6)
|
||||||
|
* fix not being able to rename paths including brackets | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ad1872e7cd4ad7ef9facf33fadfa8c6a55065dd3)
|
||||||
|
* fix errors when file already exists | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c26bc209eb167aa71cad10b7f3ea02d0dedd97b0)
|
||||||
|
* move Microsoft.Appconnector to right category | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b247b12c3f009aab4350e33f4779fd193e570050)
|
||||||
|
* replace deprecated github ::set-env command | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ab7d617886a65fe4f3c2daa929168e5678ccae60)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.8.0...0.8.1)
|
||||||
|
|
||||||
|
## 0.8.0 (2020-11-01)
|
||||||
|
|
||||||
|
* add support for different recommendation levels: strict and standard | [commit](https://github.com/undergroundwires/privacy.sexy/commit/14be3017c55ed5e0d9bdecb63fcc4e1131e79ab0)
|
||||||
|
* Add GroupMe and Spotify removal option (#34) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3785c623f837b182d82fa383dfe7709722a67248)
|
||||||
|
* switch places of download and copy buttons | [commit](https://github.com/undergroundwires/privacy.sexy/commit/50fb29038ae19b17ec006093db02cf1e568d53c3)
|
||||||
|
* change "download" button to "save" on desktop | [commit](https://github.com/undergroundwires/privacy.sexy/commit/07fc555324d8bf4fa3594a9701daaa124a873153)
|
||||||
|
* show icons on cards during indeterminate and fully selected states | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1072505219edc47d82a91f148d1f310f32869fea)
|
||||||
|
* add scripts to increase cryptography, enable camera notifications and remove todo app (#36) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4c68408f1ec339dc8d39c7ab044f825a7f7185cb)
|
||||||
|
* update recommendations to be safer and consistent | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d0019c2c9b1eea620e2e8e02b586903ce62b80e3)
|
||||||
|
* rework disabling metadata retrieval | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ac70b063b8a15bc528256185792939685be6b36f)
|
||||||
|
* add all dist folders in gitignore because of files auto-generated by vscode | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1a9db31c7778c3269a71c0bd9665827efda70a02)
|
||||||
|
* add support for shared functions #41 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8ce06facbd54184402a4b1af3c7303e64db85b8a)
|
||||||
|
* hide scrollbars on code area when not overflowing | [commit](https://github.com/undergroundwires/privacy.sexy/commit/fd28eaad061c75ea1aa7e0f0d60ea37a7e52f8c4)
|
||||||
|
* update screenshot | [commit](https://github.com/undergroundwires/privacy.sexy/commit/cfedcd724cad7708b30c7390a7bca3b6313b6726)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.6...0.8.0)
|
||||||
|
|
||||||
|
## 0.7.6 (2020-10-18)
|
||||||
|
|
||||||
|
* add docs for default0 pointing to github discussion (#30) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a3fc3782efd346b4c99d2a0b40df2eb0229f5b36)
|
||||||
|
* add robots.txt to explicitly allow indexing | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4c2f74949b0758d33049bdfa4f0124a28958f8ea)
|
||||||
|
* add more reversibility | [commit](https://github.com/undergroundwires/privacy.sexy/commit/19a092dd31fb3588277f1ab3120b409d98506752)
|
||||||
|
* refactor to read more from package.json | [commit](https://github.com/undergroundwires/privacy.sexy/commit/784a67afff681bc19147d03c947de0e165d97e87)
|
||||||
|
* simplify "why" section | [commit](https://github.com/undergroundwires/privacy.sexy/commit/77c3d2bbb8d13db86bb82ed0b5cbeaacfdea3db9)
|
||||||
|
* update dependencies to latest | [commit](https://github.com/undergroundwires/privacy.sexy/commit/11e06131655398db08faeeacff62062e46e0dddd)
|
||||||
|
* run tests on all operating systems: macos, ubuntu, windows | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d9d7f62d81d4d8f95104d33211e82641884d711f)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.5...0.7.6)
|
||||||
|
|
||||||
|
## 0.7.5 (2020-09-14)
|
||||||
|
|
||||||
|
* fix reverting (reinstalling) capabilities not working | [commit](https://github.com/undergroundwires/privacy.sexy/commit/939d838e3535bb1c9b00c8ea9dacb735ae41d700)
|
||||||
|
* fix tests and checks are not running on PRs | [commit](https://github.com/undergroundwires/privacy.sexy/commit/82d509129b4e4a5df4b84786a0d6842a7d26e888)
|
||||||
|
* fix the recycling bin option (#32) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/15db3118012a172a2191a2afad57084a65b34642)
|
||||||
|
* fix rendering issue in older edge/IE | [commit](https://github.com/undergroundwires/privacy.sexy/commit/6efed72bf25c2ddf0901caab7f22966ca13cd47a)
|
||||||
|
* fix pasting in search bar after page load showing no results | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d1694341578288eeaf8b80caf9296a38d76789f0)
|
||||||
|
* fix typo | [commit](https://github.com/undergroundwires/privacy.sexy/commit/7dd15ed06433e0e6583ab0fa46a683ce6554bbea)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.4...0.7.5)
|
||||||
|
|
||||||
|
## 0.7.4 (2020-09-12)
|
||||||
|
|
||||||
|
* fix checked checkbox has blue border | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4ae385b7fcea9014a68442714b7d99e2ee7df7d0)
|
||||||
|
* fix spectre protection getting single lined #31 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/22b23a9ece446c7f9abd4ede293051eb616ad50a)
|
||||||
|
* fix missing reg value in denying app access to account | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3c13a9e837e06e097450b31d7eb0c0e6bf20cefb)
|
||||||
|
* fix wrong path in clear all firefox user profile settings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ee66196d9a60f27d17ae7f62d02b4f119a47e6e0)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.3...0.7.4)
|
||||||
|
|
||||||
|
## 0.7.3 (2020-09-12)
|
||||||
|
|
||||||
|
* fix vscode settings file override and add more configs | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a0d61728ead04b4455437f85820121a848db9e00)
|
||||||
|
* fix nvidia tweak error message, categorize and add reversibility | [commit](https://github.com/undergroundwires/privacy.sexy/commit/99a2035fdb0766a4dfc2753133eab0d7666516cd)
|
||||||
|
* improve CPU specific tweaks by conditional platform checks and reversibility | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8df5faf4ef05a49da63973bd0fbb5c5d07d5bd93)
|
||||||
|
* fix wrong path to the main telemetry file | [commit](https://github.com/undergroundwires/privacy.sexy/commit/de4ac978bdda79573b36d355697b8a028d2c0beb)
|
||||||
|
* fix naming of firefox cleanup to mention profiles | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3ab48b1cf5f7f934f07e468ef2318ccee07f530c)
|
||||||
|
* add reversibility and more scripts to denying app access with better structure | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1d465ee3189d0e5a827453b3f0eb4361efe23770)
|
||||||
|
* fix comment lines are being detected as duplicate in validation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b6ccb5927a20412976a54fd2215eb645092f98a8)
|
||||||
|
* add more detailed error message | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1f11c39773c12eccfb3efb898b58c2f6f37ab9ca)
|
||||||
|
* fix typo in a test | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1f19b2528a69383e63e579d2885f01cd804abf6c)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.2...0.7.3)
|
||||||
|
|
||||||
|
## 0.7.2 (2020-09-06)
|
||||||
|
|
||||||
|
* update onesync documentation and do not recommend it as it breaks other apps | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f36d8bfc7848bb65ac0c641e318a689bf3816ccf)
|
||||||
|
* add reversibility for biometric disabling and do not recommend it | [commit](https://github.com/undergroundwires/privacy.sexy/commit/db74531cd4139615c6d595959217d3651f099019)
|
||||||
|
* fix bad highlighting of selected nodes when using keyboard navigation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/255133af4dfae40171406648a3e2920f16d71cb3)
|
||||||
|
* add reversibility to removing bloatware | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c7b2a703128470a05f12c9c6e8002444def37ef8)
|
||||||
|
* fix indeterminate state being lost | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1f266c33535f72b69c65985bf2eff27cd2c5a104)
|
||||||
|
* fix wording in default text in text area | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ca63a0979ef55d07d09d9443e5cea9aa888870a5)
|
||||||
|
* add best practice suggestion to come back | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f4885b6f1c82752f2143934e336d6d1b1af03015)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.1...0.7.2)
|
||||||
|
|
||||||
|
## 0.7.1 (2020-09-04)
|
||||||
|
|
||||||
|
* fix some browsers (including firefox) downloading the script as a text file | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8c17929151f9c4fa5f48564492bbf400ced95eea)
|
||||||
|
* rename screenshot image file | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b8682a852a14ed6cf49986695d9510b840ac9d3d)
|
||||||
|
* fix new/changed script higlighting not working on production builds | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8c38dd73d8c7b77d8d341c0389f4d7229f9b97fd)
|
||||||
|
* refactor unused imports | [commit](https://github.com/undergroundwires/privacy.sexy/commit/6badfef9daace0c5de3fd33652a82bfe22261b11)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.7.0...0.7.1)
|
||||||
|
|
||||||
|
## 0.7.0 (2020-09-02)
|
||||||
|
|
||||||
|
* [search] better (multilined) message when there are no results | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ec15af01dd020b364c2174fe562fd66227c2320c)
|
||||||
|
* [search] added clear/close button | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d6fa9a2a03c0ebe68b94f0b80cc52b4e200c9213)
|
||||||
|
* move script generation to /generation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/5df458739d076719e350ba194c4f3f772884fcdb)
|
||||||
|
* add auto-highlighting of selected/updated code | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b789250cb89e2130b08e1a927df8181cf945dfeb)
|
||||||
|
* prompt admin priviliges automatically | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f8ba5c46e4923d9c35f200f8a08aa6437f7c0ecc)
|
||||||
|
* add removal of ghost (default0) telemetry user | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c262681011f39b4412669b6cf233476f676ca550)
|
||||||
|
* add more windows defender tweaks, categorization and reversibility | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1a34c7374ba56bafa0209bbb55c81b233bb419ed)
|
||||||
|
* fix NTP script documentation is on wrong place | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3060ebf79cf242370433495cc3e1878b7581b202)
|
||||||
|
* updated dependencies to latest and audit fixes (#25) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c628aa9aef8ab7c815661d3c1711e7fbc65c69a2)
|
||||||
|
* categorize, fix and extend windows log files cleanup | [commit](https://github.com/undergroundwires/privacy.sexy/commit/594a14d6ca76cbd27a21877b8c373c1930589ca6)
|
||||||
|
* add more OneDrive cleanup scripts and categorize them | [commit](https://github.com/undergroundwires/privacy.sexy/commit/978d7d08638dd161082f239ed088b12302f29458)
|
||||||
|
* add disabling firefox telemetry | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f8b8b4c97ab734d5ba7370894b694993924388da)
|
||||||
|
* add disabling ccleaner telemetry | [commit](https://github.com/undergroundwires/privacy.sexy/commit/018b7e270f207aac926cb12f8069ebfcdce193ce)
|
||||||
|
* Add disabling of PowerShell 7+ telemetry (#29) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/456e40bedf9afcc846f9b13f1ea144cef6115cf6)
|
||||||
|
* categorize, fix, make scripts reversible in "UI for privacy", "security improvements" and "configure browsers" | [commit](https://github.com/undergroundwires/privacy.sexy/commit/532915b95da9fecd6b981d91bf489359e4e53caa)
|
||||||
|
* fix "Configure Defender" being in wrong category #28 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f709d6a566ed7846b677b383863deda9680a2a9c)
|
||||||
|
* do not hardcode capability versions and make them reversible | [commit](https://github.com/undergroundwires/privacy.sexy/commit/2afef4ea3d0d3d09aa1fa1eedba8493680bd8f10)
|
||||||
|
* exclude paint, wordpad and notepad from bloatware removal | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d235dee95514a01745aef9479d07f88ffb4b40b8)
|
||||||
|
* add reversibility on category level | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f51e8859eeb32c944126d692cfe03a0320c8b568)
|
||||||
|
* refactor unused imports & variables | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a23d28f2cfa2d64d45460697cf5ee9d6b5920752)
|
||||||
|
* fix search (got broken in b789250) with tests and refactorings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8bbe6ebf750f1a1cbab493fb99b5ea91f4e21609)
|
||||||
|
* update the screenshot to show off highlighting | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b4aacea2a3e0bbcf2d8a79ff67f51c0f19e888a6)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.6.2...0.7.0)
|
||||||
|
|
||||||
|
## 0.6.2 (2020-08-16)
|
||||||
|
|
||||||
|
* 🐛 fixed disabling error reporting for november 2019 update | [commit](https://github.com/undergroundwires/privacy.sexy/commit/5967347b80976a519f6f4eb1972a62f3e600df2b)
|
||||||
|
* 🐛 fixed blank screen and icons on mac | [commit](https://github.com/undergroundwires/privacy.sexy/commit/7fac0fe79f252e8f9dda4f6f83cd6fa4ba2b539f)
|
||||||
|
* 🐛 fixed removing onedrive does not delete scheduled tasks | [commit](https://github.com/undergroundwires/privacy.sexy/commit/b6bfc2572740c0cd46d3bc0058fa767dd5fa862e)
|
||||||
|
* ⚙️ enhanced tweak to disable for office telemetry | [commit](https://github.com/undergroundwires/privacy.sexy/commit/afc3bfb3b8896f332c9a196973ded3dce8fd21e4)
|
||||||
|
* ✨ added script to clear dotnet telemery | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1663bfeac7b6580b1335ca5fcf3587b69c080c72)
|
||||||
|
* 🐛 fixed changing time server not working | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c69998c7cb29ffcf40f0af03b73150736581da69)
|
||||||
|
* 🔥 removed disabling ClickToRun as it breaks office | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3d3380f27ebeea53f17f49974aaa89300ffaf2dd)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.6.1...0.6.2)
|
||||||
|
|
||||||
|
## 0.6.1 (2020-08-09)
|
||||||
|
|
||||||
|
* updated documentation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/5963d2bac551083f9d16cce6b851abf0e8b88ce7)
|
||||||
|
* fixed typo in footer | [commit](https://github.com/undergroundwires/privacy.sexy/commit/5c15a7a64aaf24578a32713dec491bf494216303)
|
||||||
|
* more scripts can be reverted | [commit](https://github.com/undergroundwires/privacy.sexy/commit/831c014f977515454ee6dc664d77a8c434495501)
|
||||||
|
* moved windows connect now to security & recommended | [commit](https://github.com/undergroundwires/privacy.sexy/commit/6049a2b834d8d17af741f8d8f8b07cd15153b001)
|
||||||
|
* fixed mac / linux download links | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4c8be45e287b5ea009d6f828f7f327f37850569e)
|
||||||
|
* tweaks to disable webcam, speech and compatibility telemetry | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a5dbe66fc175e39397f296ab2ff703e9b0ab4d7c)
|
||||||
|
* refactorings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/66d4d39d5bf3db305450514c6b6224654dafbfb2)
|
||||||
|
* fixed removing onedrive does not clean start menu / quick access | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1cc12195a3e9a11c590d3ed64d80299b50f74838)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.6.0...0.6.1)
|
||||||
|
|
||||||
|
## 0.6.0 (2020-07-26)
|
||||||
|
|
||||||
|
* fixed dead links in documentation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/25ce236a7737decaf2eb9b8c29a4c4f34d43f770)
|
||||||
|
* runs tests on each push on the repository | [commit](https://github.com/undergroundwires/privacy.sexy/commit/73c426844a0330718a9ab7de12b61ca05e853323)
|
||||||
|
* code area now shows "how" before "why" | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4ff4b52202b1c5dbfe2b80580bbe7d93132ab05c)
|
||||||
|
* support for desktop versions #20 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/04b9b59e14766ccd251474ad3710baf1f682fd49)
|
||||||
|
* reworked on footer & removed github icon | [commit](https://github.com/undergroundwires/privacy.sexy/commit/60a5a2aa4026d384bef9e6a203f1b7514a269c33)
|
||||||
|
* updated dependencies to latest | [commit](https://github.com/undergroundwires/privacy.sexy/commit/45816a2bccb3d11a50e3f2bc19c0a6cc2587deaa)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.5.0...0.6.0)
|
||||||
|
|
||||||
|
## 0.5.0 (2020-07-19)
|
||||||
|
|
||||||
|
* added ability to revert (#21) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/9c063d59defa6297c64f50b49403e8bd10620de9)
|
||||||
|
* search placeholder shows total scripts | [commit](https://github.com/undergroundwires/privacy.sexy/commit/1d5225de07186f853f4cf7aedd4998f5d00c107a)
|
||||||
|
* do not collapse card when on "Search" and "Select" | [commit](https://github.com/undergroundwires/privacy.sexy/commit/dd7e1416b4df54bf71b719d4654db88769dc0994)
|
||||||
|
* opening a card scrolls to its content div | [commit](https://github.com/undergroundwires/privacy.sexy/commit/31d2067f076c3159483baec49975617dddbd158d)
|
||||||
|
* all cards in same line now have same height | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a9f9e9044385d9aed3b5551fc6c6823e813fd1e5)
|
||||||
|
* patched loadash vulnerability (#18) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/92a7118d1c5013312772e075b9ee5a79c93710b8)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.10...0.5.0)
|
||||||
|
|
||||||
|
## 0.4.10 (2020-07-15)
|
||||||
|
|
||||||
|
* fixed script errors & added tests | [commit](https://github.com/undergroundwires/privacy.sexy/commit/9e722ddfb3825fb29d6298025baaaa033120d017)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.9...0.4.10)
|
||||||
|
|
||||||
|
## 0.4.9 (2020-07-14)
|
||||||
|
|
||||||
|
* disable office telemetry Disassembler0/Win10-Initial-Setup-Script#288 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/53cf595e1726ee3de79137fd566978fd512d218f)
|
||||||
|
* updated to may 2020 update | [commit](https://github.com/undergroundwires/privacy.sexy/commit/909c44d72a4a602ee8f27d06b6ec706c1e432ce1)
|
||||||
|
* simplified docker builds | [commit](https://github.com/undergroundwires/privacy.sexy/commit/f27a2871d74e5117fc029be82caef12246e10879)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.8...0.4.9)
|
||||||
|
|
||||||
|
## 0.4.8 (2020-07-11)
|
||||||
|
|
||||||
|
* added more scripts #16 (#17) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d8552c62ffea13ce62abce836c7dd4980eef6bb9)
|
||||||
|
* stopping services before disabling #16 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/628c16eb952495f5b3f6d794161b355f4b08b819)
|
||||||
|
* can disable features, capabilities & remove onedrive #16 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/30efbcc621eb83dd5a9c1e66b8f1f5350eb95006)
|
||||||
|
* updated one more typo (#19) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d7a1325c0b7665ce712dc411965d00fc1d6fa384)
|
||||||
|
* more tweaks #16 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/2c4eb78c3f156cb0d033977cffbe7464697680f5)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.7...0.4.8)
|
||||||
|
|
||||||
|
## 0.4.7 (2020-06-30)
|
||||||
|
|
||||||
|
* removed HKU tweak as all HKU's are changed #10 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c937af8ee7da9aa95131e56abf7bf24800390fe6)
|
||||||
|
* Fixed types + script in "Clear Windows log files" (#15) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/461a4f122b342369db5cc08c5e30961c64e68cdd)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.6...0.4.7)
|
||||||
|
|
||||||
|
## 0.4.6 (2020-06-16)
|
||||||
|
|
||||||
|
* Fixed Some More Issues (#12) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/52d5713a99422cdf900aba819e49e998abac33cc)
|
||||||
|
* removed failing continuous deployment #14 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/583c5660d6ac934b845a044e013357aa91f61c15)
|
||||||
|
* Updated Some Tweaks (#11) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/0fc18459cde57684f00764815062f838f932aed5)
|
||||||
|
* Updated Some More Tweaks (#13) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/019b838925e963b7ec052ac76c6faf5650b9eb67)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.5...0.4.6)
|
||||||
|
|
||||||
|
## 0.4.5 (2020-06-13)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.4...0.4.5)
|
||||||
|
|
||||||
|
## 0.4.4 (2020-05-24)
|
||||||
|
|
||||||
|
* fixed close card button not being visible & cleanup | [commit](https://github.com/undergroundwires/privacy.sexy/commit/0d2efe5b05aa965458b78b8fa43754ce2f4fe11b)
|
||||||
|
* new footer with privacy policy | [commit](https://github.com/undergroundwires/privacy.sexy/commit/e2ab124fb799f56ada3570fdc911361cb803e889)
|
||||||
|
* one command to lint everything "npm run lint" | [commit](https://github.com/undergroundwires/privacy.sexy/commit/bb98d20637cbf1d524ebb2973e308773006e3153)
|
||||||
|
* fix "group by" overflows on smaller screens | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c668a97950a1cb7c8bf2a7fd8a72d1101e65e8ce)
|
||||||
|
* clicking outside of a card closes it | [commit](https://github.com/undergroundwires/privacy.sexy/commit/aab8f21a8d8dbed54798af581e6e1ad9e86a4be1)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.3...0.4.4)
|
||||||
|
|
||||||
|
## 0.4.3 (2020-05-23)
|
||||||
|
|
||||||
|
* removed redundant documentation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/749a140eb8dba09cb67fec2f8dec937e66e3cff5)
|
||||||
|
* fixed broke link | [commit](https://github.com/undergroundwires/privacy.sexy/commit/97b7e03233d9718a8df30cb01ce06ca9489a0295)
|
||||||
|
* simplified heading | [commit](https://github.com/undergroundwires/privacy.sexy/commit/226074c5342f7463c06fcff1457d352ca30295a3)
|
||||||
|
* reading version from package.json instead of version file #5 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/691f989682179016ddcbf55a05cded29155288c9)
|
||||||
|
* automatically increases patch number #5 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3e3bc07576f7c7e74e3e11fc7d197cbb9a9fb8c0)
|
||||||
|
* using deployment operations from aws-static-site-with-cd | [commit](https://github.com/undergroundwires/privacy.sexy/commit/997be7113f676888892ffa35566d9ebb58a3e9ea)
|
||||||
|
* automated using bump-everywhere + more quality checks (#8) | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4a91e8ccd8a707bc6bea34ee28cff7fa4f66ee2f)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.2...0.4.3)
|
||||||
|
|
||||||
|
## 0.4.2 (2020-02-29)
|
||||||
|
|
||||||
|
* added missing semicolon for masking | [commit](https://github.com/undergroundwires/privacy.sexy/commit/e63ac4ae67da68243a525af149ff30e5d485b641)
|
||||||
|
* set font on input | [commit](https://github.com/undergroundwires/privacy.sexy/commit/0c39a06be5e4b0a2031ad5e9f5220dd669afee53)
|
||||||
|
* shortened all HKEY paths | [commit](https://github.com/undergroundwires/privacy.sexy/commit/802b36bdd8dcc1f0a2853fe7da2ea2fccd69a88c)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.1...0.4.2)
|
||||||
|
|
||||||
|
## 0.4.1 (2020-01-11)
|
||||||
|
|
||||||
|
* fixed search bug | [commit](https://github.com/undergroundwires/privacy.sexy/commit/31364bdfec503af09ffbb58044a17dfb833fc8d9)
|
||||||
|
* hide grouping while searching | [commit](https://github.com/undergroundwires/privacy.sexy/commit/92f1a36bcb1e1fe7c90efe8ccd3ede55991e9d9c)
|
||||||
|
* 👀🔍 showing search queries | [commit](https://github.com/undergroundwires/privacy.sexy/commit/97a7747933d2b515cc03ab8243e6a8ae702ef16a)
|
||||||
|
* more efficient queries with single lowercase | [commit](https://github.com/undergroundwires/privacy.sexy/commit/19813b691746d98670823025c460480400e34b6e)
|
||||||
|
* using right 🔍 input type | [commit](https://github.com/undergroundwires/privacy.sexy/commit/0ce354ea0956391ad3f37b252daac1127bfc601a)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.4.0...0.4.1)
|
||||||
|
|
||||||
|
## 0.4.0 (2020-01-11)
|
||||||
|
|
||||||
|
* 🔍 support for search | [commit](https://github.com/undergroundwires/privacy.sexy/commit/89862b2775703257b9dc2e19fbebde2c0d0fbda0)
|
||||||
|
* more scripts & better organized | [commit](https://github.com/undergroundwires/privacy.sexy/commit/95baf3175b0d2c7df516f7893a96346b94ac8eca)
|
||||||
|
* refactorings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/e3f82e069e305f6d94eab335470c8e7b44295dd6)
|
||||||
|
* more margin for the scripts | [commit](https://github.com/undergroundwires/privacy.sexy/commit/5ea46ecbf52236953d19f09a8eade08b83e6cd34)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.3.0...0.4.0)
|
||||||
|
|
||||||
|
## 0.3.0 (2020-01-09)
|
||||||
|
|
||||||
|
* added description & more descriptive title | [commit](https://github.com/undergroundwires/privacy.sexy/commit/99576340b648550149871e2c0fe0b0d8c2dd0d7c)
|
||||||
|
* allow robots | [commit](https://github.com/undergroundwires/privacy.sexy/commit/eee0e785ec2c5e6bed53d21b4126a57773e35dba)
|
||||||
|
* removed unused references | [commit](https://github.com/undergroundwires/privacy.sexy/commit/cfd888f3afc5c260a0a4a73f2843b86b9f1df2cd)
|
||||||
|
* 🚫 disable NVIDIA telemetry | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ab28f4ed8538d51e1777c86302a63a0cd9c3cb2a)
|
||||||
|
* backwards compatibility for fonts | [commit](https://github.com/undergroundwires/privacy.sexy/commit/4bc13e11926a6df77079646499e799742153b4ab)
|
||||||
|
* added back meta needed for responsiveness | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ed872ef3d9f6c92afc0ce0d06998c60463a8b4e8)
|
||||||
|
* fancy-font is renamed to main and now used | [commit](https://github.com/undergroundwires/privacy.sexy/commit/6825001c61426194dc363b96b57a321241f3ba57)
|
||||||
|
* added support for grouping | [commit](https://github.com/undergroundwires/privacy.sexy/commit/ec6b3c54072a77bb4305da1c234db6c649218b88)
|
||||||
|
* less hyphens as it looks better on mobile | [commit](https://github.com/undergroundwires/privacy.sexy/commit/e0b080af69157f46ba12e2c25e794f5384671b51)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.2.0...0.3.0)
|
||||||
|
|
||||||
|
## 0.2.0 (2020-01-06)
|
||||||
|
|
||||||
|
* added GitHub Actions badge for build & deploy | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a229aca68a92bbcd8e8176ac1dd25ce03509e074)
|
||||||
|
* more badges 📛🏆📜 | [commit](https://github.com/undergroundwires/privacy.sexy/commit/090e8319091044e53484ba8338510f6fb7c3cb80)
|
||||||
|
* typo fixes + whitespace refactorings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/e99f210c9dcf61a21e445e2a331384b6066f2c98)
|
||||||
|
* switched content information to "why" section | [commit](https://github.com/undergroundwires/privacy.sexy/commit/beb3c8339f83a224ca66ad8a911a9265ffe7c9c0)
|
||||||
|
* fixed contribution URL | [commit](https://github.com/undergroundwires/privacy.sexy/commit/7b4277d7706ccf6ba7e4b7b01aa46f8e3852cfc6)
|
||||||
|
* fixed wrong relation + lighter style | [commit](https://github.com/undergroundwires/privacy.sexy/commit/8d05b03c9f3c9fc015be6615da8c283809712065)
|
||||||
|
* better URL validation | [commit](https://github.com/undergroundwires/privacy.sexy/commit/aff463dd64fecff92a786fcba88621dff6b1cf73)
|
||||||
|
* refactoring to new function | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c646c102730481c3f4648eb714dc0a84ce35b13c)
|
||||||
|
* optimized find queries & refactorings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/d38f6cd6a8b33e11df854c7abea05974dc04d4ce)
|
||||||
|
* 🎨 styled no JS error | [commit](https://github.com/undergroundwires/privacy.sexy/commit/c359f1d89c6874b3cc94154b993e33f58bd32268)
|
||||||
|
* simplified finding duplicates | [commit](https://github.com/undergroundwires/privacy.sexy/commit/57037aaefcc0e80f0f4719cea89568490a731028)
|
||||||
|
* fixed maintainability badge URL | [commit](https://github.com/undergroundwires/privacy.sexy/commit/aaea47e7d15fe41dea26968db0107a0c53d108f3)
|
||||||
|
* fixed wrong line dumps | [commit](https://github.com/undergroundwires/privacy.sexy/commit/5ccc7c59528885ae7729197df3dfa00f924a2b3f)
|
||||||
|
* refactorings in parsing | [commit](https://github.com/undergroundwires/privacy.sexy/commit/2aa3742e30646bf1d1f3779419d161c3fb6c4808)
|
||||||
|
* using free function | [commit](https://github.com/undergroundwires/privacy.sexy/commit/20020af7c1d8de13948d8761fd4e7f0affb2badb)
|
||||||
|
* default selection is now none | [commit](https://github.com/undergroundwires/privacy.sexy/commit/3140cc663b86394d543de90228aa53e6a304d8d9)
|
||||||
|
* added hyphen lines for longer names | [commit](https://github.com/undergroundwires/privacy.sexy/commit/cced601d686d550f4225018e5311b7433efbb5ae)
|
||||||
|
* more descriptive subtitle | [commit](https://github.com/undergroundwires/privacy.sexy/commit/2cf9214b14d9720f747a71b3864ba7a28acf0ff4)
|
||||||
|
* added footer with version | [commit](https://github.com/undergroundwires/privacy.sexy/commit/10a34fae2f1a219ec52db0c74edb39b46ebd8abc)
|
||||||
|
* using font variables | [commit](https://github.com/undergroundwires/privacy.sexy/commit/60e6348dc8d53f1e81ebdb2ec0e1962aac1e9842)
|
||||||
|
* code-gen refactorings | [commit](https://github.com/undergroundwires/privacy.sexy/commit/246e753ddc9dc8bf630e538663584bf3423cc749)
|
||||||
|
* added text when nothing is chosen | [commit](https://github.com/undergroundwires/privacy.sexy/commit/a7da75d4428090423b692ce45423f5bd300d8442)
|
||||||
|
|
||||||
|
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.1.0...0.2.0)
|
||||||
|
|
||||||
|
## 0.1.0 (2019-12-31)
|
||||||
|
|
||||||
|
Initial release | [commits](https://github.com/undergroundwires/privacy.sexy/commit/4e7f244190c6ffbf7b20443e3e69cf2402c4268a)
|
||||||
39
CONTRIBUTING.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
- 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
|
||||||
|
- Submitting a fix
|
||||||
|
- Proposing new features
|
||||||
|
- Becoming a maintainer
|
||||||
|
|
||||||
|
## Pull Request Process
|
||||||
|
|
||||||
|
- [GitHub flow](https://guides.github.com/introduction/flow/index.html) is used
|
||||||
|
- Your pull requests are actively welcomed.
|
||||||
|
- The steps:
|
||||||
|
1. Fork the repo and create your branch from master.
|
||||||
|
2. If you've added code that should be tested, add tests.
|
||||||
|
3. If you've changed APIs, update the documentation.
|
||||||
|
4. Ensure the test suite passes.
|
||||||
|
5. Make sure your code lints.
|
||||||
|
6. Issue that pull request!
|
||||||
|
- 🙏 DO
|
||||||
|
- Document your changes in the pull request
|
||||||
|
- ❗ 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)
|
||||||
|
|
||||||
|
## Guidelines
|
||||||
|
|
||||||
|
### Handle the state in presentation layer
|
||||||
|
|
||||||
|
- There are two types of components:
|
||||||
|
- **Stateless**, extends `Vue`
|
||||||
|
- **Stateful**, extends [`StatefulVue`](./src/presentation/StatefulVue.ts)
|
||||||
|
- The source of truth for the state lies in application layer ([`./src/application/`](src/application/)) and must be updated from the views if they're mutating the state
|
||||||
|
- They mutate or/and react to state changes in [ApplicationContext](src/application/Context/ApplicationContext.ts).
|
||||||
|
- You can react by getting the state and listening to it and update the view accordingly in [`mounted()`](https://vuejs.org/v2/api/#mounted) method.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
By contributing, you agree that your contributions will be licensed under its GNU General Public License v3.0.
|
||||||
12
Dockerfile
@@ -1,20 +1,12 @@
|
|||||||
# +-+-+-+-+-+ +-+-+-+-+-+
|
# Build
|
||||||
# |B|u|i|l|d| |S|t|a|g|e|
|
|
||||||
# +-+-+-+-+-+ +-+-+-+-+-+
|
|
||||||
FROM node:lts-alpine as build-stage
|
FROM node:lts-alpine as build-stage
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
RUN npm install
|
RUN npm install
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN npm run build
|
RUN npm run build
|
||||||
# For testing purposes, it's easy to run http-server on lts-alpine such as continuing from here:
|
|
||||||
# RUN npm install -g http-server
|
|
||||||
# EXPOSE 8080
|
|
||||||
# CMD [ "http-server", "dist" ]
|
|
||||||
|
|
||||||
# +-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+
|
# Production stage
|
||||||
# |P|r|o|d|u|c|t|i|o|n| |S|t|a|g|e|
|
|
||||||
# +-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+
|
|
||||||
FROM nginx:stable-alpine as production-stage
|
FROM nginx:stable-alpine as production-stage
|
||||||
COPY --from=build-stage /app/dist /usr/share/nginx/html
|
COPY --from=build-stage /app/dist /usr/share/nginx/html
|
||||||
EXPOSE 80
|
EXPOSE 80
|
||||||
|
|||||||
72
README.md
@@ -1,8 +1,8 @@
|
|||||||
# privacy.sexy
|
# privacy.sexy
|
||||||
|
|
||||||
> Web tool to enforce privacy & security best-practices on Windows, because privacy is sexy 🍑🍆
|
> Enforce privacy & security best-practices on Windows and macOS, because privacy is sexy 🍑🍆
|
||||||
|
|
||||||
[](https://github.com/undergroundwires/privacy.sexy/issues)
|
[](./CONTRIBUTING.md)
|
||||||
[](https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript)
|
[](https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript)
|
||||||
[](https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability)
|
[](https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability)
|
||||||
[](https://github.com/undergroundwires/privacy.sexy/actions)
|
[](https://github.com/undergroundwires/privacy.sexy/actions)
|
||||||
@@ -12,54 +12,74 @@
|
|||||||
[](https://github.com/undergroundwires/privacy.sexy/actions)
|
[](https://github.com/undergroundwires/privacy.sexy/actions)
|
||||||
[](https://github.com/undergroundwires/bump-everywhere)
|
[](https://github.com/undergroundwires/bump-everywhere)
|
||||||
|
|
||||||
[https://privacy.sexy](https://privacy.sexy)
|
## Get started
|
||||||
|
|
||||||
|
- Online version: [https://privacy.sexy](https://privacy.sexy)
|
||||||
|
- or download latest desktop version for [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.8.2/privacy.sexy-Setup-0.8.2.exe), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.8.2/privacy.sexy-0.8.2.AppImage), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.8.2/privacy.sexy-0.8.2.dmg)
|
||||||
|
- 💡 Come back regularly to apply latest version for stronger privacy and security.
|
||||||
|
|
||||||
|
[](https://privacy.sexy)
|
||||||
|
|
||||||
## Why
|
## Why
|
||||||
|
|
||||||
- You don't need to run any compiled software on your system, just run the generated scripts.
|
- Rich tweak pool to harden security & privacy of the OS and other software on it
|
||||||
- It's open source, both application & infrastructure is 100% transparent
|
- Free (both free as in beer and free as in speech)
|
||||||
- Fully automated C/CD pipeline to AWS for provisioning serverless infrastructure using GitHub actions.
|
- No need to run any compiled software that has access to your system, just run the generated scripts
|
||||||
- Have full visibility into what the tweaks do as you enable them.
|
- Have full visibility into what the tweaks do as you enable them
|
||||||
|
- Ability to revert (undo) applied scripts
|
||||||
|
- Everything is transparent: both application and its infrastructure are open-source and automated
|
||||||
- Easily extendable
|
- Easily extendable
|
||||||
|
|
||||||
## Extend scripts
|
## Extend scripts
|
||||||
|
|
||||||
Fork it & add more scripts in [application.yaml](src/application/application.yaml) and send a pull request 👌
|
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
|
## Commands
|
||||||
|
|
||||||
- Setup and run
|
- Project setup: `npm install`
|
||||||
- For development:
|
- Testing
|
||||||
- `npm install` to project setup.
|
- Run unit tests: `npm run test:unit`
|
||||||
- `npm run serve` to compile & hot-reload for development.
|
- Lint: `npm run lint`
|
||||||
- Production (using Docker):
|
- **Desktop app**
|
||||||
- Build `docker build -t undergroundwires/privacy.sexy .`
|
- Development: `npm run electron:serve`
|
||||||
- Run `docker run -it -p 8080:8080 --rm --name privacy.sexy-1 undergroundwires/privacy.sexy`
|
- Production: `npm run electron:build` to build an executable
|
||||||
- Prepare for production: `npm run build`
|
- **Webpage**
|
||||||
- Run tests: `npm run test:unit`
|
- Development: `npm run serve` to compile & hot-reload for development.
|
||||||
- Lint and fix files: `npm run lint`
|
- Production: `npm run build` to prepare files for distribution.
|
||||||
|
- Or run using Docker:
|
||||||
|
1. Build: `docker build -t undergroundwires/privacy.sexy:0.8.2 .`
|
||||||
|
2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy-0.8.2 undergroundwires/privacy.sexy:0.8.2`
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
### Application
|
### Application
|
||||||
|
|
||||||
- Powered by **TypeScript** + **Vue.js** 💪
|
- Powered by **TypeScript**, **Vue.js** and **Electron** 💪
|
||||||
- and driven by **Domain-driven design**, **Event-driven architecture**, **Data-driven programming** concepts.
|
- and driven by **Domain-driven design**, **Event-driven architecture**, **Data-driven programming** concepts.
|
||||||
- Application uses highly decoupled models & services in different DDD layers.
|
- Application uses highly decoupled models & services in different DDD layers.
|
||||||
- **Domain layer** is where the application is modelled with validation logic.
|
- **Domain layer** is where the application is modelled with validation logic.
|
||||||
- **Presentation Layer**
|
- **Presentation Layer**
|
||||||
- Consists of Vue.js components & UI stuff.
|
- Consists of Vue.js components and other UI-related code.
|
||||||
|
- 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.
|
- Event driven as in components simply listens to events from the state and act accordingly.
|
||||||
- **Application Layer**
|
- **Application Layer**
|
||||||
- Keeps the application state
|
- Keeps the application state using [state pattern](https://en.wikipedia.org/wiki/State_pattern)
|
||||||
- The [state](src/application/State/ApplicationState.ts) is a mutable singleton & event producer.
|
- [ApplicationContext](src/application/Context/ApplicationContext.ts)
|
||||||
- The application is defined & controlled in a [single YAML file](src/application/application.yaml) (see [Data-driven programming](https://en.wikipedia.org/wiki/Data-driven_programming))
|
- Holds the [CategoryCollectionState](src/application/Context/State/CategoryCollectionState.ts)] for each OS
|
||||||
|
- Same instance is shared throughout the application
|
||||||
|
- The scripts are defined and controlled in [yaml files](src/application/collections/) per OS
|
||||||
|
- Uses [data-driven programming](https://en.wikipedia.org/wiki/Data-driven_programming)
|
||||||
|
- 📖 See [extend scripts](#extend-scripts) to read about how to extend them.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
### AWS Infrastructure
|
### AWS Infrastructure
|
||||||
|
|
||||||
[](https://github.com/undergroundwires/aws-static-site-with-cd)
|
[](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)
|
- 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/).
|
- Runs on AWS 100% serverless and automatically provisioned using [GitHub Actions](.github/workflows/).
|
||||||
@@ -71,4 +91,4 @@ Fork it & add more scripts in [application.yaml](src/application/application.yam
|
|||||||
- Versioning, tagging, creation of `CHANGELOG.md` and releasing is automated using [bump-everywhere](https://github.com/undergroundwires/bump-everywhere) action
|
- 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.
|
- Everything that's merged in the master goes directly to production.
|
||||||
|
|
||||||
[](.github/workflows/)
|
[](.github/workflows/)
|
||||||
|
|||||||
5
build/README.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
# build
|
||||||
|
|
||||||
|
- These are the file that are used by electron.
|
||||||
|
- Logos are created by from the [PNG icon](./../public/icon.png)
|
||||||
|
- by running `npx electron-icon-builder --input=./public/icon.png --output=build --flatten`
|
||||||
BIN
build/icons/1024x1024.png
Normal file
|
After Width: | Height: | Size: 225 KiB |
BIN
build/icons/128x128.png
Normal file
|
After Width: | Height: | Size: 8.5 KiB |
BIN
build/icons/16x16.png
Normal file
|
After Width: | Height: | Size: 740 B |
BIN
build/icons/24x24.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
build/icons/256x256.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
build/icons/32x32.png
Normal file
|
After Width: | Height: | Size: 1.9 KiB |
BIN
build/icons/48x48.png
Normal file
|
After Width: | Height: | Size: 3.2 KiB |
BIN
build/icons/512x512.png
Normal file
|
After Width: | Height: | Size: 76 KiB |
BIN
build/icons/64x64.png
Normal file
|
After Width: | Height: | Size: 4.1 KiB |
BIN
build/icons/icon.icns
Normal file
BIN
build/icons/icon.ico
Normal file
|
After Width: | Height: | Size: 353 KiB |
161
docs/collection-files.md
Normal file
@@ -0,0 +1,161 @@
|
|||||||
|
# Collection files
|
||||||
|
|
||||||
|
- 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)
|
||||||
|
- 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
|
||||||
|
|
||||||
|
### `Collection`
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
#### `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)**
|
||||||
|
- 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 are optionally defined to re-use the same code throughout different scripts.
|
||||||
|
- `scripting:` ***[`ScriptingDefinition`](#ScriptingDefinition)*** **(required)**
|
||||||
|
- Defines the scripting language that the code of other action uses.
|
||||||
|
|
||||||
|
### `Category`
|
||||||
|
|
||||||
|
- Category has a parent that has tree-like structure where it can have subcategories or subscripts.
|
||||||
|
- It's a logical grouping of different scripts and other categories.
|
||||||
|
|
||||||
|
#### `Category` syntax
|
||||||
|
|
||||||
|
- `category:` *`string`* (**required**)
|
||||||
|
- Name of the category
|
||||||
|
- ❗ Must be unique throughout the [Collection](#collection)
|
||||||
|
- `children: [` ***[`Category`](#Category)*** `|` [***`Script`***](#Script) `, ... ]` (**required**)
|
||||||
|
- ❗ Category must consist of at least one subcategory or script.
|
||||||
|
- Children can be combination of scripts and subcategories.
|
||||||
|
|
||||||
|
### `Script`
|
||||||
|
|
||||||
|
- Script represents a single tweak.
|
||||||
|
- A script must include either:
|
||||||
|
- A `code` and `revertCode`
|
||||||
|
- Or `call` to call YAML-defined functions
|
||||||
|
- 🙏 For any new script, please add `revertCode` and `docs` values if possible.
|
||||||
|
|
||||||
|
#### `Script` syntax
|
||||||
|
|
||||||
|
- `name`: *`string`* (**required**)
|
||||||
|
- Name of the script
|
||||||
|
- ❗ Must be unique throughout the [Collection](#collection)
|
||||||
|
- E.g. `Disable targeted ads`
|
||||||
|
- `code`: *`string`* (may be **required**)
|
||||||
|
- Batch file commands that will be executed
|
||||||
|
- 💡 If defined, best practice to also define `revertCode`
|
||||||
|
- ❗ If not defined `call` must be defined, do not define if `call` is defined.
|
||||||
|
- `revertCode`: `string`
|
||||||
|
- Code that'll undo the change done by `code` property.
|
||||||
|
- 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**)
|
||||||
|
- 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
|
||||||
|
- E.g. `https://docs.microsoft.com/en-us/windows-server/`
|
||||||
|
- `recommend`: `"standard"` | `"strict"` | `undefined` (default)
|
||||||
|
- If not defined then the script will not be recommended
|
||||||
|
- If defined it can be either
|
||||||
|
- `standard`: Only non-breaking scripts without limiting OS functionality
|
||||||
|
- `strict`: Scripts that can break certain functionality in favor of privacy and security
|
||||||
|
|
||||||
|
### `FunctionCall`
|
||||||
|
|
||||||
|
- Describes a single call to a function by optionally providing values to its parameters.
|
||||||
|
- 👀 See [parameter substitution](#parameter-substitution) for an example usage
|
||||||
|
|
||||||
|
#### `FunctionCall` syntax
|
||||||
|
|
||||||
|
- `function`: *`string`* (**required**)
|
||||||
|
- Name of the function to call.
|
||||||
|
- ❗ Function with same name must defined in `functions` property of [Collection](#collection)
|
||||||
|
- `parameters`: `[ parameterName:` *`parameterValue`*`, ... ]`
|
||||||
|
- Defines key value dictionary for each parameter and its value
|
||||||
|
- E.g.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
parameters:
|
||||||
|
userDefinedParameterName: parameterValue
|
||||||
|
# ...
|
||||||
|
appName: Microsoft.WindowsFeedbackHub
|
||||||
|
```
|
||||||
|
|
||||||
|
### `Function`
|
||||||
|
|
||||||
|
- Functions allow re-usable code throughout the defined scripts.
|
||||||
|
- Functions are templates compiled by privacy.sexy and uses special expressions.
|
||||||
|
- Expressions are defined inside mustaches (double brackets, `{{` and `}}`)
|
||||||
|
- 👀 See [parameter substitution](#parameter-substitution) for an example usage
|
||||||
|
|
||||||
|
#### Parameter substitution
|
||||||
|
|
||||||
|
A simple function example
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
function: EchoArgument
|
||||||
|
parameters: [ 'argument' ]
|
||||||
|
code: Hello {{ $argument }} !
|
||||||
|
```
|
||||||
|
|
||||||
|
It would print "Hello world" if it's called in a [script](#script) as following:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
script: Echo script
|
||||||
|
call:
|
||||||
|
function: EchoArgument
|
||||||
|
parameters:
|
||||||
|
argument: World
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `Function` syntax
|
||||||
|
|
||||||
|
- `name`: *`string`* (**required**)
|
||||||
|
- Name of the function that scripts will use.
|
||||||
|
- Convention is to use camelCase, and be verbs.
|
||||||
|
- E.g. `uninstallStoreApp`
|
||||||
|
- ❗ Function names must be unique
|
||||||
|
- `parameters`: `[` *`string`* `, ... ]`
|
||||||
|
- Name of the parameters that the function has.
|
||||||
|
- Parameter values are provided by a [Script](#script) through a [FunctionCall](#FunctionCall)
|
||||||
|
- Parameter names must be defined to be used in expressions such as [parameter substitution](#parameter-substitution)
|
||||||
|
- ❗ Parameter names must be unique
|
||||||
|
`code`: *`string`* (**required**)
|
||||||
|
- Batch file commands that will be executed
|
||||||
|
- 💡 If defined, best practice to also define `revertCode`
|
||||||
|
- `revertCode`: *`string`*
|
||||||
|
- Code that'll undo the change done by `code` property.
|
||||||
|
- 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`
|
||||||
|
|
||||||
|
### `ScriptingDefinition`
|
||||||
|
|
||||||
|
- Defines global properties for scripting that's used throughout its parent [Collection](#collection).
|
||||||
|
|
||||||
|
#### `ScriptingDefinition` syntax
|
||||||
|
|
||||||
|
- `language:` *`string`* (**required**)
|
||||||
|
- 📖 See [ScriptingLanguage.ts](./../src/domain/ScriptingLanguage.ts) enumeration for allowed values.
|
||||||
|
- `startCode:` *`string`* (**required**)
|
||||||
|
- Code that'll be inserted on top of user created script.
|
||||||
|
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
|
||||||
|
- `endCode:` *`string`* (**required**)
|
||||||
|
- Code that'll be inserted at the end of user created script.
|
||||||
|
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
|
||||||
BIN
docs/gitops.png
|
Before Width: | Height: | Size: 233 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
1
img/architecture/gitops.drawio
Normal file
BIN
img/architecture/gitops.png
Normal file
|
After Width: | Height: | Size: 483 KiB |
BIN
img/screenshot.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
6941
package-lock.json
generated
85
package.json
@@ -1,52 +1,71 @@
|
|||||||
{
|
{
|
||||||
"name": "privacy.sexy",
|
"name": "privacy.sexy",
|
||||||
"version": "0.4.3",
|
"version": "0.8.2",
|
||||||
|
"author": "undergroundwires",
|
||||||
|
"description": "Enforce privacy & security best-practices on Windows and macOS, because privacy is sexy 🍑🍆",
|
||||||
|
"homepage": "https://privacy.sexy",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/undergroundwires/privacy.sexy.git"
|
||||||
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"serve": "vue-cli-service serve",
|
"serve": "vue-cli-service serve",
|
||||||
"build": "vue-cli-service build",
|
"build": "vue-cli-service build",
|
||||||
|
"test:unit": "vue-cli-service test:unit",
|
||||||
|
"lint": "npm run lint:vue && npm run lint:yaml && npm run lint:md && npm run lint:md:relative-urls && npm run lint:md:consistency",
|
||||||
|
"electron:build": "vue-cli-service electron:build",
|
||||||
|
"electron:serve": "vue-cli-service electron:serve",
|
||||||
|
"lint:md": "markdownlint **/*.md --ignore node_modules",
|
||||||
|
"lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent",
|
||||||
|
"lint:md:relative-urls": "remark . --frail --use remark-validate-links",
|
||||||
"lint:vue": "vue-cli-service lint --no-fix",
|
"lint:vue": "vue-cli-service lint --no-fix",
|
||||||
"lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
|
"lint:yaml": "yamllint **/*.yaml --ignore=node_modules/**/*.yaml",
|
||||||
"test:unit": "vue-cli-service test:unit",
|
"postinstall": "electron-builder install-app-deps",
|
||||||
"lint:md": "markdownlint **/*.md --ignore node_modules",
|
"postuninstall": "electron-builder install-app-deps"
|
||||||
"lint:md:relative-urls": "remark . --frail --use remark-validate-links",
|
|
||||||
"lint:md:consistency": "remark . --frail --use remark-preset-lint-consistent"
|
|
||||||
},
|
},
|
||||||
|
"main": "background.js",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@fortawesome/fontawesome-svg-core": "^1.2.26",
|
"@fortawesome/fontawesome-svg-core": "^1.2.32",
|
||||||
"@fortawesome/free-brands-svg-icons": "^5.12.0",
|
"@fortawesome/free-brands-svg-icons": "^5.15.1",
|
||||||
"@fortawesome/free-regular-svg-icons": "^5.12.0",
|
"@fortawesome/free-regular-svg-icons": "^5.15.1",
|
||||||
"@fortawesome/free-solid-svg-icons": "^5.12.0",
|
"@fortawesome/free-solid-svg-icons": "^5.15.1",
|
||||||
"@fortawesome/vue-fontawesome": "^0.1.9",
|
"@fortawesome/vue-fontawesome": "^2.0.2",
|
||||||
"ace-builds": "^1.4.7",
|
"ace-builds": "^1.4.12",
|
||||||
"file-saver": "^2.0.2",
|
"file-saver": "^2.0.5",
|
||||||
"inversify": "^5.0.1",
|
"inversify": "^5.0.5",
|
||||||
"liquor-tree": "^0.2.70",
|
"liquor-tree": "^0.2.70",
|
||||||
"v-tooltip": "^2.0.2",
|
"v-tooltip": "2.0.2",
|
||||||
"vue": "^2.6.11",
|
"vue": "^2.6.12",
|
||||||
"vue-class-component": "^7.1.0",
|
"vue-class-component": "^7.2.6",
|
||||||
"vue-property-decorator": "^8.3.0"
|
"vue-js-modal": "^2.0.0-rc.6",
|
||||||
|
"vue-property-decorator": "^9.1.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/ace": "0.0.42",
|
"@types/ace": "0.0.44",
|
||||||
"@types/chai": "^4.2.7",
|
"@types/chai": "^4.2.14",
|
||||||
"@types/file-saver": "^2.0.1",
|
"@types/file-saver": "^2.0.1",
|
||||||
"@types/mocha": "^5.2.7",
|
"@types/mocha": "^8.2.0",
|
||||||
"@vue/cli-plugin-typescript": "^4.4.0",
|
"@vue/cli-plugin-typescript": "^4.5.9",
|
||||||
"@vue/cli-plugin-unit-mocha": "^4.1.1",
|
"@vue/cli-plugin-unit-mocha": "^4.5.9",
|
||||||
"@vue/cli-service": "^4.1.1",
|
"@vue/cli-service": "^4.5.9",
|
||||||
"@vue/test-utils": "1.0.0-beta.30",
|
"@vue/test-utils": "1.1.2",
|
||||||
"chai": "^4.2.0",
|
"chai": "^4.2.0",
|
||||||
|
"electron": "^11.1.0",
|
||||||
|
"electron-devtools-installer": "^3.1.1",
|
||||||
|
"electron-log": "^4.3.1",
|
||||||
|
"electron-updater": "^4.3.5",
|
||||||
"js-yaml-loader": "^1.2.2",
|
"js-yaml-loader": "^1.2.2",
|
||||||
"markdownlint-cli": "^0.23.1",
|
"markdownlint-cli": "^0.26.0",
|
||||||
"remark-cli": "^8.0.0",
|
"remark-cli": "^9.0.0",
|
||||||
"remark-lint-no-dead-urls": "^1.0.2",
|
"remark-lint-no-dead-urls": "^1.1.0",
|
||||||
"remark-preset-lint-consistent": "^3.0.0",
|
"remark-preset-lint-consistent": "^4.0.0",
|
||||||
"remark-validate-links": "^10.0.0",
|
"remark-validate-links": "^10.0.2",
|
||||||
"sass": "^1.24.0",
|
"sass": "^1.30.0",
|
||||||
"sass-loader": "^8.0.0",
|
"sass-loader": "^10.1.0",
|
||||||
"typescript": "^3.7.4",
|
"typescript": "^4.1.3",
|
||||||
"vue-template-compiler": "^2.6.11",
|
"vue-cli-plugin-electron-builder": "^2.0.0-rc.5",
|
||||||
|
"vue-template-compiler": "^2.6.12",
|
||||||
"yaml-lint": "^1.2.4"
|
"yaml-lint": "^1.2.4"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
BIN
public/icon.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
@@ -4,7 +4,7 @@
|
|||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1.0">
|
<meta name="viewport" content="width=device-width,initial-scale=1.0">
|
||||||
<title>Privacy is sexy 🍑🍆 - Enforce privacy & security on Windows</title>
|
<title>Privacy is sexy 🍑🍆 - Enforce privacy & security on Windows and macOS</title>
|
||||||
<meta name="robots" content="index,follow" />
|
<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."/>
|
<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">
|
<link rel="icon" href="<%= BASE_URL %>favicon.ico">
|
||||||
@@ -32,4 +32,4 @@
|
|||||||
<div id="app"></div>
|
<div id="app"></div>
|
||||||
<!-- built files will be auto injected -->
|
<!-- built files will be auto injected -->
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
2
public/robots.txt
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
User-agent: *
|
||||||
|
Disallow:
|
||||||
13
src/App.vue
@@ -5,19 +5,18 @@
|
|||||||
<TheSearchBar class="row" />
|
<TheSearchBar class="row" />
|
||||||
<TheScripts class="row"/>
|
<TheScripts class="row"/>
|
||||||
<TheCodeArea class="row" theme="xcode" />
|
<TheCodeArea class="row" theme="xcode" />
|
||||||
<TheCodeButtons class="row" />
|
<TheCodeButtons class="row code-buttons" />
|
||||||
<TheFooter />
|
<TheFooter />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<script lang="ts">
|
<script lang="ts">
|
||||||
import { Component, Vue, Prop } from 'vue-property-decorator';
|
import { Component, Vue } from 'vue-property-decorator';
|
||||||
import { ApplicationState, IApplicationState } from '@/application/State/ApplicationState';
|
|
||||||
import TheHeader from '@/presentation/TheHeader.vue';
|
import TheHeader from '@/presentation/TheHeader.vue';
|
||||||
import TheFooter from '@/presentation/TheFooter.vue';
|
import TheFooter from '@/presentation/TheFooter/TheFooter.vue';
|
||||||
import TheCodeArea from '@/presentation/TheCodeArea.vue';
|
import TheCodeArea from '@/presentation/TheCodeArea.vue';
|
||||||
import TheCodeButtons from '@/presentation/TheCodeButtons.vue';
|
import TheCodeButtons from '@/presentation/CodeButtons/TheCodeButtons.vue';
|
||||||
import TheSearchBar from '@/presentation/TheSearchBar.vue';
|
import TheSearchBar from '@/presentation/TheSearchBar.vue';
|
||||||
import TheScripts from '@/presentation/Scripts/TheScripts.vue';
|
import TheScripts from '@/presentation/Scripts/TheScripts.vue';
|
||||||
|
|
||||||
@@ -67,6 +66,10 @@ body {
|
|||||||
.row {
|
.row {
|
||||||
margin-bottom: 10px;
|
margin-bottom: 10px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.code-buttons {
|
||||||
|
padding-bottom: 10px;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
43
src/application/Common/Enum.ts
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
// Because we cannot do "T extends enum" 😞 https://github.com/microsoft/TypeScript/issues/30611
|
||||||
|
type EnumType = number | string;
|
||||||
|
type EnumVariable<T extends EnumType, TEnumValue extends EnumType> = { [key in T]: TEnumValue };
|
||||||
|
|
||||||
|
export interface IEnumParser<TEnum> {
|
||||||
|
parseEnum(value: string, propertyName: string): TEnum;
|
||||||
|
}
|
||||||
|
export function createEnumParser<T extends EnumType, TEnumValue extends EnumType>(
|
||||||
|
enumVariable: EnumVariable<T, TEnumValue>): IEnumParser<TEnumValue> {
|
||||||
|
return {
|
||||||
|
parseEnum: (value, propertyName) => parseEnumValue(value, propertyName, enumVariable),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
function parseEnumValue<T extends EnumType, TEnumValue extends EnumType>(
|
||||||
|
value: string,
|
||||||
|
enumName: string,
|
||||||
|
enumVariable: EnumVariable<T, TEnumValue>): TEnumValue {
|
||||||
|
if (!value) {
|
||||||
|
throw new Error(`undefined ${enumName}`);
|
||||||
|
}
|
||||||
|
if (typeof value !== 'string') {
|
||||||
|
throw new Error(`unexpected type of ${enumName}: "${typeof value}"`);
|
||||||
|
}
|
||||||
|
const casedValue = getEnumNames(enumVariable)
|
||||||
|
.find((enumValue) => enumValue.toLowerCase() === value.toLowerCase());
|
||||||
|
if (!casedValue) {
|
||||||
|
throw new Error(`unknown ${enumName}: "${value}"`);
|
||||||
|
}
|
||||||
|
return enumVariable[casedValue as keyof typeof enumVariable];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getEnumNames<T extends EnumType, TEnumValue extends EnumType>(
|
||||||
|
enumVariable: EnumVariable<T, TEnumValue>): string[] {
|
||||||
|
return Object
|
||||||
|
.values(enumVariable)
|
||||||
|
.filter((enumMember) => typeof enumMember === 'string') as string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getEnumValues<T extends EnumType, TEnumValue extends EnumType>(
|
||||||
|
enumVariable: EnumVariable<T, TEnumValue>): TEnumValue[] {
|
||||||
|
return getEnumNames(enumVariable)
|
||||||
|
.map((level) => enumVariable[level]) as TEnumValue[];
|
||||||
|
}
|
||||||
71
src/application/Context/ApplicationContext.ts
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
import { IApplicationContext, IApplicationContextChangedEvent } from './IApplicationContext';
|
||||||
|
import { ICategoryCollectionState } from './State/ICategoryCollectionState';
|
||||||
|
import { CategoryCollectionState } from './State/CategoryCollectionState';
|
||||||
|
import { IApplication } from '@/domain/IApplication';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
import { Signal } from '@/infrastructure/Events/Signal';
|
||||||
|
|
||||||
|
type StateMachine = Map<OperatingSystem, ICategoryCollectionState>;
|
||||||
|
|
||||||
|
export class ApplicationContext implements IApplicationContext {
|
||||||
|
public readonly contextChanged = new Signal<IApplicationContextChangedEvent>();
|
||||||
|
public collection: ICategoryCollection;
|
||||||
|
public currentOs: OperatingSystem;
|
||||||
|
|
||||||
|
public get state(): ICategoryCollectionState {
|
||||||
|
return this.states[this.collection.os];
|
||||||
|
}
|
||||||
|
|
||||||
|
private readonly states: StateMachine;
|
||||||
|
public constructor(
|
||||||
|
public readonly app: IApplication,
|
||||||
|
initialContext: OperatingSystem) {
|
||||||
|
validateApp(app);
|
||||||
|
validateOs(initialContext);
|
||||||
|
this.states = initializeStates(app);
|
||||||
|
this.changeContext(initialContext);
|
||||||
|
}
|
||||||
|
|
||||||
|
public changeContext(os: OperatingSystem): void {
|
||||||
|
if (this.currentOs === os) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.collection = this.app.getCollection(os);
|
||||||
|
if (!this.collection) {
|
||||||
|
throw new Error(`os "${OperatingSystem[os]}" is not defined in application`);
|
||||||
|
}
|
||||||
|
const event: IApplicationContextChangedEvent = {
|
||||||
|
newState: this.states[os],
|
||||||
|
oldState: this.states[this.currentOs],
|
||||||
|
};
|
||||||
|
this.contextChanged.notify(event);
|
||||||
|
this.currentOs = os;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateApp(app: IApplication) {
|
||||||
|
if (!app) {
|
||||||
|
throw new Error('undefined app');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateOs(os: OperatingSystem) {
|
||||||
|
if (os === undefined) {
|
||||||
|
throw new Error('undefined os');
|
||||||
|
}
|
||||||
|
if (os === OperatingSystem.Unknown) {
|
||||||
|
throw new Error('unknown os');
|
||||||
|
}
|
||||||
|
if (!(os in OperatingSystem)) {
|
||||||
|
throw new Error(`os "${os}" is out of range`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function initializeStates(app: IApplication): StateMachine {
|
||||||
|
const machine = new Map<OperatingSystem, ICategoryCollectionState>();
|
||||||
|
for (const collection of app.collections) {
|
||||||
|
machine[collection.os] = new CategoryCollectionState(collection);
|
||||||
|
}
|
||||||
|
return machine;
|
||||||
|
}
|
||||||
31
src/application/Context/ApplicationContextProvider.ts
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
import { ApplicationContext } from './ApplicationContext';
|
||||||
|
import { IApplicationContext } from '@/application/Context/IApplicationContext';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
import { Environment } from '../Environment/Environment';
|
||||||
|
import { IApplication } from '@/domain/IApplication';
|
||||||
|
import { IEnvironment } from '../Environment/IEnvironment';
|
||||||
|
import { parseApplication } from '../Parser/ApplicationParser';
|
||||||
|
|
||||||
|
export type ApplicationParserType = () => IApplication;
|
||||||
|
const ApplicationParser: ApplicationParserType = parseApplication;
|
||||||
|
|
||||||
|
export function buildContext(
|
||||||
|
parser = ApplicationParser,
|
||||||
|
environment = Environment.CurrentEnvironment): IApplicationContext {
|
||||||
|
const app = parser();
|
||||||
|
const os = getInitialOs(app, environment);
|
||||||
|
return new ApplicationContext(app, os);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getInitialOs(app: IApplication, environment: IEnvironment): OperatingSystem {
|
||||||
|
const currentOs = environment.os;
|
||||||
|
const supportedOsList = app.getSupportedOsList();
|
||||||
|
if (supportedOsList.includes(currentOs)) {
|
||||||
|
return currentOs;
|
||||||
|
}
|
||||||
|
supportedOsList.sort((os1, os2) => {
|
||||||
|
const getPriority = (os: OperatingSystem) => app.getCollection(os).totalScripts;
|
||||||
|
return getPriority(os2) - getPriority(os1);
|
||||||
|
});
|
||||||
|
return supportedOsList[0];
|
||||||
|
}
|
||||||
16
src/application/Context/IApplicationContext.ts
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import { ICategoryCollectionState } from './State/ICategoryCollectionState';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
import { ISignal } from '@/infrastructure/Events/ISignal';
|
||||||
|
import { IApplication } from '@/domain/IApplication';
|
||||||
|
|
||||||
|
export interface IApplicationContext {
|
||||||
|
readonly app: IApplication;
|
||||||
|
readonly state: ICategoryCollectionState;
|
||||||
|
readonly contextChanged: ISignal<IApplicationContextChangedEvent>;
|
||||||
|
changeContext(os: OperatingSystem): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IApplicationContextChangedEvent {
|
||||||
|
readonly newState: ICategoryCollectionState;
|
||||||
|
readonly oldState: ICategoryCollectionState;
|
||||||
|
}
|
||||||
23
src/application/Context/State/CategoryCollectionState.ts
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
import { UserFilter } from './Filter/UserFilter';
|
||||||
|
import { IUserFilter } from './Filter/IUserFilter';
|
||||||
|
import { ApplicationCode } from './Code/ApplicationCode';
|
||||||
|
import { UserSelection } from './Selection/UserSelection';
|
||||||
|
import { IUserSelection } from './Selection/IUserSelection';
|
||||||
|
import { ICategoryCollectionState } from './ICategoryCollectionState';
|
||||||
|
import { IApplicationCode } from './Code/IApplicationCode';
|
||||||
|
import { ICategoryCollection } from '../../../domain/ICategoryCollection';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
export class CategoryCollectionState implements ICategoryCollectionState {
|
||||||
|
public readonly os: OperatingSystem;
|
||||||
|
public readonly code: IApplicationCode;
|
||||||
|
public readonly selection: IUserSelection;
|
||||||
|
public readonly filter: IUserFilter;
|
||||||
|
|
||||||
|
public constructor(readonly collection: ICategoryCollection) {
|
||||||
|
this.selection = new UserSelection(collection, []);
|
||||||
|
this.code = new ApplicationCode(this.selection, collection.scripting);
|
||||||
|
this.filter = new UserFilter(collection);
|
||||||
|
this.os = collection.os;
|
||||||
|
}
|
||||||
|
}
|
||||||
39
src/application/Context/State/Code/ApplicationCode.ts
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import { CodeChangedEvent } from './Event/CodeChangedEvent';
|
||||||
|
import { CodePosition } from './Position/CodePosition';
|
||||||
|
import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
|
||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||||
|
import { IUserSelection } from '@/application/Context/State/Selection/IUserSelection';
|
||||||
|
import { UserScriptGenerator } from './Generation/UserScriptGenerator';
|
||||||
|
import { Signal } from '@/infrastructure/Events/Signal';
|
||||||
|
import { IApplicationCode } from './IApplicationCode';
|
||||||
|
import { IUserScriptGenerator } from './Generation/IUserScriptGenerator';
|
||||||
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
|
||||||
|
export class ApplicationCode implements IApplicationCode {
|
||||||
|
public readonly changed = new Signal<ICodeChangedEvent>();
|
||||||
|
public current: string;
|
||||||
|
|
||||||
|
private scriptPositions = new Map<SelectedScript, CodePosition>();
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
userSelection: IUserSelection,
|
||||||
|
private readonly scriptingDefinition: IScriptingDefinition,
|
||||||
|
private readonly generator: IUserScriptGenerator = new UserScriptGenerator()) {
|
||||||
|
if (!userSelection) { throw new Error('userSelection is null or undefined'); }
|
||||||
|
if (!scriptingDefinition) { throw new Error('scriptingDefinition is null or undefined'); }
|
||||||
|
if (!generator) { throw new Error('generator is null or undefined'); }
|
||||||
|
this.setCode(userSelection.selectedScripts);
|
||||||
|
userSelection.changed.on((scripts) => {
|
||||||
|
this.setCode(scripts);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private setCode(scripts: ReadonlyArray<SelectedScript>): void {
|
||||||
|
const oldScripts = Array.from(this.scriptPositions.keys());
|
||||||
|
const code = this.generator.buildCode(scripts, this.scriptingDefinition);
|
||||||
|
this.current = code.code;
|
||||||
|
this.scriptPositions = code.scriptPositions;
|
||||||
|
const event = new CodeChangedEvent(code.code, oldScripts, code.scriptPositions);
|
||||||
|
this.changed.notify(event);
|
||||||
|
}
|
||||||
|
}
|
||||||
64
src/application/Context/State/Code/Event/CodeChangedEvent.ts
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
import { ICodeChangedEvent } from './ICodeChangedEvent';
|
||||||
|
import { SelectedScript } from '../../Selection/SelectedScript';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
|
|
||||||
|
export class CodeChangedEvent implements ICodeChangedEvent {
|
||||||
|
public readonly code: string;
|
||||||
|
public readonly addedScripts: ReadonlyArray<IScript>;
|
||||||
|
public readonly removedScripts: ReadonlyArray<IScript>;
|
||||||
|
public readonly changedScripts: ReadonlyArray<IScript>;
|
||||||
|
|
||||||
|
private readonly scripts: Map<IScript, ICodePosition>;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
code: string,
|
||||||
|
oldScripts: ReadonlyArray<SelectedScript>,
|
||||||
|
scripts: Map<SelectedScript, ICodePosition>) {
|
||||||
|
ensureAllPositionsExist(code, Array.from(scripts.values()));
|
||||||
|
this.code = code;
|
||||||
|
const newScripts = Array.from(scripts.keys());
|
||||||
|
this.addedScripts = selectIfNotExists(newScripts, oldScripts);
|
||||||
|
this.removedScripts = selectIfNotExists(oldScripts, newScripts);
|
||||||
|
this.changedScripts = getChangedScripts(oldScripts, newScripts);
|
||||||
|
this.scripts = new Map<IScript, ICodePosition>();
|
||||||
|
scripts.forEach((position, selection) => {
|
||||||
|
this.scripts.set(selection.script, position);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public isEmpty(): boolean {
|
||||||
|
return this.scripts.size === 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
public getScriptPositionInCode(script: IScript): ICodePosition {
|
||||||
|
return this.scripts.get(script);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureAllPositionsExist(script: string, positions: ReadonlyArray<ICodePosition>) {
|
||||||
|
const totalLines = script.split(/\r\n|\r|\n/).length;
|
||||||
|
for (const position of positions) {
|
||||||
|
if (position.endLine > totalLines) {
|
||||||
|
throw new Error(`script end line (${position.endLine}) is out of range.` +
|
||||||
|
`(total code lines: ${totalLines}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getChangedScripts(
|
||||||
|
oldScripts: ReadonlyArray<SelectedScript>,
|
||||||
|
newScripts: ReadonlyArray<SelectedScript>): ReadonlyArray<IScript> {
|
||||||
|
return newScripts
|
||||||
|
.filter((newScript) => oldScripts.find((oldScript) => oldScript.id === newScript.id
|
||||||
|
&& oldScript.revert !== newScript.revert ))
|
||||||
|
.map((selection) => selection.script);
|
||||||
|
}
|
||||||
|
|
||||||
|
function selectIfNotExists(
|
||||||
|
selectableContainer: ReadonlyArray<SelectedScript>,
|
||||||
|
test: ReadonlyArray<SelectedScript>) {
|
||||||
|
return selectableContainer
|
||||||
|
.filter((script) => !test.find((oldScript) => oldScript.id === script.id))
|
||||||
|
.map((selection) => selection.script);
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
|
|
||||||
|
export interface ICodeChangedEvent {
|
||||||
|
readonly code: string;
|
||||||
|
addedScripts: ReadonlyArray<IScript>;
|
||||||
|
removedScripts: ReadonlyArray<IScript>;
|
||||||
|
changedScripts: ReadonlyArray<IScript>;
|
||||||
|
isEmpty(): boolean;
|
||||||
|
getScriptPositionInCode(script: IScript): ICodePosition;
|
||||||
|
}
|
||||||
@@ -1,11 +1,25 @@
|
|||||||
|
import { ICodeBuilder } from './ICodeBuilder';
|
||||||
|
|
||||||
const NewLine = '\n';
|
const NewLine = '\n';
|
||||||
const TotalFunctionSeparatorChars = 58;
|
const TotalFunctionSeparatorChars = 58;
|
||||||
|
|
||||||
export class CodeBuilder {
|
export abstract class CodeBuilder implements ICodeBuilder {
|
||||||
private readonly lines = new Array<string>();
|
private readonly lines = new Array<string>();
|
||||||
|
|
||||||
|
// Returns current line starting from 0 (no lines), or 1 (have single line)
|
||||||
|
public get currentLine(): number {
|
||||||
|
return this.lines.length;
|
||||||
|
}
|
||||||
|
|
||||||
public appendLine(code?: string): CodeBuilder {
|
public appendLine(code?: string): CodeBuilder {
|
||||||
this.lines.push(code);
|
if (!code) {
|
||||||
|
this.lines.push('');
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
const lines = code.match(/[^\r\n]+/g);
|
||||||
|
for (const line of lines) {
|
||||||
|
this.lines.push(line);
|
||||||
|
}
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -15,7 +29,7 @@ export class CodeBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public appendCommentLine(commentLine?: string): CodeBuilder {
|
public appendCommentLine(commentLine?: string): CodeBuilder {
|
||||||
this.lines.push(`:: ${commentLine}`);
|
this.lines.push(`${this.getCommentDelimiter()} ${commentLine}`);
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -23,9 +37,8 @@ export class CodeBuilder {
|
|||||||
if (!name) { throw new Error('name cannot be empty or null'); }
|
if (!name) { throw new Error('name cannot be empty or null'); }
|
||||||
if (!code) { throw new Error('code cannot be empty or null'); }
|
if (!code) { throw new Error('code cannot be empty or null'); }
|
||||||
return this
|
return this
|
||||||
.appendLine()
|
|
||||||
.appendCommentLineWithHyphensAround(name)
|
.appendCommentLineWithHyphensAround(name)
|
||||||
.appendLine(`echo --- ${name}`)
|
.appendLine(this.writeStandardOut(`--- ${name}`))
|
||||||
.appendLine(code)
|
.appendLine(code)
|
||||||
.appendTrailingHyphensCommentLine();
|
.appendTrailingHyphensCommentLine();
|
||||||
}
|
}
|
||||||
@@ -42,10 +55,13 @@ export class CodeBuilder {
|
|||||||
return this
|
return this
|
||||||
.appendTrailingHyphensCommentLine()
|
.appendTrailingHyphensCommentLine()
|
||||||
.appendCommentLine(firstHyphens + sectionName + secondHyphens)
|
.appendCommentLine(firstHyphens + sectionName + secondHyphens)
|
||||||
.appendTrailingHyphensCommentLine();
|
.appendTrailingHyphensCommentLine(TotalFunctionSeparatorChars);
|
||||||
}
|
}
|
||||||
|
|
||||||
public toString(): string {
|
public toString(): string {
|
||||||
return this.lines.join(NewLine);
|
return this.lines.join(NewLine);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected abstract getCommentDelimiter(): string;
|
||||||
|
protected abstract writeStandardOut(text: string): string;
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
||||||
|
import { ICodeBuilder } from './ICodeBuilder';
|
||||||
|
import { ICodeBuilderFactory } from './ICodeBuilderFactory';
|
||||||
|
import { BatchBuilder } from './Languages/BatchBuilder';
|
||||||
|
import { ShellBuilder } from './Languages/ShellBuilder';
|
||||||
|
|
||||||
|
export class CodeBuilderFactory implements ICodeBuilderFactory {
|
||||||
|
public create(language: ScriptingLanguage): ICodeBuilder {
|
||||||
|
switch (language) {
|
||||||
|
case ScriptingLanguage.shellscript: return new ShellBuilder();
|
||||||
|
case ScriptingLanguage.batchfile: return new BatchBuilder();
|
||||||
|
default: throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
export interface ICodeBuilder {
|
||||||
|
currentLine: number;
|
||||||
|
appendLine(code?: string): ICodeBuilder;
|
||||||
|
appendTrailingHyphensCommentLine(totalRepeatHyphens: number): ICodeBuilder;
|
||||||
|
appendCommentLine(commentLine?: string): ICodeBuilder;
|
||||||
|
appendCommentLineWithHyphensAround(sectionName: string, totalRepeatHyphens: number): ICodeBuilder;
|
||||||
|
appendFunction(name: string, code: string): ICodeBuilder;
|
||||||
|
toString(): string;
|
||||||
|
}
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
||||||
|
import { ICodeBuilder } from './ICodeBuilder';
|
||||||
|
|
||||||
|
export interface ICodeBuilderFactory {
|
||||||
|
create(language: ScriptingLanguage): ICodeBuilder;
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||||
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
|
|
||||||
|
export interface IUserScript {
|
||||||
|
code: string;
|
||||||
|
scriptPositions: Map<SelectedScript, ICodePosition>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||||
|
import { IUserScript } from './IUserScript';
|
||||||
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
|
||||||
|
export interface IUserScriptGenerator {
|
||||||
|
buildCode(
|
||||||
|
selectedScripts: ReadonlyArray<SelectedScript>,
|
||||||
|
scriptingDefinition: IScriptingDefinition): IUserScript;
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import { CodeBuilder } from '@/application/Context/State/Code/Generation/CodeBuilder';
|
||||||
|
|
||||||
|
export class BatchBuilder extends CodeBuilder {
|
||||||
|
protected getCommentDelimiter(): string {
|
||||||
|
return '::';
|
||||||
|
}
|
||||||
|
protected writeStandardOut(text: string): string {
|
||||||
|
return `echo ${text}`;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import { CodeBuilder } from '@/application/Context/State/Code/Generation/CodeBuilder';
|
||||||
|
|
||||||
|
export class ShellBuilder extends CodeBuilder {
|
||||||
|
protected getCommentDelimiter(): string {
|
||||||
|
return '#';
|
||||||
|
}
|
||||||
|
protected writeStandardOut(text: string): string {
|
||||||
|
return `echo '${text}'`;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
|
||||||
|
import { IUserScriptGenerator } from './IUserScriptGenerator';
|
||||||
|
import { ICodePosition } from '@/application/Context/State/Code/Position/ICodePosition';
|
||||||
|
import { CodePosition } from '../Position/CodePosition';
|
||||||
|
import { IUserScript } from './IUserScript';
|
||||||
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
import { ICodeBuilder } from './ICodeBuilder';
|
||||||
|
import { ICodeBuilderFactory } from './ICodeBuilderFactory';
|
||||||
|
import { CodeBuilderFactory } from './CodeBuilderFactory';
|
||||||
|
|
||||||
|
export class UserScriptGenerator implements IUserScriptGenerator {
|
||||||
|
constructor(private readonly codeBuilderFactory: ICodeBuilderFactory = new CodeBuilderFactory()) {
|
||||||
|
|
||||||
|
}
|
||||||
|
public buildCode(
|
||||||
|
selectedScripts: ReadonlyArray<SelectedScript>,
|
||||||
|
scriptingDefinition: IScriptingDefinition): IUserScript {
|
||||||
|
if (!selectedScripts) { throw new Error('undefined scripts'); }
|
||||||
|
if (!scriptingDefinition) { throw new Error('undefined definition'); }
|
||||||
|
let scriptPositions = new Map<SelectedScript, ICodePosition>();
|
||||||
|
if (!selectedScripts.length) {
|
||||||
|
return { code: '', scriptPositions };
|
||||||
|
}
|
||||||
|
let builder = this.codeBuilderFactory.create(scriptingDefinition.language);
|
||||||
|
builder = initializeCode(scriptingDefinition.startCode, builder);
|
||||||
|
for (const selection of selectedScripts) {
|
||||||
|
scriptPositions = appendSelection(selection, scriptPositions, builder);
|
||||||
|
}
|
||||||
|
const code = finalizeCode(builder, scriptingDefinition.endCode);
|
||||||
|
return { code, scriptPositions };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function initializeCode(startCode: string, builder: ICodeBuilder): ICodeBuilder {
|
||||||
|
if (!startCode) {
|
||||||
|
return builder;
|
||||||
|
}
|
||||||
|
return builder
|
||||||
|
.appendLine(startCode)
|
||||||
|
.appendLine();
|
||||||
|
}
|
||||||
|
|
||||||
|
function finalizeCode(builder: ICodeBuilder, endCode: string): string {
|
||||||
|
if (!endCode) {
|
||||||
|
return builder.toString();
|
||||||
|
}
|
||||||
|
return builder.appendLine()
|
||||||
|
.appendLine(endCode)
|
||||||
|
.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
function appendSelection(
|
||||||
|
selection: SelectedScript,
|
||||||
|
scriptPositions: Map<SelectedScript, ICodePosition>,
|
||||||
|
builder: ICodeBuilder): Map<SelectedScript, ICodePosition> {
|
||||||
|
const startPosition = builder.currentLine + 1; // Because first line will be empty to separate scripts
|
||||||
|
builder = appendCode(selection, builder);
|
||||||
|
const endPosition = builder.currentLine - 1;
|
||||||
|
builder.appendLine();
|
||||||
|
const position = new CodePosition(startPosition, endPosition);
|
||||||
|
scriptPositions.set(selection, position);
|
||||||
|
return scriptPositions;
|
||||||
|
}
|
||||||
|
|
||||||
|
function appendCode(selection: SelectedScript, builder: ICodeBuilder): ICodeBuilder {
|
||||||
|
const name = selection.revert ? `${selection.script.name} (revert)` : selection.script.name;
|
||||||
|
const scriptCode = selection.revert ? selection.script.code.revert : selection.script.code.execute;
|
||||||
|
return builder
|
||||||
|
.appendLine()
|
||||||
|
.appendFunction(name, scriptCode);
|
||||||
|
}
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
|
import { ICodeChangedEvent } from './Event/ICodeChangedEvent';
|
||||||
import { ISignal } from '@/infrastructure/Events/ISignal';
|
import { ISignal } from '@/infrastructure/Events/ISignal';
|
||||||
|
|
||||||
export interface IApplicationCode {
|
export interface IApplicationCode {
|
||||||
readonly changed: ISignal<string>;
|
readonly changed: ISignal<ICodeChangedEvent>;
|
||||||
readonly current: string;
|
readonly current: string;
|
||||||
}
|
}
|
||||||
24
src/application/Context/State/Code/Position/CodePosition.ts
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
import { ICodePosition } from './ICodePosition';
|
||||||
|
|
||||||
|
export class CodePosition implements ICodePosition {
|
||||||
|
public get totalLines(): number {
|
||||||
|
return this.endLine - this.startLine;
|
||||||
|
}
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
public readonly startLine: number,
|
||||||
|
public readonly endLine: number) {
|
||||||
|
if (startLine < 0) {
|
||||||
|
throw new Error('Code cannot start in a negative line');
|
||||||
|
}
|
||||||
|
if (endLine < 0) {
|
||||||
|
throw new Error('Code cannot end in a negative line');
|
||||||
|
}
|
||||||
|
if (endLine === startLine) {
|
||||||
|
throw new Error('Empty code');
|
||||||
|
}
|
||||||
|
if (endLine < startLine) {
|
||||||
|
throw new Error('End line cannot be less than start line');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
export interface ICodePosition {
|
||||||
|
readonly startLine: number;
|
||||||
|
readonly endLine: number;
|
||||||
|
readonly totalLines: number;
|
||||||
|
}
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
import { IFilterResult } from './IFilterResult';
|
import { IFilterResult } from './IFilterResult';
|
||||||
import { IScript } from '@/domain/Script';
|
import { IScript } from '@/domain/IScript';
|
||||||
import { ICategory } from '@/domain/ICategory';
|
import { ICategory } from '@/domain/ICategory';
|
||||||
|
|
||||||
export class FilterResult implements IFilterResult {
|
export class FilterResult implements IFilterResult {
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
|
import { ISignal } from '@/infrastructure/Events/ISignal';
|
||||||
import { IFilterResult } from './IFilterResult';
|
import { IFilterResult } from './IFilterResult';
|
||||||
import { ISignal } from '@/infrastructure/Events/Signal';
|
|
||||||
|
|
||||||
export interface IUserFilter {
|
export interface IUserFilter {
|
||||||
|
readonly currentFilter: IFilterResult | undefined;
|
||||||
readonly filtered: ISignal<IFilterResult>;
|
readonly filtered: ISignal<IFilterResult>;
|
||||||
readonly filterRemoved: ISignal<void>;
|
readonly filterRemoved: ISignal<void>;
|
||||||
setFilter(filter: string): void;
|
setFilter(filter: string): void;
|
||||||
52
src/application/Context/State/Filter/UserFilter.ts
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { FilterResult } from './FilterResult';
|
||||||
|
import { IFilterResult } from './IFilterResult';
|
||||||
|
import { IUserFilter } from './IUserFilter';
|
||||||
|
import { Signal } from '@/infrastructure/Events/Signal';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
|
||||||
|
export class UserFilter implements IUserFilter {
|
||||||
|
public readonly filtered = new Signal<IFilterResult>();
|
||||||
|
public readonly filterRemoved = new Signal<void>();
|
||||||
|
public currentFilter: IFilterResult | undefined;
|
||||||
|
|
||||||
|
constructor(private collection: ICategoryCollection) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
public setFilter(filter: string): void {
|
||||||
|
if (!filter) {
|
||||||
|
throw new Error('Filter must be defined and not empty. Use removeFilter() to remove the filter');
|
||||||
|
}
|
||||||
|
const filterLowercase = filter.toLocaleLowerCase();
|
||||||
|
const filteredScripts = this.collection.getAllScripts().filter(
|
||||||
|
(script) => isScriptAMatch(script, filterLowercase));
|
||||||
|
const filteredCategories = this.collection.getAllCategories().filter(
|
||||||
|
(category) => category.name.toLowerCase().includes(filterLowercase));
|
||||||
|
const matches = new FilterResult(
|
||||||
|
filteredScripts,
|
||||||
|
filteredCategories,
|
||||||
|
filter,
|
||||||
|
);
|
||||||
|
this.currentFilter = matches;
|
||||||
|
this.filtered.notify(matches);
|
||||||
|
}
|
||||||
|
|
||||||
|
public removeFilter(): void {
|
||||||
|
this.currentFilter = undefined;
|
||||||
|
this.filterRemoved.notify();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function isScriptAMatch(script: IScript, filterLowercase: string) {
|
||||||
|
if (script.name.toLowerCase().includes(filterLowercase)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (script.code.execute.toLowerCase().includes(filterLowercase)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
if (script.code.revert) {
|
||||||
|
return script.code.revert.toLowerCase().includes(filterLowercase);
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
13
src/application/Context/State/ICategoryCollectionState.ts
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
import { IUserFilter } from './Filter/IUserFilter';
|
||||||
|
import { IUserSelection } from './Selection/IUserSelection';
|
||||||
|
import { IApplicationCode } from './Code/IApplicationCode';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
export interface ICategoryCollectionState {
|
||||||
|
readonly code: IApplicationCode;
|
||||||
|
readonly filter: IUserFilter;
|
||||||
|
readonly selection: IUserSelection;
|
||||||
|
readonly collection: ICategoryCollection;
|
||||||
|
readonly os: OperatingSystem;
|
||||||
|
}
|
||||||
21
src/application/Context/State/Selection/IUserSelection.ts
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import { SelectedScript } from './SelectedScript';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { ICategory } from '@/domain/ICategory';
|
||||||
|
import { ISignal } from '@/infrastructure/Events/ISignal';
|
||||||
|
|
||||||
|
export interface IUserSelection {
|
||||||
|
readonly changed: ISignal<ReadonlyArray<SelectedScript>>;
|
||||||
|
readonly selectedScripts: ReadonlyArray<SelectedScript>;
|
||||||
|
readonly totalSelected: number;
|
||||||
|
areAllSelected(category: ICategory): boolean;
|
||||||
|
isAnySelected(category: ICategory): boolean;
|
||||||
|
removeAllInCategory(categoryId: number): void;
|
||||||
|
addOrUpdateAllInCategory(categoryId: number, revert: boolean): void;
|
||||||
|
addSelectedScript(scriptId: string, revert: boolean): void;
|
||||||
|
addOrUpdateSelectedScript(scriptId: string, revert: boolean): void;
|
||||||
|
removeSelectedScript(scriptId: string): void;
|
||||||
|
selectOnly(scripts: ReadonlyArray<IScript>): void;
|
||||||
|
isSelected(scriptId: string): boolean;
|
||||||
|
selectAll(): void;
|
||||||
|
deselectAll(): void;
|
||||||
|
}
|
||||||
14
src/application/Context/State/Selection/SelectedScript.ts
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
import { BaseEntity } from '@/infrastructure/Entity/BaseEntity';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
|
||||||
|
export class SelectedScript extends BaseEntity<string> {
|
||||||
|
constructor(
|
||||||
|
public readonly script: IScript,
|
||||||
|
public readonly revert: boolean,
|
||||||
|
) {
|
||||||
|
super(script.id);
|
||||||
|
if (revert && !script.canRevert()) {
|
||||||
|
throw new Error('cannot revert an irreversible script');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
145
src/application/Context/State/Selection/UserSelection.ts
Normal file
@@ -0,0 +1,145 @@
|
|||||||
|
import { SelectedScript } from './SelectedScript';
|
||||||
|
import { IUserSelection } from './IUserSelection';
|
||||||
|
import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
|
||||||
|
import { IScript } from '@/domain/IScript';
|
||||||
|
import { Signal } from '@/infrastructure/Events/Signal';
|
||||||
|
import { IRepository } from '@/infrastructure/Repository/IRepository';
|
||||||
|
import { ICategory } from '@/domain/ICategory';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
|
||||||
|
export class UserSelection implements IUserSelection {
|
||||||
|
public readonly changed = new Signal<ReadonlyArray<SelectedScript>>();
|
||||||
|
private readonly scripts: IRepository<string, SelectedScript>;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
private readonly collection: ICategoryCollection,
|
||||||
|
selectedScripts: ReadonlyArray<SelectedScript>) {
|
||||||
|
this.scripts = new InMemoryRepository<string, SelectedScript>();
|
||||||
|
if (selectedScripts && selectedScripts.length > 0) {
|
||||||
|
for (const script of selectedScripts) {
|
||||||
|
this.scripts.addItem(script);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public areAllSelected(category: ICategory): boolean {
|
||||||
|
if (this.selectedScripts.length === 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
const scripts = category.getAllScriptsRecursively();
|
||||||
|
if (this.selectedScripts.length < scripts.length) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return scripts.every((script) => this.selectedScripts.some((selected) => selected.id === script.id));
|
||||||
|
}
|
||||||
|
|
||||||
|
public isAnySelected(category: ICategory): boolean {
|
||||||
|
if (this.selectedScripts.length === 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return this.selectedScripts.some((s) => category.includes(s.script));
|
||||||
|
}
|
||||||
|
|
||||||
|
public removeAllInCategory(categoryId: number): void {
|
||||||
|
const category = this.collection.findCategory(categoryId);
|
||||||
|
const scriptsToRemove = category.getAllScriptsRecursively()
|
||||||
|
.filter((script) => this.scripts.exists(script.id));
|
||||||
|
if (!scriptsToRemove.length) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for (const script of scriptsToRemove) {
|
||||||
|
this.scripts.removeItem(script.id);
|
||||||
|
}
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
|
||||||
|
public addOrUpdateAllInCategory(categoryId: number, revert: boolean = false): void {
|
||||||
|
const category = this.collection.findCategory(categoryId);
|
||||||
|
const scriptsToAddOrUpdate = category.getAllScriptsRecursively()
|
||||||
|
.filter((script) =>
|
||||||
|
!this.scripts.exists(script.id)
|
||||||
|
|| this.scripts.getById(script.id).revert !== revert,
|
||||||
|
);
|
||||||
|
if (!scriptsToAddOrUpdate.length) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
for (const script of scriptsToAddOrUpdate) {
|
||||||
|
const selectedScript = new SelectedScript(script, revert);
|
||||||
|
this.scripts.addOrUpdateItem(selectedScript);
|
||||||
|
}
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
|
||||||
|
public addSelectedScript(scriptId: string, revert: boolean): void {
|
||||||
|
const script = this.collection.findScript(scriptId);
|
||||||
|
if (!script) {
|
||||||
|
throw new Error(`Cannot add (id: ${scriptId}) as it is unknown`);
|
||||||
|
}
|
||||||
|
const selectedScript = new SelectedScript(script, revert);
|
||||||
|
this.scripts.addItem(selectedScript);
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
|
||||||
|
public addOrUpdateSelectedScript(scriptId: string, revert: boolean): void {
|
||||||
|
const script = this.collection.findScript(scriptId);
|
||||||
|
const selectedScript = new SelectedScript(script, revert);
|
||||||
|
this.scripts.addOrUpdateItem(selectedScript);
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
|
||||||
|
public removeSelectedScript(scriptId: string): void {
|
||||||
|
this.scripts.removeItem(scriptId);
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
|
||||||
|
public isSelected(scriptId: string): boolean {
|
||||||
|
return this.scripts.exists(scriptId);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Get users scripts based on his/her selections */
|
||||||
|
public get selectedScripts(): ReadonlyArray<SelectedScript> {
|
||||||
|
return this.scripts.getItems();
|
||||||
|
}
|
||||||
|
|
||||||
|
public get totalSelected(): number {
|
||||||
|
return this.scripts.getItems().length;
|
||||||
|
}
|
||||||
|
|
||||||
|
public selectAll(): void {
|
||||||
|
for (const script of this.collection.getAllScripts()) {
|
||||||
|
if (!this.scripts.exists(script.id)) {
|
||||||
|
const selection = new SelectedScript(script, false);
|
||||||
|
this.scripts.addItem(selection);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
|
||||||
|
public deselectAll(): void {
|
||||||
|
const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
|
||||||
|
for (const scriptId of selectedScriptIds) {
|
||||||
|
this.scripts.removeItem(scriptId);
|
||||||
|
}
|
||||||
|
this.changed.notify([]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public selectOnly(scripts: readonly IScript[]): void {
|
||||||
|
if (!scripts || scripts.length === 0) {
|
||||||
|
throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
|
||||||
|
}
|
||||||
|
// Unselect from selected scripts
|
||||||
|
if (this.scripts.length !== 0) {
|
||||||
|
this.scripts.getItems()
|
||||||
|
.filter((existing) => !scripts.some((script) => existing.id === script.id))
|
||||||
|
.map((script) => script.id)
|
||||||
|
.forEach((scriptId) => this.scripts.removeItem(scriptId));
|
||||||
|
}
|
||||||
|
// Select from unselected scripts
|
||||||
|
const unselectedScripts = scripts.filter((script) => !this.scripts.exists(script.id));
|
||||||
|
for (const toSelect of unselectedScripts) {
|
||||||
|
const selection = new SelectedScript(toSelect, false);
|
||||||
|
this.scripts.addItem(selection);
|
||||||
|
}
|
||||||
|
this.changed.notify(this.scripts.getItems());
|
||||||
|
}
|
||||||
|
}
|
||||||
54
src/application/Environment/BrowserOs/BrowserOsDetector.ts
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
import { DetectorBuilder } from './DetectorBuilder';
|
||||||
|
import { IBrowserOsDetector } from './IBrowserOsDetector';
|
||||||
|
|
||||||
|
export class BrowserOsDetector implements IBrowserOsDetector {
|
||||||
|
private readonly detectors = BrowserDetectors;
|
||||||
|
public detect(userAgent: string): OperatingSystem {
|
||||||
|
if (!userAgent) {
|
||||||
|
return OperatingSystem.Unknown;
|
||||||
|
}
|
||||||
|
for (const detector of this.detectors) {
|
||||||
|
const os = detector.detect(userAgent);
|
||||||
|
if (os !== OperatingSystem.Unknown) {
|
||||||
|
return os;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return OperatingSystem.Unknown;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reference: https://github.com/keithws/browser-report/blob/master/index.js#L304
|
||||||
|
const BrowserDetectors =
|
||||||
|
[
|
||||||
|
define(OperatingSystem.KaiOS, (b) =>
|
||||||
|
b.mustInclude('KAIOS')),
|
||||||
|
define(OperatingSystem.ChromeOS, (b) =>
|
||||||
|
b.mustInclude('CrOS')),
|
||||||
|
define(OperatingSystem.BlackBerryOS, (b) =>
|
||||||
|
b.mustInclude('BlackBerry')),
|
||||||
|
define(OperatingSystem.BlackBerryTabletOS, (b) =>
|
||||||
|
b.mustInclude('RIM Tablet OS')),
|
||||||
|
define(OperatingSystem.BlackBerry, (b) =>
|
||||||
|
b.mustInclude('BB10')),
|
||||||
|
define(OperatingSystem.Android, (b) =>
|
||||||
|
b.mustInclude('Android').mustNotInclude('Windows Phone')),
|
||||||
|
define(OperatingSystem.Android, (b) =>
|
||||||
|
b.mustInclude('Adr').mustNotInclude('Windows Phone')),
|
||||||
|
define(OperatingSystem.iOS, (b) =>
|
||||||
|
b.mustInclude('like Mac OS X')),
|
||||||
|
define(OperatingSystem.Linux, (b) =>
|
||||||
|
b.mustInclude('Linux').mustNotInclude('Android').mustNotInclude('Adr')),
|
||||||
|
define(OperatingSystem.Windows, (b) =>
|
||||||
|
b.mustInclude('Windows').mustNotInclude('Windows Phone')),
|
||||||
|
define(OperatingSystem.WindowsPhone, (b) =>
|
||||||
|
b.mustInclude('Windows Phone')),
|
||||||
|
define(OperatingSystem.macOS, (b) =>
|
||||||
|
b.mustInclude('OS X').mustNotInclude('Android').mustNotInclude('like Mac OS X')),
|
||||||
|
];
|
||||||
|
|
||||||
|
function define(os: OperatingSystem, applyRules: (builder: DetectorBuilder) => DetectorBuilder): IBrowserOsDetector {
|
||||||
|
const builder = new DetectorBuilder(os);
|
||||||
|
applyRules(builder);
|
||||||
|
return builder.build();
|
||||||
|
}
|
||||||
53
src/application/Environment/BrowserOs/DetectorBuilder.ts
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
import { IBrowserOsDetector } from './IBrowserOsDetector';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
export class DetectorBuilder {
|
||||||
|
private readonly existingPartsInUserAgent = new Array<string>();
|
||||||
|
private readonly notExistingPartsInUserAgent = new Array<string>();
|
||||||
|
|
||||||
|
constructor(private readonly os: OperatingSystem) { }
|
||||||
|
|
||||||
|
public mustInclude(str: string): DetectorBuilder {
|
||||||
|
return this.add(str, this.existingPartsInUserAgent);
|
||||||
|
}
|
||||||
|
|
||||||
|
public mustNotInclude(str: string): DetectorBuilder {
|
||||||
|
return this.add(str, this.notExistingPartsInUserAgent);
|
||||||
|
}
|
||||||
|
|
||||||
|
public build(): IBrowserOsDetector {
|
||||||
|
if (!this.existingPartsInUserAgent.length) {
|
||||||
|
throw new Error('Must include at least a part');
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
detect: (agent) => this.detect(agent),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private detect(userAgent: string): OperatingSystem {
|
||||||
|
if (!userAgent) {
|
||||||
|
throw new Error('User agent is null or undefined');
|
||||||
|
}
|
||||||
|
if (this.existingPartsInUserAgent.some((part) => !userAgent.includes(part))) {
|
||||||
|
return OperatingSystem.Unknown;
|
||||||
|
}
|
||||||
|
if (this.notExistingPartsInUserAgent.some((part) => userAgent.includes(part))) {
|
||||||
|
return OperatingSystem.Unknown;
|
||||||
|
}
|
||||||
|
return this.os;
|
||||||
|
}
|
||||||
|
|
||||||
|
private add(part: string, array: string[]): DetectorBuilder {
|
||||||
|
if (!part) {
|
||||||
|
throw new Error('part is empty or undefined');
|
||||||
|
}
|
||||||
|
if (this.existingPartsInUserAgent.includes(part)) {
|
||||||
|
throw new Error(`part ${part} is already included as existing part`);
|
||||||
|
}
|
||||||
|
if (this.notExistingPartsInUserAgent.includes(part)) {
|
||||||
|
throw new Error(`part ${part} is already included as not existing part`);
|
||||||
|
}
|
||||||
|
array.push(part);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
export interface IBrowserOsDetector {
|
||||||
|
detect(userAgent: string): OperatingSystem;
|
||||||
|
}
|
||||||
80
src/application/Environment/Environment.ts
Normal file
@@ -0,0 +1,80 @@
|
|||||||
|
import { BrowserOsDetector } from './BrowserOs/BrowserOsDetector';
|
||||||
|
import { IBrowserOsDetector } from './BrowserOs/IBrowserOsDetector';
|
||||||
|
import { IEnvironment } from './IEnvironment';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
interface IEnvironmentVariables {
|
||||||
|
readonly window: Window & typeof globalThis;
|
||||||
|
readonly process: NodeJS.Process;
|
||||||
|
readonly navigator: Navigator;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Environment implements IEnvironment {
|
||||||
|
public static readonly CurrentEnvironment: IEnvironment = new Environment({
|
||||||
|
window,
|
||||||
|
process,
|
||||||
|
navigator,
|
||||||
|
});
|
||||||
|
public readonly isDesktop: boolean;
|
||||||
|
public readonly os: OperatingSystem;
|
||||||
|
protected constructor(
|
||||||
|
variables: IEnvironmentVariables,
|
||||||
|
browserOsDetector: IBrowserOsDetector = new BrowserOsDetector()) {
|
||||||
|
if (!variables) {
|
||||||
|
throw new Error('variables is null or empty');
|
||||||
|
}
|
||||||
|
this.isDesktop = isDesktop(variables);
|
||||||
|
this.os = this.isDesktop ?
|
||||||
|
getDesktopOsType(getProcessPlatform(variables))
|
||||||
|
: browserOsDetector.detect(getUserAgent(variables));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getUserAgent(variables: IEnvironmentVariables): string {
|
||||||
|
if (!variables.window || !variables.window.navigator) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return variables.window.navigator.userAgent;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getProcessPlatform(variables: IEnvironmentVariables): string {
|
||||||
|
if (!variables.process || !variables.process.platform) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return variables.process.platform;
|
||||||
|
}
|
||||||
|
|
||||||
|
function getDesktopOsType(processPlatform: string): OperatingSystem {
|
||||||
|
// https://nodejs.org/api/process.html#process_process_platform
|
||||||
|
if (processPlatform === 'darwin') {
|
||||||
|
return OperatingSystem.macOS;
|
||||||
|
} else if (processPlatform === 'win32') {
|
||||||
|
return OperatingSystem.Windows;
|
||||||
|
} else if (processPlatform === 'linux') {
|
||||||
|
return OperatingSystem.Linux;
|
||||||
|
}
|
||||||
|
return OperatingSystem.Unknown;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isDesktop(variables: IEnvironmentVariables): boolean {
|
||||||
|
// More: https://github.com/electron/electron/issues/2288
|
||||||
|
// Renderer process
|
||||||
|
if (variables.window
|
||||||
|
&& variables.window.process
|
||||||
|
&& variables.window.process.type === 'renderer') {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
// Main process
|
||||||
|
if (variables.process
|
||||||
|
&& variables.process.versions
|
||||||
|
&& Boolean(variables.process.versions.electron)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
// Detect the user agent when the `nodeIntegration` option is set to true
|
||||||
|
if (variables.navigator
|
||||||
|
&& variables.navigator.userAgent
|
||||||
|
&& variables.navigator.userAgent.includes('Electron')) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
6
src/application/Environment/IEnvironment.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
|
||||||
|
export interface IEnvironment {
|
||||||
|
readonly isDesktop: boolean;
|
||||||
|
readonly os: OperatingSystem;
|
||||||
|
}
|
||||||
@@ -1,21 +1,38 @@
|
|||||||
import { Category } from '../../domain/Category';
|
import { IApplication } from '@/domain/IApplication';
|
||||||
import { Application } from '../../domain/Application';
|
import { IProjectInformation } from '@/domain/IProjectInformation';
|
||||||
import applicationFile from 'js-yaml-loader!./../application.yaml';
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
import { parseCategory } from './CategoryParser';
|
import { parseCategoryCollection } from './CategoryCollectionParser';
|
||||||
|
import WindowsData from 'js-yaml-loader!@/application/collections/windows.yaml';
|
||||||
|
import MacOsData from 'js-yaml-loader!@/application/collections/macos.yaml';
|
||||||
|
import { CollectionData } from 'js-yaml-loader!@/*';
|
||||||
|
import { parseProjectInformation } from '@/application/Parser/ProjectInformationParser';
|
||||||
|
import { Application } from '@/domain/Application';
|
||||||
|
|
||||||
export function parseApplication(): Application {
|
export function parseApplication(
|
||||||
const categories = new Array<Category>();
|
parser = CategoryCollectionParser,
|
||||||
if (!applicationFile.actions || applicationFile.actions.length <= 0) {
|
processEnv: NodeJS.ProcessEnv = process.env,
|
||||||
throw new Error('Application does not define any action');
|
collectionsData = PreParsedCollections): IApplication {
|
||||||
}
|
validateCollectionsData(collectionsData);
|
||||||
for (const action of applicationFile.actions) {
|
const information = parseProjectInformation(processEnv);
|
||||||
const category = parseCategory(action);
|
const collections = collectionsData.map((collection) => parser(collection, information));
|
||||||
categories.push(category);
|
const app = new Application(information, collections);
|
||||||
}
|
|
||||||
const app = new Application(
|
|
||||||
applicationFile.name,
|
|
||||||
applicationFile.repositoryUrl,
|
|
||||||
process.env.VUE_APP_VERSION,
|
|
||||||
categories);
|
|
||||||
return app;
|
return app;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type CategoryCollectionParserType
|
||||||
|
= (file: CollectionData, info: IProjectInformation) => ICategoryCollection;
|
||||||
|
|
||||||
|
const CategoryCollectionParser: CategoryCollectionParserType
|
||||||
|
= (file, info) => parseCategoryCollection(file, info);
|
||||||
|
|
||||||
|
const PreParsedCollections: readonly CollectionData []
|
||||||
|
= [ WindowsData, MacOsData ];
|
||||||
|
|
||||||
|
function validateCollectionsData(collections: readonly CollectionData[]) {
|
||||||
|
if (!collections.length) {
|
||||||
|
throw new Error('no collection provided');
|
||||||
|
}
|
||||||
|
if (collections.some((collection) => !collection)) {
|
||||||
|
throw new Error('undefined collection provided');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
39
src/application/Parser/CategoryCollectionParser.ts
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
import { Category } from '@/domain/Category';
|
||||||
|
import { CollectionData } from 'js-yaml-loader!@/*';
|
||||||
|
import { parseCategory } from './CategoryParser';
|
||||||
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||||
|
import { parseScriptingDefinition } from './ScriptingDefinitionParser';
|
||||||
|
import { createEnumParser } from '../Common/Enum';
|
||||||
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
||||||
|
import { CategoryCollection } from '@/domain/CategoryCollection';
|
||||||
|
import { IProjectInformation } from '@/domain/IProjectInformation';
|
||||||
|
import { CategoryCollectionParseContext } from './Script/CategoryCollectionParseContext';
|
||||||
|
|
||||||
|
export function parseCategoryCollection(
|
||||||
|
content: CollectionData,
|
||||||
|
info: IProjectInformation,
|
||||||
|
osParser = createEnumParser(OperatingSystem)): ICategoryCollection {
|
||||||
|
validate(content);
|
||||||
|
const scripting = parseScriptingDefinition(content.scripting, info);
|
||||||
|
const context = new CategoryCollectionParseContext(content.functions, scripting);
|
||||||
|
const categories = new Array<Category>();
|
||||||
|
for (const action of content.actions) {
|
||||||
|
const category = parseCategory(action, context);
|
||||||
|
categories.push(category);
|
||||||
|
}
|
||||||
|
const os = osParser.parseEnum(content.os, 'os');
|
||||||
|
const collection = new CategoryCollection(
|
||||||
|
os,
|
||||||
|
categories,
|
||||||
|
scripting);
|
||||||
|
return collection;
|
||||||
|
}
|
||||||
|
|
||||||
|
function validate(content: CollectionData): void {
|
||||||
|
if (!content) {
|
||||||
|
throw new Error('content is null or undefined');
|
||||||
|
}
|
||||||
|
if (!content.actions || content.actions.length <= 0) {
|
||||||
|
throw new Error('content does not define any action');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,26 +1,26 @@
|
|||||||
import { YamlCategory, YamlScript } from 'js-yaml-loader!./application.yaml';
|
import { CategoryData, ScriptData, CategoryOrScriptData } from 'js-yaml-loader!@/*';
|
||||||
import { Script } from '@/domain/Script';
|
import { Script } from '@/domain/Script';
|
||||||
import { Category } from '../../domain/Category';
|
import { Category } from '@/domain/Category';
|
||||||
import { parseDocUrls } from './DocumentationParser';
|
import { parseDocUrls } from './DocumentationParser';
|
||||||
|
import { ICategoryCollectionParseContext } from './Script/ICategoryCollectionParseContext';
|
||||||
|
import { parseScript } from './Script/ScriptParser';
|
||||||
|
|
||||||
let categoryIdCounter: number = 0;
|
let categoryIdCounter: number = 0;
|
||||||
|
|
||||||
|
|
||||||
interface ICategoryChildren {
|
interface ICategoryChildren {
|
||||||
subCategories: Category[];
|
subCategories: Category[];
|
||||||
subScripts: Script[];
|
subScripts: Script[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export function parseCategory(category: YamlCategory): Category {
|
export function parseCategory(category: CategoryData, context: ICategoryCollectionParseContext): Category {
|
||||||
if (!category.children || category.children.length <= 0) {
|
if (!context) { throw new Error('undefined context'); }
|
||||||
throw Error('Category has no children');
|
ensureValid(category);
|
||||||
}
|
|
||||||
const children: ICategoryChildren = {
|
const children: ICategoryChildren = {
|
||||||
subCategories: new Array<Category>(),
|
subCategories: new Array<Category>(),
|
||||||
subScripts: new Array<Script>(),
|
subScripts: new Array<Script>(),
|
||||||
};
|
};
|
||||||
for (const categoryOrScript of category.children) {
|
for (const data of category.children) {
|
||||||
parseCategoryChild(categoryOrScript, children, category);
|
parseCategoryChild(data, children, category, context);
|
||||||
}
|
}
|
||||||
return new Category(
|
return new Category(
|
||||||
/*id*/ categoryIdCounter++,
|
/*id*/ categoryIdCounter++,
|
||||||
@@ -31,30 +31,41 @@ export function parseCategory(category: YamlCategory): Category {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseCategoryChild(
|
function ensureValid(category: CategoryData) {
|
||||||
categoryOrScript: any, children: ICategoryChildren, parent: YamlCategory) {
|
if (!category) {
|
||||||
if (isCategory(categoryOrScript)) {
|
throw Error('category is null or undefined');
|
||||||
const subCategory = parseCategory(categoryOrScript as YamlCategory);
|
}
|
||||||
children.subCategories.push(subCategory);
|
if (!category.children || category.children.length === 0) {
|
||||||
} else if (isScript(categoryOrScript)) {
|
throw Error(`category has no children: "${category.category}"`);
|
||||||
const yamlScript = categoryOrScript as YamlScript;
|
}
|
||||||
const script = new Script(
|
if (!category.category || category.category.length === 0) {
|
||||||
/* name */ yamlScript.name,
|
throw Error('category has no name');
|
||||||
/* code */ yamlScript.code,
|
|
||||||
/* docs */ parseDocUrls(yamlScript),
|
|
||||||
/* is recommended? */ yamlScript.recommend);
|
|
||||||
children.subScripts.push(script);
|
|
||||||
} else {
|
|
||||||
throw new Error(`Child element is neither a category or a script.
|
|
||||||
Parent: ${parent.category}, element: ${categoryOrScript}`);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function parseCategoryChild(
|
||||||
function isScript(categoryOrScript: any): boolean {
|
data: CategoryOrScriptData,
|
||||||
return categoryOrScript.code && categoryOrScript.code.length > 0;
|
children: ICategoryChildren,
|
||||||
|
parent: CategoryData,
|
||||||
|
context: ICategoryCollectionParseContext) {
|
||||||
|
if (isCategory(data)) {
|
||||||
|
const subCategory = parseCategory(data as CategoryData, context);
|
||||||
|
children.subCategories.push(subCategory);
|
||||||
|
} else if (isScript(data)) {
|
||||||
|
const scriptData = data as ScriptData;
|
||||||
|
const script = parseScript(scriptData, context);
|
||||||
|
children.subScripts.push(script);
|
||||||
|
} else {
|
||||||
|
throw new Error(`Child element is neither a category or a script.
|
||||||
|
Parent: ${parent.category}, element: ${JSON.stringify(data)}`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function isCategory(categoryOrScript: any): boolean {
|
function isScript(data: any): boolean {
|
||||||
return categoryOrScript.category && categoryOrScript.category.length > 0;
|
return (data.code && data.code.length > 0)
|
||||||
|
|| data.call;
|
||||||
|
}
|
||||||
|
|
||||||
|
function isCategory(data: any): boolean {
|
||||||
|
return data.category && data.category.length > 0;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,34 +1,46 @@
|
|||||||
import { YamlDocumentable } from 'js-yaml-loader!./application.yaml';
|
import { DocumentableData, DocumentationUrlsData } from 'js-yaml-loader!@/*';
|
||||||
|
|
||||||
export function parseDocUrls(documentable: YamlDocumentable): ReadonlyArray<string> {
|
export function parseDocUrls(documentable: DocumentableData): ReadonlyArray<string> {
|
||||||
|
if (!documentable) {
|
||||||
|
throw new Error('documentable is null or undefined');
|
||||||
|
}
|
||||||
const docs = documentable.docs;
|
const docs = documentable.docs;
|
||||||
if (!docs) {
|
if (!docs || !docs.length) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
const result = new DocumentationUrls();
|
let result = new DocumentationUrlContainer();
|
||||||
if (docs instanceof Array) {
|
result = addDocs(docs, result);
|
||||||
for (const doc of docs) {
|
|
||||||
if (typeof doc !== 'string') {
|
|
||||||
throw new Error('Docs field (documentation url) must be an array of strings');
|
|
||||||
}
|
|
||||||
result.add(doc);
|
|
||||||
}
|
|
||||||
} else if (typeof docs === 'string') {
|
|
||||||
result.add(docs);
|
|
||||||
} else {
|
|
||||||
throw new Error('Docs field (documentation url) must a string or array of strings');
|
|
||||||
}
|
|
||||||
return result.getAll();
|
return result.getAll();
|
||||||
}
|
}
|
||||||
|
|
||||||
class DocumentationUrls {
|
function addDocs(docs: DocumentationUrlsData, urls: DocumentationUrlContainer): DocumentationUrlContainer {
|
||||||
|
if (docs instanceof Array) {
|
||||||
|
urls.addUrls(docs);
|
||||||
|
} else if (typeof docs === 'string') {
|
||||||
|
urls.addUrl(docs);
|
||||||
|
} else {
|
||||||
|
throw new Error('Docs field (documentation url) must a string or array of strings');
|
||||||
|
}
|
||||||
|
return urls;
|
||||||
|
}
|
||||||
|
|
||||||
|
class DocumentationUrlContainer {
|
||||||
private readonly urls = new Array<string>();
|
private readonly urls = new Array<string>();
|
||||||
|
|
||||||
public add(url: string) {
|
public addUrl(url: string) {
|
||||||
validateUrl(url);
|
validateUrl(url);
|
||||||
this.urls.push(url);
|
this.urls.push(url);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public addUrls(urls: readonly any[]) {
|
||||||
|
for (const url of urls) {
|
||||||
|
if (typeof url !== 'string') {
|
||||||
|
throw new Error('Docs field (documentation url) must be an array of strings');
|
||||||
|
}
|
||||||
|
this.addUrl(url);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public getAll(): ReadonlyArray<string> {
|
public getAll(): ReadonlyArray<string> {
|
||||||
return this.urls;
|
return this.urls;
|
||||||
}
|
}
|
||||||
|
|||||||
12
src/application/Parser/ProjectInformationParser.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { IProjectInformation } from '@/domain/IProjectInformation';
|
||||||
|
import { ProjectInformation } from '@/domain/ProjectInformation';
|
||||||
|
|
||||||
|
export function parseProjectInformation(
|
||||||
|
environment: NodeJS.ProcessEnv): IProjectInformation {
|
||||||
|
return new ProjectInformation(
|
||||||
|
environment.VUE_APP_NAME,
|
||||||
|
environment.VUE_APP_VERSION,
|
||||||
|
environment.VUE_APP_REPOSITORY_URL,
|
||||||
|
environment.VUE_APP_HOMEPAGE_URL,
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
import { FunctionData } from 'js-yaml-loader!*';
|
||||||
|
import { IScriptCompiler } from './Compiler/IScriptCompiler';
|
||||||
|
import { ScriptCompiler } from './Compiler/ScriptCompiler';
|
||||||
|
import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
|
||||||
|
import { SyntaxFactory } from './Syntax/SyntaxFactory';
|
||||||
|
import { ISyntaxFactory } from './Syntax/ISyntaxFactory';
|
||||||
|
|
||||||
|
export class CategoryCollectionParseContext implements ICategoryCollectionParseContext {
|
||||||
|
public readonly compiler: IScriptCompiler;
|
||||||
|
public readonly syntax: ILanguageSyntax;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
functionsData: ReadonlyArray<FunctionData> | undefined,
|
||||||
|
scripting: IScriptingDefinition,
|
||||||
|
syntaxFactory: ISyntaxFactory = new SyntaxFactory()) {
|
||||||
|
if (!scripting) { throw new Error('undefined scripting'); }
|
||||||
|
this.syntax = syntaxFactory.create(scripting.language);
|
||||||
|
this.compiler = new ScriptCompiler(functionsData, this.syntax);
|
||||||
|
}
|
||||||
|
}
|
||||||
73
src/application/Parser/Script/Compiler/ILCode.ts
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
export interface IILCode {
|
||||||
|
compile(): string;
|
||||||
|
getUniqueParameterNames(): string[];
|
||||||
|
substituteParameter(parameterName: string, parameterValue: string): IILCode;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function generateIlCode(rawText: string): IILCode {
|
||||||
|
const ilCode = generateIl(rawText);
|
||||||
|
return new ILCode(ilCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
class ILCode implements IILCode {
|
||||||
|
private readonly ilCode: string;
|
||||||
|
|
||||||
|
constructor(ilCode: string) {
|
||||||
|
this.ilCode = ilCode;
|
||||||
|
}
|
||||||
|
|
||||||
|
public substituteParameter(parameterName: string, parameterValue: string): IILCode {
|
||||||
|
const newCode = substituteParameter(this.ilCode, parameterName, parameterValue);
|
||||||
|
return new ILCode(newCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
public getUniqueParameterNames(): string[] {
|
||||||
|
return getUniqueParameterNames(this.ilCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
public compile(): string {
|
||||||
|
ensureNoExpressionLeft(this.ilCode);
|
||||||
|
return this.ilCode;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Trim each expression and put them inside "{{exp|}}" e.g. "{{ $hello }}" becomes "{{exp|$hello}}"
|
||||||
|
function generateIl(rawText: string): string {
|
||||||
|
return rawText.replace(/\{\{([\s]*[^;\s\{]+[\s]*)\}\}/g, (_, match) => {
|
||||||
|
return `\{\{exp|${match.trim()}\}\}`;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// finds all "{{exp|..}} left"
|
||||||
|
function ensureNoExpressionLeft(ilCode: string) {
|
||||||
|
const allSubstitutions = ilCode.matchAll(/\{\{exp\|(.*?)\}\}/g);
|
||||||
|
const allMatches = Array.from(allSubstitutions, (match) => match[1]);
|
||||||
|
const uniqueExpressions = getDistinctValues(allMatches);
|
||||||
|
if (uniqueExpressions.length > 0) {
|
||||||
|
throw new Error(`unknown expression: ${printList(uniqueExpressions)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parses all distinct usages of {{exp|$parameterName}}
|
||||||
|
function getUniqueParameterNames(ilCode: string) {
|
||||||
|
const allSubstitutions = ilCode.matchAll(/\{\{exp\|\$([^;\s\{]+[\s]*)\}\}/g);
|
||||||
|
const allParameters = Array.from(allSubstitutions, (match) => match[1]);
|
||||||
|
const uniqueParameterNames = getDistinctValues(allParameters);
|
||||||
|
return uniqueParameterNames;
|
||||||
|
}
|
||||||
|
|
||||||
|
// substitutes {{exp|$parameterName}} to value of the parameter
|
||||||
|
function substituteParameter(ilCode: string, parameterName: string, parameterValue: string) {
|
||||||
|
const pattern = `{{exp|$${parameterName}}}`;
|
||||||
|
return ilCode.split(pattern).join(parameterValue); // as .replaceAll() is not yet supported by TS
|
||||||
|
}
|
||||||
|
|
||||||
|
function getDistinctValues(values: readonly string[]): string[] {
|
||||||
|
return values.filter((value, index, self) => {
|
||||||
|
return self.indexOf(value) === index;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function printList(list: readonly string[]): string {
|
||||||
|
return `"${list.join('","')}"`;
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
import { IScriptCode } from '@/domain/IScriptCode';
|
||||||
|
import { ScriptData } from 'js-yaml-loader!@/*';
|
||||||
|
|
||||||
|
export interface IScriptCompiler {
|
||||||
|
canCompile(script: ScriptData): boolean;
|
||||||
|
compile(script: ScriptData): IScriptCode;
|
||||||
|
}
|
||||||
171
src/application/Parser/Script/Compiler/ScriptCompiler.ts
Normal file
@@ -0,0 +1,171 @@
|
|||||||
|
import { generateIlCode, IILCode } from './ILCode';
|
||||||
|
import { IScriptCode } from '@/domain/IScriptCode';
|
||||||
|
import { ScriptCode } from '@/domain/ScriptCode';
|
||||||
|
import { ScriptData, FunctionData, FunctionCallData, ScriptFunctionCallData, FunctionCallParametersData } from 'js-yaml-loader!@/*';
|
||||||
|
import { IScriptCompiler } from './IScriptCompiler';
|
||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
|
||||||
|
interface ICompiledCode {
|
||||||
|
readonly code: string;
|
||||||
|
readonly revertCode: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ScriptCompiler implements IScriptCompiler {
|
||||||
|
constructor(
|
||||||
|
private readonly functions: readonly FunctionData[] | undefined,
|
||||||
|
private syntax: ILanguageSyntax) {
|
||||||
|
ensureValidFunctions(functions);
|
||||||
|
if (!syntax) { throw new Error('undefined syntax'); }
|
||||||
|
}
|
||||||
|
public canCompile(script: ScriptData): boolean {
|
||||||
|
if (!script.call) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
public compile(script: ScriptData): IScriptCode {
|
||||||
|
this.ensureCompilable(script.call);
|
||||||
|
const compiledCodes = new Array<ICompiledCode>();
|
||||||
|
const calls = getCallSequence(script.call);
|
||||||
|
calls.forEach((currentCall, currentCallIndex) => {
|
||||||
|
ensureValidCall(currentCall, script.name);
|
||||||
|
const commonFunction = this.getFunctionByName(currentCall.function);
|
||||||
|
let functionCode = compileCode(commonFunction, currentCall.parameters);
|
||||||
|
if (currentCallIndex !== calls.length - 1) {
|
||||||
|
functionCode = appendLine(functionCode);
|
||||||
|
}
|
||||||
|
compiledCodes.push(functionCode);
|
||||||
|
});
|
||||||
|
const scriptCode = merge(compiledCodes);
|
||||||
|
return new ScriptCode(scriptCode.code, scriptCode.revertCode, script.name, this.syntax);
|
||||||
|
}
|
||||||
|
|
||||||
|
private getFunctionByName(name: string): FunctionData {
|
||||||
|
const func = this.functions.find((f) => f.name === name);
|
||||||
|
if (!func) {
|
||||||
|
throw new Error(`called function is not defined "${name}"`);
|
||||||
|
}
|
||||||
|
return func;
|
||||||
|
}
|
||||||
|
private ensureCompilable(call: ScriptFunctionCallData) {
|
||||||
|
if (!this.functions || this.functions.length === 0) {
|
||||||
|
throw new Error('cannot compile without shared functions');
|
||||||
|
}
|
||||||
|
if (typeof call !== 'object') {
|
||||||
|
throw new Error('called function(s) must be an object');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getDuplicates(texts: readonly string[]): string[] {
|
||||||
|
return texts.filter((item, index) => texts.indexOf(item) !== index);
|
||||||
|
}
|
||||||
|
|
||||||
|
function printList(list: readonly string[]): string {
|
||||||
|
return `"${list.join('","')}"`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureNoDuplicatesInFunctionNames(functions: readonly FunctionData[]) {
|
||||||
|
const duplicateFunctionNames = getDuplicates(functions
|
||||||
|
.map((func) => func.name.toLowerCase()));
|
||||||
|
if (duplicateFunctionNames.length) {
|
||||||
|
throw new Error(`duplicate function name: ${printList(duplicateFunctionNames)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function ensureNoUndefinedItem(functions: readonly FunctionData[]) {
|
||||||
|
if (functions.some((func) => !func)) {
|
||||||
|
throw new Error(`some functions are undefined`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function ensureNoDuplicatesInParameterNames(functions: readonly FunctionData[]) {
|
||||||
|
const functionsWithParameters = functions
|
||||||
|
.filter((func) => func.parameters && func.parameters.length > 0);
|
||||||
|
for (const func of functionsWithParameters) {
|
||||||
|
const duplicateParameterNames = getDuplicates(func.parameters);
|
||||||
|
if (duplicateParameterNames.length) {
|
||||||
|
throw new Error(`"${func.name}": duplicate parameter name: ${printList(duplicateParameterNames)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureNoDuplicateCode(functions: readonly FunctionData[]) {
|
||||||
|
const duplicateCodes = getDuplicates(functions.map((func) => func.code));
|
||||||
|
if (duplicateCodes.length > 0) {
|
||||||
|
throw new Error(`duplicate "code" in functions: ${printList(duplicateCodes)}`);
|
||||||
|
}
|
||||||
|
const duplicateRevertCodes = getDuplicates(functions
|
||||||
|
.filter((func) => func.revertCode)
|
||||||
|
.map((func) => func.revertCode));
|
||||||
|
if (duplicateRevertCodes.length > 0) {
|
||||||
|
throw new Error(`duplicate "revertCode" in functions: ${printList(duplicateRevertCodes)}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureValidFunctions(functions: readonly FunctionData[]) {
|
||||||
|
if (!functions || functions.length === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
ensureNoUndefinedItem(functions);
|
||||||
|
ensureNoDuplicatesInFunctionNames(functions);
|
||||||
|
ensureNoDuplicatesInParameterNames(functions);
|
||||||
|
ensureNoDuplicateCode(functions);
|
||||||
|
}
|
||||||
|
|
||||||
|
function appendLine(code: ICompiledCode): ICompiledCode {
|
||||||
|
const appendLineIfNotEmpty = (str: string) => str ? `${str}\n` : str;
|
||||||
|
return {
|
||||||
|
code: appendLineIfNotEmpty(code.code),
|
||||||
|
revertCode: appendLineIfNotEmpty(code.revertCode),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function merge(codes: readonly ICompiledCode[]): ICompiledCode {
|
||||||
|
return {
|
||||||
|
code: codes.map((code) => code.code).join(''),
|
||||||
|
revertCode: codes.map((code) => code.revertCode).join(''),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function compileCode(func: FunctionData, parameters: FunctionCallParametersData): ICompiledCode {
|
||||||
|
return {
|
||||||
|
code: compileExpressions(func.code, parameters),
|
||||||
|
revertCode: compileExpressions(func.revertCode, parameters),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function compileExpressions(code: string, parameters: FunctionCallParametersData): string {
|
||||||
|
let intermediateCode = generateIlCode(code);
|
||||||
|
intermediateCode = substituteParameters(intermediateCode, parameters);
|
||||||
|
return intermediateCode.compile();
|
||||||
|
}
|
||||||
|
|
||||||
|
function substituteParameters(intermediateCode: IILCode, parameters: FunctionCallParametersData): IILCode {
|
||||||
|
const parameterNames = intermediateCode.getUniqueParameterNames();
|
||||||
|
if (parameterNames.length && !parameters) {
|
||||||
|
throw new Error(`no parameters defined, expected: ${printList(parameterNames)}`);
|
||||||
|
}
|
||||||
|
for (const parameterName of parameterNames) {
|
||||||
|
const parameterValue = parameters[parameterName];
|
||||||
|
if (!parameterValue) {
|
||||||
|
throw Error(`parameter value is not provided for "${parameterName}" in function call`);
|
||||||
|
}
|
||||||
|
intermediateCode = intermediateCode.substituteParameter(parameterName, parameterValue);
|
||||||
|
}
|
||||||
|
return intermediateCode;
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureValidCall(call: FunctionCallData, scriptName: string) {
|
||||||
|
if (!call) {
|
||||||
|
throw new Error(`undefined function call in script "${scriptName}"`);
|
||||||
|
}
|
||||||
|
if (!call.function) {
|
||||||
|
throw new Error(`empty function name called in script "${scriptName}"`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getCallSequence(call: ScriptFunctionCallData): FunctionCallData[] {
|
||||||
|
if (call instanceof Array) {
|
||||||
|
return call as FunctionCallData[];
|
||||||
|
}
|
||||||
|
return [ call as FunctionCallData ];
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
import { IScriptCompiler } from './Compiler/IScriptCompiler';
|
||||||
|
|
||||||
|
export interface ICategoryCollectionParseContext {
|
||||||
|
readonly compiler: IScriptCompiler;
|
||||||
|
readonly syntax: ILanguageSyntax;
|
||||||
|
}
|
||||||
54
src/application/Parser/Script/ScriptParser.ts
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
import { Script } from '@/domain/Script';
|
||||||
|
import { ScriptData } from 'js-yaml-loader!@/*';
|
||||||
|
import { parseDocUrls } from '../DocumentationParser';
|
||||||
|
import { RecommendationLevel } from '@/domain/RecommendationLevel';
|
||||||
|
import { IScriptCode } from '@/domain/IScriptCode';
|
||||||
|
import { ScriptCode } from '@/domain/ScriptCode';
|
||||||
|
import { createEnumParser, IEnumParser } from '../../Common/Enum';
|
||||||
|
import { ICategoryCollectionParseContext } from './ICategoryCollectionParseContext';
|
||||||
|
|
||||||
|
export function parseScript(
|
||||||
|
data: ScriptData, context: ICategoryCollectionParseContext,
|
||||||
|
levelParser = createEnumParser(RecommendationLevel)): Script {
|
||||||
|
validateScript(data);
|
||||||
|
if (!context) { throw new Error('undefined context'); }
|
||||||
|
const script = new Script(
|
||||||
|
/* name */ data.name,
|
||||||
|
/* code */ parseCode(data, context),
|
||||||
|
/* docs */ parseDocUrls(data),
|
||||||
|
/* level */ parseLevel(data.recommend, levelParser));
|
||||||
|
return script;
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseLevel(level: string, parser: IEnumParser<RecommendationLevel>): RecommendationLevel | undefined {
|
||||||
|
if (!level) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return parser.parseEnum(level, 'level');
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseCode(script: ScriptData, context: ICategoryCollectionParseContext): IScriptCode {
|
||||||
|
if (context.compiler.canCompile(script)) {
|
||||||
|
return context.compiler.compile(script);
|
||||||
|
}
|
||||||
|
return new ScriptCode(script.code, script.revertCode, script.name, context.syntax);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureNotBothCallAndCode(script: ScriptData) {
|
||||||
|
if (script.code && script.call) {
|
||||||
|
throw new Error('cannot define both "call" and "code"');
|
||||||
|
}
|
||||||
|
if (script.revertCode && script.call) {
|
||||||
|
throw new Error('cannot define "revertCode" if "call" is defined');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function validateScript(script: ScriptData) {
|
||||||
|
if (!script) {
|
||||||
|
throw new Error('undefined script');
|
||||||
|
}
|
||||||
|
if (!script.code && !script.call) {
|
||||||
|
throw new Error('must define either "call" or "code"');
|
||||||
|
}
|
||||||
|
ensureNotBothCallAndCode(script);
|
||||||
|
}
|
||||||
6
src/application/Parser/Script/Syntax/BatchFileSyntax.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
|
||||||
|
export class BatchFileSyntax implements ILanguageSyntax {
|
||||||
|
public readonly commentDelimiters = [ 'REM', '::' ];
|
||||||
|
public readonly commonCodeParts = [ '(', ')', 'else' ];
|
||||||
|
}
|
||||||
6
src/application/Parser/Script/Syntax/ISyntaxFactory.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
||||||
|
|
||||||
|
export interface ISyntaxFactory {
|
||||||
|
create(language: ScriptingLanguage): ILanguageSyntax;
|
||||||
|
}
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
|
||||||
|
export class ShellScriptSyntax implements ILanguageSyntax {
|
||||||
|
public readonly commentDelimiters = [ '#' ];
|
||||||
|
public readonly commonCodeParts = [ '(', ')', 'else' ];
|
||||||
|
}
|
||||||
15
src/application/Parser/Script/Syntax/SyntaxFactory.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { ILanguageSyntax } from '@/domain/ScriptCode';
|
||||||
|
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
||||||
|
import { ISyntaxFactory } from './ISyntaxFactory';
|
||||||
|
import { BatchFileSyntax } from './BatchFileSyntax';
|
||||||
|
import { ShellScriptSyntax } from './ShellScriptSyntax';
|
||||||
|
|
||||||
|
export class SyntaxFactory implements ISyntaxFactory {
|
||||||
|
public create(language: ScriptingLanguage): ILanguageSyntax {
|
||||||
|
switch (language) {
|
||||||
|
case ScriptingLanguage.batchfile: return new BatchFileSyntax();
|
||||||
|
case ScriptingLanguage.shellscript: return new ShellScriptSyntax();
|
||||||
|
default: throw new RangeError(`unknown language: "${ScriptingLanguage[language]}"`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
36
src/application/Parser/ScriptingDefinitionParser.ts
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
||||||
|
import { ScriptingDefinitionData } from 'js-yaml-loader!@/*';
|
||||||
|
import { ScriptingDefinition } from '@/domain/ScriptingDefinition';
|
||||||
|
import { ScriptingLanguage } from '@/domain/ScriptingLanguage';
|
||||||
|
import { IProjectInformation } from '@/domain/IProjectInformation';
|
||||||
|
import { createEnumParser } from '../Common/Enum';
|
||||||
|
import { generateIlCode } from './Script/Compiler/ILCode';
|
||||||
|
|
||||||
|
export function parseScriptingDefinition(
|
||||||
|
definition: ScriptingDefinitionData,
|
||||||
|
info: IProjectInformation,
|
||||||
|
date = new Date(),
|
||||||
|
languageParser = createEnumParser(ScriptingLanguage)): IScriptingDefinition {
|
||||||
|
if (!info) {
|
||||||
|
throw new Error('undefined info');
|
||||||
|
}
|
||||||
|
if (!definition) {
|
||||||
|
throw new Error('undefined definition');
|
||||||
|
}
|
||||||
|
const language = languageParser.parseEnum(definition.language, 'language');
|
||||||
|
const startCode = applySubstitutions(definition.startCode, info, date);
|
||||||
|
const endCode = applySubstitutions(definition.endCode, info, date);
|
||||||
|
return new ScriptingDefinition(
|
||||||
|
language,
|
||||||
|
startCode,
|
||||||
|
endCode,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function applySubstitutions(code: string, info: IProjectInformation, date: Date): string {
|
||||||
|
let ilCode = generateIlCode(code);
|
||||||
|
ilCode = ilCode.substituteParameter('homepage', info.homepage);
|
||||||
|
ilCode = ilCode.substituteParameter('version', info.version);
|
||||||
|
ilCode = ilCode.substituteParameter('date', date.toUTCString());
|
||||||
|
return ilCode.compile();
|
||||||
|
}
|
||||||
@@ -1,45 +0,0 @@
|
|||||||
import { UserFilter } from './Filter/UserFilter';
|
|
||||||
import { IUserFilter } from './Filter/IUserFilter';
|
|
||||||
import { ApplicationCode } from './Code/ApplicationCode';
|
|
||||||
import { UserSelection } from './Selection/UserSelection';
|
|
||||||
import { IUserSelection } from './Selection/IUserSelection';
|
|
||||||
import { AsyncLazy } from '../../infrastructure/Threading/AsyncLazy';
|
|
||||||
import { Signal } from '../../infrastructure/Events/Signal';
|
|
||||||
import { parseApplication } from '../Parser/ApplicationParser';
|
|
||||||
import { IApplicationState } from './IApplicationState';
|
|
||||||
import { Script } from '../../domain/Script';
|
|
||||||
import { Application } from '../../domain/Application';
|
|
||||||
import { IApplicationCode } from './Code/IApplicationCode';
|
|
||||||
|
|
||||||
/** Mutatable singleton application state that's the single source of truth throughout the application */
|
|
||||||
export class ApplicationState implements IApplicationState {
|
|
||||||
/** Get singleton application state */
|
|
||||||
public static GetAsync(): Promise<IApplicationState> {
|
|
||||||
return ApplicationState.instance.getValueAsync();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Application instance with all scripts. */
|
|
||||||
private static instance = new AsyncLazy<IApplicationState>(() => {
|
|
||||||
const application = parseApplication();
|
|
||||||
const selectedScripts = new Array<Script>();
|
|
||||||
const state = new ApplicationState(application, selectedScripts);
|
|
||||||
return Promise.resolve(state);
|
|
||||||
});
|
|
||||||
|
|
||||||
public readonly code: IApplicationCode;
|
|
||||||
public readonly stateChanged = new Signal<IApplicationState>();
|
|
||||||
public readonly selection: IUserSelection;
|
|
||||||
public readonly filter: IUserFilter;
|
|
||||||
|
|
||||||
private constructor(
|
|
||||||
/** Inner instance of the all scripts */
|
|
||||||
public readonly app: Application,
|
|
||||||
/** Initially selected scripts */
|
|
||||||
public readonly defaultScripts: Script[]) {
|
|
||||||
this.selection = new UserSelection(app, defaultScripts);
|
|
||||||
this.code = new ApplicationCode(this.selection, app.version);
|
|
||||||
this.filter = new UserFilter(app);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export { IApplicationState, IUserFilter };
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
import { UserScriptGenerator } from './UserScriptGenerator';
|
|
||||||
import { IUserSelection } from './../Selection/IUserSelection';
|
|
||||||
import { Signal } from '@/infrastructure/Events/Signal';
|
|
||||||
import { IApplicationCode } from './IApplicationCode';
|
|
||||||
import { IScript } from '@/domain/IScript';
|
|
||||||
|
|
||||||
export class ApplicationCode implements IApplicationCode {
|
|
||||||
public readonly changed = new Signal<string>();
|
|
||||||
public current: string;
|
|
||||||
|
|
||||||
private readonly generator: UserScriptGenerator;
|
|
||||||
|
|
||||||
constructor(userSelection: IUserSelection, private readonly version: string) {
|
|
||||||
if (!userSelection) { throw new Error('userSelection is null or undefined'); }
|
|
||||||
if (!version) { throw new Error('version is null or undefined'); }
|
|
||||||
this.generator = new UserScriptGenerator();
|
|
||||||
this.setCode(userSelection.selectedScripts);
|
|
||||||
userSelection.changed.on((scripts) => {
|
|
||||||
this.setCode(scripts);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
private setCode(scripts: ReadonlyArray<IScript>) {
|
|
||||||
this.current = scripts.length === 0 ? '' : this.generator.buildCode(scripts, this.version);
|
|
||||||
this.changed.notify(this.current);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
import { CodeBuilder } from './CodeBuilder';
|
|
||||||
import { Script } from '@/domain/Script';
|
|
||||||
|
|
||||||
const adminRightsScript = {
|
|
||||||
name: 'Ensure admin privileges',
|
|
||||||
code: 'fltmc >nul 2>&1 || (\n' +
|
|
||||||
' echo This batch script requires administrator privileges. Right-click on\n' +
|
|
||||||
' echo the script and select "Run as administrator".\n' +
|
|
||||||
' pause\n' +
|
|
||||||
' exit 1\n' +
|
|
||||||
')',
|
|
||||||
};
|
|
||||||
|
|
||||||
export class UserScriptGenerator {
|
|
||||||
public buildCode(scripts: ReadonlyArray<Script>, version: string): string {
|
|
||||||
if (!scripts) { throw new Error('scripts is undefined'); }
|
|
||||||
if (!scripts.length) { throw new Error('scripts are empty'); }
|
|
||||||
if (!version) { throw new Error('version is undefined'); }
|
|
||||||
const builder = new CodeBuilder()
|
|
||||||
.appendLine('@echo off')
|
|
||||||
.appendCommentLine(`https://privacy.sexy — v${version} — ${new Date().toUTCString()}`)
|
|
||||||
.appendFunction(adminRightsScript.name, adminRightsScript.code).appendLine();
|
|
||||||
for (const script of scripts) {
|
|
||||||
builder.appendFunction(script.name, script.code).appendLine();
|
|
||||||
}
|
|
||||||
return builder.appendLine()
|
|
||||||
.appendLine('pause')
|
|
||||||
.appendLine('exit /b 0')
|
|
||||||
.toString();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
import { FilterResult } from './FilterResult';
|
|
||||||
import { IFilterResult } from './IFilterResult';
|
|
||||||
import { Application } from '../../../domain/Application';
|
|
||||||
import { IUserFilter } from './IUserFilter';
|
|
||||||
import { Signal } from '@/infrastructure/Events/Signal';
|
|
||||||
|
|
||||||
export class UserFilter implements IUserFilter {
|
|
||||||
public readonly filtered = new Signal<IFilterResult>();
|
|
||||||
public readonly filterRemoved = new Signal<void>();
|
|
||||||
|
|
||||||
constructor(private application: Application) {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
public setFilter(filter: string): void {
|
|
||||||
if (!filter) {
|
|
||||||
throw new Error('Filter must be defined and not empty. Use removeFilter() to remove the filter');
|
|
||||||
}
|
|
||||||
const filterLowercase = filter.toLocaleLowerCase();
|
|
||||||
const filteredScripts = this.application.getAllScripts().filter(
|
|
||||||
(script) =>
|
|
||||||
script.name.toLowerCase().includes(filterLowercase) ||
|
|
||||||
script.code.toLowerCase().includes(filterLowercase));
|
|
||||||
const filteredCategories = this.application.getAllCategories().filter(
|
|
||||||
(script) => script.name.toLowerCase().includes(filterLowercase));
|
|
||||||
|
|
||||||
const matches = new FilterResult(
|
|
||||||
filteredScripts,
|
|
||||||
filteredCategories,
|
|
||||||
filter,
|
|
||||||
);
|
|
||||||
|
|
||||||
this.filtered.notify(matches);
|
|
||||||
}
|
|
||||||
|
|
||||||
public removeFilter(): void {
|
|
||||||
this.filterRemoved.notify();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
import { IApplication } from './../../domain/IApplication';
|
|
||||||
import { IUserFilter } from './Filter/IUserFilter';
|
|
||||||
import { IUserSelection } from './Selection/IUserSelection';
|
|
||||||
import { ISignal } from '@/infrastructure/Events/ISignal';
|
|
||||||
import { IApplicationCode } from './Code/IApplicationCode';
|
|
||||||
export { IUserSelection, IApplicationCode, IUserFilter };
|
|
||||||
|
|
||||||
export interface IApplicationState {
|
|
||||||
/** Event that fires when the application states changes with new application state as parameter */
|
|
||||||
readonly code: IApplicationCode;
|
|
||||||
readonly filter: IUserFilter;
|
|
||||||
readonly stateChanged: ISignal<IApplicationState>;
|
|
||||||
readonly selection: IUserSelection;
|
|
||||||
readonly app: IApplication;
|
|
||||||
}
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
import { ISignal } from '@/infrastructure/Events/Signal';
|
|
||||||
import { IScript } from '@/domain/IScript';
|
|
||||||
|
|
||||||
export interface IUserSelection {
|
|
||||||
readonly changed: ISignal<ReadonlyArray<IScript>>;
|
|
||||||
readonly selectedScripts: ReadonlyArray<IScript>;
|
|
||||||
readonly totalSelected: number;
|
|
||||||
addSelectedScript(scriptId: string): void;
|
|
||||||
removeSelectedScript(scriptId: string): void;
|
|
||||||
selectOnly(scripts: ReadonlyArray<IScript>): void;
|
|
||||||
isSelected(script: IScript): boolean;
|
|
||||||
selectAll(): void;
|
|
||||||
deselectAll(): void;
|
|
||||||
}
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
import { IApplication } from '@/domain/IApplication';
|
|
||||||
import { IUserSelection } from './IUserSelection';
|
|
||||||
import { InMemoryRepository } from '@/infrastructure/Repository/InMemoryRepository';
|
|
||||||
import { IScript } from '@/domain/Script';
|
|
||||||
import { Signal } from '@/infrastructure/Events/Signal';
|
|
||||||
|
|
||||||
export class UserSelection implements IUserSelection {
|
|
||||||
public readonly changed = new Signal<ReadonlyArray<IScript>>();
|
|
||||||
|
|
||||||
private readonly scripts = new InMemoryRepository<string, IScript>();
|
|
||||||
|
|
||||||
constructor(
|
|
||||||
private readonly app: IApplication,
|
|
||||||
/** Initially selected scripts */
|
|
||||||
selectedScripts: ReadonlyArray<IScript>) {
|
|
||||||
if (selectedScripts && selectedScripts.length > 0) {
|
|
||||||
for (const script of selectedScripts) {
|
|
||||||
this.scripts.addItem(script);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Add a script to users application */
|
|
||||||
public addSelectedScript(scriptId: string): void {
|
|
||||||
const script = this.app.findScript(scriptId);
|
|
||||||
if (!script) {
|
|
||||||
throw new Error(`Cannot add (id: ${scriptId}) as it is unknown`);
|
|
||||||
}
|
|
||||||
this.scripts.addItem(script);
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Remove a script from users application */
|
|
||||||
public removeSelectedScript(scriptId: string): void {
|
|
||||||
this.scripts.removeItem(scriptId);
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public isSelected(script: IScript): boolean {
|
|
||||||
return this.scripts.exists(script);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Get users scripts based on his/her selections */
|
|
||||||
public get selectedScripts(): ReadonlyArray<IScript> {
|
|
||||||
return this.scripts.getItems();
|
|
||||||
}
|
|
||||||
|
|
||||||
public get totalSelected(): number {
|
|
||||||
return this.scripts.getItems().length;
|
|
||||||
}
|
|
||||||
|
|
||||||
public selectAll(): void {
|
|
||||||
for (const script of this.app.getAllScripts()) {
|
|
||||||
if (!this.scripts.exists(script)) {
|
|
||||||
this.scripts.addItem(script);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
|
|
||||||
public deselectAll(): void {
|
|
||||||
const selectedScriptIds = this.scripts.getItems().map((script) => script.id);
|
|
||||||
for (const scriptId of selectedScriptIds) {
|
|
||||||
this.scripts.removeItem(scriptId);
|
|
||||||
}
|
|
||||||
this.changed.notify([]);
|
|
||||||
}
|
|
||||||
|
|
||||||
public selectOnly(scripts: readonly IScript[]): void {
|
|
||||||
if (!scripts || scripts.length === 0) {
|
|
||||||
throw new Error('Scripts are empty. Use deselectAll() if you want to deselect everything');
|
|
||||||
}
|
|
||||||
// Unselect from selected scripts
|
|
||||||
if (this.scripts.length !== 0) {
|
|
||||||
this.scripts.getItems()
|
|
||||||
.filter((existing) => !scripts.some((script) => existing.id === script.id))
|
|
||||||
.map((script) => script.id)
|
|
||||||
.forEach((scriptId) => this.scripts.removeItem(scriptId));
|
|
||||||
}
|
|
||||||
// Select from unselected scripts
|
|
||||||
scripts
|
|
||||||
.filter((script) => !this.scripts.exists(script))
|
|
||||||
.forEach((script) => this.scripts.addItem(script));
|
|
||||||
this.changed.notify(this.scripts.getItems());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
28
src/application/application.yaml.d.ts
vendored
@@ -1,28 +0,0 @@
|
|||||||
declare module 'js-yaml-loader!*' {
|
|
||||||
type CategoryOrScript = YamlCategory | YamlScript;
|
|
||||||
type DocumentationUrls = ReadonlyArray<string> | string;
|
|
||||||
|
|
||||||
export interface YamlDocumentable {
|
|
||||||
docs?: DocumentationUrls;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface YamlScript extends YamlDocumentable {
|
|
||||||
name: string;
|
|
||||||
code: string;
|
|
||||||
recommend: boolean;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface YamlCategory extends YamlDocumentable {
|
|
||||||
children: ReadonlyArray<CategoryOrScript>;
|
|
||||||
category: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface ApplicationYaml {
|
|
||||||
name: string;
|
|
||||||
repositoryUrl: string;
|
|
||||||
actions: ReadonlyArray<YamlCategory>;
|
|
||||||
}
|
|
||||||
|
|
||||||
const content: ApplicationYaml;
|
|
||||||
export default content;
|
|
||||||
}
|
|
||||||
56
src/application/collections/collection.yaml.d.ts
vendored
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
declare module 'js-yaml-loader!*' {
|
||||||
|
export interface CollectionData {
|
||||||
|
readonly os: string;
|
||||||
|
readonly scripting: ScriptingDefinitionData;
|
||||||
|
readonly actions: ReadonlyArray<CategoryData>;
|
||||||
|
readonly functions?: ReadonlyArray<FunctionData>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CategoryData extends DocumentableData {
|
||||||
|
readonly children: ReadonlyArray<CategoryOrScriptData>;
|
||||||
|
readonly category: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CategoryOrScriptData = CategoryData | ScriptData;
|
||||||
|
export type DocumentationUrlsData = ReadonlyArray<string> | string;
|
||||||
|
|
||||||
|
export interface DocumentableData {
|
||||||
|
readonly docs?: DocumentationUrlsData;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FunctionData {
|
||||||
|
name: string;
|
||||||
|
code: string;
|
||||||
|
revertCode?: string;
|
||||||
|
parameters?: readonly string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FunctionCallParametersData {
|
||||||
|
[index: string]: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FunctionCallData {
|
||||||
|
function: string;
|
||||||
|
parameters?: FunctionCallParametersData;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ScriptFunctionCallData = readonly FunctionCallData[] | FunctionCallData | undefined;
|
||||||
|
|
||||||
|
export interface ScriptData extends DocumentableData {
|
||||||
|
name: string;
|
||||||
|
code?: string;
|
||||||
|
revertCode?: string;
|
||||||
|
call: ScriptFunctionCallData;
|
||||||
|
recommend?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ScriptingDefinitionData {
|
||||||
|
readonly language: string;
|
||||||
|
readonly fileExtension: string;
|
||||||
|
readonly startCode: string;
|
||||||
|
readonly endCode: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
const content: CollectionData;
|
||||||
|
export default content;
|
||||||
|
}
|
||||||
225
src/application/collections/macos.yaml
Normal file
@@ -0,0 +1,225 @@
|
|||||||
|
# Structure documented in "docs/collections.md"
|
||||||
|
os: macos
|
||||||
|
scripting:
|
||||||
|
language: shellscript
|
||||||
|
startCode: |-
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
# {{ $homepage }} — v{{ $version }} — {{ $date }}
|
||||||
|
if [ "$EUID" -ne 0 ]; then
|
||||||
|
script_path=$([[ "$0" = /* ]] && echo "$0" || echo "$PWD/${0#./}")
|
||||||
|
sudo "$script_path" || (
|
||||||
|
echo 'Administrator privileges are required.'
|
||||||
|
exit 1
|
||||||
|
)
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
endCode: |-
|
||||||
|
echo 'Your privacy and security is now hardened 🎉💪'
|
||||||
|
echo 'Press any key to exit.'
|
||||||
|
read -n 1 -s
|
||||||
|
actions:
|
||||||
|
-
|
||||||
|
category: Privacy cleanup
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
category: Clear terminal history
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
name: Clear bash history
|
||||||
|
recommend: standard
|
||||||
|
code: rm -f ~/.bash_history
|
||||||
|
-
|
||||||
|
name: Clear zsh history
|
||||||
|
recommend: standard
|
||||||
|
code: rm -f ~/.zsh_history
|
||||||
|
-
|
||||||
|
name: Clear CUPS printer job cache
|
||||||
|
recommend: strict
|
||||||
|
code: |-
|
||||||
|
sudo rm -rfv /var/spool/cups/c0*
|
||||||
|
sudo rm -rfv /var/spool/cups/tmp/*
|
||||||
|
sudo rm -rfv /var/spool/cups/cache/job.cache*
|
||||||
|
-
|
||||||
|
name: Clear the list of iOS devices connected
|
||||||
|
recommend: strict
|
||||||
|
code: |-
|
||||||
|
sudo defaults delete /Users/$USER/Library/Preferences/com.apple.iPod.plist "conn:128:Last Connect"
|
||||||
|
sudo defaults delete /Users/$USER/Library/Preferences/com.apple.iPod.plist Devices
|
||||||
|
sudo defaults delete /Library/Preferences/com.apple.iPod.plist "conn:128:Last Connect"
|
||||||
|
sudo defaults delete /Library/Preferences/com.apple.iPod.plist Devices
|
||||||
|
sudo rm -rfv /var/db/lockdown/*
|
||||||
|
-
|
||||||
|
name: Reset privacy database (remove all permissions)
|
||||||
|
code: sudo tccutil reset All
|
||||||
|
-
|
||||||
|
category: Configure programs
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
name: Disable Firefox telemetry
|
||||||
|
recommend: standard
|
||||||
|
docs: https://github.com/mozilla/policy-templates/blob/master/README.md
|
||||||
|
code: |-
|
||||||
|
# Enable Firefox policies so the telemetry can be configured.
|
||||||
|
sudo defaults write /Library/Preferences/org.mozilla.firefox EnterprisePoliciesEnabled -bool TRUE
|
||||||
|
# Disable sending usage data
|
||||||
|
sudo defaults write /Library/Preferences/org.mozilla.firefox DisableTelemetry -bool TRUE
|
||||||
|
revertCode: |-
|
||||||
|
sudo defaults delete /Library/Preferences/org.mozilla.firefox EnterprisePoliciesEnabled
|
||||||
|
sudo defaults delete /Library/Preferences/org.mozilla.firefox DisableTelemetry
|
||||||
|
-
|
||||||
|
name: Disable Microsoft Office diagnostics data sending
|
||||||
|
recommend: standard
|
||||||
|
code: defaults write com.microsoft.office DiagnosticDataTypePreference -string ZeroDiagnosticData
|
||||||
|
revertCode: defaults delete com.microsoft.office DiagnosticDataTypePreference
|
||||||
|
-
|
||||||
|
name: Uninstall Google update
|
||||||
|
recommend: strict
|
||||||
|
code: |-
|
||||||
|
googleUpdateFile=~/Library/Google/GoogleSoftwareUpdate/GoogleSoftwareUpdate.bundle/Contents/Resources/ksinstall
|
||||||
|
if [ -f "$googleUpdateFile" ]; then
|
||||||
|
$googleUpdateFile --nuke
|
||||||
|
echo Uninstalled google update
|
||||||
|
else
|
||||||
|
echo Google update file does not exist
|
||||||
|
fi
|
||||||
|
-
|
||||||
|
name: Disable Homebrew user behavior analytics
|
||||||
|
recommend: standard
|
||||||
|
docs: https://docs.brew.sh/Analytics
|
||||||
|
call:
|
||||||
|
-
|
||||||
|
function: PersistUserEnvironmentConfiguration
|
||||||
|
parameters:
|
||||||
|
configuration: export HOMEBREW_NO_ANALYTICS=1
|
||||||
|
-
|
||||||
|
name: Disable NET Core CLI telemetry
|
||||||
|
recommend: standard
|
||||||
|
call:
|
||||||
|
-
|
||||||
|
function: PersistUserEnvironmentConfiguration
|
||||||
|
parameters:
|
||||||
|
configuration: export DOTNET_CLI_TELEMETRY_OPTOUT=1
|
||||||
|
-
|
||||||
|
name: Disable PowerShell Core telemetry
|
||||||
|
recommend: standard
|
||||||
|
docs: https://github.com/PowerShell/PowerShell/tree/release/v7.1.1#telemetry
|
||||||
|
call:
|
||||||
|
-
|
||||||
|
function: PersistUserEnvironmentConfiguration
|
||||||
|
parameters:
|
||||||
|
configuration: export POWERSHELL_TELEMETRY_OPTOUT=1
|
||||||
|
-
|
||||||
|
category: Configure OS
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
category: Configure Apple Remote Desktop
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
name: Deactivate the Remote Management Service
|
||||||
|
recommend: strict
|
||||||
|
code: sudo /System/Library/CoreServices/RemoteManagement/ARDAgent.app/Contents/Resources/kickstart -deactivate -stop
|
||||||
|
revertCode: sudo /System/Library/CoreServices/RemoteManagement/ARDAgent.app/Contents/Resources/kickstart -activate -restart -agent -console
|
||||||
|
-
|
||||||
|
name: Remove Apple Remote Desktop Settings
|
||||||
|
recommend: strict
|
||||||
|
code: |-
|
||||||
|
sudo rm -rf /var/db/RemoteManagement
|
||||||
|
sudo defaults delete /Library/Preferences/com.apple.RemoteDesktop.plist
|
||||||
|
defaults delete ~/Library/Preferences/com.apple.RemoteDesktop.plist
|
||||||
|
sudo rm -r /Library/Application\ Support/Apple/Remote\ Desktop/
|
||||||
|
rm -r ~/Library/Application\ Support/Remote\ Desktop/
|
||||||
|
rm -r ~/Library/Containers/com.apple.RemoteDesktop
|
||||||
|
-
|
||||||
|
name: Disable Internet based spell correction
|
||||||
|
code: defaults write NSGlobalDomain WebAutomaticSpellingCorrectionEnabled -bool false
|
||||||
|
revertCode: defaults delete NSGlobalDomain WebAutomaticSpellingCorrectionEnabled
|
||||||
|
-
|
||||||
|
name: Disable Remote Apple Events
|
||||||
|
recommend: strict
|
||||||
|
code: sudo systemsetup -setremoteappleevents off
|
||||||
|
revertCode: sudo systemsetup -setremoteappleevents on
|
||||||
|
-
|
||||||
|
name: Do not store documents to iCloud Drive by default
|
||||||
|
docs: https://macos-defaults.com/finder/nsdocumentsavenewdocumentstocloud.html
|
||||||
|
recommend: standard
|
||||||
|
code: defaults write NSGlobalDomain NSDocumentSaveNewDocumentsToCloud -bool false
|
||||||
|
revertCode: defaults delete NSGlobalDomain NSDocumentSaveNewDocumentsToCloud
|
||||||
|
-
|
||||||
|
category: Security improvements
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
category: Configure macOS Application Firewall
|
||||||
|
children:
|
||||||
|
-
|
||||||
|
name: Enable firewall
|
||||||
|
recommend: standard
|
||||||
|
docs: https://www.stigviewer.com/stig/apple_os_x_10.13/2018-10-01/finding/V-81681
|
||||||
|
code: /usr/libexec/ApplicationFirewall/socketfilterfw --setglobalstate on
|
||||||
|
revertCode: /usr/libexec/ApplicationFirewall/socketfilterfw --setglobalstate off
|
||||||
|
-
|
||||||
|
name: Turn on firewall logging
|
||||||
|
recommend: standard
|
||||||
|
docs: https://www.stigviewer.com/stig/apple_os_x_10.13/2018-10-01/finding/V-81671
|
||||||
|
code: /usr/libexec/ApplicationFirewall/socketfilterfw --setloggingmode on
|
||||||
|
revertCode: /usr/libexec/ApplicationFirewall/socketfilterfw --setloggingmode off
|
||||||
|
-
|
||||||
|
name: Turn on stealth mode
|
||||||
|
recommend: standard
|
||||||
|
docs: https://www.stigviewer.com/stig/apple_os_x_10.8_mountain_lion_workstation/2015-02-10/finding/V-51327
|
||||||
|
code: /usr/libexec/ApplicationFirewall/socketfilterfw --setstealthmode on
|
||||||
|
revertCode: /usr/libexec/ApplicationFirewall/socketfilterfw --setstealthmode off
|
||||||
|
-
|
||||||
|
name: Disable Spotlight indexing
|
||||||
|
code: sudo mdutil -i off -d /
|
||||||
|
revertCode: sudo mdutil -i on /
|
||||||
|
-
|
||||||
|
name: Disable Captive portal
|
||||||
|
docs:
|
||||||
|
- https://web.archive.org/web/20171008071031if_/http://blog.erratasec.com/2010/09/apples-secret-wispr-request.html#.WdnPa5OyL6Y
|
||||||
|
- https://web.archive.org/web/20130407200745/http://www.divertednetworks.net/apple-captiveportal.html
|
||||||
|
- https://web.archive.org/web/20170622064304/https://grpugh.wordpress.com/2014/10/29/an-undocumented-change-to-captive-network-assistant-settings-in-os-x-10-10-yosemite/
|
||||||
|
code: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.captive.control.plist Active -bool false
|
||||||
|
revertCode: sudo defaults delete /Library/Preferences/SystemConfiguration/com.apple.captive.control.plist Active
|
||||||
|
-
|
||||||
|
name: Require a password to wake the computer from sleep or screen saver
|
||||||
|
code: defaults write /Library/Preferences/com.apple.screensaver askForPassword -bool true
|
||||||
|
revertCode: sudo defaults delete /Library/Preferences/com.apple.screensaver askForPassword
|
||||||
|
-
|
||||||
|
name: Do not show recent items on dock
|
||||||
|
docs: https://developer.apple.com/documentation/devicemanagement/dock
|
||||||
|
code: defaults write com.apple.dock show-recents -bool false
|
||||||
|
revertCode: defaults delete com.apple.dock show-recents
|
||||||
|
-
|
||||||
|
name: Disable AirDrop file sharing
|
||||||
|
recommend: strict
|
||||||
|
code: defaults write com.apple.NetworkBrowser DisableAirDrop -bool true
|
||||||
|
revertCode: defaults write com.apple.NetworkBrowser DisableAirDrop -bool false
|
||||||
|
functions:
|
||||||
|
-
|
||||||
|
name: PersistUserEnvironmentConfiguration
|
||||||
|
parameters: [ configuration ]
|
||||||
|
code: |-
|
||||||
|
command='{{ $configuration }}'
|
||||||
|
declare -a profile_files=("$HOME/.bash_profile" "$HOME/.zprofile")
|
||||||
|
for profile_file in "${profile_files[@]}"
|
||||||
|
do
|
||||||
|
touch "$profile_file"
|
||||||
|
if ! grep -q "$command" "${profile_file}"; then
|
||||||
|
echo "$command" >> "$profile_file"
|
||||||
|
echo "[$profile_file] Configured"
|
||||||
|
else
|
||||||
|
echo "[$profile_file] No need for any action, already configured"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
revertCode: |-
|
||||||
|
command='{{ $configuration }}'
|
||||||
|
declare -a profile_files=("$HOME/.bash_profile" "$HOME/.zprofile")
|
||||||
|
for profile_file in "${profile_files[@]}"
|
||||||
|
do
|
||||||
|
if grep -q "$command" "${profile_file}" 2>/dev/null; then
|
||||||
|
sed -i '' "/$command/d" "$profile_file"
|
||||||
|
echo "[$profile_file] Reverted configuration"
|
||||||
|
else
|
||||||
|
echo "[$profile_file] No need for any action, configuration does not exist"
|
||||||
|
fi
|
||||||
|
done
|
||||||