From 87e60483904989975746cc41beeff6bbe01887aa Mon Sep 17 00:00:00 2001 From: Mike Maietta Date: Sat, 12 Oct 2024 09:00:42 -0700 Subject: [PATCH] update doc hyperlinks --- packages/app-builder-lib/scheme.json | 4 ++-- packages/app-builder-lib/src/configuration.ts | 4 ++-- pages/tutorials/adding-electron-fuses.md | 3 +-- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json index cd35a854a3a..f72462c7e3a 100644 --- a/packages/app-builder-lib/scheme.json +++ b/packages/app-builder-lib/scheme.json @@ -1305,7 +1305,7 @@ "type": "boolean" }, "grantFileProtocolExtraPrivileges": { - "description": "The grantFileProtocolExtraPrivileges fuse changes whether pages loaded from the `file://` protocol are given privileges beyond what they would receive in a traditional web browser. This behavior was core to Electron apps in original versions of Electron but is no longer required as apps should be [serving local files from custom protocols](./security.md#18-avoid-usage-of-the-file-protocol-and-prefer-usage-of-custom-protocols) now instead. If you aren't serving pages from `file://` you should disable this fuse.\nThe extra privileges granted to the `file://` protocol by this fuse are incompletely documented below:\n* `file://` protocol pages can use `fetch` to load other assets over `file://`\n* `file://` protocol pages can use service workers\n* `file://` protocol pages have universal access granted to child frames also running on `file://` protocols regardless of sandbox settings", + "description": "The grantFileProtocolExtraPrivileges fuse changes whether pages loaded from the `file://` protocol are given privileges beyond what they would receive in a traditional web browser. This behavior was core to Electron apps in original versions of Electron but is no longer required as apps should be [serving local files from custom protocols](https://github.com/electron/electron/blob/main/docs/tutorial/security.md#18-avoid-usage-of-the-file-protocol-and-prefer-usage-of-custom-protocols) now instead. If you aren't serving pages from `file://` you should disable this fuse.\nThe extra privileges granted to the `file://` protocol by this fuse are incompletely documented below:\n* `file://` protocol pages can use `fetch` to load other assets over `file://`\n* `file://` protocol pages can use service workers\n* `file://` protocol pages have universal access granted to child frames also running on `file://` protocols regardless of sandbox settings", "type": "boolean" }, "loadBrowserProcessSpecificV8Snapshot": { @@ -1321,7 +1321,7 @@ "type": "boolean" }, "runAsNode": { - "description": "The runAsNode fuse toggles whether the `ELECTRON_RUN_AS_NODE` environment variable is respected or not. Please note that if this fuse is disabled then `process.fork` in the main process will not function as expected as it depends on this environment variable to function. Instead, we recommend that you use [Utility Processes](../api/utility-process.md), which work for many use cases where you need a standalone Node.js process (like a Sqlite server process or similar scenarios).", + "description": "The runAsNode fuse toggles whether the `ELECTRON_RUN_AS_NODE` environment variable is respected or not. Please note that if this fuse is disabled then `process.fork` in the main process will not function as expected as it depends on this environment variable to function. Instead, we recommend that you use [Utility Processes](https://github.com/electron/electron/blob/main/docs/api/utility-process.md), which work for many use cases where you need a standalone Node.js process (like a Sqlite server process or similar scenarios).", "type": "boolean" } }, diff --git a/packages/app-builder-lib/src/configuration.ts b/packages/app-builder-lib/src/configuration.ts index 369b5e2ba12..f0c06e75bca 100644 --- a/packages/app-builder-lib/src/configuration.ts +++ b/packages/app-builder-lib/src/configuration.ts @@ -388,7 +388,7 @@ export interface MetadataDirectories { */ export interface FuseOptionsV1 { /** - *The runAsNode fuse toggles whether the `ELECTRON_RUN_AS_NODE` environment variable is respected or not. Please note that if this fuse is disabled then `process.fork` in the main process will not function as expected as it depends on this environment variable to function. Instead, we recommend that you use [Utility Processes](../api/utility-process.md), which work for many use cases where you need a standalone Node.js process (like a Sqlite server process or similar scenarios). + *The runAsNode fuse toggles whether the `ELECTRON_RUN_AS_NODE` environment variable is respected or not. Please note that if this fuse is disabled then `process.fork` in the main process will not function as expected as it depends on this environment variable to function. Instead, we recommend that you use [Utility Processes](https://github.com/electron/electron/blob/main/docs/api/utility-process.md), which work for many use cases where you need a standalone Node.js process (like a Sqlite server process or similar scenarios). */ runAsNode?: boolean /** @@ -420,7 +420,7 @@ export interface FuseOptionsV1 { */ loadBrowserProcessSpecificV8Snapshot?: boolean /** - * The grantFileProtocolExtraPrivileges fuse changes whether pages loaded from the `file://` protocol are given privileges beyond what they would receive in a traditional web browser. This behavior was core to Electron apps in original versions of Electron but is no longer required as apps should be [serving local files from custom protocols](./security.md#18-avoid-usage-of-the-file-protocol-and-prefer-usage-of-custom-protocols) now instead. If you aren't serving pages from `file://` you should disable this fuse. + * The grantFileProtocolExtraPrivileges fuse changes whether pages loaded from the `file://` protocol are given privileges beyond what they would receive in a traditional web browser. This behavior was core to Electron apps in original versions of Electron but is no longer required as apps should be [serving local files from custom protocols](https://github.com/electron/electron/blob/main/docs/tutorial/security.md#18-avoid-usage-of-the-file-protocol-and-prefer-usage-of-custom-protocols) now instead. If you aren't serving pages from `file://` you should disable this fuse. * The extra privileges granted to the `file://` protocol by this fuse are incompletely documented below: * * `file://` protocol pages can use `fetch` to load other assets over `file://` * * `file://` protocol pages can use service workers diff --git a/pages/tutorials/adding-electron-fuses.md b/pages/tutorials/adding-electron-fuses.md index 57ae42c586e..75d7f04cbc7 100644 --- a/pages/tutorials/adding-electron-fuses.md +++ b/pages/tutorials/adding-electron-fuses.md @@ -1,5 +1,4 @@ -!!! info -Information below pulled from integration with [@electron/fuses](https://github.com/electron/fuses) and [electron tutorial](https://raw.githubusercontent.com/electron/electron/refs/heads/main/docs/tutorial/fuses.md) for easier reading/access. +!!! Information below has been partially copied from integration with [@electron/fuses](https://github.com/electron/fuses) and [electron tutorial](https://raw.githubusercontent.com/electron/electron/refs/heads/main/docs/tutorial/fuses.md) for easier reading/access. ## What are fuses?