From 2b959fe2ee456245c7ffd616acdc65a2470724b3 Mon Sep 17 00:00:00 2001 From: develar Date: Tue, 19 Apr 2016 18:24:18 +0200 Subject: [PATCH] docs: the "asar: false" option Closes #335 --- README.md | 2 ++ docs/Options.md | 1 + src/metadata.ts | 6 ++++++ 3 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 3c1bae170ab..14543e7c188 100755 --- a/README.md +++ b/README.md @@ -72,6 +72,8 @@ See [options](https://github.com/electron-userland/electron-builder/wiki/Options 5. Install [required system packages](https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build). +Please note — packaged into an asar archive [by default](https://github.com/electron-userland/electron-builder/wiki/Options#BuildMetadata-asar). + # Auto Update `electron-builder` produces all required artifacts: diff --git a/docs/Options.md b/docs/Options.md index 023f0d442a3..b083f591211 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -52,6 +52,7 @@ Here documented only `electron-builder` specific options: | --- | --- | app-bundle-id | *OS X-only.* The bundle identifier to use in the application's plist. | app-category-type |

*OS X-only.* The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.

For example, app-category-type=public.app-category.developer-tools will set the application category to *Developer Tools*.

Valid values are listed in [Apple’s documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).

+| asar |

Whether to package the application’s source code into an archive, using [Electron’s archive format](https://github.com/electron/asar). Defaults to true. Reasons why you may want to disable this feature are described in [an application packaging tutorial in Electron’s documentation](http://electron.atom.io/docs/latest/tutorial/application-packaging/#limitations-on-node-api/).

| iconUrl |

*windows-only.* A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.

Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.

| productName | See [AppMetadata.productName](#AppMetadata-productName). | extraResources |

A [glob expression](https://www.npmjs.com/package/glob#glob-primer), when specified, copy the file or directory with matching names directly into the app’s directory (Contents/Resources for OS X).

You can use ${os} (expanded to osx, linux or win according to current platform) and ${arch} in the pattern.

If directory matched, all contents are copied. So, you can just specify foo to copy <project_dir>/foo directory.

May be specified in the platform options (i.e. in the build.osx).

diff --git a/src/metadata.ts b/src/metadata.ts index e9e3647c08b..8e7f6586205 100755 --- a/src/metadata.ts +++ b/src/metadata.ts @@ -86,6 +86,12 @@ export interface BuildMetadata { */ readonly "app-category-type"?: string + /* + Whether to package the application's source code into an archive, using [Electron's archive format](https://github.com/electron/asar). Defaults to `true`. + Reasons why you may want to disable this feature are described in [an application packaging tutorial in Electron's documentation](http://electron.atom.io/docs/latest/tutorial/application-packaging/#limitations-on-node-api/). + */ + readonly asar?: boolean + /* *windows-only.* A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.