feat(nsis): option to not create desktop shortcut

develar · develar · commit 350e24106aba · 2017-06-26T19:49:13.000+02:00
Close #1597
diff --git a/docs/Options.md b/docs/Options.md
@@ -275,6 +275,7 @@ Configuration Options
     If `oneClick` is `false`: no install mode installer page (choice per-machine or per-user), always install per-machine.
   * <a name="NsisOptions-allowElevation"></a>`allowElevation` = `true` Boolean - *boring installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.
   * <a name="NsisOptions-allowToChangeInstallationDirectory"></a>`allowToChangeInstallationDirectory` = `false` Boolean - *boring installer only.* Whether to allow user to change installation directory.
+  * <a name="NsisOptions-createDesktopShortcut"></a>`createDesktopShortcut` = `true` Boolean - Whether to create desktop shortcut.
   * <a name="NsisOptions-runAfterFinish"></a>`runAfterFinish` = `true` Boolean - *one-click installer only.* Run application after finish.
   * <a name="NsisOptions-installerIcon"></a>`installerIcon` String - The path to installer icon, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `build/installerIcon.ico` or application icon.
   * <a name="NsisOptions-uninstallerIcon"></a>`uninstallerIcon` String - The path to uninstaller icon, relative to the the [build resources](https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-buildResources) or to the project directory. Defaults to `build/uninstallerIcon.ico` or application icon.
diff --git a/packages/electron-builder/src/options/winOptions.ts b/packages/electron-builder/src/options/winOptions.ts
@@ -132,6 +132,12 @@ export interface NsisOptions extends CommonNsisOptions, TargetSpecificOptions {
    */
   readonly allowToChangeInstallationDirectory?: boolean
 
+  /**
+   * Whether to create desktop shortcut.
+   * @default true
+   */
+  readonly createDesktopShortcut?: boolean
+
   /**
    * *one-click installer only.* Run application after finish.
    * @default true
diff --git a/packages/electron-builder/src/targets/nsis.ts b/packages/electron-builder/src/targets/nsis.ts
@@ -410,7 +410,10 @@ export class NsisTarget extends Target {
       defines.MUI_UNICON = uninstallerIcon
     }
 
-    defines.UNINSTALL_DISPLAY_NAME = packager.expandMacro(this.options.uninstallDisplayName || "${productName} ${version}", null, {}, false)
+    defines.UNINSTALL_DISPLAY_NAME = packager.expandMacro(options.uninstallDisplayName || "${productName} ${version}", null, {}, false)
+    if (options.createDesktopShortcut === false) {
+      defines.DO_NOT_CREATE_DESKTOP_SHORTCUT = null
+    }
   }
 
   private configureDefinesForAllTypeOfInstaller(defines: any) {
diff --git a/packages/electron-builder/templates/nsis/installSection.nsh b/packages/electron-builder/templates/nsis/installSection.nsh
@@ -87,14 +87,18 @@ ${endif}
 
 StrCpy $appExe "$INSTDIR\${APP_EXECUTABLE_FILENAME}"
 Var /GLOBAL shortcuts
-StrCpy $shortcuts ""
-!ifndef allowToChangeInstallationDirectory
-  ReadRegStr $R1 SHELL_CONTEXT "${INSTALL_REGISTRY_KEY}" KeepShortcuts
-
-  ${if} $R1 == "true"
-  ${andIf} ${FileExists} "$appExe"
-    StrCpy $shortcuts "--keep-shortcuts"
-  ${endIf}
+!ifdef DO_NOT_CREATE_DESKTOP_SHORTCUT
+  StrCpy $shortcuts "--keep-shortcuts"
+!else
+  StrCpy $shortcuts ""
+  !ifndef allowToChangeInstallationDirectory
+    ReadRegStr $R1 SHELL_CONTEXT "${INSTALL_REGISTRY_KEY}" KeepShortcuts
+
+    ${if} $R1 == "true"
+    ${andIf} ${FileExists} "$appExe"
+      StrCpy $shortcuts "--keep-shortcuts"
+    ${endIf}
+  !endif
 !endif
 
 !ifdef ONE_CLICK
diff --git a/test/src/windows/oneClickInstallerTest.ts b/test/src/windows/oneClickInstallerTest.ts
@@ -37,6 +37,7 @@ test.ifAll.ifNotCiMac("multi language license", app({
     publish: null,
     nsis: {
       uninstallDisplayName: "Hi!!!",
+      createDesktopShortcut: false,
     }
   },
 }, {

Original file line number	Diff line number	Diff line change
`@@ -410,7 +410,10 @@ export class NsisTarget extends Target {`
`410`	`410`	`defines.MUI_UNICON = uninstallerIcon`
`411`	`411`	`}`
`412`	`412`
`413`		`- defines.UNINSTALL_DISPLAY_NAME = packager.expandMacro(this.options.uninstallDisplayName \|\| "${productName} ${version}", null, {}, false)`
	`413`	`+ defines.UNINSTALL_DISPLAY_NAME = packager.expandMacro(options.uninstallDisplayName \|\| "${productName} ${version}", null, {}, false)`
	`414`	`+ if (options.createDesktopShortcut === false) {`
	`415`	`+ defines.DO_NOT_CREATE_DESKTOP_SHORTCUT = null`
	`416`	`+ }`
`414`	`417`	`}`
`415`	`418`
`416`	`419`	`private configureDefinesForAllTypeOfInstaller(defines: any) {`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ test.ifAll.ifNotCiMac("multi language license", app({`
`37`	`37`	`publish: null,`
`38`	`38`	`nsis: {`
`39`	`39`	`uninstallDisplayName: "Hi!!!",`
	`40`	`+ createDesktopShortcut: false,`
`40`	`41`	`}`
`41`	`42`	`},`
`42`	`43`	`}, {`