Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
67c3677621 | ||
|
|
bab6316e76 | ||
|
|
48730bca05 | ||
|
|
698b570ee6 | ||
|
|
a3f11dff18 | ||
|
|
5e359c2fb8 | ||
|
|
2147eae687 | ||
|
|
286295128d | ||
|
|
8501495c17 | ||
|
|
888c9166fc | ||
|
|
e5f6edf405 | ||
|
|
e8a52f717d | ||
|
|
d45750428c | ||
|
|
cf55ca9e28 | ||
|
|
3e5239f7d3 | ||
|
|
7669985f8e | ||
|
|
5047c9b6e7 |
@@ -5,3 +5,7 @@ end_of_line = lf
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
max_line_length = 100
|
||||
|
||||
[{Dockerfile}]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
@@ -8,4 +8,5 @@ runs:
|
||||
-
|
||||
name: Run `npm ci` with retries
|
||||
shell: bash
|
||||
run: npm run install-deps -- --ci --root-directory "${{ inputs.working-directory }}"
|
||||
run: npm run install-deps -- --ci
|
||||
working-directory: ${{ inputs.working-directory }}
|
||||
|
||||
32
.github/workflows/checks.build.yaml
vendored
@@ -1,4 +1,4 @@
|
||||
name: build-checks
|
||||
name: checks.build
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -68,3 +68,33 @@ jobs:
|
||||
-
|
||||
name: Verify bundled desktop build artifacts
|
||||
run: npm run check:verify-build-artifacts -- --electron-bundled
|
||||
|
||||
build-docker:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ macos, ubuntu ] # Windows runners do not support Linux containers
|
||||
fail-fast: false # Allows to see results from other combinations
|
||||
runs-on: ${{ matrix.os }}-latest
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
-
|
||||
name: Install Docker on macOS
|
||||
if: matrix.os == 'macos' # macOS runner is missing Docker
|
||||
run: |-
|
||||
# Install Docker
|
||||
brew install docker
|
||||
# Docker on macOS misses daemon due to licensing, so install colima as runtime
|
||||
brew install colima
|
||||
# Start the daemon
|
||||
colima start
|
||||
-
|
||||
name: Build Docker image
|
||||
run: docker build -t undergroundwires/privacy.sexy:latest .
|
||||
-
|
||||
name: Run Docker image on port 8080
|
||||
run: docker run -d -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest
|
||||
-
|
||||
name: Check server is up and returns HTTP 200
|
||||
run: node ./scripts/verify-web-server-status.js --url http://localhost:8080
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: security-checks
|
||||
name: checks.security.dependencies
|
||||
|
||||
on:
|
||||
push:
|
||||
42
.github/workflows/checks.security.sast.yaml
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
name: checks.security.sast
|
||||
|
||||
on:
|
||||
push:
|
||||
pull_request:
|
||||
schedule:
|
||||
- cron: '0 0 * * 0' # at 00:00 on every Sunday
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
language: [
|
||||
javascript # analyzes code written in JavaScript, TypeScript and both.
|
||||
]
|
||||
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
-
|
||||
name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v2
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
queries: +security-and-quality
|
||||
-
|
||||
name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v2
|
||||
-
|
||||
name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v2
|
||||
with:
|
||||
category: "/language:${{ matrix.language }}"
|
||||
19
CHANGELOG.md
@@ -1,5 +1,24 @@
|
||||
# Changelog
|
||||
|
||||
## 0.12.4 (2023-09-25)
|
||||
|
||||
* win: fix Windows spotlight revert, docs, recommend | [659fea7](https://github.com/undergroundwires/privacy.sexy/commit/659fea7afcabcd0ea273cfdcc8c4bae190c126f3)
|
||||
* win: fix Edge telemetry disabling for v116+ #242 | [6d301f9](https://github.com/undergroundwires/privacy.sexy/commit/6d301f99616ed49975876803d0098eafe4d3cb2e)
|
||||
* win: fix, improve disabling automatic updates #252 | [6e9b65d](https://github.com/undergroundwires/privacy.sexy/commit/6e9b65d8b1b481c1471dde90876c37838b4ac4e5)
|
||||
* win: refactor `update.mode` key for VSCode #215 | [c27172c](https://github.com/undergroundwires/privacy.sexy/commit/c27172c32e7c316b7cb0f44cab611eed89ca034e)
|
||||
* Fix wrong action path in website CI deployment | [a1f2497](https://github.com/undergroundwires/privacy.sexy/commit/a1f24973813ccbdd7e1f06c64e1912a991a6bb64)
|
||||
* Fix compiler bug with nested optional arguments | [53222fd](https://github.com/undergroundwires/privacy.sexy/commit/53222fd83c2846089746a217482195806f960d18)
|
||||
* Fix no spacing after lists in documentation text | [f810ed0](https://github.com/undergroundwires/privacy.sexy/commit/f810ed0c147c2a46cae3b70b635ed81128646fff)
|
||||
* Rewrite tooltip UI for efficiency and Vue 3.0 #230 | [8b930fc](https://github.com/undergroundwires/privacy.sexy/commit/8b930fc57c8ee6691ed6165bcb27d97e64a1a0c0)
|
||||
* win: fix uninstallation of newer Edge #236 | [60dde11](https://github.com/undergroundwires/privacy.sexy/commit/60dde11311a2409537f5965f370b0daaaec53339)
|
||||
* win: fix delivery optimization side-effects #173 | [203daeb](https://github.com/undergroundwires/privacy.sexy/commit/203daeb4a2fca0a0295cbc2a736394f9f87725e6)
|
||||
* win: fix Defender scan artifacts removal #246 | [cb21a97](https://github.com/undergroundwires/privacy.sexy/commit/cb21a970b6b867e1476a5eb8a72b9a7fdd53a744)
|
||||
* Fix outdated and broken links in README #161 | [0303ef2](https://github.com/undergroundwires/privacy.sexy/commit/0303ef2fd98b36306523e2a0c5f5ae812a4c6c99)
|
||||
* Fix loss of tree node state when switching views | [8f188ac](https://github.com/undergroundwires/privacy.sexy/commit/8f188acd3c2d93e40c89569c74bc5cff992f0052)
|
||||
* Fix slow appearance of nodes on tree view | [bd2082e](https://github.com/undergroundwires/privacy.sexy/commit/bd2082e8c574db065bb4462f30ea3ace2cb028cb)
|
||||
|
||||
[compare](https://github.com/undergroundwires/privacy.sexy/compare/0.12.3...0.12.4)
|
||||
|
||||
## 0.12.3 (2023-09-09)
|
||||
|
||||
* linux: use user.js over prefs.js for Firefox #232 | [dae6d11](https://github.com/undergroundwires/privacy.sexy/commit/dae6d114daab6857d773071211eb57619b136281)
|
||||
|
||||
17
Dockerfile
@@ -1,13 +1,16 @@
|
||||
# Build
|
||||
FROM node:lts-alpine as build-stage
|
||||
FROM node:lts-alpine AS build-stage
|
||||
WORKDIR /app
|
||||
COPY package*.json ./
|
||||
RUN npm install
|
||||
COPY . .
|
||||
RUN npm run build
|
||||
RUN npm run install-deps
|
||||
RUN npm run build \
|
||||
&& npm run check:verify-build-artifacts -- --web
|
||||
RUN mkdir /dist \
|
||||
&& dist_directory=$(node 'scripts/print-dist-dir.js' --web) \
|
||||
&& cp -a "${dist_directory}/." '/dist'
|
||||
|
||||
# Production stage
|
||||
FROM nginx:stable-alpine as production-stage
|
||||
COPY --from=build-stage /app/dist /usr/share/nginx/html
|
||||
FROM nginx:stable-alpine AS production-stage
|
||||
COPY --from=build-stage /dist /usr/share/nginx/html
|
||||
EXPOSE 80
|
||||
CMD ["nginx", "-g", "daemon off;"]
|
||||
CMD ["nginx", "-g", "daemon off;"]
|
||||
|
||||
48
README.md
@@ -16,14 +16,6 @@
|
||||
src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"
|
||||
/>
|
||||
</a>
|
||||
<!-- Code quality -->
|
||||
<br />
|
||||
<a href="https://lgtm.com/projects/g/undergroundwires/privacy.sexy/context:javascript" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Language grade: JavaScript/TypeScript"
|
||||
src="https://img.shields.io/lgtm/grade/javascript/g/undergroundwires/privacy.sexy.svg?logo=lgtm&logoWidth=18"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://codeclimate.com/github/undergroundwires/privacy.sexy/maintainability" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Maintainability"
|
||||
@@ -50,6 +42,20 @@
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/e2e-tests/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<!-- Security checks -->
|
||||
<br />
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.sast.yaml" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Status of dependency security checks"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.sast/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.dependencies.yaml" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Status of Static Analysis Security Testing (SAST)"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.security.dependencies/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<!-- Checks -->
|
||||
<br />
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.quality.yaml" target="_blank" rel="noopener noreferrer">
|
||||
@@ -58,16 +64,10 @@
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/quality-checks/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.security.yaml" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Security checks status"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/security-checks/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.build.yaml" target="_blank" rel="noopener noreferrer">
|
||||
<img
|
||||
alt="Build checks status"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/build-checks/badge.svg"
|
||||
alt="Status of build checks"
|
||||
src="https://github.com/undergroundwires/privacy.sexy/workflows/checks.build/badge.svg"
|
||||
/>
|
||||
</a>
|
||||
<a href="https://github.com/undergroundwires/privacy.sexy/actions/workflows/checks.desktop-runtime-errors.yaml" target="_blank" rel="noopener noreferrer">
|
||||
@@ -122,7 +122,7 @@
|
||||
## Get started
|
||||
|
||||
- 🌍️ **Online**: [https://privacy.sexy](https://privacy.sexy).
|
||||
- 🖥️ **Offline**: Check [releases page](https://github.com/undergroundwires/privacy.sexy/releases), or download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.3/privacy.sexy-Setup-0.12.3.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.3/privacy.sexy-0.12.3.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.3/privacy.sexy-0.12.3.AppImage).
|
||||
- 🖥️ **Offline**: Download directly for: [Windows](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.4/privacy.sexy-Setup-0.12.4.exe), [macOS](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.4/privacy.sexy-0.12.4.dmg), [Linux](https://github.com/undergroundwires/privacy.sexy/releases/download/0.12.4/privacy.sexy-0.12.4.AppImage). For more options, see [here](#additional-install-options).
|
||||
|
||||
Online version does not require to run any software on your computer. Offline version has more functions such as running the scripts directly.
|
||||
|
||||
@@ -150,6 +150,16 @@ Online version does not require to run any software on your computer. Offline ve
|
||||
|
||||
**Contribute 👷**. Contributions of any type are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) as the starting point. It includes useful information like [how to add new scripts](./CONTRIBUTING.md#extend-scripts).
|
||||
|
||||
## Additional Install Options
|
||||
|
||||
- Check the [releases page](https://github.com/undergroundwires/privacy.sexy/releases) for all available versions.
|
||||
- Using [Scoop](https://scoop.sh/#/apps?q=privacy.sexy&s=2&d=1&o=true) package manager on Windows:
|
||||
|
||||
```powershell
|
||||
scoop bucket add extras
|
||||
scoop install privacy.sexy
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
Refer to [development.md](./docs/development.md) for Docker usage and reading more about setting up your development environment.
|
||||
@@ -157,3 +167,7 @@ Refer to [development.md](./docs/development.md) for Docker usage and reading mo
|
||||
Check [architecture.md](./docs/architecture.md) for an overview of design and how different parts and layers work together. You can refer to [application.md](./docs/application.md) for a closer look at application layer codebase and [presentation.md](./docs/presentation.md) for code related to GUI layer. [collection-files.md](./docs/collection-files.md) explains the YAML files that are the core of the application and [templating.md](./docs/templating.md) documents how to use templating language in those files. In [ci-cd.md](./docs/ci-cd.md), you can read more about the pipelines that automates maintenance tasks and ensures you get what see.
|
||||
|
||||
[docs/](./docs/) folder includes all other documentation.
|
||||
|
||||
## Security
|
||||
|
||||
Security is a top priority at privacy.sexy. An extensive commitment to security verification ensures this priority. For any security concerns or vulnerabilities, please consult the [Security Policy](./SECURITY.md).
|
||||
|
||||
31
SECURITY.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Security Policy
|
||||
|
||||
privacy.sexy takes security seriously. Commitment is made to address all security issues with urgency. Responsible reporting of any discovered vulnerabilities in the project is highly encouraged.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Efforts to responsibly disclose findings are greatly appreciated. To report a security vulnerability, follow these steps:
|
||||
|
||||
- For general vulnerabilities, [open an issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose) using the bug report template.
|
||||
- For sensitive matters, [contact the developer directly](https://undergroundwires.dev).
|
||||
|
||||
## Security Report Handling
|
||||
|
||||
Upon receipt of a security report, the following actions will be taken:
|
||||
|
||||
- The report will be confirmed, identifying the affected components.
|
||||
- The impact and severity of the issue will be assessed.
|
||||
- Work on a fix and plan a release to address the vulnerability will be initiated.
|
||||
- The reporter will be kept updated about the progress.
|
||||
|
||||
## Testing
|
||||
|
||||
Regular and extensive testing is conducted to ensure robust security in the project. Information about testing practices can be found in the [Testing Documentation](./docs/tests.md).
|
||||
|
||||
## Support
|
||||
|
||||
For additional assistance or any unanswered questions, [submit a GitHub issue](https://github.com/undergroundwires/privacy.sexy/issues/new/choose). Security concerns are a priority, and necessary support to address them is assured.
|
||||
|
||||
---
|
||||
|
||||
Active contribution to the safety and security of privacy.sexy is thanked. This collaborative effort keeps the project resilient and trustworthy for all.
|
||||
@@ -174,3 +174,19 @@
|
||||
- `endCode:` *`string`* (**required**)
|
||||
- Code that'll be inserted at the end of user created script.
|
||||
- Global variables such as `$homepage`, `$version`, `$date` can be used using [parameter substitution](./templating.md#parameter-substitution) code syntax such as `Welcome to {{ $homepage }}!`
|
||||
|
||||
## Naming guidelines
|
||||
|
||||
- Prioritize consistency throughout all names.
|
||||
- Use an instruction format like "do this, do that" for clear, direct guidance. This approach reduces potential confusion and offers easy-to-follow steps. It provides specific, unambiguous instructions.
|
||||
- Ensure brand names adhere to their official casing.
|
||||
- Choose clear and uncomplicated language.
|
||||
- Favor the terms:
|
||||
- "Disable" over "Turn off"
|
||||
- "Configure" over "Set up"
|
||||
- "Clear" over "Erase" or "Clean"
|
||||
- "Minimize" over "Limit" or "Reduce" (when it enhances clarity)
|
||||
- "Remove" over "Uninstall"
|
||||
- Structure your phrases for clarity.
|
||||
- For instance, "Disable XX telemetry" or "Clear XX data" are preferred over "Clear data from XX", "Disable telemetry in XX", or "Clear data of XX".
|
||||
- Use sentence case rather than Title Case.
|
||||
|
||||
@@ -60,6 +60,7 @@ See [ci-cd.md](./ci-cd.md) for more information.
|
||||
|
||||
1. Build: `docker build -t undergroundwires/privacy.sexy:latest .`
|
||||
2. Run: `docker run -it -p 8080:80 --rm --name privacy.sexy undergroundwires/privacy.sexy:latest`
|
||||
3. Application should be available at [`http://localhost:8080`](http://localhost:8080)
|
||||
|
||||
### Building
|
||||
|
||||
@@ -81,11 +82,12 @@ See [ci-cd.md](./ci-cd.md) for more information.
|
||||
|
||||
#### Automation scripts
|
||||
|
||||
- [**`node scripts/print-dist-dir.js [-- <options>]`**](../scripts/print-dist-dir.js):
|
||||
- [**`node scripts/print-dist-dir.js [<options>]`**](../scripts/print-dist-dir.js):
|
||||
- Determines the absolute path of a distribution directory based on CLI arguments and outputs its absolute path.
|
||||
- Primarily used by automation scripts.
|
||||
- [**`npm run check:verify-build-artifacts [-- <options>]`**](../scripts/verify-build-artifacts.js):
|
||||
- Verifies the existence and content of build artifacts. Useful for ensuring that the build process is generating the expected output.
|
||||
- [**`node scripts/verify-web-server-status.js --url [URL]`**](../scripts/verify-web-server-status.js):
|
||||
- Checks if a specified server is up with retries and returns an HTTP 200 status code.
|
||||
|
||||
## Recommended extensions
|
||||
|
||||
|
||||
@@ -56,6 +56,11 @@ These checks validate various qualities like runtime execution, building process
|
||||
- Use [various tools](./../package.json) and [scripts](./../scripts).
|
||||
- Are automatically executed as [GitHub workflows](./../.github/workflows).
|
||||
|
||||
### Security checks
|
||||
|
||||
- [`checks.security.sast`](./../.github/workflows/checks.security.sast.yaml): Utilizes CodeQL to conduct Static Analysis Security Testing (SAST) to ensure the secure integrity of the codebase.
|
||||
- [`checks.security.dependencies`](./../.github/workflows/checks.security.dependencies.yaml): Performs audits on third-party dependencies to identify and mitigate potential vulnerabilities, safeguarding the project from exploitable weaknesses.
|
||||
|
||||
## Tests structure
|
||||
|
||||
- [`package.json`](./../package.json): Defines test commands and includes tools used in tests.
|
||||
|
||||
118
package-lock.json
generated
@@ -1,20 +1,15 @@
|
||||
{
|
||||
"name": "privacy.sexy",
|
||||
"version": "0.12.3",
|
||||
"version": "0.12.4",
|
||||
"lockfileVersion": 2,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "privacy.sexy",
|
||||
"version": "0.12.3",
|
||||
"version": "0.12.4",
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"@floating-ui/vue": "^1.0.2",
|
||||
"@fortawesome/fontawesome-svg-core": "^6.4.0",
|
||||
"@fortawesome/free-brands-svg-icons": "^6.4.0",
|
||||
"@fortawesome/free-regular-svg-icons": "^6.4.0",
|
||||
"@fortawesome/free-solid-svg-icons": "^6.4.0",
|
||||
"@fortawesome/vue-fontawesome": "^2.0.9",
|
||||
"@juggle/resize-observer": "^3.4.0",
|
||||
"ace-builds": "^1.23.4",
|
||||
"cross-fetch": "^4.0.0",
|
||||
@@ -2578,72 +2573,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"node_modules/@fortawesome/fontawesome-common-types": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-common-types/-/fontawesome-common-types-6.4.2.tgz",
|
||||
"integrity": "sha512-1DgP7f+XQIJbLFCTX1V2QnxVmpLdKdzzo2k8EmvDOePfchaIGQ9eCHj2up3/jNEbZuBqel5OxiaOJf37TWauRA==",
|
||||
"hasInstallScript": true,
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/@fortawesome/fontawesome-svg-core": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-svg-core/-/fontawesome-svg-core-6.4.2.tgz",
|
||||
"integrity": "sha512-gjYDSKv3TrM2sLTOKBc5rH9ckje8Wrwgx1CxAPbN5N3Fm4prfi7NsJVWd1jklp7i5uSCVwhZS5qlhMXqLrpAIg==",
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/@fortawesome/free-brands-svg-icons": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/free-brands-svg-icons/-/free-brands-svg-icons-6.4.2.tgz",
|
||||
"integrity": "sha512-LKOwJX0I7+mR/cvvf6qIiqcERbdnY+24zgpUSouySml+5w8B4BJOx8EhDR/FTKAu06W12fmUIcv6lzPSwYKGGg==",
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/@fortawesome/free-regular-svg-icons": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/free-regular-svg-icons/-/free-regular-svg-icons-6.4.2.tgz",
|
||||
"integrity": "sha512-0+sIUWnkgTVVXVAPQmW4vxb9ZTHv0WstOa3rBx9iPxrrrDH6bNLsDYuwXF9b6fGm+iR7DKQvQshUH/FJm3ed9Q==",
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/@fortawesome/free-solid-svg-icons": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/free-solid-svg-icons/-/free-solid-svg-icons-6.4.2.tgz",
|
||||
"integrity": "sha512-sYwXurXUEQS32fZz9hVCUUv/xu49PEJEyUOsA51l6PU/qVgfbTb2glsTEaJngVVT8VqBATRIdh7XVgV1JF1LkA==",
|
||||
"hasInstallScript": true,
|
||||
"dependencies": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/@fortawesome/vue-fontawesome": {
|
||||
"version": "2.0.10",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/vue-fontawesome/-/vue-fontawesome-2.0.10.tgz",
|
||||
"integrity": "sha512-OTETSXz+3ygD2OK2/vy82cmUBpuJqeOAg4gfnnv+f2Rir1tDIhQg026Q3NQxznq83ZLz8iNqGG9XJm26inpDeg==",
|
||||
"peerDependencies": {
|
||||
"@fortawesome/fontawesome-svg-core": "~1 || ~6",
|
||||
"vue": "~2"
|
||||
}
|
||||
},
|
||||
"node_modules/@hapi/hoek": {
|
||||
"version": "9.3.0",
|
||||
"resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz",
|
||||
@@ -23015,49 +22944,6 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"@fortawesome/fontawesome-common-types": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-common-types/-/fontawesome-common-types-6.4.2.tgz",
|
||||
"integrity": "sha512-1DgP7f+XQIJbLFCTX1V2QnxVmpLdKdzzo2k8EmvDOePfchaIGQ9eCHj2up3/jNEbZuBqel5OxiaOJf37TWauRA=="
|
||||
},
|
||||
"@fortawesome/fontawesome-svg-core": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/fontawesome-svg-core/-/fontawesome-svg-core-6.4.2.tgz",
|
||||
"integrity": "sha512-gjYDSKv3TrM2sLTOKBc5rH9ckje8Wrwgx1CxAPbN5N3Fm4prfi7NsJVWd1jklp7i5uSCVwhZS5qlhMXqLrpAIg==",
|
||||
"requires": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
}
|
||||
},
|
||||
"@fortawesome/free-brands-svg-icons": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/free-brands-svg-icons/-/free-brands-svg-icons-6.4.2.tgz",
|
||||
"integrity": "sha512-LKOwJX0I7+mR/cvvf6qIiqcERbdnY+24zgpUSouySml+5w8B4BJOx8EhDR/FTKAu06W12fmUIcv6lzPSwYKGGg==",
|
||||
"requires": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
}
|
||||
},
|
||||
"@fortawesome/free-regular-svg-icons": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/free-regular-svg-icons/-/free-regular-svg-icons-6.4.2.tgz",
|
||||
"integrity": "sha512-0+sIUWnkgTVVXVAPQmW4vxb9ZTHv0WstOa3rBx9iPxrrrDH6bNLsDYuwXF9b6fGm+iR7DKQvQshUH/FJm3ed9Q==",
|
||||
"requires": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
}
|
||||
},
|
||||
"@fortawesome/free-solid-svg-icons": {
|
||||
"version": "6.4.2",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/free-solid-svg-icons/-/free-solid-svg-icons-6.4.2.tgz",
|
||||
"integrity": "sha512-sYwXurXUEQS32fZz9hVCUUv/xu49PEJEyUOsA51l6PU/qVgfbTb2glsTEaJngVVT8VqBATRIdh7XVgV1JF1LkA==",
|
||||
"requires": {
|
||||
"@fortawesome/fontawesome-common-types": "6.4.2"
|
||||
}
|
||||
},
|
||||
"@fortawesome/vue-fontawesome": {
|
||||
"version": "2.0.10",
|
||||
"resolved": "https://registry.npmjs.org/@fortawesome/vue-fontawesome/-/vue-fontawesome-2.0.10.tgz",
|
||||
"integrity": "sha512-OTETSXz+3ygD2OK2/vy82cmUBpuJqeOAg4gfnnv+f2Rir1tDIhQg026Q3NQxznq83ZLz8iNqGG9XJm26inpDeg==",
|
||||
"requires": {}
|
||||
},
|
||||
"@hapi/hoek": {
|
||||
"version": "9.3.0",
|
||||
"resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "privacy.sexy",
|
||||
"version": "0.12.3",
|
||||
"version": "0.12.4",
|
||||
"private": true,
|
||||
"slogan": "Now you have the choice",
|
||||
"description": "Enforce privacy & security best-practices on Windows, macOS and Linux, because privacy is sexy 🍑🍆",
|
||||
@@ -35,11 +35,6 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@floating-ui/vue": "^1.0.2",
|
||||
"@fortawesome/fontawesome-svg-core": "^6.4.0",
|
||||
"@fortawesome/free-brands-svg-icons": "^6.4.0",
|
||||
"@fortawesome/free-regular-svg-icons": "^6.4.0",
|
||||
"@fortawesome/free-solid-svg-icons": "^6.4.0",
|
||||
"@fortawesome/vue-fontawesome": "^2.0.9",
|
||||
"@juggle/resize-observer": "^3.4.0",
|
||||
"ace-builds": "^1.23.4",
|
||||
"cross-fetch": "^4.0.0",
|
||||
|
||||
62
scripts/verify-web-server-status.js
Normal file
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
* Description:
|
||||
* This script checks if a server, provided as a CLI argument, is up
|
||||
* and returns an HTTP 200 status code.
|
||||
* It is designed to provide easy verification of server availability
|
||||
* and will retry a specified number of times.
|
||||
*
|
||||
* Usage:
|
||||
* node ./scripts/verify-web-server-status.js --url [URL]
|
||||
*
|
||||
* Options:
|
||||
* --url URL of the server to check
|
||||
*/
|
||||
|
||||
import { get } from 'http';
|
||||
|
||||
const MAX_RETRIES = 30;
|
||||
const RETRY_DELAY_IN_SECONDS = 3;
|
||||
const URL_PARAMETER_NAME = '--url';
|
||||
|
||||
function checkServer(currentRetryCount = 1) {
|
||||
const serverUrl = getServerUrl();
|
||||
console.log(`Requesting ${serverUrl}...`);
|
||||
get(serverUrl, (res) => {
|
||||
if (res.statusCode === 200) {
|
||||
console.log('🎊 Success: The server is up and returned HTTP 200.');
|
||||
process.exit(0);
|
||||
} else {
|
||||
console.log(`Server returned HTTP status code ${res.statusCode}.`);
|
||||
retry(currentRetryCount);
|
||||
}
|
||||
}).on('error', (err) => {
|
||||
console.error('Error making the request:', err);
|
||||
retry(currentRetryCount);
|
||||
});
|
||||
}
|
||||
|
||||
function retry(currentRetryCount) {
|
||||
console.log(`Attempt ${currentRetryCount}/${MAX_RETRIES}:`);
|
||||
console.log(`Retrying in ${RETRY_DELAY_IN_SECONDS} seconds.`);
|
||||
|
||||
const remainingTime = (MAX_RETRIES - currentRetryCount) * RETRY_DELAY_IN_SECONDS;
|
||||
console.log(`Time remaining before timeout: ${remainingTime}s`);
|
||||
|
||||
if (currentRetryCount < MAX_RETRIES) {
|
||||
setTimeout(() => checkServer(currentRetryCount + 1), RETRY_DELAY_IN_SECONDS * 1000);
|
||||
} else {
|
||||
console.log('Failure: The server at did not return HTTP 200 within the allocated time. Exiting.');
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
function getServerUrl() {
|
||||
const urlIndex = process.argv.indexOf(URL_PARAMETER_NAME);
|
||||
if (urlIndex === -1 || urlIndex === process.argv.length - 1) {
|
||||
console.error(`Parameter "${URL_PARAMETER_NAME}" is not provided.`);
|
||||
process.exit(1);
|
||||
}
|
||||
return process.argv[urlIndex + 1];
|
||||
}
|
||||
|
||||
checkServer();
|
||||
@@ -1,4 +1,4 @@
|
||||
# Structure documented in "docs/collection-files.md"
|
||||
# Structure is documented in "docs/collection-files.md"
|
||||
os: macos
|
||||
scripting:
|
||||
language: shellscript
|
||||
@@ -21,7 +21,7 @@ actions:
|
||||
-
|
||||
category: Privacy cleanup
|
||||
children:
|
||||
-
|
||||
-
|
||||
category: Clear terminal history
|
||||
children:
|
||||
-
|
||||
@@ -48,18 +48,18 @@ actions:
|
||||
# on main HDD
|
||||
sudo rm -rfv ~/.Trash/* &>/dev/null
|
||||
-
|
||||
name: Clear system cache files
|
||||
name: Clear system cache
|
||||
recommend: strict
|
||||
code: |-
|
||||
sudo rm -rfv /Library/Caches/* &>/dev/null
|
||||
sudo rm -rfv /System/Library/Caches/* &>/dev/null
|
||||
sudo rm -rfv ~/Library/Caches/* &>/dev/null
|
||||
-
|
||||
category: Clear OS logs
|
||||
category: Clear operating system logs
|
||||
recommend: strict
|
||||
children:
|
||||
-
|
||||
category: Clear unified logs (diagnostics)
|
||||
category: Clear unified diagnostic logs
|
||||
docs: https://developer.apple.com/documentation/os/logging
|
||||
children:
|
||||
-
|
||||
@@ -69,15 +69,15 @@ actions:
|
||||
sudo rm -rfv /private/var/db/diagnostics/*
|
||||
sudo rm -rfv /var/db/diagnostics/*
|
||||
-
|
||||
name: Clear shared-cache strings data
|
||||
docs:
|
||||
name: Clear shared cache strings data
|
||||
docs:
|
||||
- https://eclecticlight.co/2017/09/23/sierras-unified-log-evolves-more-persistent-and-a-valuable-log-log/
|
||||
- https://github.com/privacysexy-forks/dtformats/blob/main/documentation/Apple%20Unified%20Logging%20and%20Activity%20Tracing%20formats.asciidoc
|
||||
code: |-
|
||||
sudo rm -rfv /private/var/db/uuidtext/
|
||||
sudo rm -rfv /var/db/uuidtext/
|
||||
-
|
||||
category: Clear system logs (/var/log/)
|
||||
category: Clear system logs
|
||||
children:
|
||||
-
|
||||
name: Clear Apple System Logs (ASL)
|
||||
@@ -94,7 +94,7 @@ actions:
|
||||
docs: https://discussions.apple.com/thread/1829842
|
||||
code: sudo rm -fv /var/log/install.log
|
||||
-
|
||||
name: Clear all system logs
|
||||
name: Clear all system logs in `/var/log/` directory
|
||||
docs: https://www.howtogeek.com/356942/how-to-view-the-system-log-on-a-mac/
|
||||
code: sudo rm -rfv /var/log/* # Clears including /var/log/system.log
|
||||
-
|
||||
@@ -105,7 +105,7 @@ actions:
|
||||
name: Clear Mail logs
|
||||
code: rm -rfv ~/Library/Containers/com.apple.mail/Data/Library/Logs/Mail/*
|
||||
-
|
||||
name: Clear audit logs (login, logout, authentication and other user activity)
|
||||
name: Clear user activity audit logs (login, logout, authentication, etc.)
|
||||
docs:
|
||||
- https://papers.put.as/papers/macosx/2012/Mac_Log_Analysis_Sarah_Edwards_DFIRSummit2012.pdf
|
||||
- http://macadmins.psu.edu/wp-content/uploads/sites/24696/2016/06/psumac2016-19-osxlogs_macadmins_2016.pdf
|
||||
@@ -113,7 +113,7 @@ actions:
|
||||
sudo rm -rfv /var/audit/*
|
||||
sudo rm -rfv /private/var/audit/*
|
||||
-
|
||||
name: Clear user logs (user reports)
|
||||
name: Clear user report logs
|
||||
docs:
|
||||
- https://www.howtogeek.com/356942/how-to-view-the-system-log-on-a-mac/
|
||||
- https://apple.stackexchange.com/questions/272929/is-it-safe-to-delete-the-content-of-library-logs
|
||||
@@ -134,15 +134,15 @@ actions:
|
||||
category: Clear browser history
|
||||
children:
|
||||
-
|
||||
category: Clear Google Chrome history
|
||||
category: Clear Chrome history
|
||||
children:
|
||||
-
|
||||
name: Clear Google Chrome browsing history
|
||||
name: Clear Chrome browsing history
|
||||
code: |-
|
||||
rm -rfv ~/Library/Application\ Support/Google/Chrome/Default/History &>/dev/null
|
||||
rm -rfv ~/Library/Application\ Support/Google/Chrome/Default/History-journal &>/dev/null
|
||||
-
|
||||
name: Google Chrome Cache Files
|
||||
name: Clear Chrome cache
|
||||
code: sudo rm -rfv ~/Library/Application\ Support/Google/Chrome/Default/Application\ Cache/* &>/dev/null
|
||||
-
|
||||
category: Clear Safari history
|
||||
@@ -165,7 +165,7 @@ actions:
|
||||
docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
|
||||
code: rm -f ~/Library/Safari/Downloads.plist
|
||||
-
|
||||
name: Clear Safari top sites
|
||||
name: Clear Safari frequently visited sites
|
||||
docs: https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
|
||||
code: rm -f ~/Library/Safari/TopSites.plist
|
||||
-
|
||||
@@ -182,7 +182,7 @@ actions:
|
||||
docs: https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
|
||||
code: rm -f ~/Library/Caches/com.apple.Safari/Cache.db
|
||||
-
|
||||
name: Clear Safari web page icons displayed on URL bar
|
||||
name: Clear Safari URL bar web page icons
|
||||
docs:
|
||||
- https://davidkoepi.wordpress.com/2013/04/20/safariforensic/
|
||||
- https://lifehacker.com/safaris-private-browsing-mode-saves-urls-in-an-easily-a-1691944343
|
||||
@@ -194,11 +194,11 @@ actions:
|
||||
- https://www.reddit.com/r/apple/comments/18lp92/your_apple_computer_keeps_a_screen_shot_of_nearly/
|
||||
code: rm -rfv ~/Library/Caches/com.apple.Safari/Webpage\ Previews
|
||||
-
|
||||
name: Clear copy of the Safari history
|
||||
name: Clear Safari history copy
|
||||
docs: https://forensicsfromthesausagefactory.blogspot.com/2010/06/safari-history-spotlight-webhistory.html
|
||||
code: rm -rfv ~/Library/Caches/Metadata/Safari/History
|
||||
-
|
||||
name: Clear search history embedded in Safari preferences
|
||||
name: Clear search term history embedded in Safari preferences
|
||||
docs: https://krypted.com/tag/recentsearchstrings/
|
||||
code: defaults write ~/Library/Preferences/com.apple.Safari RecentSearchStrings '( )'
|
||||
-
|
||||
@@ -215,11 +215,11 @@ actions:
|
||||
docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
|
||||
code: rm -f ~/Library/Safari/PerSiteZoomPreferences.plist
|
||||
-
|
||||
name: Clear URLs that are allowed to display notifications in Safari
|
||||
name: Clear allowed URLs for Safari notifications
|
||||
docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
|
||||
code: rm -f ~/Library/Safari/UserNotificationPreferences.plist
|
||||
-
|
||||
name: Clear Safari per-site preferences for Downloads, Geolocation, PopUps, and Autoplays
|
||||
name: Clear Safari preferences for downloads, geolocation, pop-ups, and autoplay per site
|
||||
docs: https://blog.d204n6.com/2020/09/macos-safari-preferences-and-privacy.html
|
||||
code: rm -f ~/Library/Safari/PerSitePreferences.db
|
||||
-
|
||||
@@ -231,15 +231,15 @@ actions:
|
||||
sudo rm -rf ~/Library/Caches/Mozilla/
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/netpredictions.sqlite
|
||||
-
|
||||
name: Delete Firefox form history
|
||||
name: Clear Firefox form history
|
||||
code: |-
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/formhistory.sqlite
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/formhistory.dat
|
||||
-
|
||||
name: Delete Firefox site preferences
|
||||
name: Clear Firefox site preferences
|
||||
code: rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/content-prefs.sqlite
|
||||
-
|
||||
name: Delete Firefox session restore data (loads after the browser closes or crashes)
|
||||
name: Clear Firefox session restore data (loads after the browser closes or crashes)
|
||||
code: |-
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionCheckpoints.json
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionstore*.js*
|
||||
@@ -250,7 +250,7 @@ actions:
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionstore-backups/previous.bak*
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/sessionstore-backups/upgrade.js*-20*
|
||||
-
|
||||
name: Delete Firefox passwords
|
||||
name: Clear Firefox passwords
|
||||
docs: https://web.archive.org/web/20210425202923/http://kb.mozillazine.org/Password_Manager
|
||||
code: |-
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/signons.txt
|
||||
@@ -259,20 +259,20 @@ actions:
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/signons.sqlite
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/logins.json
|
||||
-
|
||||
name: Delete Firefox HTML5 cookies
|
||||
name: Clear Firefox HTML5 cookies
|
||||
code: rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/webappsstore.sqlite
|
||||
-
|
||||
name: Delete Firefox crash reports
|
||||
name: Clear Firefox crash reports
|
||||
code: |-
|
||||
rm -rfv ~/Library/Application\ Support/Firefox/Crash\ Reports/
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/minidumps/*.dmp
|
||||
-
|
||||
name: Delete Firefox backup files
|
||||
name: Clear Firefox backup files
|
||||
code: |-
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/bookmarkbackups/*.json
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/bookmarkbackups/*.jsonlz4
|
||||
-
|
||||
name: Delete Firefox cookies
|
||||
name: Clear Firefox cookies
|
||||
code: |-
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/cookies.txt
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/cookies.sqlite
|
||||
@@ -280,7 +280,7 @@ actions:
|
||||
rm -fv ~/Library/Application\ Support/Firefox/Profiles/*/cookies.sqlite-wal
|
||||
rm -rfv ~/Library/Application\ Support/Firefox/Profiles/*/storage/default/http*
|
||||
-
|
||||
category: Clear third party application data
|
||||
category: Clear third-party application data
|
||||
children:
|
||||
-
|
||||
name: Clear Adobe cache
|
||||
@@ -290,18 +290,18 @@ actions:
|
||||
name: Clear Gradle cache
|
||||
recommend: strict
|
||||
code: |-
|
||||
if [ -d "/Users/${HOST}/.gradle/caches" ]; then
|
||||
if [ -d "~/.gradle/caches" ]; then
|
||||
rm -rfv ~/.gradle/caches/ &> /dev/null
|
||||
fi
|
||||
-
|
||||
name: Clear Dropbox cache
|
||||
recommend: standard
|
||||
code: |-
|
||||
if [ -d "/Users/${HOST}/Dropbox" ]; then
|
||||
if [ -d "~/Dropbox/.dropbox.cache" ]; then
|
||||
sudo rm -rfv ~/Dropbox/.dropbox.cache/* &>/dev/null
|
||||
fi
|
||||
-
|
||||
name: Clear Google Drive file stream cache
|
||||
name: Clear Google Drive File Stream cache
|
||||
recommend: standard
|
||||
code: |-
|
||||
killall "Google Drive File Stream"
|
||||
@@ -323,21 +323,54 @@ actions:
|
||||
brew tap --repair &>/dev/null
|
||||
fi
|
||||
-
|
||||
name: Clear any old versions of Ruby gems
|
||||
name: Clear old Ruby gem versions
|
||||
recommend: strict
|
||||
code: |-
|
||||
if type "gem" &> /dev/null; then
|
||||
gem cleanup &>/dev/null
|
||||
fi
|
||||
-
|
||||
name: Clear Docker
|
||||
name: Clear unused Docker data
|
||||
recommend: strict
|
||||
docs: |-
|
||||
This script frees up disk space, but also improves user privacy by:
|
||||
|
||||
1. **Removal of stopped containers**: Containers often run applications or services that might process sensitive
|
||||
or personal data. Even if a container is stopped, its filesystem remains intact, and potentially sensitive data inside
|
||||
it can be accessed. By removing stopped containers, we eliminate this potential privacy risk.
|
||||
|
||||
2. **Deletion of unused images**: Images can sometimes contain sensitive information, especially if they were built
|
||||
from `Dockerfile`s that copied local files or were used in scenarios where sensitive data was processed. Deleting unused
|
||||
images ensures that any inadvertent sensitive information embedded in those images is eradicated.
|
||||
|
||||
3. **Cleanup of network configurations**: Networks, especially custom ones, can contain configurations that reveal details
|
||||
about system architecture, inter-container communication, or even hardcoded secrets. Removing unused networks mitigates
|
||||
risks associated with lingering, outdated, or insecure configurations.
|
||||
|
||||
4. **Elimination of build cache**: The Docker build process uses a cache to speed up image creation. This cache can contain
|
||||
remnants of previous builds, including potentially sensitive data or files. Pruning the build cache ensures that these remnants
|
||||
are deleted, further safeguarding privacy.
|
||||
|
||||
5. **Footprint reduction**: By consistently pruning unused Docker objects, the overall footprint of Docker on the system is
|
||||
reduced. This makes it harder for malicious actors to exploit any lingering or overlooked vulnerabilities in the system or Docker
|
||||
itself.
|
||||
|
||||
This script runs `docker system prune -af` command to clean up unused Docker data [1].
|
||||
|
||||
Specifically, the command will [1]:
|
||||
|
||||
- Remove all stopped containers.
|
||||
- Remove all networks not used by at least one container.
|
||||
- Remove all images not used by any container.
|
||||
- Remove all build cache.
|
||||
|
||||
[1]: https://web.archive.org/web/20230810171526/https://docs.docker.com/engine/reference/commandline/system_prune/ "docker system prune | Docker Documentation"
|
||||
code: |-
|
||||
if type "docker" &> /dev/null; then
|
||||
docker system prune -af
|
||||
fi
|
||||
-
|
||||
name: Clear Pyenv-VirtualEnv cache
|
||||
name: Clear Pyenv-Virtualenv cache
|
||||
recommend: strict
|
||||
code: |-
|
||||
if [ "$PYENV_VIRTUALENV_CACHE_PATH" ]; then
|
||||
@@ -359,22 +392,22 @@ actions:
|
||||
yarn cache clean --force
|
||||
fi
|
||||
-
|
||||
category: iOS Cleanup
|
||||
category: Clear iOS usage data
|
||||
children:
|
||||
-
|
||||
name: Clear iOS applications
|
||||
name: Clear iOS app copies from iTunes
|
||||
recommend: strict
|
||||
code: rm -rfv ~/Music/iTunes/iTunes\ Media/Mobile\ Applications/* &>/dev/null
|
||||
-
|
||||
name: Clear iOS photo caches
|
||||
name: Clear iOS photo cache
|
||||
recommend: standard
|
||||
code: rm -rf ~/Pictures/iPhoto\ Library/iPod\ Photo\ Cache/*
|
||||
-
|
||||
name: Remove iOS Device Backups
|
||||
name: Clear iOS Device Backups
|
||||
recommend: strict
|
||||
code: rm -rfv ~/Library/Application\ Support/MobileSync/Backup/* &>/dev/null
|
||||
-
|
||||
name: Clear iOS Simulators
|
||||
name: Clear iOS simulators
|
||||
recommend: strict
|
||||
code: |-
|
||||
if type "xcrun" &>/dev/null; then
|
||||
@@ -385,7 +418,7 @@ actions:
|
||||
xcrun simctl erase all
|
||||
fi
|
||||
-
|
||||
name: Clear the list of iOS devices connected
|
||||
name: Clear list of connected iOS devices
|
||||
recommend: strict
|
||||
code: |-
|
||||
sudo defaults delete /Users/$USER/Library/Preferences/com.apple.iPod.plist "conn:128:Last Connect"
|
||||
@@ -394,7 +427,7 @@ actions:
|
||||
sudo defaults delete /Library/Preferences/com.apple.iPod.plist Devices
|
||||
sudo rm -rfv /var/db/lockdown/*
|
||||
-
|
||||
name: Clear XCode Derived Data and Archives
|
||||
name: Clear Xcode's derived data and archives
|
||||
recommend: strict
|
||||
code: |-
|
||||
rm -rfv ~/Library/Developer/Xcode/DerivedData/* &>/dev/null
|
||||
@@ -407,51 +440,51 @@ actions:
|
||||
sudo dscacheutil -flushcache
|
||||
sudo killall -HUP mDNSResponder
|
||||
-
|
||||
name: Purge inactive memory
|
||||
name: Clear inactive memory
|
||||
recommend: standard
|
||||
code: sudo purge
|
||||
-
|
||||
category: Reset privacy permissions for all applications
|
||||
category: Clear all privacy permissions for applications
|
||||
children:
|
||||
-
|
||||
name: Reset camera permissions
|
||||
name: Clear "camera" permissions
|
||||
code: tccutil reset Camera
|
||||
-
|
||||
name: Reset microphone permissions
|
||||
name: Clear "microphone" permissions
|
||||
code: tccutil reset Microphone
|
||||
-
|
||||
name: Reset accessibility permissions
|
||||
name: Clear "accessibility" permissions
|
||||
code: tccutil reset Accessibility
|
||||
-
|
||||
name: Reset screen capture permissions
|
||||
name: Clear "screen capture" permissions
|
||||
code: tccutil reset ScreenCapture
|
||||
-
|
||||
name: Reset reminders permissions
|
||||
name: Clear "reminders" permissions
|
||||
code: tccutil reset Reminders
|
||||
-
|
||||
name: Reset photos permissions
|
||||
name: Clear "photos" permissions
|
||||
code: tccutil reset Photos
|
||||
-
|
||||
name: Reset calendar permissions
|
||||
name: Clear "calendar" permissions
|
||||
code: tccutil reset Calendar
|
||||
-
|
||||
name: Reset full disk access permissions
|
||||
name: Clear "full disk access" permissions
|
||||
code: tccutil reset SystemPolicyAllFiles
|
||||
-
|
||||
name: Reset contacts permissions
|
||||
name: Clear "contacts" permissions
|
||||
code: tccutil reset SystemPolicyAllFiles
|
||||
-
|
||||
name: Reset desktop folder permissions
|
||||
name: Clear "desktop folder" permissions
|
||||
code: tccutil reset SystemPolicyDesktopFolder
|
||||
-
|
||||
name: Reset documents folder permissions
|
||||
name: Clear "documents folder" permissions
|
||||
code: tccutil reset SystemPolicyDocumentsFolder
|
||||
-
|
||||
name: Reset downloads permissions
|
||||
name: Clear "downloads" permissions
|
||||
code: tccutil reset SystemPolicyDownloadsFolder
|
||||
-
|
||||
name: Reset all app permissions
|
||||
code: tccutil reset All
|
||||
name: Clear all app permissions
|
||||
code: tccutil reset All
|
||||
-
|
||||
category: Configure programs
|
||||
children:
|
||||
@@ -468,20 +501,20 @@ actions:
|
||||
sudo defaults delete /Library/Preferences/org.mozilla.firefox EnterprisePoliciesEnabled
|
||||
sudo defaults delete /Library/Preferences/org.mozilla.firefox DisableTelemetry
|
||||
-
|
||||
name: Disable Microsoft Office diagnostics data sending
|
||||
name: Disable Microsoft Office telemetry
|
||||
recommend: standard
|
||||
code: defaults write com.microsoft.office DiagnosticDataTypePreference -string ZeroDiagnosticData
|
||||
revertCode: defaults delete com.microsoft.office DiagnosticDataTypePreference
|
||||
-
|
||||
name: Uninstall Google update
|
||||
name: Remove Google Software Update service
|
||||
recommend: strict
|
||||
code: |-
|
||||
googleUpdateFile=~/Library/Google/GoogleSoftwareUpdate/GoogleSoftwareUpdate.bundle/Contents/Resources/ksinstall
|
||||
if [ -f "$googleUpdateFile" ]; then
|
||||
$googleUpdateFile --nuke
|
||||
echo Uninstalled google update
|
||||
echo 'Uninstalled Google update'
|
||||
else
|
||||
echo Google update file does not exist
|
||||
echo 'Google update file does not exist'
|
||||
fi
|
||||
-
|
||||
name: Disable Homebrew user behavior analytics
|
||||
@@ -514,12 +547,12 @@ actions:
|
||||
docs: |-
|
||||
Parallels Desktop for Mac is software providing hardware virtualization for macOS [1].
|
||||
|
||||
When you use it, it collects and share your personal data to third parties [2]. Personal
|
||||
When you use it, it collects and shares your personal data to third parties [2]. Personal
|
||||
data include IP address of your device, your broad geographical location (country, state
|
||||
(if applicable), and city) and used product [2].
|
||||
|
||||
It includes third-party ads [3] and automatic check for updates [4] by default. Both of these
|
||||
behaviors communicate with online services that reveal data about you.
|
||||
|
||||
It includes third-party advertisements [3] and automatic check for updates [4] by default.
|
||||
Both of these behaviors communicate with online services that reveal personal data about you.
|
||||
|
||||
[1]: https://web.archive.org/web/20221012155943/https://en.wikipedia.org/wiki/Parallels_Desktop_for_Mac "Parallels Desktop for Mac - Wikipedia | en.wikipedia.org"
|
||||
[2]: https://web.archive.org/web/20221012155829/https://www.parallels.com/about/legal/privacy/ "Privacy Statement | parallels.com"
|
||||
@@ -527,7 +560,7 @@ actions:
|
||||
[4]: https://web.archive.org/web/20221012151953/http://download.parallels.com/stm/docs/en/Parallels_Desktop_Users_Guide/22220.htm "Automatic Updating | Parallels Desktop Users Guide | download.parallels.com"
|
||||
children:
|
||||
-
|
||||
name: Turn off ads in Parallels Desktop
|
||||
name: Disable Parallels Desktop advertisements
|
||||
recommend: standard
|
||||
docs: |-
|
||||
Parallels Desktop in-product notifications to show ads from Parallels or other third
|
||||
@@ -544,7 +577,7 @@ actions:
|
||||
default). It's undocumented but still kept disabled by this script.
|
||||
|
||||
[1]: https://web.archive.org/save/https://forum.parallels.com/threads/unable-to-process-the-upgrade-request.345603/ "Unable to process the upgrade request | Parallels Forums | forum.parallels.com"
|
||||
[2]: https://web.archive.org/web/20221012151800/https://kb.parallels.com/114422 "How do I turn off notifications in Parallels Desktop and Parallels Access? | Knowledge Base | parallels.com"
|
||||
[2]: https://web.archive.org/web/20221012151800/https://kb.parallels.com/114422 "How do I turn off notifications in Parallels Desktop and Parallels Access? | Knowledge Base | parallels.com"
|
||||
code: |-
|
||||
defaults write 'com.parallels.Parallels Desktop' 'ProductPromo.ForcePromoOff' -bool yes
|
||||
defaults write 'com.parallels.Parallels Desktop' 'WelcomeScreenPromo.PromoOff' -bool yes
|
||||
@@ -552,16 +585,16 @@ actions:
|
||||
defaults write 'com.parallels.Parallels Desktop' 'ProductPromo.ForcePromoOff' -bool no
|
||||
defaults write 'com.parallels.Parallels Desktop' 'WelcomeScreenPromo.PromoOff' -bool yes
|
||||
-
|
||||
category: Disable Parallels Desktop auto-updates
|
||||
category: Disable Parallels Desktop automatic updates
|
||||
docs: |-
|
||||
Parallels Desktop by default checks for updates frequently and automatically downloads them [1].
|
||||
This reveal personal data about [2] you without your control.
|
||||
This reveal personal data about you [2] without your control.
|
||||
|
||||
[1]: https://web.archive.org/web/20221012151953/http://download.parallels.com/stm/docs/en/Parallels_Desktop_Users_Guide/22220.htm "Automatic Updating | Parallels Desktop Users Guide | download.parallels.com"
|
||||
[2]: https://web.archive.org/web/20221012155829/https://www.parallels.com/about/legal/privacy/ "Privacy Statement | parallels.com"
|
||||
children:
|
||||
-
|
||||
name: Disable automatically downloading Parallels Desktop updates
|
||||
name: Disable automatic downloads for Parallels Desktop updates
|
||||
docs: |-
|
||||
Automatic downloads are enabled by default, and this script disables automatic downloads.
|
||||
|
||||
@@ -570,11 +603,11 @@ actions:
|
||||
- Check: `defaults read 'com.parallels.Parallels Desktop' 'Application preferences.Download updates automatically'`
|
||||
- Values: 0 - Disabled, 1 - Enabled (default)
|
||||
|
||||
[1]: https://web.archive.org/web/20221012153810/https://download.parallels.com/desktop/v18/docs/en_US/Parallels-Desktop-Business-Edition-Administrators-Guide/37744.htm "Parallels Desktop Business Edition Administrator's Guide v18 - Configuring individual Macs | download.parallels.com"
|
||||
[1]: https://web.archive.org/web/20221012153810/https://download.parallels.com/desktop/v18/docs/en_US/Parallels-Desktop-Business-Edition-Administrators-Guide/37744.htm "Parallels Desktop Business Edition Administrator's Guide v18 - Configuring individual Macs | download.parallels.com"
|
||||
code: defaults write 'com.parallels.Parallels Desktop' 'Application preferences.Download updates automatically' -bool no
|
||||
revertCode: defaults write 'com.parallels.Parallels Desktop' 'Application preferences.Download updates automatically' -bool yes
|
||||
-
|
||||
name: Disable automatically checking for Parallels Desktop updates
|
||||
name: Disable automatic checks for Parallels Desktop updates
|
||||
docs: |-
|
||||
Automatic checks are weekly by default, and this script disables the checks completely.
|
||||
|
||||
@@ -593,7 +626,7 @@ actions:
|
||||
category: Configure Apple Remote Desktop
|
||||
children:
|
||||
-
|
||||
name: Deactivate the Remote Management Service
|
||||
name: Disable remote management service
|
||||
recommend: strict
|
||||
code: sudo /System/Library/CoreServices/RemoteManagement/ARDAgent.app/Contents/Resources/kickstart -deactivate -stop
|
||||
revertCode: sudo /System/Library/CoreServices/RemoteManagement/ARDAgent.app/Contents/Resources/kickstart -activate -restart -agent -console
|
||||
@@ -604,26 +637,26 @@ actions:
|
||||
sudo rm -rf /var/db/RemoteManagement
|
||||
sudo defaults delete /Library/Preferences/com.apple.RemoteDesktop.plist
|
||||
defaults delete ~/Library/Preferences/com.apple.RemoteDesktop.plist
|
||||
sudo rm -r /Library/Application\ Support/Apple/Remote\ Desktop/
|
||||
sudo rm -rf /Library/Application\ Support/Apple/Remote\ Desktop/
|
||||
rm -r ~/Library/Application\ Support/Remote\ Desktop/
|
||||
rm -r ~/Library/Containers/com.apple.RemoteDesktop
|
||||
-
|
||||
name: Disable Internet based spell correction
|
||||
name: Disable online spell correction
|
||||
code: defaults write NSGlobalDomain WebAutomaticSpellingCorrectionEnabled -bool false
|
||||
revertCode: defaults delete NSGlobalDomain WebAutomaticSpellingCorrectionEnabled
|
||||
-
|
||||
name: Disable Remote Apple Events
|
||||
name: Disable remote Apple events
|
||||
recommend: strict
|
||||
code: sudo systemsetup -setremoteappleevents off
|
||||
revertCode: sudo systemsetup -setremoteappleevents on
|
||||
-
|
||||
name: Do not store documents to iCloud Drive by default
|
||||
name: Disable automatic storage of documents in iCloud Drive
|
||||
docs: https://macos-defaults.com/finder/nsdocumentsavenewdocumentstocloud.html
|
||||
recommend: standard
|
||||
code: defaults write NSGlobalDomain NSDocumentSaveNewDocumentsToCloud -bool false
|
||||
revertCode: defaults delete NSGlobalDomain NSDocumentSaveNewDocumentsToCloud
|
||||
-
|
||||
name: Do not show recent items on dock
|
||||
name: Disable display of recent applications on Dock
|
||||
docs: https://developer.apple.com/documentation/devicemanagement/dock
|
||||
code: defaults write com.apple.dock show-recents -bool false
|
||||
revertCode: defaults delete com.apple.dock show-recents
|
||||
@@ -636,7 +669,7 @@ actions:
|
||||
category: Configure Siri
|
||||
children:
|
||||
-
|
||||
name: Opt-out from Siri data collection
|
||||
name: Disable participation in Siri data collection
|
||||
recommend: standard
|
||||
code: defaults write com.apple.assistant.support 'Siri Data Sharing Opt-In Status' -int 2
|
||||
revertCode: defaults delete com.apple.assistant.support 'Siri Data Sharing Opt-In Status'
|
||||
@@ -683,7 +716,7 @@ actions:
|
||||
launchctl enable "gui/$UID/com.apple.Siri.agent"
|
||||
sudo launchctl enable 'system/com.apple.Siri.agent'
|
||||
if [ $(/usr/bin/csrutil status | awk '/status/ {print $5}' | sed 's/\.$//') = "enabled" ]; then
|
||||
>&2 echo 'This script requires SIP to be disabled. Read more: https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection''
|
||||
>&2 echo 'This script requires SIP to be disabled. Read more: https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection'
|
||||
fi
|
||||
-
|
||||
name: Disable "Do you want to enable Siri?" pop-up
|
||||
@@ -694,15 +727,15 @@ actions:
|
||||
code: defaults write com.apple.SetupAssistant 'DidSeeSiriSetup' -bool True
|
||||
revertCode: defaults delete com.apple.SetupAssistant 'DidSeeSiriSetup'
|
||||
-
|
||||
category: Hide Siri
|
||||
category: Remove Siri from user interface
|
||||
children:
|
||||
-
|
||||
name: Hide Siri from menu bar
|
||||
name: Remove Siri from menu bar
|
||||
recommend: strict
|
||||
code: defaults write com.apple.systemuiserver 'NSStatusItem Visible Siri' 0
|
||||
revertCode: defaults write com.apple.systemuiserver 'NSStatusItem Visible Siri' 1
|
||||
-
|
||||
name: Hide Siri from status menu
|
||||
name: Remove Siri from status menu
|
||||
recommend: strict
|
||||
docs: https://derflounder.wordpress.com/2016/09/20/blocking-siri-on-macos-sierra/
|
||||
code: |-
|
||||
@@ -712,11 +745,11 @@ actions:
|
||||
defaults delete com.apple.Siri 'StatusMenuVisible'
|
||||
defaults delete com.apple.Siri 'UserHasDeclinedEnable'
|
||||
-
|
||||
name: Disable Spotlight indexing
|
||||
name: Disable Spotlight indexing
|
||||
code: sudo mdutil -i off -d /
|
||||
revertCode: sudo mdutil -i on /
|
||||
-
|
||||
name: Disable Personalized advertisements and identifier collection
|
||||
name: Disable personalized advertisements and identifier tracking
|
||||
recommend: standard
|
||||
docs: |-
|
||||
This script enhances your privacy by deactivating Personalized Ads and disabling the collection
|
||||
@@ -746,7 +779,7 @@ actions:
|
||||
|
||||
Please note: The `forceLimitAdTracking` key limits ad tracking [3] [4] and is found in CIS
|
||||
benchmarks for macOS [4]. However, the official macOS documentation specifies that it is
|
||||
applicable only to iOS 7 and later versions, not to macOS [3]. The key does not exist on the OS
|
||||
applicable only to iOS 7 and newer versions, not to macOS [3]. The key does not exist on the OS
|
||||
by default.
|
||||
|
||||
[1]: https://web.archive.org/web/20230731152633/https://www.apple.com/legal/privacy/data/en/apple-advertising/ "Legal - Apple Advertising & Privacy - Apple"
|
||||
@@ -789,7 +822,7 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.alf globalstate -bool false
|
||||
defaults write com.apple.security.firewall EnableFirewall -bool false
|
||||
-
|
||||
name: Turn on firewall logging
|
||||
name: Enable firewall logging
|
||||
recommend: standard
|
||||
docs:
|
||||
- https://www.stigviewer.com/stig/apple_os_x_10.13/2018-10-01/finding/V-81671
|
||||
@@ -801,7 +834,7 @@ actions:
|
||||
/usr/libexec/ApplicationFirewall/socketfilterfw --setloggingmode off
|
||||
sudo defaults write /Library/Preferences/com.apple.alf loggingenabled -bool false
|
||||
-
|
||||
name: Turn on stealth mode
|
||||
name: Enable stealth mode
|
||||
recommend: standard
|
||||
docs:
|
||||
- https://www.stigviewer.com/stig/apple_os_x_10.8_mountain_lion_workstation/2015-02-10/finding/V-51327
|
||||
@@ -816,16 +849,16 @@ actions:
|
||||
sudo defaults write /Library/Preferences/com.apple.alf stealthenabled -bool false
|
||||
defaults write com.apple.security.firewall EnableStealthMode -bool false
|
||||
-
|
||||
category: Disable auto-permitting incoming traffic for apps
|
||||
category: Disable automatic permission for incoming traffic in applications
|
||||
children:
|
||||
-
|
||||
name: Prevent automatically allowing incoming connections to signed apps
|
||||
name: Disable automatic incoming connections for signed apps
|
||||
docs: https://daiderd.com/nix-darwin/manual/index.html
|
||||
recommend: strict
|
||||
code: sudo defaults write /Library/Preferences/com.apple.alf allowsignedenabled -bool false
|
||||
revertCode: sudo defaults write /Library/Preferences/com.apple.alf allowsignedenabled -bool true
|
||||
-
|
||||
name: Prevent automatically allowing incoming connections to downloaded signed apps
|
||||
name: Disable automatic incoming connections for downloaded signed apps
|
||||
docs: https://daiderd.com/nix-darwin/manual/index.html
|
||||
recommend: strict
|
||||
code: sudo defaults write /Library/Preferences/com.apple.alf allowdownloadsignedenabled -bool false
|
||||
@@ -845,18 +878,18 @@ actions:
|
||||
code: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.captive.control.plist Active -bool false
|
||||
revertCode: sudo defaults delete /Library/Preferences/SystemConfiguration/com.apple.captive.control.plist Active
|
||||
-
|
||||
category: Use screen saver for protection
|
||||
category: Enable protective screen saver
|
||||
children:
|
||||
-
|
||||
name: Require a password to wake the computer from sleep or screen saver
|
||||
name: Enable password requirement for waking from sleep or screen saver
|
||||
# The screen saver acts as a session lock and prevents unauthorized users from accessing the current user's account.
|
||||
docs: https://www.stigviewer.com/stig/apple_macos_11_big_sur/2020-11-27/finding/V-230744
|
||||
code: sudo defaults write /Library/Preferences/com.apple.screensaver askForPassword -bool true
|
||||
revertCode: sudo defaults delete /Library/Preferences/com.apple.screensaver askForPassword
|
||||
-
|
||||
name: Initiate session lock five seconds after screen saver is started
|
||||
name: Enable session lock five seconds after screen saver initiation
|
||||
docs: https://www.stigviewer.com/stig/apple_macos_11_big_sur/2020-11-27/finding/V-230745
|
||||
# An unattended system with an excessive grace period is vulnerable to a malicious user.
|
||||
# An unattended system with an excessive grace period is vulnerable to a malicious user.
|
||||
code: sudo defaults write /Library/Preferences/com.apple.screensaver 'askForPasswordDelay' -int 5
|
||||
revertCode: sudo defaults delete /Library/Preferences/com.apple.screensaver 'askForPasswordDelay'
|
||||
-
|
||||
@@ -864,36 +897,36 @@ actions:
|
||||
docs:
|
||||
- https://www.stigviewer.com/stig/apple_macos_11_big_sur/2021-06-16/finding/V-230823
|
||||
- https://www.stigviewer.com/stig/apple_os_x_10.13/2018-10-01/finding/V-81615
|
||||
children:
|
||||
-
|
||||
name: Disables signing in as Guest from the login screen
|
||||
code: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool NO
|
||||
revetCode: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool YES
|
||||
-
|
||||
name: Disables Guest access to file shares over AF
|
||||
code: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool NO
|
||||
revetCode: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool YES
|
||||
-
|
||||
name: Disables Guest access to file shares over SMB
|
||||
code: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool NO
|
||||
revetCode: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool YES
|
||||
-
|
||||
category: Prevent unauthorized connections
|
||||
children:
|
||||
-
|
||||
name: Disable remote login (incoming SSH and SFTP connections)
|
||||
name: Disable guest sign-in from login screen
|
||||
code: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool NO
|
||||
revertCode: sudo defaults write /Library/Preferences/com.apple.loginwindow GuestEnabled -bool YES
|
||||
-
|
||||
name: Disable guest access to file shares over AF
|
||||
code: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool NO
|
||||
revertCode: sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.smb.server AllowGuestAccess -bool YES
|
||||
-
|
||||
name: Disable guest access to file shares over SMB
|
||||
code: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool NO
|
||||
revertCode: sudo defaults write /Library/Preferences/com.apple.AppleFileServer guestAccess -bool YES
|
||||
-
|
||||
category: Disable unauthorized connections
|
||||
children:
|
||||
-
|
||||
name: Disable incoming SSH and SFTP remote logins
|
||||
recommend: standard
|
||||
docs: https://osxdaily.com/2016/08/16/enable-ssh-mac-command-line/
|
||||
# Check if enabled: sudo systemsetup -getremotelogin, returns "Remote Login: On" or "Off"
|
||||
code: echo 'yes' | sudo systemsetup -setremotelogin off
|
||||
revertCode: sudo systemsetup -setremotelogin on
|
||||
-
|
||||
name: Disable insecure TFTP service
|
||||
name: Disable the insecure TFTP service
|
||||
recommend: standard
|
||||
# If the system does not require Trivial File Transfer Protocol (TFTP), then support for
|
||||
# it is non-essential and should be disabled. The information system should be configured to
|
||||
# provide only essential capabilities. Disabling TFTP helps prevent the unauthorized connection
|
||||
# of devices and the unauthorized transfer of information.
|
||||
# of devices and the unauthorized transfer of information.
|
||||
docs: https://www.stigviewer.com/stig/apple_macos_11_big_sur/2021-06-16/finding/V-230813
|
||||
code: sudo launchctl disable 'system/com.apple.tftpd'
|
||||
revertCode: sudo launchctl enable 'system/com.apple.tftpd'
|
||||
@@ -921,13 +954,13 @@ actions:
|
||||
- https://www.cups.org/doc/security.html # Security risks
|
||||
children:
|
||||
-
|
||||
name: Disable sharing of local printers with other computers
|
||||
name: Disable local printer sharing with other computers
|
||||
recommend: standard
|
||||
docs: https://www.cups.org/doc/man-cupsctl.html
|
||||
code: cupsctl --no-share-printers
|
||||
revertCode: cupsctl --share-printers
|
||||
-
|
||||
name: Disable printing from any address including the Internet
|
||||
name: Disable printing from external addresses, including the internet
|
||||
recommend: standard
|
||||
docs: https://www.cups.org/doc/man-cupsctl.html
|
||||
code: cupsctl --no-remote-any
|
||||
@@ -952,7 +985,7 @@ actions:
|
||||
category: Clean File Quarantine from downloaded files
|
||||
children:
|
||||
-
|
||||
name: Clear File Quarantine logs of all downloaded files
|
||||
name: Clear logs of all downloaded files from File Quarantine
|
||||
recommend: strict
|
||||
docs:
|
||||
- https://www.macobserver.com/tips/how-to/your-mac-remembers-everything-you-download-heres-how-to-clear-download-history/
|
||||
@@ -969,7 +1002,7 @@ actions:
|
||||
if ls -lO "$db_file" | grep --silent 'schg'; then
|
||||
sudo chflags noschg "$db_file"
|
||||
echo "Found and removed system immutable flag"
|
||||
has_sytem_immutable_flag=true
|
||||
has_system_immutable_flag=true
|
||||
fi
|
||||
if ls -lO "$db_file" | grep --silent 'uchg'; then
|
||||
sudo chflags nouchg "$db_file"
|
||||
@@ -978,7 +1011,7 @@ actions:
|
||||
fi
|
||||
sqlite3 "$db_file" "$db_query"
|
||||
echo "Executed the query \"$db_query\""
|
||||
if [ "$has_sytem_immutable_flag" = true ] ; then
|
||||
if [ "$has_system_immutable_flag" = true ] ; then
|
||||
sudo chflags schg "$db_file"
|
||||
echo "Added system immutable flag back"
|
||||
fi
|
||||
@@ -1012,10 +1045,10 @@ actions:
|
||||
' \
|
||||
{} \;
|
||||
-
|
||||
category: Disable File Quarantine from tracking downloaded files
|
||||
category: Disable macOS File Quarantine tracking for downloaded files
|
||||
children:
|
||||
-
|
||||
name: Prevent quarantine from logging downloaded files
|
||||
name: Disable downloaded file logging in quarantine
|
||||
docs:
|
||||
- https://eclecticlight.co/2019/04/25/%F0%9F%8E%97-quarantine-apps/
|
||||
- https://eclecticlight.co/2017/12/11/xattr-com-apple-quarantine-the-quarantine-flag/
|
||||
@@ -1038,7 +1071,7 @@ actions:
|
||||
>&2 echo "Cannot revert immutability, file does not exist at\"$file_to_lock\""
|
||||
fi
|
||||
-
|
||||
name: Disable using extended quarantine attribute on downloaded files (disables warning)
|
||||
name: Disable extended quarantine attribute for downloaded files (disables warning)
|
||||
# Disables dialogs shown when opening an application for the first time
|
||||
# i.e. "Application Downloaded from Internet" quarantine warning.
|
||||
docs:
|
||||
@@ -1054,7 +1087,7 @@ actions:
|
||||
# Can protect against unknown threats.
|
||||
children:
|
||||
-
|
||||
name: Prevent Gatekeeper from automatically reactivating itself
|
||||
name: Disable Gatekeeper's automatic reactivation
|
||||
docs:
|
||||
- https://osxdaily.com/2015/11/05/stop-gatekeeper-auto-rearm-mac-os-x/
|
||||
- https://www.cnet.com/tech/computing/how-to-disable-gatekeeper-permanently-on-os-x/
|
||||
@@ -1071,8 +1104,8 @@ actions:
|
||||
code: |-
|
||||
os_major_ver=$(sw_vers -productVersion | awk -F "." '{print $1}')
|
||||
os_minor_ver=$(sw_vers -productVersion | awk -F "." '{print $2}')
|
||||
if [[ $os_major_ver -le 10 \
|
||||
|| ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 ) \
|
||||
if [[ $os_major_ver -le 10 \
|
||||
|| ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 ) \
|
||||
]]; then
|
||||
echo "No action needed, Gatekeeper is not available this OS version"
|
||||
else
|
||||
@@ -1090,8 +1123,8 @@ actions:
|
||||
revertCode: |-
|
||||
os_major_ver=$(sw_vers -productVersion | awk -F "." '{print $1}')
|
||||
os_minor_ver=$(sw_vers -productVersion | awk -F "." '{print $2}')
|
||||
if [[ $os_major_ver -le 10 \
|
||||
|| ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 ) \
|
||||
if [[ $os_major_ver -le 10 \
|
||||
|| ( $os_major_ver -eq 10 && $os_minor_ver -lt 7 ) \
|
||||
]]; then
|
||||
>&2 echo "Gatekeeper is not available in this OS version"
|
||||
else
|
||||
@@ -1107,7 +1140,7 @@ actions:
|
||||
fi
|
||||
fi
|
||||
-
|
||||
name: Disable Library Validation Entitlement (checks signature of libraries)
|
||||
name: Disable library validation entitlement (library signature validation)
|
||||
docs:
|
||||
- https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_disable-library-validation
|
||||
- https://www.macenhance.com/docs/general/sip-library-validation.html
|
||||
@@ -1121,25 +1154,25 @@ actions:
|
||||
- https://macadminsdoc.readthedocs.io/en/master/Profiles-and-Settings/OS-X-Updates.html
|
||||
children:
|
||||
-
|
||||
name: Disable automatically checking for updates
|
||||
name: Disable automatic checks for updates
|
||||
docs: https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
code: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticCheckEnabled' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticCheckEnabled' -bool true
|
||||
-
|
||||
name: Disable automatically downloading new updates when available
|
||||
name: Disable automatic downloads for updates
|
||||
docs: https://developer.apple.com/documentation/devicemanagement/softwareupdate
|
||||
code: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticDownload' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticDownload' -bool true
|
||||
-
|
||||
name: Disable automatically installing macOS updates
|
||||
name: Disable automatic installation of macOS updates
|
||||
docs:
|
||||
# References for AutoUpdateRestartRequired
|
||||
- https://kb.vmware.com/s/article/2960635
|
||||
@@ -1149,48 +1182,48 @@ actions:
|
||||
code: |-
|
||||
# For OS X Yosemite through macOS High Sierra (>= 10.10 && < 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdateRestartRequired' -bool false
|
||||
# For Mojave and later (>= 10.14)
|
||||
# For Mojave and newer (>= 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallMacOSUpdates' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite through macOS High Sierra (>= 10.10 && < 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdateRestartRequired' -bool true
|
||||
# For Mojave and later (>= 10.14)
|
||||
# For Mojave and newer (>= 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallMacOSUpdates' -bool true
|
||||
-
|
||||
name: Disable automatically updating app from the App Store
|
||||
name: Disable automatic app updates from the App Store
|
||||
docs:
|
||||
- https://kb.vmware.com/s/article/2960635
|
||||
- https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
|
||||
code: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdate' -bool false
|
||||
# For Mojave and later (>= 10.14)
|
||||
# For Mojave and newer (>= 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallAppUpdates' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite and later
|
||||
# For OS X Yosemite and newer
|
||||
sudo defaults write /Library/Preferences/com.apple.commerce 'AutoUpdate' -bool true
|
||||
# For Mojave and later (>= 10.14)
|
||||
# For Mojave and newer (>= 10.14)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AutomaticallyInstallAppUpdates' -bool true
|
||||
-
|
||||
name: Disable installation of macOS beta releases
|
||||
name: Disable macOS beta release installation
|
||||
docs: https://support.apple.com/en-gb/HT203018
|
||||
code: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AllowPreReleaseInstallation' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'AllowPreReleaseInstallation' -bool true
|
||||
-
|
||||
name: Disable automatically installing configuration data (e.g. XProtect, Gatekeeper, MRT)
|
||||
name: Disable automatic installation for configuration data (e.g. XProtect, Gatekeeper, MRT)
|
||||
docs: https://derflounder.wordpress.com/2018/12/28/enabling-automatic-macos-software-updates-for-os-x-yosemite-through-macos-mojave/
|
||||
code: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'ConfigDataInstall' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'ConfigDataInstall' -bool true
|
||||
-
|
||||
name: Disable automatically installing system data files and security updates
|
||||
name: Disable automatic installation for system data files and security updates
|
||||
docs:
|
||||
# References for CriticalUpdateInstall
|
||||
- https://derflounder.wordpress.com/2014/12/24/managing-os-xs-automatic-security-updates/
|
||||
@@ -1198,10 +1231,10 @@ actions:
|
||||
# References for softwareupdate --background-critical
|
||||
- https://managingosx.wordpress.com/2013/04/30/undocumented-options/
|
||||
code: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'CriticalUpdateInstall' -bool false
|
||||
revertCode: |-
|
||||
# For OS X Yosemite and later (>= 10.10)
|
||||
# For OS X Yosemite and newer (>= 10.10)
|
||||
sudo defaults write /Library/Preferences/com.apple.SoftwareUpdate 'CriticalUpdateInstall' -bool true
|
||||
# Trigger background check with normal scan (critical updates only)
|
||||
sudo softwareupdate --background-critical
|
||||
|
||||
1
src/presentation/assets/icons/battery-full.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M464 160c8.8 0 16 7.2 16 16V336c0 8.8-7.2 16-16 16H80c-8.8 0-16-7.2-16-16V176c0-8.8 7.2-16 16-16H464zM80 96C35.8 96 0 131.8 0 176V336c0 44.2 35.8 80 80 80H464c44.2 0 80-35.8 80-80V320c17.7 0 32-14.3 32-32V224c0-17.7-14.3-32-32-32V176c0-44.2-35.8-80-80-80H80zm368 96H96V320H448V192z"/></svg>
|
||||
|
After Width: | Height: | Size: 392 B |
1
src/presentation/assets/icons/battery-half.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M464 160c8.8 0 16 7.2 16 16V336c0 8.8-7.2 16-16 16H80c-8.8 0-16-7.2-16-16V176c0-8.8 7.2-16 16-16H464zM80 96C35.8 96 0 131.8 0 176V336c0 44.2 35.8 80 80 80H464c44.2 0 80-35.8 80-80V320c17.7 0 32-14.3 32-32V224c0-17.7-14.3-32-32-32V176c0-44.2-35.8-80-80-80H80zm208 96H96V320H288V192z"/></svg>
|
||||
|
After Width: | Height: | Size: 392 B |
1
src/presentation/assets/icons/circle-info.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>
|
||||
|
After Width: | Height: | Size: 363 B |
1
src/presentation/assets/icons/copy.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M208 0H332.1c12.7 0 24.9 5.1 33.9 14.1l67.9 67.9c9 9 14.1 21.2 14.1 33.9V336c0 26.5-21.5 48-48 48H208c-26.5 0-48-21.5-48-48V48c0-26.5 21.5-48 48-48zM48 128h80v64H64V448H256V416h64v48c0 26.5-21.5 48-48 48H48c-26.5 0-48-21.5-48-48V176c0-26.5 21.5-48 48-48z"/></svg>
|
||||
|
After Width: | Height: | Size: 365 B |
1
src/presentation/assets/icons/desktop.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M64 0C28.7 0 0 28.7 0 64V352c0 35.3 28.7 64 64 64H240l-10.7 32H160c-17.7 0-32 14.3-32 32s14.3 32 32 32H416c17.7 0 32-14.3 32-32s-14.3-32-32-32H346.7L336 416H512c35.3 0 64-28.7 64-64V64c0-35.3-28.7-64-64-64H64zM512 64V288H64V64H512z"/></svg>
|
||||
|
After Width: | Height: | Size: 342 B |
1
src/presentation/assets/icons/face-smile.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M464 256A208 208 0 1 0 48 256a208 208 0 1 0 416 0zM0 256a256 256 0 1 1 512 0A256 256 0 1 1 0 256zm177.6 62.1C192.8 334.5 218.8 352 256 352s63.2-17.5 78.4-33.9c9-9.7 24.2-10.4 33.9-1.4s10.4 24.2 1.4 33.9c-22 23.8-60 49.4-113.6 49.4s-91.7-25.5-113.6-49.4c-9-9.7-8.4-24.9 1.4-33.9s24.9-8.4 33.9 1.4zM144.4 208a32 32 0 1 1 64 0 32 32 0 1 1 -64 0zm192-32a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>
|
||||
|
After Width: | Height: | Size: 495 B |
1
src/presentation/assets/icons/file-arrow-down.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path d="M64 0C28.7 0 0 28.7 0 64V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V160H256c-17.7 0-32-14.3-32-32V0H64zM256 0V128H384L256 0zM216 232V334.1l31-31c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9l-72 72c-9.4 9.4-24.6 9.4-33.9 0l-72-72c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l31 31V232c0-13.3 10.7-24 24-24s24 10.7 24 24z"/></svg>
|
||||
|
After Width: | Height: | Size: 428 B |
1
src/presentation/assets/icons/floppy-disk.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M64 32C28.7 32 0 60.7 0 96V416c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V173.3c0-17-6.7-33.3-18.7-45.3L352 50.7C340 38.7 323.7 32 306.7 32H64zm0 96c0-17.7 14.3-32 32-32H288c17.7 0 32 14.3 32 32v64c0 17.7-14.3 32-32 32H96c-17.7 0-32-14.3-32-32V128zM224 288a64 64 0 1 1 0 128 64 64 0 1 1 0-128z"/></svg>
|
||||
|
After Width: | Height: | Size: 407 B |
1
src/presentation/assets/icons/folder-open.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M384 480h48c11.4 0 21.9-6 27.6-15.9l112-192c5.8-9.9 5.8-22.1 .1-32.1S555.5 224 544 224H144c-11.4 0-21.9 6-27.6 15.9L48 357.1V96c0-8.8 7.2-16 16-16H181.5c4.2 0 8.3 1.7 11.3 4.7l26.5 26.5c21 21 49.5 32.8 79.2 32.8H416c8.8 0 16 7.2 16 16v32h48V160c0-35.3-28.7-64-64-64H298.5c-17 0-33.3-6.7-45.3-18.7L226.7 50.7c-12-12-28.3-18.7-45.3-18.7H64C28.7 32 0 60.7 0 96V416c0 35.3 28.7 64 64 64H87.7 384z"/></svg>
|
||||
|
After Width: | Height: | Size: 503 B |
1
src/presentation/assets/icons/folder.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M0 96C0 60.7 28.7 32 64 32H196.1c19.1 0 37.4 7.6 50.9 21.1L289.9 96H448c35.3 0 64 28.7 64 64V416c0 35.3-28.7 64-64 64H64c-35.3 0-64-28.7-64-64V96zM64 80c-8.8 0-16 7.2-16 16V416c0 8.8 7.2 16 16 16H448c8.8 0 16-7.2 16-16V160c0-8.8-7.2-16-16-16H286.6c-10.6 0-20.8-4.2-28.3-11.7L213.1 87c-4.5-4.5-10.6-7-17-7H64z"/></svg>
|
||||
|
After Width: | Height: | Size: 419 B |
1
src/presentation/assets/icons/github.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.4 KiB |
1
src/presentation/assets/icons/globe.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.3c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64H348.7c2.2 20.4 3.3 41.8 3.3 64zm28.8-64H503.9c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64zm112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6c78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7c10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5c11.6 26 20.9 58.2 27 94.7zm-209 0H18.6C48.6 85.9 112.2 29.1 190.6 8.4C165.1 42.6 145.3 96.1 135.3 160zM8.1 192H131.2c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64zM194.7 446.6c-11.6-26-20.9-58.2-27-94.6H344.3c-6.1 36.4-15.5 68.6-27 94.6c-10.5 23.6-22.2 40.7-33.5 51.5C272.6 508.8 263.3 512 256 512s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6C112.2 482.9 48.6 426.1 18.6 352H135.3zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6c25.5-34.2 45.2-87.7 55.3-151.6H493.4z"/></svg>
|
||||
|
After Width: | Height: | Size: 1.1 KiB |
1
src/presentation/assets/icons/left-right.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M504.3 273.6c4.9-4.5 7.7-10.9 7.7-17.6s-2.8-13-7.7-17.6l-112-104c-7-6.5-17.2-8.2-25.9-4.4s-14.4 12.5-14.4 22l0 56-192 0 0-56c0-9.5-5.7-18.2-14.4-22s-18.9-2.1-25.9 4.4l-112 104C2.8 243 0 249.3 0 256s2.8 13 7.7 17.6l112 104c7 6.5 17.2 8.2 25.9 4.4s14.4-12.5 14.4-22l0-56 192 0 0 56c0 9.5 5.7 18.2 14.4 22s18.9 2.1 25.9-4.4l112-104z"/></svg>
|
||||
|
After Width: | Height: | Size: 440 B |
1
src/presentation/assets/icons/magnifying-glass.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352a144 144 0 1 0 0-288 144 144 0 1 0 0 288z"/></svg>
|
||||
|
After Width: | Height: | Size: 343 B |
1
src/presentation/assets/icons/play.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg>
|
||||
|
After Width: | Height: | Size: 257 B |
1
src/presentation/assets/icons/tag.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 80V229.5c0 17 6.7 33.3 18.7 45.3l176 176c25 25 65.5 25 90.5 0L418.7 317.3c25-25 25-65.5 0-90.5l-176-176c-12-12-28.3-18.7-45.3-18.7H48C21.5 32 0 53.5 0 80zm112 32a32 32 0 1 1 0 64 32 32 0 1 1 0-64z"/></svg>
|
||||
|
After Width: | Height: | Size: 310 B |
1
src/presentation/assets/icons/user-secret.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M224 16c-6.7 0-10.8-2.8-15.5-6.1C201.9 5.4 194 0 176 0c-30.5 0-52 43.7-66 89.4C62.7 98.1 32 112.2 32 128c0 14.3 25 27.1 64.6 35.9c-.4 4-.6 8-.6 12.1c0 17 3.3 33.2 9.3 48H45.4C38 224 32 230 32 237.4c0 1.7 .3 3.4 1 5l38.8 96.9C28.2 371.8 0 423.8 0 482.3C0 498.7 13.3 512 29.7 512H418.3c16.4 0 29.7-13.3 29.7-29.7c0-58.5-28.2-110.4-71.7-143L415 242.4c.6-1.6 1-3.3 1-5c0-7.4-6-13.4-13.4-13.4H342.7c6-14.8 9.3-31 9.3-48c0-4.1-.2-8.1-.6-12.1C391 155.1 416 142.3 416 128c0-15.8-30.7-29.9-78-38.6C324 43.7 302.5 0 272 0c-18 0-25.9 5.4-32.5 9.9c-4.8 3.3-8.8 6.1-15.5 6.1zm56 208H267.6c-16.5 0-31.1-10.6-36.3-26.2c-2.3-7-12.2-7-14.5 0c-5.2 15.6-19.9 26.2-36.3 26.2H168c-22.1 0-40-17.9-40-40V169.6c28.2 4.1 61 6.4 96 6.4s67.8-2.3 96-6.4V184c0 22.1-17.9 40-40 40zm-88 96l16 32L176 480 128 288l64 32zm128-32L272 480 240 352l16-32 64-32z"/></svg>
|
||||
|
After Width: | Height: | Size: 934 B |
1
src/presentation/assets/icons/xmark.svg
Normal file
@@ -0,0 +1 @@
|
||||
<!-- Source: Font Awesome 6 --><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><path d="M342.6 150.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L192 210.7 86.6 105.4c-12.5-12.5-32.8-12.5-45.3 0s-12.5 32.8 0 45.3L146.7 256 41.4 361.4c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L192 301.3 297.4 406.6c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L237.3 256 342.6 150.6z"/></svg>
|
||||
|
After Width: | Height: | Size: 390 B |
@@ -1,4 +1,3 @@
|
||||
import { IconBootstrapper } from './Modules/IconBootstrapper';
|
||||
import { VueConstructor, IVueBootstrapper } from './IVueBootstrapper';
|
||||
import { VueBootstrapper } from './Modules/VueBootstrapper';
|
||||
import { RuntimeSanityValidator } from './Modules/RuntimeSanityValidator';
|
||||
@@ -14,7 +13,6 @@ export class ApplicationBootstrapper implements IVueBootstrapper {
|
||||
|
||||
private static getAllBootstrappers(): IVueBootstrapper[] {
|
||||
return [
|
||||
new IconBootstrapper(),
|
||||
new VueBootstrapper(),
|
||||
new RuntimeSanityValidator(),
|
||||
new AppInitializationLogger(),
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
import { library } from '@fortawesome/fontawesome-svg-core';
|
||||
import { faGithub } from '@fortawesome/free-brands-svg-icons';
|
||||
/** BRAND ICONS (PREFIX: fab) */
|
||||
import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome';
|
||||
/** REGULAR ICONS (PREFIX: far) */
|
||||
import { faFolderOpen, faFolder, faSmile } from '@fortawesome/free-regular-svg-icons';
|
||||
/** SOLID ICONS (PREFIX: fas (default)) */
|
||||
import {
|
||||
faTimes, faFileDownload, faCopy, faSearch, faInfoCircle, faUserSecret, faDesktop, faTag, faGlobe,
|
||||
faSave, faBatteryFull, faBatteryHalf, faPlay, faArrowsAltH,
|
||||
} from '@fortawesome/free-solid-svg-icons';
|
||||
import { IVueBootstrapper, VueConstructor } from '../IVueBootstrapper';
|
||||
|
||||
export class IconBootstrapper implements IVueBootstrapper {
|
||||
public bootstrap(vue: VueConstructor): void {
|
||||
library.add(
|
||||
faGithub,
|
||||
faUserSecret,
|
||||
faSmile,
|
||||
faDesktop,
|
||||
faGlobe,
|
||||
faTag,
|
||||
faFolderOpen,
|
||||
faFolder,
|
||||
faTimes,
|
||||
faFileDownload,
|
||||
faSave,
|
||||
faCopy,
|
||||
faPlay,
|
||||
faSearch,
|
||||
faBatteryFull,
|
||||
faBatteryHalf,
|
||||
faInfoCircle,
|
||||
faArrowsAltH,
|
||||
);
|
||||
vue.component('font-awesome-icon', FontAwesomeIcon);
|
||||
}
|
||||
}
|
||||
@@ -7,11 +7,12 @@
|
||||
<TheCodeButtons class="app__row app__code-buttons" />
|
||||
<TheFooter />
|
||||
</div>
|
||||
<OptionalDevToolkit />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent } from 'vue';
|
||||
import { defineAsyncComponent, defineComponent } from 'vue';
|
||||
import TheHeader from '@/presentation/components/TheHeader.vue';
|
||||
import TheFooter from '@/presentation/components/TheFooter/TheFooter.vue';
|
||||
import TheCodeButtons from '@/presentation/components/Code/CodeButtons/TheCodeButtons.vue';
|
||||
@@ -22,6 +23,10 @@ import { provideDependencies } from '../bootstrapping/DependencyProvider';
|
||||
|
||||
const singletonAppContext = await buildContext();
|
||||
|
||||
const OptionalDevToolkit = process.env.NODE_ENV !== 'production'
|
||||
? defineAsyncComponent(() => import('@/presentation/components/DevToolkit/DevToolkit.vue'))
|
||||
: null;
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
TheHeader,
|
||||
@@ -29,6 +34,7 @@ export default defineComponent({
|
||||
TheScriptArea,
|
||||
TheSearchBar,
|
||||
TheFooter,
|
||||
OptionalDevToolkit,
|
||||
},
|
||||
setup() {
|
||||
provideDependencies(singletonAppContext); // In Vue 3.0 we can move it to main.ts
|
||||
@@ -59,5 +65,4 @@ export default defineComponent({
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
@@ -4,30 +4,30 @@
|
||||
type="button"
|
||||
@click="onClicked"
|
||||
>
|
||||
<font-awesome-icon
|
||||
<AppIcon
|
||||
class="button__icon"
|
||||
:icon="[iconPrefix, iconName]"
|
||||
size="2x"
|
||||
:icon="iconName"
|
||||
/>
|
||||
<div class="button__text">{{text}}</div>
|
||||
</button>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent } from 'vue';
|
||||
import { defineComponent, PropType } from 'vue';
|
||||
import { IconName } from '@/presentation/components/Shared/Icon/IconName';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
AppIcon,
|
||||
},
|
||||
props: {
|
||||
text: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
iconPrefix: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
iconName: {
|
||||
type: String,
|
||||
type: String as PropType<IconName>,
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
@@ -64,6 +64,10 @@ export default defineComponent({
|
||||
box-shadow: 0 3px 9px $color-primary-darkest;
|
||||
border-radius: 4px;
|
||||
|
||||
&__icon {
|
||||
font-size: 2em;
|
||||
}
|
||||
|
||||
@include clickable;
|
||||
|
||||
width: 10%;
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
<span class="dollar">$</span>
|
||||
<code><slot /></code>
|
||||
<TooltipWrapper>
|
||||
<font-awesome-icon
|
||||
<AppIcon
|
||||
class="copy-button"
|
||||
:icon="['fas', 'copy']"
|
||||
icon="copy"
|
||||
@click="copyCode"
|
||||
/>
|
||||
<template v-slot:tooltip>
|
||||
@@ -19,10 +19,12 @@
|
||||
import { defineComponent, useSlots } from 'vue';
|
||||
import { Clipboard } from '@/infrastructure/Clipboard';
|
||||
import TooltipWrapper from '@/presentation/components/Shared/TooltipWrapper.vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
TooltipWrapper,
|
||||
AppIcon,
|
||||
},
|
||||
setup() {
|
||||
const slots = useSlots();
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
<p>
|
||||
<strong>2. The hard (manual) alternative</strong>. This requires you to do additional manual
|
||||
steps. If you are unsure how to follow the instructions, hover on information
|
||||
(<font-awesome-icon :icon="['fas', 'info-circle']" />)
|
||||
(<AppIcon icon="circle-info" />)
|
||||
icons near the steps, or follow the easy alternative described above.
|
||||
</p>
|
||||
<p>
|
||||
@@ -27,9 +27,9 @@
|
||||
<div class="step__action">
|
||||
<span>{{ step.action.instruction }}</span>
|
||||
<TooltipWrapper v-if="step.action.details">
|
||||
<font-awesome-icon
|
||||
<AppIcon
|
||||
class="explanation"
|
||||
:icon="['fas', 'info-circle']"
|
||||
icon="circle-info"
|
||||
/>
|
||||
<template v-slot:tooltip>
|
||||
<div v-html="step.action.details" />
|
||||
@@ -39,9 +39,9 @@
|
||||
<div v-if="step.code" class="step__code">
|
||||
<CodeInstruction>{{ step.code.instruction }}</CodeInstruction>
|
||||
<TooltipWrapper v-if="step.code.details">
|
||||
<font-awesome-icon
|
||||
<AppIcon
|
||||
class="explanation"
|
||||
:icon="['fas', 'info-circle']"
|
||||
icon="circle-info"
|
||||
/>
|
||||
<template v-slot:tooltip>
|
||||
<div v-html="step.code.details" />
|
||||
@@ -62,6 +62,7 @@ import {
|
||||
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import TooltipWrapper from '@/presentation/components/Shared/TooltipWrapper.vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import CodeInstruction from './CodeInstruction.vue';
|
||||
import { IInstructionListData } from './InstructionListData';
|
||||
|
||||
@@ -69,6 +70,7 @@ export default defineComponent({
|
||||
components: {
|
||||
CodeInstruction,
|
||||
TooltipWrapper,
|
||||
AppIcon,
|
||||
},
|
||||
props: {
|
||||
data: {
|
||||
|
||||
@@ -4,19 +4,16 @@
|
||||
v-if="canRun"
|
||||
text="Run"
|
||||
v-on:click="executeCode"
|
||||
icon-prefix="fas"
|
||||
icon-name="play"
|
||||
/>
|
||||
<IconButton
|
||||
:text="isDesktopVersion ? 'Save' : 'Download'"
|
||||
v-on:click="saveCode"
|
||||
icon-prefix="fas"
|
||||
:icon-name="isDesktopVersion ? 'save' : 'file-download'"
|
||||
:icon-name="isDesktopVersion ? 'floppy-disk' : 'file-arrow-down'"
|
||||
/>
|
||||
<IconButton
|
||||
text="Copy"
|
||||
v-on:click="copyCode"
|
||||
icon-prefix="fas"
|
||||
icon-name="copy"
|
||||
/>
|
||||
<ModalDialog v-if="instructions" v-model="areInstructionsVisible">
|
||||
|
||||
71
src/presentation/components/DevToolkit/DevToolkit.vue
Normal file
@@ -0,0 +1,71 @@
|
||||
<template>
|
||||
<div class="dev-toolkit">
|
||||
<div class="title">
|
||||
Tools
|
||||
</div>
|
||||
<hr />
|
||||
<button
|
||||
v-for="action in devActions"
|
||||
@click="action.handler"
|
||||
:key="action.name"
|
||||
type="button">
|
||||
{{ action.name }}
|
||||
</button>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent } from 'vue';
|
||||
import { dumpNames } from './DumpNames';
|
||||
|
||||
export default defineComponent({
|
||||
setup() {
|
||||
const devActions: readonly DevAction[] = [
|
||||
{
|
||||
name: 'Log script/category names',
|
||||
handler: async () => {
|
||||
const names = await dumpNames();
|
||||
console.log(names);
|
||||
},
|
||||
},
|
||||
];
|
||||
return {
|
||||
devActions,
|
||||
};
|
||||
},
|
||||
});
|
||||
|
||||
interface DevAction {
|
||||
readonly name: string;
|
||||
readonly handler: () => void | Promise<void>;
|
||||
}
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
@use "@/presentation/assets/styles/main" as *;
|
||||
|
||||
.dev-toolkit {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
right: 0;
|
||||
background-color: rgba($color-on-surface, 0.5);
|
||||
color: $color-on-primary;
|
||||
padding: 10px;
|
||||
z-index: 10000;
|
||||
|
||||
.title {
|
||||
font-weight: bold;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
button {
|
||||
display: block;
|
||||
margin-bottom: 10px;
|
||||
padding: 5px 10px;
|
||||
background-color: $color-primary;
|
||||
color: $color-on-primary;
|
||||
border: none;
|
||||
cursor: pointer;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
35
src/presentation/components/DevToolkit/DumpNames.ts
Normal file
@@ -0,0 +1,35 @@
|
||||
import { IApplication } from '@/domain/IApplication';
|
||||
import { ApplicationFactory } from '@/application/ApplicationFactory';
|
||||
|
||||
export async function dumpNames(): Promise<string> {
|
||||
const application = await ApplicationFactory.Current.getApp();
|
||||
const names = collectNames(application);
|
||||
const output = names.join('\n');
|
||||
return output;
|
||||
}
|
||||
|
||||
function collectNames(application: IApplication): string[] {
|
||||
const { collections } = application;
|
||||
|
||||
const allNames = [
|
||||
...collections.flatMap((collection) => collection.getAllCategories().map((c) => c.name)),
|
||||
...collections.flatMap((collection) => collection.getAllScripts().map((c) => c.name)),
|
||||
];
|
||||
|
||||
const uniqueNames = [...new Set(allNames)];
|
||||
|
||||
return shuffle(uniqueNames);
|
||||
}
|
||||
|
||||
/*
|
||||
Shuffle an array of strings, returning a new array with elements in random order.
|
||||
Uses the Fisher-Yates (or Durstenfeld) algorithm.
|
||||
*/
|
||||
function shuffle(array: readonly string[]): string[] {
|
||||
const shuffledArray = [...array];
|
||||
for (let i = array.length - 1; i > 0; i--) {
|
||||
const j = Math.floor(Math.random() * (i + 1));
|
||||
[shuffledArray[i], shuffledArray[j]] = [shuffledArray[j], shuffledArray[i]];
|
||||
}
|
||||
return shuffledArray;
|
||||
}
|
||||
@@ -4,9 +4,9 @@
|
||||
:style="{ cursor: cursorCssValue }"
|
||||
@mousedown="startResize">
|
||||
<div class="line" />
|
||||
<font-awesome-icon
|
||||
<AppIcon
|
||||
class="icon"
|
||||
:icon="['fas', 'arrows-alt-h']"
|
||||
icon="left-right"
|
||||
/>
|
||||
<div class="line" />
|
||||
</div>
|
||||
@@ -14,8 +14,12 @@
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent, onUnmounted } from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
AppIcon,
|
||||
},
|
||||
emits: {
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
resized: (displacementX: number) => true,
|
||||
|
||||
@@ -17,18 +17,18 @@
|
||||
</span>
|
||||
<span v-else>Oh no 😢</span>
|
||||
<!-- Expand icon -->
|
||||
<font-awesome-icon
|
||||
<AppIcon
|
||||
class="card__inner__expand-icon"
|
||||
:icon="['far', isExpanded ? 'folder-open' : 'folder']"
|
||||
:icon="isExpanded ? 'folder-open' : 'folder'"
|
||||
/>
|
||||
<!-- Indeterminate and full states -->
|
||||
<div class="card__inner__state-icons">
|
||||
<font-awesome-icon
|
||||
:icon="['fa', 'battery-half']"
|
||||
<AppIcon
|
||||
icon="battery-half"
|
||||
v-if="isAnyChildSelected && !areAllChildrenSelected"
|
||||
/>
|
||||
<font-awesome-icon
|
||||
:icon="['fa', 'battery-full']"
|
||||
<AppIcon
|
||||
icon="battery-full"
|
||||
v-if="areAllChildrenSelected"
|
||||
/>
|
||||
</div>
|
||||
@@ -38,8 +38,8 @@
|
||||
<ScriptsTree :categoryId="categoryId" />
|
||||
</div>
|
||||
<div class="card__expander__close-button">
|
||||
<font-awesome-icon
|
||||
:icon="['fas', 'times']"
|
||||
<AppIcon
|
||||
icon="xmark"
|
||||
v-on:click="collapse()"
|
||||
/>
|
||||
</div>
|
||||
@@ -52,6 +52,7 @@ import {
|
||||
defineComponent, ref, watch, computed,
|
||||
inject,
|
||||
} from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
||||
import ScriptsTree from '@/presentation/components/Scripts/View/Tree/ScriptsTree.vue';
|
||||
import { sleep } from '@/infrastructure/Threading/AsyncSleep';
|
||||
@@ -59,6 +60,7 @@ import { sleep } from '@/infrastructure/Threading/AsyncSleep';
|
||||
export default defineComponent({
|
||||
components: {
|
||||
ScriptsTree,
|
||||
AppIcon,
|
||||
},
|
||||
props: {
|
||||
categoryId: {
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
class="search__query__close-button"
|
||||
v-on:click="clearSearchQuery()"
|
||||
>
|
||||
<font-awesome-icon :icon="['fas', 'times']" />
|
||||
<AppIcon icon="xmark" />
|
||||
</div>
|
||||
</div>
|
||||
<div v-if="!searchHasMatches" class="search-no-matches">
|
||||
@@ -41,6 +41,7 @@ import {
|
||||
defineComponent, PropType, ref, computed,
|
||||
inject,
|
||||
} from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
||||
import ScriptsTree from '@/presentation/components/Scripts/View/Tree/ScriptsTree.vue';
|
||||
import CardList from '@/presentation/components/Scripts/View/Cards/CardList.vue';
|
||||
@@ -52,6 +53,7 @@ export default defineComponent({
|
||||
components: {
|
||||
ScriptsTree,
|
||||
CardList,
|
||||
AppIcon,
|
||||
},
|
||||
props: {
|
||||
currentView: {
|
||||
|
||||
@@ -6,14 +6,18 @@
|
||||
v-on:click.stop
|
||||
v-on:click="toggle()"
|
||||
>
|
||||
<font-awesome-icon :icon="['fas', 'info-circle']" />
|
||||
<AppIcon icon="circle-info" />
|
||||
</a>
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent, ref } from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
AppIcon,
|
||||
},
|
||||
emits: [
|
||||
'show',
|
||||
'hide',
|
||||
@@ -52,5 +56,4 @@ export default defineComponent({
|
||||
color: $color-primary-light;
|
||||
}
|
||||
}
|
||||
|
||||
</style>
|
||||
|
||||
40
src/presentation/components/Shared/Icon/AppIcon.vue
Normal file
@@ -0,0 +1,40 @@
|
||||
<template>
|
||||
<div v-html="svgContent" class="inline-icon" />
|
||||
</template>
|
||||
|
||||
<script lang="ts">
|
||||
import {
|
||||
defineComponent,
|
||||
PropType,
|
||||
inject,
|
||||
} from 'vue';
|
||||
import { useSvgLoader } from './UseSvgLoader';
|
||||
import { IconName } from './IconName';
|
||||
|
||||
export default defineComponent({
|
||||
props: {
|
||||
icon: {
|
||||
type: String as PropType<IconName>,
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
setup(props) {
|
||||
const useSvgLoaderHook = inject('useSvgLoaderHook', useSvgLoader);
|
||||
const { svgContent } = useSvgLoaderHook(() => props.icon);
|
||||
return { svgContent };
|
||||
},
|
||||
});
|
||||
|
||||
</script>
|
||||
|
||||
<style lang="scss" scoped>
|
||||
.inline-icon {
|
||||
display: inline-block;
|
||||
::v-deep svg { // using ::v-deep because when v-html is used the content doesn't go through Vue's template compiler.
|
||||
display: inline-block;
|
||||
height: 1em;
|
||||
overflow: visible;
|
||||
vertical-align: -0.125em;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
22
src/presentation/components/Shared/Icon/IconName.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
export const IconNames = [
|
||||
'magnifying-glass',
|
||||
'copy',
|
||||
'circle-info',
|
||||
'user-secret',
|
||||
'tag',
|
||||
'github',
|
||||
'face-smile',
|
||||
'globe',
|
||||
'desktop',
|
||||
'xmark',
|
||||
'battery-half',
|
||||
'battery-full',
|
||||
'folder',
|
||||
'folder-open',
|
||||
'left-right',
|
||||
'file-arrow-down',
|
||||
'floppy-disk',
|
||||
'play',
|
||||
] as const;
|
||||
|
||||
export type IconName = typeof IconNames[number];
|
||||
92
src/presentation/components/Shared/Icon/UseSvgLoader.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import {
|
||||
WatchSource, readonly, ref, watch,
|
||||
} from 'vue';
|
||||
import { AsyncLazy } from '@/infrastructure/Threading/AsyncLazy';
|
||||
import { IconName } from './IconName';
|
||||
|
||||
export function useSvgLoader(
|
||||
iconWatcher: WatchSource<IconName>,
|
||||
loaders: FileLoaders = RawSvgLoaders,
|
||||
) {
|
||||
const svgContent = ref<string>('');
|
||||
|
||||
watch(iconWatcher, async (iconName) => {
|
||||
svgContent.value = await lazyLoadSvg(iconName, loaders);
|
||||
}, { immediate: true });
|
||||
|
||||
return {
|
||||
svgContent: readonly(svgContent),
|
||||
};
|
||||
}
|
||||
|
||||
export function clearIconCache() {
|
||||
LazyIconCache.clear();
|
||||
}
|
||||
|
||||
export type FileLoaders = Record<string, () => Promise<string>>;
|
||||
|
||||
const LazyIconCache = new Map<IconName, AsyncLazy<string>>();
|
||||
|
||||
async function lazyLoadSvg(name: IconName, loaders: FileLoaders): Promise<string> {
|
||||
let iconLoader = LazyIconCache.get(name);
|
||||
if (!iconLoader) {
|
||||
iconLoader = new AsyncLazy<string>(() => loadSvg(name, loaders));
|
||||
LazyIconCache.set(name, iconLoader);
|
||||
}
|
||||
const icon = await iconLoader.getValue();
|
||||
return icon;
|
||||
}
|
||||
|
||||
async function loadSvg(name: IconName, loaders: FileLoaders): Promise<string> {
|
||||
const iconPath = `/assets/icons/${name}.svg`;
|
||||
const loader = loaders[iconPath];
|
||||
if (!loader) {
|
||||
throw new Error(`missing icon for "${name}" in "${iconPath}"`);
|
||||
}
|
||||
const svgContent = await loader();
|
||||
const modifiedContent = modifySvg(svgContent);
|
||||
return modifiedContent;
|
||||
}
|
||||
|
||||
const RawSvgLoaders = import.meta.glob('@/presentation/assets/icons/**/*.svg', {
|
||||
as: 'raw', // This will load the SVG file content as a string.
|
||||
/*
|
||||
Using `eager: true` to preload all icons.
|
||||
Pros:
|
||||
- Speed: Icons are instantly accessible post-initial load.
|
||||
Cons:
|
||||
- Increased initial load time due to preloading of all icons.
|
||||
- Increased bundle size.
|
||||
*/
|
||||
eager: false,
|
||||
});
|
||||
|
||||
function modifySvg(svgSource: string): string {
|
||||
const parser = new DOMParser();
|
||||
const doc = parser.parseFromString(svgSource, 'image/svg+xml');
|
||||
let svgRoot = doc.documentElement;
|
||||
svgRoot = removeSvgComments(svgRoot);
|
||||
svgRoot = fillSvgCurrentColor(svgRoot);
|
||||
return new XMLSerializer()
|
||||
.serializeToString(svgRoot);
|
||||
}
|
||||
|
||||
function removeSvgComments(svgRoot: HTMLElement): HTMLElement {
|
||||
const comments = Array.from(svgRoot.childNodes).filter(
|
||||
(node) => node.nodeType === Node.COMMENT_NODE,
|
||||
);
|
||||
for (const comment of comments) {
|
||||
svgRoot.removeChild(comment);
|
||||
}
|
||||
Array.from(svgRoot.children).forEach((child) => {
|
||||
removeSvgComments(child as HTMLElement);
|
||||
});
|
||||
return svgRoot;
|
||||
}
|
||||
|
||||
function fillSvgCurrentColor(svgRoot: HTMLElement): HTMLElement {
|
||||
svgRoot.querySelectorAll('path').forEach((el: Element) => {
|
||||
el.setAttribute('fill', 'currentColor');
|
||||
});
|
||||
return svgRoot;
|
||||
}
|
||||
@@ -10,9 +10,7 @@
|
||||
class="dialog__close-button"
|
||||
@click="hide"
|
||||
>
|
||||
<font-awesome-icon
|
||||
:icon="['fas', 'times']"
|
||||
/>
|
||||
<AppIcon icon="xmark" />
|
||||
</div>
|
||||
</div>
|
||||
</ModalContainer>
|
||||
@@ -20,11 +18,13 @@
|
||||
|
||||
<script lang="ts">
|
||||
import { defineComponent, computed } from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import ModalContainer from './ModalContainer.vue';
|
||||
|
||||
export default defineComponent({
|
||||
components: {
|
||||
ModalContainer,
|
||||
AppIcon,
|
||||
},
|
||||
emits: {
|
||||
/* eslint-disable @typescript-eslint/no-unused-vars */
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
'container-supported': hasCurrentOsDesktopVersion,
|
||||
}">
|
||||
<span class="description">
|
||||
<font-awesome-icon class="description__icon" :icon="['fas', 'desktop']" />
|
||||
<AppIcon class="description__icon" icon="desktop" />
|
||||
<span class="description__text">For desktop:</span>
|
||||
</span>
|
||||
<span class="urls">
|
||||
@@ -21,6 +21,7 @@
|
||||
import { defineComponent, inject } from 'vue';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import DownloadUrlListItem from './DownloadUrlListItem.vue';
|
||||
|
||||
const supportedOperativeSystems: readonly OperatingSystem[] = [
|
||||
@@ -32,6 +33,7 @@ const supportedOperativeSystems: readonly OperatingSystem[] = [
|
||||
export default defineComponent({
|
||||
components: {
|
||||
DownloadUrlListItem,
|
||||
AppIcon,
|
||||
},
|
||||
setup() {
|
||||
const { os: currentOs } = inject(InjectionKeys.useRuntimeEnvironment);
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<div class="footer">
|
||||
<div class="footer__section">
|
||||
<span v-if="isDesktop" class="footer__section__item">
|
||||
<font-awesome-icon class="icon" :icon="['fas', 'globe']" />
|
||||
<AppIcon class="icon" icon="globe" />
|
||||
<span>
|
||||
Online version at <a :href="homepageUrl" target="_blank" rel="noopener noreferrer">{{ homepageUrl }}</a>
|
||||
</span>
|
||||
@@ -15,24 +15,24 @@
|
||||
<div class="footer__section">
|
||||
<div class="footer__section__item">
|
||||
<a :href="feedbackUrl" target="_blank" rel="noopener noreferrer">
|
||||
<font-awesome-icon class="icon" :icon="['far', 'smile']" />
|
||||
<AppIcon class="icon" icon="face-smile" />
|
||||
<span>Feedback</span>
|
||||
</a>
|
||||
</div>
|
||||
<div class="footer__section__item">
|
||||
<a :href="repositoryUrl" target="_blank" rel="noopener noreferrer">
|
||||
<font-awesome-icon class="icon" :icon="['fab', 'github']" />
|
||||
<AppIcon class="icon" icon="github" />
|
||||
<span>Source Code</span>
|
||||
</a>
|
||||
</div>
|
||||
<div class="footer__section__item">
|
||||
<a :href="releaseUrl" target="_blank" rel="noopener noreferrer">
|
||||
<font-awesome-icon class="icon" :icon="['fas', 'tag']" />
|
||||
<AppIcon class="icon" icon="tag" />
|
||||
<span>v{{ version }}</span>
|
||||
</a>
|
||||
</div>
|
||||
<div class="footer__section__item">
|
||||
<font-awesome-icon class="icon" :icon="['fas', 'user-secret']" />
|
||||
<AppIcon class="icon" icon="user-secret" />
|
||||
<a @click="showPrivacyDialog()">Privacy</a>
|
||||
</div>
|
||||
</div>
|
||||
@@ -48,6 +48,7 @@ import {
|
||||
defineComponent, ref, computed, inject,
|
||||
} from 'vue';
|
||||
import ModalDialog from '@/presentation/components/Shared/Modal/ModalDialog.vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
||||
import DownloadUrlList from './DownloadUrlList.vue';
|
||||
import PrivacyPolicy from './PrivacyPolicy.vue';
|
||||
@@ -57,6 +58,7 @@ export default defineComponent({
|
||||
ModalDialog,
|
||||
PrivacyPolicy,
|
||||
DownloadUrlList,
|
||||
AppIcon,
|
||||
},
|
||||
setup() {
|
||||
const { info } = inject(InjectionKeys.useApplication);
|
||||
|
||||
@@ -22,6 +22,7 @@ export default defineComponent({
|
||||
};
|
||||
},
|
||||
});
|
||||
|
||||
</script>
|
||||
|
||||
<style scoped lang="scss">
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
v-model="searchQuery"
|
||||
>
|
||||
<div class="icon-wrapper">
|
||||
<font-awesome-icon :icon="['fas', 'search']" />
|
||||
<AppIcon icon="magnifying-glass" />
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
@@ -19,11 +19,13 @@ import {
|
||||
} from 'vue';
|
||||
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
||||
import { NonCollapsing } from '@/presentation/components/Scripts/View/Cards/NonCollapsingDirective';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import { IReadOnlyUserFilter } from '@/application/Context/State/Filter/IUserFilter';
|
||||
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
||||
import { IEventSubscription } from '@/infrastructure/Events/IEventSource';
|
||||
|
||||
export default defineComponent({
|
||||
components: { AppIcon },
|
||||
directives: {
|
||||
NonCollapsing,
|
||||
},
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
import {
|
||||
describe, it, expect,
|
||||
} from 'vitest';
|
||||
import { IconNames } from '@/presentation/components/Shared/Icon/IconName';
|
||||
import { useSvgLoader } from '@/presentation/components/Shared/Icon/UseSvgLoader';
|
||||
import { waitForValueChange } from '@tests/shared/WaitForValueChange';
|
||||
|
||||
describe('useSvgLoader', () => {
|
||||
describe('can load all SVGs', () => {
|
||||
for (const iconName of IconNames) {
|
||||
it(iconName, async () => {
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => iconName);
|
||||
await waitForValueChange(svgContent);
|
||||
// assert
|
||||
expect(svgContent.value).toBeTruthy();
|
||||
});
|
||||
}
|
||||
});
|
||||
});
|
||||
17
tests/shared/WaitForValueChange.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { WatchSource, watch } from 'vue';
|
||||
|
||||
export function waitForValueChange<T>(valueWatcher: WatchSource<T>, timeoutMs = 2000): Promise<T> {
|
||||
return new Promise<T>((resolve, reject) => {
|
||||
const unwatch = watch(valueWatcher, (newValue, oldValue) => {
|
||||
if (newValue !== oldValue) {
|
||||
unwatch();
|
||||
resolve(newValue);
|
||||
}
|
||||
}, { immediate: false });
|
||||
|
||||
setTimeout(() => {
|
||||
unwatch();
|
||||
reject(new Error('Timeout waiting for value to change.'));
|
||||
}, timeoutMs);
|
||||
});
|
||||
}
|
||||
100
tests/unit/presentation/components/Shared/Icon/AppIcon.spec.ts
Normal file
@@ -0,0 +1,100 @@
|
||||
import {
|
||||
describe, it, expect,
|
||||
} from 'vitest';
|
||||
import { shallowMount } from '@vue/test-utils';
|
||||
import { nextTick } from 'vue';
|
||||
import AppIcon from '@/presentation/components/Shared/Icon/AppIcon.vue';
|
||||
import { IconName } from '@/presentation/components/Shared/Icon/IconName';
|
||||
import { UseSvgLoaderStub } from '@tests/unit/shared/Stubs/UseSvgLoaderStub';
|
||||
|
||||
describe('AppIcon.vue', () => {
|
||||
it('renders the correct SVG content based on the icon prop', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const expectedIconContent = '<svg id="expected-svg" />';
|
||||
const svgLoaderStub = new UseSvgLoaderStub();
|
||||
svgLoaderStub.withSvgIcon(expectedIconName, expectedIconContent);
|
||||
|
||||
// act
|
||||
const wrapper = mountComponent({
|
||||
iconPropValue: expectedIconName,
|
||||
loader: svgLoaderStub,
|
||||
});
|
||||
await nextTick();
|
||||
|
||||
// assert
|
||||
const actualSvg = extractAndNormalizeSvg(wrapper.html());
|
||||
const expectedSvg = extractAndNormalizeSvg(expectedIconContent);
|
||||
expect(actualSvg).to.equal(
|
||||
expectedSvg,
|
||||
`Expected:\n\n${expectedSvg}\n\nActual:\n\n${actualSvg}`,
|
||||
);
|
||||
});
|
||||
it('updates the SVG content when the icon prop changes', async () => {
|
||||
// arrange
|
||||
const initialIconName: IconName = 'magnifying-glass';
|
||||
const updatedIconName: IconName = 'copy';
|
||||
const updatedIconContent = '<svg id="updated-svg" />';
|
||||
const svgLoaderStub = new UseSvgLoaderStub();
|
||||
svgLoaderStub.withSvgIcon(initialIconName, '<svg id="initial-svg" />');
|
||||
svgLoaderStub.withSvgIcon(updatedIconName, updatedIconContent);
|
||||
|
||||
// act
|
||||
const wrapper = mountComponent({
|
||||
iconPropValue: initialIconName,
|
||||
loader: svgLoaderStub,
|
||||
});
|
||||
await wrapper.setProps({ icon: updatedIconName });
|
||||
await nextTick();
|
||||
|
||||
// assert
|
||||
const actualSvg = extractAndNormalizeSvg(wrapper.html());
|
||||
const expectedSvg = extractAndNormalizeSvg(updatedIconContent);
|
||||
expect(actualSvg).to.equal(
|
||||
expectedSvg,
|
||||
`Expected:\n\n${expectedSvg}\n\nActual:\n\n${actualSvg}`,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
function mountComponent(options: {
|
||||
readonly iconPropValue: IconName,
|
||||
readonly loader: UseSvgLoaderStub,
|
||||
}) {
|
||||
return shallowMount(AppIcon, {
|
||||
propsData: {
|
||||
icon: options.iconPropValue,
|
||||
},
|
||||
provide: {
|
||||
useSvgLoaderHook: options.loader.get(),
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
function extractAndNormalizeSvg(svgString: string): string {
|
||||
const svg = extractSvg(svgString);
|
||||
return normalizeSvg(svg);
|
||||
}
|
||||
|
||||
function extractSvg(svgString: string): string {
|
||||
const svgMatches = svgString.match(/<svg[\s\S]*?(<\/svg>|\/>)/g);
|
||||
if (!svgMatches || svgMatches.length === 0) {
|
||||
throw new Error(`No SVG found in: ${svgString}`);
|
||||
}
|
||||
if (svgMatches.length > 1) {
|
||||
throw new Error(`Multiple SVGs found in: ${svgString}`);
|
||||
}
|
||||
const svgContent = svgMatches[0];
|
||||
return svgContent;
|
||||
}
|
||||
|
||||
function normalizeSvg(svgString: string): string {
|
||||
return svgString
|
||||
.replace(/\n/g, '') // Remove newlines
|
||||
.replace(/\s+/g, ' ') // Replace all whitespace sequences with a single space
|
||||
.replace(/> </g, '><') // Remove spaces between tags
|
||||
.replace(/ <\//g, '</') // Remove spaces before closing tags
|
||||
.replace(/\s+\/>/g, '/>') // Remove spaces before self-closing tag end
|
||||
.replace(/<(\w+)([^>]*)><\/\1>/g, '<$1$2/>') // Convert to self-closing SVG tags
|
||||
.trim(); // Remove leading and trailing spaces
|
||||
}
|
||||
@@ -0,0 +1,160 @@
|
||||
import {
|
||||
describe, it, expect, beforeEach,
|
||||
} from 'vitest';
|
||||
import { ref } from 'vue';
|
||||
import { IconName } from '@/presentation/components/Shared/Icon/IconName';
|
||||
import { FileLoaders, clearIconCache, useSvgLoader } from '@/presentation/components/Shared/Icon/UseSvgLoader';
|
||||
import { waitForValueChange } from '@tests/shared/WaitForValueChange';
|
||||
|
||||
describe('useSvgLoader', () => {
|
||||
beforeEach(() => {
|
||||
clearIconCache();
|
||||
});
|
||||
describe('SVG loading', () => {
|
||||
it('renders initial SVG content based on icon name', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const expectedIconContent = '<svg id="expected-content"/>';
|
||||
const { loaders, addIcon } = useSvgMock();
|
||||
addIcon(expectedIconName, expectedIconContent);
|
||||
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await waitForValueChange(svgContent);
|
||||
|
||||
// assert
|
||||
expect(svgContent.value).to.equal(expectedIconContent);
|
||||
});
|
||||
it('updates SVG content when icon name changes', async () => {
|
||||
// arrange
|
||||
const initialIconName: IconName = 'magnifying-glass';
|
||||
const iconName = ref<IconName>(initialIconName);
|
||||
const initialIconContent = '<svg id="initial"/>';
|
||||
const updatedIconName: IconName = 'copy';
|
||||
const updatedIconContent = '<svg id="updated"/>';
|
||||
const { addIcon, loaders } = useSvgMock();
|
||||
addIcon(initialIconName, initialIconContent);
|
||||
addIcon(updatedIconName, updatedIconContent);
|
||||
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => iconName.value, loaders);
|
||||
await waitForValueChange(svgContent);
|
||||
iconName.value = updatedIconName;
|
||||
await waitForValueChange(svgContent);
|
||||
|
||||
// assert
|
||||
expect(svgContent.value).to.equal(updatedIconContent);
|
||||
});
|
||||
it('lazy loads SVG icons and does not preload', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const unexpectedIconName: IconName = 'copy';
|
||||
const { addIcon, getSvgFetchCount, loaders } = useSvgMock();
|
||||
addIcon(expectedIconName);
|
||||
addIcon(unexpectedIconName);
|
||||
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await waitForValueChange(svgContent);
|
||||
|
||||
// assert
|
||||
expect(getSvgFetchCount(expectedIconName)).to.equal(1);
|
||||
expect(getSvgFetchCount(unexpectedIconName)).to.equal(0);
|
||||
});
|
||||
it('avoids loading same SVG content multiple times for concurrent calls', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const { addIcon, getSvgFetchCount, loaders } = useSvgMock();
|
||||
addIcon(expectedIconName);
|
||||
|
||||
// act
|
||||
const { svgContent: svgContent1 } = useSvgLoader(() => expectedIconName, loaders);
|
||||
const { svgContent: svgContent2 } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await Promise.all([
|
||||
waitForValueChange(svgContent1),
|
||||
waitForValueChange(svgContent2),
|
||||
]);
|
||||
|
||||
// assert
|
||||
expect(getSvgFetchCount(expectedIconName)).to.equal(1);
|
||||
});
|
||||
});
|
||||
describe('SVG content manipulation', () => {
|
||||
it('sets path fill color to currentColor', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const { addIcon, loaders } = useSvgMock();
|
||||
addIcon(expectedIconName, '<svg id="svg-with-paths"><path /><path /></svg>');
|
||||
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await waitForValueChange(svgContent);
|
||||
|
||||
// assert
|
||||
const svgElement = new DOMParser().parseFromString(svgContent.value, 'image/svg+xml');
|
||||
const pathElements = Array.from(svgElement.querySelectorAll('path'));
|
||||
expect(pathElements).to.have.lengthOf(2, svgContent.value);
|
||||
const fillAttributeValues = pathElements.map((el: Element) => el.getAttribute('fill'));
|
||||
expect(fillAttributeValues).to.have.members(['currentColor', 'currentColor']);
|
||||
});
|
||||
it('removes comments from loaded SVG', async () => {
|
||||
// arrange
|
||||
const commentLine = '<!-- This is a comment -->';
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const { addIcon, loaders } = useSvgMock();
|
||||
addIcon(expectedIconName, `<svg>${commentLine}<path></path></svg>`);
|
||||
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await waitForValueChange(svgContent);
|
||||
|
||||
// assert
|
||||
expect(svgContent.value).not.to.include(commentLine);
|
||||
});
|
||||
});
|
||||
describe('icon cache management', () => {
|
||||
it('reloads SVG content after clearing cache', async () => {
|
||||
// arrange
|
||||
const expectedIconName: IconName = 'magnifying-glass';
|
||||
const { addIcon, getSvgFetchCount, loaders } = useSvgMock();
|
||||
addIcon(expectedIconName);
|
||||
|
||||
// act
|
||||
const { svgContent } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await waitForValueChange(svgContent);
|
||||
expect(getSvgFetchCount(expectedIconName)).to.equal(1);
|
||||
clearIconCache();
|
||||
const { svgContent: newSvgContent } = useSvgLoader(() => expectedIconName, loaders);
|
||||
await waitForValueChange(newSvgContent);
|
||||
|
||||
// assert
|
||||
expect(getSvgFetchCount(expectedIconName)).to.equal(2);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
function useSvgMock() {
|
||||
const ICON_PATH_PREFIX = '/assets/icons/';
|
||||
function getPath(iconName: IconName) {
|
||||
return `${ICON_PATH_PREFIX}${iconName}.svg`;
|
||||
}
|
||||
const svgFetchCount = {} as Record<IconName, number>;
|
||||
const loaders = {} as FileLoaders;
|
||||
function addIcon(iconName: IconName, svgContent = '<svg id="stub" />') {
|
||||
const path = getPath(iconName);
|
||||
svgFetchCount[iconName] = 0;
|
||||
loaders[path] = () => {
|
||||
svgFetchCount[iconName] += 1;
|
||||
return Promise.resolve(svgContent);
|
||||
};
|
||||
}
|
||||
function getSvgFetchCount(iconName: IconName): number {
|
||||
return svgFetchCount[iconName];
|
||||
}
|
||||
return {
|
||||
loaders,
|
||||
getSvgFetchCount,
|
||||
getPath,
|
||||
addIcon,
|
||||
};
|
||||
}
|
||||
@@ -4,12 +4,13 @@ export async function expectThrowsAsync(
|
||||
method: () => Promise<unknown>,
|
||||
errorMessage: string,
|
||||
) {
|
||||
let error: Error;
|
||||
let error: Error | undefined;
|
||||
try {
|
||||
await method();
|
||||
} catch (err) {
|
||||
error = err;
|
||||
}
|
||||
expect(error).toBeDefined();
|
||||
expect(error).to.be.an(Error.name);
|
||||
if (errorMessage) {
|
||||
expect(error.message).to.equal(errorMessage);
|
||||
|
||||
31
tests/unit/shared/Stubs/UseSvgLoaderStub.ts
Normal file
@@ -0,0 +1,31 @@
|
||||
import {
|
||||
WatchSource, computed, ref, watch,
|
||||
} from 'vue';
|
||||
import { IconName } from '@/presentation/components/Shared/Icon/IconName';
|
||||
import { useSvgLoader } from '@/presentation/components/Shared/Icon/UseSvgLoader';
|
||||
|
||||
export class UseSvgLoaderStub {
|
||||
private readonly icons = new Map<IconName, string>();
|
||||
|
||||
public withSvgIcon(name: IconName, svgContent: string): this {
|
||||
this.icons.set(name, svgContent);
|
||||
return this;
|
||||
}
|
||||
|
||||
public get(): typeof useSvgLoader {
|
||||
return (iconWatcher: WatchSource<IconName>) => {
|
||||
const iconName = ref<IconName | undefined>();
|
||||
watch(iconWatcher, (newIconName) => {
|
||||
iconName.value = newIconName;
|
||||
}, { immediate: true });
|
||||
return {
|
||||
svgContent: computed<string>(() => {
|
||||
if (!iconName.value) {
|
||||
return '';
|
||||
}
|
||||
return this.icons.get(iconName.value) || '';
|
||||
}),
|
||||
};
|
||||
};
|
||||
}
|
||||
}
|
||||