Browse Source

docs: update references to Electron Packager (#40480)

David Sanders 1 year ago
parent
commit
2677f36db1

+ 1 - 1
docs/api/app.md

@@ -1514,7 +1514,7 @@ A `boolean` property that returns  `true` if the app is packaged, `false` otherw
 [tasks]:https://learn.microsoft.com/en-us/windows/win32/shell/taskbar-extensions#tasks
 [app-user-model-id]: https://learn.microsoft.com/en-us/windows/win32/shell/appids
 [electron-forge]: https://www.electronforge.io/
-[electron-packager]: https://github.com/electron/electron-packager
+[electron-packager]: https://github.com/electron/packager
 [CFBundleURLTypes]: https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/TP40009249-102207-TPXREF115
 [LSCopyDefaultHandlerForURLScheme]: https://developer.apple.com/documentation/coreservices/1441725-lscopydefaulthandlerforurlscheme?language=objc
 [handoff]: https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/Handoff/HandoffFundamentals/HandoffFundamentals.html

+ 1 - 1
docs/fiddles/system/protocol-handler/launch-app-from-URL-in-another-app/index.html

@@ -44,7 +44,7 @@
   <h3>Packaging</h3>
   <p>This feature will only work on macOS when your app is packaged. It will not work when you're launching it in
     development from the command-line. When you package your app you'll need to make sure the macOS <code>plist</code>
-    for the app is updated to include the new protocol handler. If you're using <code>electron-packager</code> then you
+    for the app is updated to include the new protocol handler. If you're using <code>@electron/packager</code> then you
     can add the flag <code>--extend-info</code> with a path to the <code>plist</code> you've created. The one for this
     app is below:</p>
 

+ 1 - 1
docs/tutorial/asar-integrity.md

@@ -13,7 +13,7 @@ Currently ASAR integrity checking is only supported on macOS.
 
 ### Electron Forge / Electron Packager
 
-If you are using `>= [email protected]` or `>= @electron-forge/[email protected]` then all these requirements are met for you automatically and you can skip to [Toggling the Fuse](#toggling-the-fuse).
+If you are using `>= @electron/packager`, `>= [email protected]` or `>= @electron-forge/[email protected]` then all these requirements are met for you automatically and you can skip to [Toggling the Fuse](#toggling-the-fuse).
 
 ### Other build systems
 

+ 1 - 1
docs/tutorial/boilerplates-and-clis.md

@@ -30,7 +30,7 @@ Electron Forge is a tool for packaging and publishing Electron applications. It
 into a single extensible interface so that anyone can jump right into making Electron apps.
 
 Forge comes with [a ready-to-use template](https://electronforge.io/templates) using Webpack as a bundler. It includes an example typescript configuration and provides two configuration files to enable easy customization. It uses the same core modules used by the
-greater Electron community (like [`electron-packager`](https://github.com/electron/electron-packager)) –
+greater Electron community (like [`@electron/packager`](https://github.com/electron/packager)) –
 changes made by Electron maintainers (like Slack) benefit Forge's users, too.
 
 You can find more information and documentation on [electronforge.io](https://electronforge.io/).

+ 5 - 5
docs/tutorial/code-signing.md

@@ -51,7 +51,7 @@ ways to get your application signed and notarized.
 
 If you're using Electron's favorite build tool, getting your application signed
 and notarized requires a few additions to your configuration. [Forge](https://electronforge.io) is a
-collection of the official Electron tools, using [`electron-packager`][],
+collection of the official Electron tools, using [`@electron/packager`][],
 [`@electron/osx-sign`][], and [`@electron/notarize`][] under the hood.
 
 Detailed instructions on how to configure your application can be found in the
@@ -61,14 +61,14 @@ the Electron Forge docs.
 ### Using Electron Packager
 
 If you're not using an integrated build pipeline like Forge, you
-are likely using [`electron-packager`][], which includes [`@electron/osx-sign`][] and
+are likely using [`@electron/packager`][], which includes [`@electron/osx-sign`][] and
 [`@electron/notarize`][].
 
 If you're using Packager's API, you can pass [in configuration that both signs
-and notarizes your application](https://electron.github.io/electron-packager/main/interfaces/electronpackager.options.html).
+and notarizes your application](https://electron.github.io/packager/main/interfaces/electronpackager.options.html).
 
 ```js @ts-nocheck
-const packager = require('electron-packager')
+const packager = require('@electron/packager')
 
 packager({
   dir: '/path/to/my/app',
@@ -190,7 +190,7 @@ See the [Windows Store Guide][].
 
 [apple developer program]: https://developer.apple.com/programs/
 [`@electron/osx-sign`]: https://github.com/electron/osx-sign
-[`electron-packager`]: https://github.com/electron/electron-packager
+[`@electron/packager`]: https://github.com/electron/packager
 [`@electron/notarize`]: https://github.com/electron/notarize
 [`electron-winstaller`]: https://github.com/electron/windows-installer
 [`electron-wix-msi`]: https://github.com/electron-userland/electron-wix-msi

+ 2 - 2
docs/tutorial/dark-mode.md

@@ -199,7 +199,7 @@ Run the example using Electron Fiddle and then click the "Toggle Dark Mode" butt
 
 [system-wide-dark-mode]: https://developer.apple.com/design/human-interface-guidelines/macos/visual-design/dark-mode/
 [electron-forge]: https://www.electronforge.io/
-[electron-packager]: https://github.com/electron/electron-packager
-[packager-darwindarkmode-api]: https://electron.github.io/electron-packager/main/interfaces/electronpackager.options.html#darwindarkmodesupport
+[electron-packager]: https://github.com/electron/packager
+[packager-darwindarkmode-api]: https://electron.github.io/packager/main/interfaces/electronpackager.options.html#darwindarkmodesupport
 [prefers-color-scheme]: https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme
 [event-listeners]: https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener

+ 2 - 2
docs/tutorial/launch-app-from-url-in-another-app.md

@@ -159,7 +159,7 @@ shows the bare minimum needed to add the configuration changes)_:
 }
 ```
 
-#### [Electron Packager](https://github.com/electron/electron-packager)
+#### [Electron Packager](https://github.com/electron/packager)
 
 For macOS support:
 
@@ -168,7 +168,7 @@ Electron Forge is handled, except
 `protocols` is part of the Packager options passed to the `packager` function.
 
 ```javascript @ts-nocheck
-const packager = require('electron-packager')
+const packager = require('@electron/packager')
 
 packager({
   // ...other options...

+ 5 - 5
docs/tutorial/snapcraft.md

@@ -16,7 +16,7 @@ There are three ways to create a `.snap` file:
 1) Using [Electron Forge][electron-forge] or
    [`electron-builder`][electron-builder], both tools that come with `snap`
    support out of the box. This is the easiest option.
-2) Using `electron-installer-snap`, which takes `electron-packager`'s output.
+2) Using `electron-installer-snap`, which takes `@electron/packager`'s output.
 3) Using an already created `.deb` package.
 
 In some cases, you will need to have the `snapcraft` tool installed.
@@ -35,7 +35,7 @@ npm install --save-dev electron-installer-snap
 
 ### Step 1: Package Your Electron Application
 
-Package the application using [electron-packager][electron-packager] (or a
+Package the application using [@electron/packager][electron-packager] (or a
 similar tool). Make sure to remove `node_modules` that you don't need in your
 final application, since any module you don't actually need will increase
 your application's size.
@@ -79,7 +79,7 @@ snap(options)
   .then(snapPath => console.log(`Created snap at ${snapPath}!`))
 ```
 
-## Using `snapcraft` with `electron-packager`
+## Using `snapcraft` with `@electron/packager`
 
 ### Step 1: Create Sample Snapcraft Project
 
@@ -113,7 +113,7 @@ parts:
     plugin: nil
     source: https://github.com/electron/electron-quick-start.git
     override-build: |
-        npm install electron electron-packager
+        npm install electron @electron/packager
         npx electron-packager . --overwrite --platform=linux --output=release-build --prune=true
         cp -rv ./electron-quick-start-linux-* $SNAPCRAFT_PART_INSTALL/electron-quick-start
     build-snaps:
@@ -266,7 +266,7 @@ Finally, configure your application's environment for PipeWire:
 ```
 
 [snapcraft-syntax]: https://docs.snapcraft.io/build-snaps/syntax
-[electron-packager]: https://github.com/electron/electron-packager
+[electron-packager]: https://github.com/electron/packager
 [electron-forge]: https://github.com/electron/forge
 [electron-builder]: https://github.com/electron-userland/electron-builder
 [electron-installer-debian]: https://github.com/electron-userland/electron-installer-debian

+ 2 - 2
docs/tutorial/tutorial-5-packaging.md

@@ -35,7 +35,7 @@ as a **distributable**). Distributables can be either installers (e.g. MSI on Wi
 portable executable files (e.g. `.app` on macOS).
 
 Electron Forge is an all-in-one tool that handles the packaging and distribution of Electron
-apps. Under the hood, it combines a lot of existing Electron tools (e.g. [`electron-packager`][],
+apps. Under the hood, it combines a lot of existing Electron tools (e.g. [`@electron/packager`][],
 [`@electron/osx-sign`][], [`electron-winstaller`][], etc.) into a single interface so you do not
 have to worry about wiring them all together.
 
@@ -200,7 +200,7 @@ information.
 
 [`@electron/osx-sign`]: https://github.com/electron/osx-sign
 [application packaging]: ./application-distribution.md
-[`electron-packager`]: https://github.com/electron/electron-packager
+[`@electron/packager`]: https://github.com/electron/packager
 [`electron-winstaller`]: https://github.com/electron/windows-installer
 [electron forge]: https://www.electronforge.io
 [electron forge cli documentation]: https://www.electronforge.io/cli#commands

+ 1 - 1
docs/tutorial/using-native-node-modules.md

@@ -169,5 +169,5 @@ environment variable.
 [abi]: https://en.wikipedia.org/wiki/Application_binary_interface
 [@electron/rebuild]: https://github.com/electron/rebuild
 [electron-forge]: https://electronforge.io/
-[electron-packager]: https://github.com/electron/electron-packager
+[electron-packager]: https://github.com/electron/packager
 [node-pre-gyp]: https://github.com/mapbox/node-pre-gyp

+ 2 - 2
docs/tutorial/windows-store-guide.md

@@ -42,7 +42,7 @@ npm install -g electron-windows-store
 
 ## Step 1: Package Your Electron Application
 
-Package the application using [electron-packager][electron-packager] (or a similar tool).
+Package the application using [`@electron/packager`][electron-packager] (or a similar tool).
 Make sure to remove `node_modules` that you don't need in your final application, since
 any module you don't actually need will increase your application's size.
 
@@ -151,7 +151,7 @@ Once installation succeeded, you can move on to compiling your Electron app.
 [windows-sdk]: https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/
 [app-converter]: https://learn.microsoft.com/en-us/windows/msix/packaging-tool/tool-overview
 [add-appxpackage]: https://learn.microsoft.com/en-us/previous-versions//hh856048(v=technet.10)?redirectedfrom=MSDN
-[electron-packager]: https://github.com/electron/electron-packager
+[electron-packager]: https://github.com/electron/packager
 [electron-windows-store]: https://github.com/electron-userland/electron-windows-store
 [background-task]: https://github.com/felixrieseberg/electron-uwp-background
 [centennial-campaigns]: https://developer.microsoft.com/en-us/windows/projects/campaigns/desktop-bridge