diff --git a/.babelrc b/.babelrc
new file mode 100644
index 00000000000..5c5ae7d7630
--- /dev/null
+++ b/.babelrc
@@ -0,0 +1,43 @@
+{
+ env: {
+ development: {
+ plugins: [
+ [
+ "transform-async-to-module-method",
+ {
+ module: "bluebird-lst-c",
+ method: "coroutine"
+ }
+ ],
+ "transform-es2015-parameters",
+ "transform-es2015-spread",
+ "transform-es2015-destructuring",
+ "array-includes",
+ [
+ "transform-inline-imports-commonjs",
+ {
+ excludeModules: ["path"]
+ }
+ ],
+ ],
+ },
+ test: {
+ sourceMaps: "inline",
+ plugins: [
+ [
+ "transform-async-to-module-method",
+ {
+ module: "bluebird-lst-c",
+ method: "coroutine"
+ }
+ ],
+ [
+ "transform-inline-imports-commonjs",
+ {
+ excludeModules: ["path"]
+ }
+ ],
+ ]
+ }
+ }
+}
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 6cd89979bf8..8f131770e95 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,16 +1,31 @@
node_modules/
*.log
-out/
+
+#**/out/**/*
+#!**/*js.snap
+
dist/
+
/.idea/compiler.xml
/.idea/encodings.xml
-/.idea/copyright/profiles_settings.xml
/.idea/workspace.xml
+/.idea/copyright/
/.idea/deployment.xml
+/.idea/shelf/
+
+/docs/.idea/
+
/typings/browser/
/typings/browser.d.ts
/typings/main.d.ts
+
.DS_Store
-.idea/shelf/
+
/test/typings/electron-builder.d.ts
-/test/typings/electron-auto-updater.d.ts
\ No newline at end of file
+/test/typings/electron-auto-updater.d.ts
+
+/nsis-auto-updater/out/
+/out/
+# to not exclude .js.snap (jest snapshots)
+/test/out/**/*.js
+/test/out/**/*.map
\ No newline at end of file
diff --git a/.idea/codeStyleSettings.xml b/.idea/codeStyleSettings.xml
index d52229a2c3d..1038133a841 100644
--- a/.idea/codeStyleSettings.xml
+++ b/.idea/codeStyleSettings.xml
@@ -20,8 +20,12 @@
+
+
+
+
diff --git a/.idea/dictionaries/develar.xml b/.idea/dictionaries/develar.xml
index dd56977cc42..f0a00dae295 100644
--- a/.idea/dictionaries/develar.xml
+++ b/.idea/dictionaries/develar.xml
@@ -16,6 +16,8 @@
appxmanifestarchiverarchs
+ armv
+ asaraspxatexitatime
@@ -40,6 +42,7 @@
debiandepcheckdevel
+ develardevmodediffletdigester
@@ -72,6 +75,7 @@
hklmhomedirhrtime
+ icnsicnsutilsicnviconset
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
index a4ab52713ac..16cea617f7b 100644
--- a/.idea/inspectionProfiles/Project_Default.xml
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -3,8 +3,17 @@
+
+
+
+
+
+
+
+
+
diff --git a/.idea/rc-producer.yml b/.idea/rc-producer.yml
new file mode 100644
index 00000000000..d32be87c1a5
--- /dev/null
+++ b/.idea/rc-producer.yml
@@ -0,0 +1,14 @@
+- &defaults
+ files: ["test/src/**/*", "!**/helpers/**/*"]
+ script: "node_modules/.bin/jest"
+ scriptArgs: ["-i", "--env", "jest-environment-node-debug", &filePattern '/${fileNameWithoutExt}\.\w+$']
+ rcName: "${fileNameWithoutExt}"
+ beforeRun: typescript
+
+-
+ <<: *defaults
+ lineRegExp: '^\s*(?:test|it)(?:\.\w+)?\("([^"'']+)'
+ scriptArgs: ["-i", "--env", "jest-environment-node-debug", "-t", "${0regExp}", *filePattern]
+ rcName: "${fileNameWithoutExt}.${0}"
+ env:
+ TEST_APP_TMP_DIR: /tmp/electron-builder-test
\ No newline at end of file
diff --git a/.idea/runConfigurations/ArtifactPublisherTest.xml b/.idea/runConfigurations/ArtifactPublisherTest.xml
deleted file mode 100644
index 78bee45d503..00000000000
--- a/.idea/runConfigurations/ArtifactPublisherTest.xml
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/runConfigurations/BuildTest.xml b/.idea/runConfigurations/BuildTest.xml
deleted file mode 100644
index 84eb02dad06..00000000000
--- a/.idea/runConfigurations/BuildTest.xml
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/runConfigurations/CodeSignTest.xml b/.idea/runConfigurations/CodeSignTest.xml
deleted file mode 100644
index 4322aa815c4..00000000000
--- a/.idea/runConfigurations/CodeSignTest.xml
+++ /dev/null
@@ -1,16 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/runConfigurations/RepoSlugTest.xml b/.idea/runConfigurations/RepoSlugTest.xml
deleted file mode 100644
index 62b3caea04d..00000000000
--- a/.idea/runConfigurations/RepoSlugTest.xml
+++ /dev/null
@@ -1,5 +0,0 @@
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/runConfigurations/winPackagerTest__debug_logging_.xml b/.idea/runConfigurations/winPackagerTest__debug_logging_.xml
deleted file mode 100644
index 18875c1d738..00000000000
--- a/.idea/runConfigurations/winPackagerTest__debug_logging_.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/.idea/scopes/json5.xml b/.idea/scopes/json5.xml
new file mode 100644
index 00000000000..e11bd99491d
--- /dev/null
+++ b/.idea/scopes/json5.xml
@@ -0,0 +1,3 @@
+
+
+
\ No newline at end of file
diff --git a/.mention-bot b/.mention-bot
new file mode 100644
index 00000000000..78cb7b19b29
--- /dev/null
+++ b/.mention-bot
@@ -0,0 +1,3 @@
+{
+ "userBlacklist": ["develar"]
+}
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
index b8dd1a06788..193c169a9ff 100755
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,7 +1,7 @@
matrix:
include:
- os: osx
- env: TEST_FILES=BuildTest,extraMetadataTest,globTest,filesTest,ignoreTest,linux.* NODE_VERSION=7 PUBLISH_TO_NPM=true
+ env: TEST_FILES=BuildTest,extraMetadataTest,globTest,filesTest,ignoreTest,linux.* NODE_VERSION=6 PUBLISH_TO_NPM=true
- os: osx
env: TEST_FILES=windows.*,mac.* NODE_VERSION=7
@@ -29,9 +29,7 @@ before_install:
install:
- nvm install $NODE_VERSION
- nvm use --delete-prefix $NODE_VERSION
-- mkdir -p ~/Library/Caches/Yarn
-- curl -o- -L https://yarnpkg.com/install.sh | bash
-- export PATH="$PATH:$HOME/.yarn/bin"
+- ln -sf $PWD/test/yarn.js /usr/local/bin/yarn
- yarn install --pure-lockfile
- if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" && "$AUTO_PUBLISH" != "false" && "$TRAVIS_TAG" == "" && "$PUBLISH_TO_NPM" == "true" ]]; then yarn add @develar/semantic-release@next --dev ; fi
diff --git a/MAINTAINING.md b/MAINTAINING.md
index f8578cc7f9c..3f972e32c89 100644
--- a/MAINTAINING.md
+++ b/MAINTAINING.md
@@ -6,7 +6,7 @@ new version with tag `next` will be published if `fix`, `feat` or `BREAKING CHAN
# Sync wiki
To add `wiki` upstream:
```
-git remote add upstream https://github.com/electron-userland/electron-builder.wiki.git
+git remote add wiki git@github.com:electron-userland/electron-builder.wiki.git
```
-To sync: `npm run update-wiki`
\ No newline at end of file
+To sync: `yarn update-wiki`
\ No newline at end of file
diff --git a/README.md b/README.md
index c14aa725562..1686f053dcd 100755
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ For an app that will be shipped to production, you should sign your application.
"build": {
"appId": "your.id",
"mac": {
- "category": "your.app.category.type",
+ "category": "your.app.category.type"
},
"win": {
"iconUrl": "(windows-only) https link to icon"
diff --git a/appveyor.yml b/appveyor.yml
index f4f5064fc71..8c06a195bcb 100644
--- a/appveyor.yml
+++ b/appveyor.yml
@@ -6,15 +6,13 @@ cache:
- '%USERPROFILE%\.electron'
environment:
- RUN_IN_BAND: true
+ TEST_FILES: BuildTest,extraMetadataTest,filesTest,globTest
install:
- ps: Install-Product node 6 x64
- # unknown yarn error
- - npm install
- - npm prune
+ - node ./test/yarn.js
build: off
test_script:
- - npm run test
\ No newline at end of file
+ - node ./test/yarn.js test
\ No newline at end of file
diff --git a/docker/7/Dockerfile b/docker/7/Dockerfile
index 71aa8514924..96a6466c4d6 100644
--- a/docker/7/Dockerfile
+++ b/docker/7/Dockerfile
@@ -1,6 +1,6 @@
FROM electronuserland/electron-builder:base
-ENV NODE_VERSION 7.1.0
+ENV NODE_VERSION 7.2.0
# https://github.com/npm/npm/issues/4531
RUN curl -SLO "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.xz" \
diff --git a/docker/base/Dockerfile b/docker/base/Dockerfile
index 1eb54385db5..1f9fa2ffd8b 100644
--- a/docker/base/Dockerfile
+++ b/docker/base/Dockerfile
@@ -1,4 +1,4 @@
-FROM buildpack-deps:yakkety-curl
+FROM buildpack-deps:xenial-curl
# rpm is required for FPM to build rpm package
# yasm is required to build p7zip
@@ -15,9 +15,8 @@ ENV USE_SYSTEM_7ZA true
ENV DEBUG_COLORS true
ENV FORCE_COLOR true
-RUN apt-key adv --fetch-keys http://dl.yarnpkg.com/debian/pubkey.gpg && echo "deb http://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \
-apt-get update -y && \
- apt-get install --no-install-recommends -y git snapcraft yarn xorriso bsdtar build-essential autoconf libssl-dev icnsutils graphicsmagick gcc-multilib g++-multilib libgnome-keyring-dev lzip rpm yasm && \
+RUN curl -L https://yarnpkg.com/latest.tar.gz | tar xvz && mv dist yarn && ln -s /yarn/bin/yarn /usr/local/bin/yarn && apt-get update -y && \
+ apt-get install --no-install-recommends -y git snapcraft xorriso bsdtar build-essential autoconf libssl-dev icnsutils graphicsmagick gcc-multilib g++-multilib libgnome-keyring-dev lzip rpm yasm && \
apt-get clean && \
rm -rf /var/lib/apt/lists/* && \
curl -L http://tukaani.org/xz/xz-$XZ_VERSION.tar.xz | tar -xJ && cd xz-$XZ_VERSION && ./configure && make && make install && cd .. && rm -rf xz-$XZ_VERSION && ldconfig && \
@@ -48,4 +47,5 @@ WORKDIR /project
RUN locale-gen en_US.UTF-8
ENV LANG en_US.UTF-8
ENV LANGUAGE en_US:en
-ENV LC_ALL en_US.UTF-8
\ No newline at end of file
+ENV LC_ALL en_US.UTF-8
+ENV PATH "$HOME/.yarn/bin:$PATH"
\ No newline at end of file
diff --git a/docker/wine/Dockerfile b/docker/wine/Dockerfile
index df96a42f3a5..6967f5c7796 100644
--- a/docker/wine/Dockerfile
+++ b/docker/wine/Dockerfile
@@ -2,7 +2,7 @@ FROM electronuserland/electron-builder:latest
# libgnome-keyring-dev — to build keytar
RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys F9CB8DB0 && \
-echo "deb http://ppa.launchpad.net/ubuntu-wine/ppa/ubuntu yakkety main " | tee /etc/apt/sources.list.d/wine.list && \
+echo "deb http://ppa.launchpad.net/ubuntu-wine/ppa/ubuntu xenial main " | tee /etc/apt/sources.list.d/wine.list && \
dpkg --add-architecture i386 && \
apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 3FA7E0328081BFF6A14DA29AA6A19B38D3D831EF && \
echo "deb http://download.mono-project.com/repo/debian wheezy main" | tee /etc/apt/sources.list.d/mono-xamarin.list && \
diff --git a/docs/Multi Platform Build.md b/docs/Multi Platform Build.md
index be04daa33ec..766caf8b83c 100755
--- a/docs/Multi Platform Build.md
+++ b/docs/Multi Platform Build.md
@@ -81,4 +81,4 @@ dist: trusty
## Windows
-Use [Docker](https://github.com/electron-userland/electron-builder/wiki/Docker).
+Please use [Docker](https://github.com/electron-userland/electron-builder/wiki/Docker).
diff --git a/docs/NSIS.md b/docs/NSIS.md
index 796b6f2fdc5..64e575507b9 100644
--- a/docs/NSIS.md
+++ b/docs/NSIS.md
@@ -38,4 +38,8 @@ So, it is better to use [GUID](http://stackoverflow.com/a/246935/1910191).
You are not forced to explicitly specify it — name-based [UUID v5](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_5_.28SHA-1_hash_.26_namespace.29) will be generated from your [appId](https://github.com/electron-userland/electron-builder/wiki/Options#BuildMetadata-appId) or [name](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata-name).
It means that you **should not change appId** once your application in use (or name if `appId` was not set). Application product name (title) or description can be safely changed.
-You can explicitly set guid using option [nsis.guid](https://github.com/electron-userland/electron-builder/wiki/Options#NsisOptions-guid), but it is not recommended — consider using [appId](https://github.com/electron-userland/electron-builder/wiki/Options#BuildMetadata-appId).
\ No newline at end of file
+You can explicitly set guid using option [nsis.guid](https://github.com/electron-userland/electron-builder/wiki/Options#NsisOptions-guid), but it is not recommended — consider using [appId](https://github.com/electron-userland/electron-builder/wiki/Options#BuildMetadata-appId).
+
+It is also important to set the Application User Model ID (AUMID) to the [appId](https://github.com/electron-userland/electron-builder/wiki/Options#BuildMetadata-appId) of the application, in order for notifications on Windows 8/8.1 to function and for Window 10 notifications to display the app icon within the notifications by default. The AUIMD should be set within the Main process and before any BrowserWindows have been opened, it is normally the first piece of code executed.
+
+`app.setAppUserModelId(appId)`
diff --git a/docs/Options.md b/docs/Options.md
index 245bfe8e4c5..f6366ca2129 100644
--- a/docs/Options.md
+++ b/docs/Options.md
@@ -27,6 +27,7 @@ Don't customize paths to background and icon, — just follow conventions.
* [Application package.json](#AppMetadata)
* [Development package.json](#DevMetadata)
* [.build](#BuildMetadata)
+ * [.build.appx](#AppXOptions)
* [.build.dmg](#DmgOptions)
* [.build.dmg.window](#DmgWindow)
* [.build.fileAssociations](#FileAssociation)
@@ -58,7 +59,6 @@ Don't customize paths to background and icon, — just follow conventions.
| Name | Description
| --- | ---
| **build** | See [.build](#BuildMetadata).
-| directories | See [.directories](#MetadataDirectories)
## `.build`
@@ -70,7 +70,7 @@ Don't customize paths to background and icon, — just follow conventions.
| files |
A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the [app directory](#MetadataDirectories-app), which specifies which files to include when copying files to create the package.
See [File Patterns](#multiple-glob-patterns).
| extraResources |
A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the project directory, when specified, copy the file or directory with matching names directly into the app’s resources directory (Contents/Resources for MacOS, resources for Linux/Windows).
Glob rules the same as for [files](#multiple-glob-patterns).
| extraFiles | The same as [extraResources](#BuildMetadata-extraResources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux/Windows).
-| asar |
Whether to package the application’s source code into an archive, using [Electron’s archive format](http://electron.atom.io/docs/tutorial/application-packaging/). 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/tutorial/application-packaging/#limitations-of-the-node-api).
Or you can pass object of any asar options.
Node modules, that must be unpacked, will be detected automatically, you don’t need to explicitly set asarUnpack - please file issue if this doesn’t work.
+| asar |
Whether to package the application’s source code into an archive, using [Electron’s archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Defaults to true. Node modules, that must be unpacked, will be detected automatically, you don’t need to explicitly set [asarUnpack](#BuildMetadata-asarUnpack) - please file issue if this doesn’t work.
Or you can pass object of asar options.
| asarUnpack | A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.
| fileAssociations | The file associations. See [.build.fileAssociations](#FileAssociation).
| protocols | The URL protocol scheme(s) to associate the app with. See [.build.protocol](#Protocol).
@@ -91,6 +91,21 @@ Don't customize paths to background and icon, — just follow conventions.
| electronDist | The path to custom Electron build (e.g. `~/electron/out/R`). Only macOS supported, file issue if need for Linux or Windows.
| electronDownload | The [electron-download](https://github.com/electron-userland/electron-download#usage) options.
| publish | See [.build.publish](#PublishConfiguration).
+| forceCodeSigning | Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct).
+| directories | See [.directories](#MetadataDirectories)
+
+
+### `.build.appx`
+
+Please see [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx).
+
+| Name | Description
+| --- | ---
+| backgroundColor | The background color of the app tile. Please see [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).
+| publisher | Describes the publisher information. The Publisher attribute must match the publisher subject information of the certificate used to sign a package. For now, required.
+| displayName | A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
+| publisherDisplayName | A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
+| identityName | Describes the contents of the package. The Name attribute is case-sensitive. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx).
### `.build.dmg`
@@ -132,7 +147,8 @@ macOS and NSIS only. Array of option objects.
| **name** | The name. e.g. `PNG`.
| description | *windows-only.* The description.
| icon | The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.
-| role | *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`.
+| role | *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`. Corresponds to `CFBundleTypeRole`.
+| isPackage | *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
### `.build.linux`
@@ -191,6 +207,7 @@ See [NSIS target notes](https://github.com/electron-userland/electron-builder/wi
| allowElevation | *boring installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions. Defaults to `true`.
| runAfterFinish | *one-click installer only.* Run application after finish. Defaults to `true`.
| guid | See [GUID vs Application Name](https://github.com/electron-userland/electron-builder/wiki/NSIS#guid-vs-application-name).
+| installerIcon | The path to installer icon. Defaults to `build/installerIcon.ico` or application icon.
| installerHeader | *boring installer only.* `MUI_HEADERIMAGE`, relative to the project directory. Defaults to `build/installerHeader.bmp`
| installerHeaderIcon | *one-click installer only.* The path to header icon (above the progress bar), relative to the project directory. Defaults to `build/installerHeaderIcon.ico` or application icon.
| include | The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](https://github.com/electron-userland/electron-builder/wiki/NSIS#custom-nsis-script).
@@ -270,14 +287,15 @@ Windows specific build options.
| Name | Description
| --- | ---
-| target | Target package type: list of `nsis`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `nsis`.
-| signingHashAlgorithms | Array of signing algorithms used. Defaults to `['sha1', 'sha256']`
+| target |
Target package type: list of nsis, appx, squirrel, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2, dir. Defaults to nsis.
AppX package can be built only on Windows 10.
+| signingHashAlgorithms |
Array of signing algorithms used. Defaults to ['sha1', 'sha256']
For AppX sha256 is always used.
| icon | The path to application icon. Defaults to `build/icon.ico` (consider using this convention instead of complicating your configuration).
| legalTrademarks | The trademarks and registered trademarks.
-| certificateFile | The path to the *.pfx certificate you want to sign with. Required only if you build on macOS and need different certificate than the one set in `CSC_LINK` - see [Code Signing](https://github.com/electron-userland/electron-builder/wiki/Code-Signing).
-| certificatePassword | The password to the certificate provided in `certificateFile`. Required only if you build on macOS and need to use a different password than the one set in `CSC_KEY_PASSWORD` - see [Code Signing](https://github.com/electron-userland/electron-builder/wiki/Code-Signing).
+| certificateFile |
The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable CSC_LINK (WIN_CSC_LINK) for some reason. Please see [Code Signing](https://github.com/electron-userland/electron-builder/wiki/Code-Signing).
+| certificatePassword |
The password to the certificate provided in certificateFile. Please use it only if you cannot use env variable CSC_KEY_PASSWORD (WIN_CSC_KEY_PASSWORD) for some reason. Please see [Code Signing](https://github.com/electron-userland/electron-builder/wiki/Code-Signing).
| certificateSubjectName | The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows.
| rfc3161TimeStampServer | The URL of the RFC 3161 time stamp server. Defaults to `http://timestamp.comodoca.com/rfc3161`.
+| timeStampServer | The URL of the time stamp server. Defaults to `http://timestamp.verisign.com/scripts/timstamp.dll`.
## `.directories`
@@ -306,9 +324,8 @@ Development dependencies are never copied in any case. You don't need to ignore
[Multiple patterns](#multiple-glob-patterns) are supported. You can use `${os}` (expanded to mac, 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 `foo` directory.
-Remember that default pattern `**/*` is not added to your custom, so, you have to add it explicitly — e.g. `["**/*", "!ignoreMe${/*}"]`.
-
-`package.json` is added to your custom in any case.
+Remember that default pattern `**/*` **is not added to your custom** if some of your patterns is not ignore (i.e. not starts with `!`).
+ `package.json` is added to your custom in any case.
May be specified in the platform options (e.g. in the `build.mac`).
diff --git a/docs/Two package.json Structure.md b/docs/Two package.json Structure.md
index d8ab02e6e5f..b37996de8e9 100644
--- a/docs/Two package.json Structure.md
+++ b/docs/Two package.json Structure.md
@@ -6,7 +6,7 @@ Since version 8 electron-builder rebuilds only production dependencies, so, you
2. For your application (`./app/package.json`)
- The `package.json` resides in the `app` directory. Declare your application dependencies (`depencencies`) here. *Only this directory is distributed with the final, packaged application.*
+ The `package.json` resides in the `app` directory. Declare your application dependencies (`dependencies`) here. *Only this directory is distributed with the final, packaged application.*
Why?
@@ -15,4 +15,4 @@ Why?
Please see [Loading App Dependencies Manually](https://github.com/electron-userland/electron-builder/wiki/Loading-App-Dependencies-Manually) and [#379](https://github.com/electron-userland/electron-builder/issues/379#issuecomment-218503881).
-If you use the two-package.json project structure, you'll only have your `devDependencies` in your development `package.json` and your `dependencies` in your app `package.json`. To ensure your dependencies are always updated based on both files, simply add `"postinstall": "install-app-deps"` to your development `package.json`. This will basically automatically trigger an `npm install` within your app directory so you don't have to do this work every time you install/update your dependencies.
\ No newline at end of file
+If you use the two-package.json project structure, you'll only have your `devDependencies` in your development `package.json` and your `dependencies` in your app `package.json`. To ensure your dependencies are always updated based on both files, simply add `"postinstall": "install-app-deps"` to your development `package.json`. This will basically automatically trigger an `npm install` within your app directory so you don't have to do this work every time you install/update your dependencies.
diff --git a/docs/programmaticUsage.js b/docs/programmaticUsage.js
index d658d95d3ad..093d67a56f7 100644
--- a/docs/programmaticUsage.js
+++ b/docs/programmaticUsage.js
@@ -6,7 +6,7 @@ const builder = require("electron-builder")
builder.build({
platform: [builder.Platform.MAC],
"//": "platform, arch and other properties, see PackagerOptions in the node_modules/electron-builder/out/electron-builder.d.ts",
- devMetadata: {
+ config: {
"//": "build and other properties, see https://goo.gl/5jVxoO"
}
})
diff --git a/nsis-auto-updater/package.json b/nsis-auto-updater/package.json
index f365102bbc3..f2e78726186 100644
--- a/nsis-auto-updater/package.json
+++ b/nsis-auto-updater/package.json
@@ -1,6 +1,6 @@
{
"name": "electron-auto-updater",
- "version": "0.6.0",
+ "version": "0.7.2",
"description": "NSIS Auto Updater",
"main": "out/nsis-auto-updater/src/main.js",
"author": "Vladimir Krivosheev",
@@ -13,13 +13,11 @@
],
"dependencies": {
"bluebird-lst-c": "^1.0.5",
- "debug": "^2.3.2",
- "fs-extra-p": "^2.0.7",
- "ini": "^1.3.4",
+ "debug": "^2.4.5",
+ "fs-extra-p": "^3.0.3",
"js-yaml": "^3.7.0",
"semver": "^5.3.0",
- "source-map-support": "^0.4.6",
- "tunnel-agent": "^0.4.3"
+ "source-map-support": "^0.4.6"
},
"typings": "./out/electron-auto-updater.d.ts"
}
diff --git a/nsis-auto-updater/src/BintrayProvider.ts b/nsis-auto-updater/src/BintrayProvider.ts
index a3179ff0ca1..08a8083ce57 100644
--- a/nsis-auto-updater/src/BintrayProvider.ts
+++ b/nsis-auto-updater/src/BintrayProvider.ts
@@ -1,6 +1,5 @@
import { Provider, FileInfo } from "./api"
-import { BintrayClient } from "../../src/publish/bintray"
-import { HttpError } from "../../src/publish/restApiRequest"
+import { BintrayClient, HttpError } from "../../src/publish/bintray"
import { BintrayOptions, VersionInfo } from "../../src/options/publishOptions"
export class BintrayProvider implements Provider {
@@ -18,7 +17,7 @@ export class BintrayProvider implements Provider {
}
}
catch (e) {
- if (e instanceof HttpError && e.response.statusCode === 404) {
+ if ("response" in e && e.response.statusCode === 404) {
throw new Error(`No latest version, please ensure that user, package and repository correctly configured. Or at least one version is published. ${e.stack || e.message}`)
}
throw e
@@ -29,7 +28,7 @@ export class BintrayProvider implements Provider {
try {
const files = await this.client.getVersionFiles(versionInfo.version)
const suffix = `${versionInfo.version}.exe`
- for (let file of files) {
+ for (const file of files) {
if (file.name.endsWith(suffix) && file.name.includes("Setup")) {
return {
name: file.name,
diff --git a/nsis-auto-updater/src/GenericProvider.ts b/nsis-auto-updater/src/GenericProvider.ts
index 9f0d65a5b56..7e284925118 100644
--- a/nsis-auto-updater/src/GenericProvider.ts
+++ b/nsis-auto-updater/src/GenericProvider.ts
@@ -1,8 +1,8 @@
import { Provider, FileInfo } from "./api"
-import { HttpError, request } from "../../src/publish/restApiRequest"
import { GenericServerOptions, UpdateInfo } from "../../src/options/publishOptions"
import * as url from "url"
import * as path from "path"
+import { HttpError, request } from "../../src/util/httpExecutor"
export class GenericProvider implements Provider {
private readonly baseUrl = url.parse(this.configuration.url)
diff --git a/nsis-auto-updater/src/GitHubProvider.ts b/nsis-auto-updater/src/GitHubProvider.ts
index d4e9a105e24..1d3f0e52462 100644
--- a/nsis-auto-updater/src/GitHubProvider.ts
+++ b/nsis-auto-updater/src/GitHubProvider.ts
@@ -1,8 +1,8 @@
import { Provider, FileInfo } from "./api"
import { VersionInfo, GithubOptions, UpdateInfo } from "../../src/options/publishOptions"
-import { request, HttpError } from "../../src/publish/restApiRequest"
import { validateUpdateInfo } from "./GenericProvider"
import * as path from "path"
+import { HttpError, request } from "../../src/util/httpExecutor"
export class GitHubProvider implements Provider {
constructor(private readonly options: GithubOptions) {
diff --git a/nsis-auto-updater/src/NsisUpdater.ts b/nsis-auto-updater/src/NsisUpdater.ts
index f05354a13b7..51d4174d765 100644
--- a/nsis-auto-updater/src/NsisUpdater.ts
+++ b/nsis-auto-updater/src/NsisUpdater.ts
@@ -12,6 +12,8 @@ import { readFile } from "fs-extra-p"
import { safeLoad } from "js-yaml"
import { GenericProvider } from "./GenericProvider"
import { GitHubProvider } from "./GitHubProvider"
+import { executorHolder } from "../../src/util/httpExecutor"
+import { ElectronHttpExecutor } from "./electronHttpExecutor"
export class NsisUpdater extends EventEmitter {
private setupPath: string | null
@@ -21,6 +23,8 @@ export class NsisUpdater extends EventEmitter {
private clientPromise: Promise>
+ private readonly untilAppReady: Promise
+
private readonly app: any
private quitHandlerAdded = false
@@ -28,12 +32,25 @@ export class NsisUpdater extends EventEmitter {
constructor(options?: PublishConfiguration | BintrayOptions | GithubOptions) {
super()
- this.app = (global).__test_app || require("electron").app
-
- if (options == null) {
- this.clientPromise = this.loadUpdateConfig()
+ if ((global).__test_app) {
+ this.app = (global).__test_app
+ this.untilAppReady = BluebirdPromise.resolve()
}
else {
+ this.app = require("electron").app
+ executorHolder.httpExecutor = new ElectronHttpExecutor()
+ this.untilAppReady = new BluebirdPromise((resolve, reject) => {
+ if (this.app.isReady()) {
+ resolve()
+ }
+ else {
+ this.app.on("ready", resolve)
+ }
+ })
+ }
+
+
+ if (options != null) {
this.setFeedURL(options)
}
}
@@ -47,15 +64,12 @@ export class NsisUpdater extends EventEmitter {
}
async checkForUpdates(): Promise {
- if (this.clientPromise == null) {
- const message = "Update URL is not set"
- const error = new Error(message)
- this.emit("error", error, message)
- throw error
- }
-
+ await this.untilAppReady
this.emit("checking-for-update")
try {
+ if (this.clientPromise == null) {
+ this.clientPromise = NsisUpdater.loadUpdateConfig()
+ }
return await this.doCheckForUpdates()
}
catch (e) {
@@ -145,7 +159,11 @@ export class NsisUpdater extends EventEmitter {
// prevent calling several times
this.quitAndInstallCalled = true
- spawn(setupPath, isSilent ? ["/S"] : [], {
+ const args = ["--updated"]
+ if (isSilent) {
+ args.push("/S")
+ }
+ spawn(setupPath, args, {
detached: true,
stdio: "ignore",
}).unref()
@@ -153,14 +171,8 @@ export class NsisUpdater extends EventEmitter {
return true
}
- async loadUpdateConfig() {
- try {
- return createClient(safeLoad(await readFile(path.join((global).__test_resourcesPath || (process).resourcesPath, "app-update.yml"), "utf-8")))
- }
- catch (e) {
- this.emit("error", e, (e.stack || e).toString())
- throw e
- }
+ private static async loadUpdateConfig() {
+ return createClient(safeLoad(await readFile(path.join((global).__test_resourcesPath || (process).resourcesPath, "app-update.yml"), "utf-8")))
}
}
@@ -168,13 +180,16 @@ function createClient(data: string | PublishConfiguration | BintrayOptions | Git
if (typeof data === "string") {
throw new Error("Please pass PublishConfiguration object")
}
- else {
- const provider = (data).provider
- switch (provider) {
- case "github": return new GitHubProvider(data)
- case "generic": return new GenericProvider(data)
- case "bintray": return new BintrayProvider(data)
- default: throw new Error(`Unsupported provider: ${provider}`)
- }
+
+ const provider = (data).provider
+ switch (provider) {
+ case "github":
+ return new GitHubProvider(data)
+ case "generic":
+ return new GenericProvider(data)
+ case "bintray":
+ return new BintrayProvider(data)
+ default:
+ throw new Error(`Unsupported provider: ${provider}`)
}
}
\ No newline at end of file
diff --git a/nsis-auto-updater/src/electronHttpExecutor.ts b/nsis-auto-updater/src/electronHttpExecutor.ts
new file mode 100644
index 00000000000..22d0ff87f9a
--- /dev/null
+++ b/nsis-auto-updater/src/electronHttpExecutor.ts
@@ -0,0 +1,222 @@
+import { Socket } from "net"
+import { net } from "electron"
+import { createWriteStream, ensureDir } from "fs-extra-p"
+import BluebirdPromise from "bluebird-lst-c"
+import * as path from "path"
+import { HttpExecutor, DownloadOptions, HttpError, DigestTransform } from "../../src/util/httpExecutor"
+import { Url } from "url"
+import { safeLoad } from "js-yaml"
+import _debug from "debug"
+import Debugger = debug.Debugger
+import { parse as parseUrl } from "url"
+
+export class ElectronHttpExecutor implements HttpExecutor {
+ private readonly debug: Debugger = _debug("electron-builder")
+
+ private readonly maxRedirects = 10
+
+ request(url: Url, token: string | null = null, data: {[name: string]: any; } | null = null, method: string = "GET"): Promise {
+ const options: any = Object.assign({
+ method: method,
+ headers: {
+ "User-Agent": "electron-builder"
+ }
+ }, url)
+
+ if (url.hostname!!.includes("github") && !url.path!.endsWith(".yml")) {
+ options.headers.Accept = "application/vnd.github.v3+json"
+ }
+
+ const encodedData = data == null ? undefined : new Buffer(JSON.stringify(data))
+ if (encodedData != null) {
+ options.method = "post"
+ options.headers["Content-Type"] = "application/json"
+ options.headers["Content-Length"] = encodedData.length
+ }
+ return this.doApiRequest(options, token, it => it.end(encodedData))
+ }
+
+ download(url: string, destination: string, options?: DownloadOptions | null): Promise {
+ return new BluebirdPromise( (resolve, reject) => {
+ this.doDownload(url, destination, 0, options || {}, (error: Error) => {
+ if (error == null) {
+ resolve(destination)
+ }
+ else {
+ reject(error)
+ }
+ })
+ })
+ }
+
+ private addTimeOutHandler(request: Electron.ClientRequest, callback: (error: Error) => void) {
+ request.on("socket", function (socket: Socket) {
+ socket.setTimeout(60 * 1000, () => {
+ callback(new Error("Request timed out"))
+ request.abort()
+ })
+ })
+ }
+
+ private doDownload(url: string, destination: string, redirectCount: number, options: DownloadOptions, callback: (error: Error | null) => void) {
+ const ensureDirPromise = options.skipDirCreation ? BluebirdPromise.resolve() : ensureDir(path.dirname(destination))
+
+ const parsedUrl = parseUrl(url)
+ // user-agent must be specified, otherwise some host can return 401 unauthorised
+
+ //FIXME hack, the electron typings specifies Protocol with capital but the code actually uses with small case
+ const requestOpts = {
+ protocol: parsedUrl.protocol,
+ hostname: parsedUrl.hostname,
+ path: parsedUrl.path,
+ headers: {
+ "User-Agent": "electron-builder"
+ },
+ }
+
+ const request = net.request(requestOpts, (response: Electron.IncomingMessage) => {
+ if (response.statusCode >= 400) {
+ callback(new Error(`Cannot download "${url}", status ${response.statusCode}: ${response.statusMessage}`))
+ return
+ }
+
+ const redirectUrl = this.safeGetHeader(response, "location")
+ if (redirectUrl != null) {
+ if (redirectCount < this.maxRedirects) {
+ this.doDownload(redirectUrl, destination, redirectCount++, options, callback)
+ }
+ else {
+ callback(new Error("Too many redirects (> " + this.maxRedirects + ")"))
+ }
+ return
+ }
+
+ const sha2Header = this.safeGetHeader(response, "X-Checksum-Sha2")
+ if (sha2Header != null && options.sha2 != null) {
+ // todo why bintray doesn't send this header always
+ if (sha2Header == null) {
+ throw new Error("checksum is required, but server response doesn't contain X-Checksum-Sha2 header")
+ }
+ else if (sha2Header !== options.sha2) {
+ throw new Error(`checksum mismatch: expected ${options.sha2} but got ${sha2Header} (X-Checksum-Sha2 header)`)
+ }
+ }
+
+ ensureDirPromise
+ .then(() => {
+ const fileOut = createWriteStream(destination)
+ if (options.sha2 == null) {
+ response.pipe(fileOut)
+ }
+ else {
+ response
+ .pipe(new DigestTransform(options.sha2))
+ .pipe(fileOut)
+ }
+
+ fileOut.on("finish", () => (fileOut.close)(callback))
+ })
+ .catch(callback)
+
+ let ended = false
+ response.on("end", () => {
+ ended = true
+ })
+
+ response.on("close", () => {
+ if (!ended) {
+ callback(new Error("Request aborted"))
+ }
+ })
+ })
+ this.addTimeOutHandler(request, callback)
+ request.on("error", callback)
+ request.end()
+ }
+
+ private safeGetHeader(response: Electron.IncomingMessage, headerKey: string) {
+ return response.headers[headerKey] ? response.headers[headerKey].pop() : null
+ }
+
+
+ doApiRequest(options: Electron.RequestOptions, token: string | null, requestProcessor: (request: Electron.ClientRequest, reject: (error: Error) => void) => void, redirectCount: number = 0): Promise {
+ const requestOptions: any = options
+ this.debug(`HTTPS request: ${JSON.stringify(requestOptions, null, 2)}`)
+
+ if (token != null) {
+ (requestOptions.headers).authorization = token.startsWith("Basic") ? token : `token ${token}`
+ }
+
+ requestOptions.protocol = "https:"
+ return new BluebirdPromise((resolve, reject, onCancel) => {
+ const request = net.request(options, (response: Electron.IncomingMessage) => {
+ try {
+ if (response.statusCode === 404) {
+ // error is clear, we don't need to read detailed error description
+ reject(new HttpError(response, `method: ${options.method} url: https://${options.hostname}${options.path}
+
+Please double check that your authentication token is correct. Due to security reasons actual status maybe not reported, but 404.
+`))
+ }
+ else if (response.statusCode === 204) {
+ // on DELETE request
+ resolve()
+ return
+ }
+
+ const redirectUrl = this.safeGetHeader(response, "location")
+ if (redirectUrl != null) {
+ if (redirectCount > 10) {
+ reject(new Error("Too many redirects (> 10)"))
+ return
+ }
+
+ if (options.path!.endsWith("/latest")) {
+ resolve({location: redirectUrl})
+ }
+ else {
+ this.doApiRequest(Object.assign({}, options, parseUrl(redirectUrl)), token, requestProcessor)
+ .then(resolve)
+ .catch(reject)
+ }
+ return
+ }
+
+ let data = ""
+ response.setEncoding("utf8")
+ response.on("data", (chunk: string) => {
+ data += chunk
+ })
+
+ response.on("end", () => {
+ try {
+ const contentType = response.headers["content-type"]
+ const isJson = contentType != null && contentType.includes("json")
+ if (response.statusCode >= 400) {
+ if (isJson) {
+ reject(new HttpError(response, JSON.parse(data)))
+ }
+ else {
+ reject(new HttpError(response))
+ }
+ }
+ else {
+ resolve(data.length === 0 ? null : (isJson || !options.path!.includes(".yml")) ? JSON.parse(data) : safeLoad(data))
+ }
+ }
+ catch (e) {
+ reject(e)
+ }
+ })
+ }
+ catch (e) {
+ reject(e)
+ }
+ })
+ this.addTimeOutHandler(request, reject)
+ request.on("error", reject)
+ requestProcessor(request, reject)
+ onCancel!(() => request.abort())
+ })
+ }
+}
\ No newline at end of file
diff --git a/nsis-auto-updater/tsconfig.json b/nsis-auto-updater/tsconfig.json
index ab901c69e6b..2022ac98c0c 100755
--- a/nsis-auto-updater/tsconfig.json
+++ b/nsis-auto-updater/tsconfig.json
@@ -24,11 +24,7 @@
"../typings/debug.d.ts",
"../node_modules/@types/node/index.d.ts",
"../node_modules/fs-extra-p/index.d.ts",
- "../node_modules/bluebird-lst-c/index.d.ts",
- "../src/util/httpRequest.ts",
- "../src/publish/restApiRequest.ts",
- "../src/publish/restApiRequest.ts",
- "../src/publish/bintray.ts"
+ "../node_modules/bluebird-lst-c/index.d.ts"
],
"include": [
"src/**/*.ts"
diff --git a/package.json b/package.json
index bee4294bdf0..77932296275 100644
--- a/package.json
+++ b/package.json
@@ -26,7 +26,7 @@
"update-wiki": "git subtree split -b wiki --prefix docs/ && git push -f wiki wiki:master",
"whitespace": "whitespace 'src/**/*.ts'",
"docker-images": "docker/build.sh",
- "precommit": "validate-commit-msg"
+ "test-deps-mac": "brew install rpm dpkg mono lzip gnu-tar graphicsmagick xz && brew install wine --without-x11"
},
"repository": "electron-userland/electron-builder",
"engines": {
@@ -49,7 +49,8 @@
"Windows",
"OS X",
"MacOS",
- "Mac"
+ "Mac",
+ "appx"
],
"author": "Stefan Judis",
"license": "MIT",
@@ -58,26 +59,26 @@
"dependencies": {
"7zip-bin": "^2.0.4",
"ansi-escapes": "^1.4.0",
- "archiver": "^1.2.0",
- "archiver-utils": "^1.3.0",
+ "archiver": "^1.3.0",
"asar-electron-builder": "^0.13.5",
"bluebird-lst-c": "^1.0.5",
"chalk": "^1.1.3",
"chromium-pickle-js": "^0.2.0",
"cli-cursor": "^1.0.2",
"cuint": "^0.2.2",
- "debug": "^2.3.3",
+ "debug": "2.5.1",
"electron-download-tf": "3.1.0",
"electron-macos-sign": "^1.3.4",
- "fs-extra-p": "^2.0.7",
+ "fs-extra-p": "^3.0.3",
"hosted-git-info": "^2.1.5",
"ini": "^1.3.4",
+ "is-ci": "^1.0.10",
"isbinaryfile": "^3.0.1",
"js-yaml": "^3.7.0",
"lodash.template": "^4.4.0",
"mime": "^1.3.4",
"minimatch": "^3.0.3",
- "node-emoji": "^1.4.1",
+ "node-emoji": "^1.4.3",
"normalize-package-data": "^2.3.5",
"parse-color": "^1.0.0",
"plist": "^2.0.1",
@@ -88,59 +89,35 @@
"sanitize-filename": "^1.6.1",
"semver": "^5.3.0",
"source-map-support": "^0.4.6",
+ "stat-mode": "^0.2.2",
"tunnel-agent": "^0.4.3",
- "update-notifier": "^1.0.2",
+ "update-notifier": "^1.0.3",
"uuid-1345": "^0.99.6",
- "yargs": "^6.4.0"
+ "yargs": "^6.5.0"
},
"devDependencies": {
- "@develar/semantic-release": "^6.3.21",
+ "@develar/semantic-release": "^6.3.26",
+ "@types/electron": "^1.4.30",
"@types/ini": "^1.3.29",
- "@types/jest": "^16.0.0",
- "@types/js-yaml": "^3.5.28",
+ "@types/jest": "^16.0.2",
+ "@types/js-yaml": "^3.5.29",
"@types/source-map-support": "^0.2.28",
"babel-plugin-array-includes": "^2.0.3",
"babel-plugin-transform-async-to-module-method": "^6.16.0",
"babel-plugin-transform-es2015-destructuring": "^6.19.0",
- "babel-plugin-transform-es2015-parameters": "^6.18.0",
+ "babel-plugin-transform-es2015-parameters": "^6.21.0",
"babel-plugin-transform-es2015-spread": "^6.8.0",
"babel-plugin-transform-inline-imports-commonjs": "^1.2.0",
"decompress-zip": "^0.3.0",
- "depcheck": "^0.6.5",
- "diff": "^3.0.1",
- "husky": "^0.11.9",
- "jest-cli": "^17.0.3",
- "json8": "^0.9.2",
+ "depcheck": "^0.6.7",
+ "jest-cli": "^18.0.0",
+ "jest-environment-node-debug": "^0.0.2",
"path-sort": "^0.1.0",
- "ts-babel": "^1.1.4",
- "tslint": "4.0.0-dev.1",
- "typescript": "^2.1.1",
- "validate-commit-msg": "^2.8.2",
+ "ts-babel": "^1.2.2",
+ "tslint": "^4.1.1",
+ "typescript": "^2.1.4",
"whitespace": "^2.1.0"
},
- "babel": {
- "plugins": [
- [
- "transform-async-to-module-method",
- {
- "module": "bluebird-lst-c",
- "method": "coroutine"
- }
- ],
- "transform-es2015-parameters",
- "transform-es2015-spread",
- "transform-es2015-destructuring",
- "array-includes",
- [
- "transform-inline-imports-commonjs",
- {
- "excludeModules": [
- "path"
- ]
- }
- ]
- ]
- },
"jest": {
"testEnvironment": "node",
"testPathDirs": [
@@ -153,10 +130,7 @@
"modulePaths": [
""
],
- "setupTestFrameworkScriptFile": "test/jestSetup.js"
- },
- "release": {
- "verifyConditions": []
+ "setupTestFrameworkScriptFile": "/test/jestSetup.js"
},
"typings": "./out/electron-builder.d.ts",
"publishConfig": {
diff --git a/src/appInfo.ts b/src/appInfo.ts
index 8b9a686718f..7db028c4d55 100644
--- a/src/appInfo.ts
+++ b/src/appInfo.ts
@@ -1,4 +1,4 @@
-import { DevMetadata, AppMetadata } from "./metadata"
+import { DevMetadata, AppMetadata, BuildMetadata } from "./metadata"
import { warn } from "./util/log"
import { smarten } from "./platformPackager"
import { isEmptyOrSpaces } from "./util/util"
@@ -15,10 +15,14 @@ export class AppInfo {
readonly productName: string
readonly productFilename: string
+ private get config(): BuildMetadata {
+ return this.devMetadata.build
+ }
+
constructor(public metadata: AppMetadata, private devMetadata: DevMetadata, buildVersion?: string | null) {
this.version = metadata.version!
- this.buildNumber = (this.devMetadata.build)["build-version"] || process.env.TRAVIS_BUILD_NUMBER || process.env.APPVEYOR_BUILD_NUMBER || process.env.CIRCLE_BUILD_NUM || process.env.BUILD_NUMBER
+ this.buildNumber = (this.config)["build-version"] || process.env.TRAVIS_BUILD_NUMBER || process.env.APPVEYOR_BUILD_NUMBER || process.env.CIRCLE_BUILD_NUM || process.env.BUILD_NUMBER
if (isEmptyOrSpaces(buildVersion)) {
buildVersion = this.version
@@ -31,7 +35,7 @@ export class AppInfo {
this.buildVersion = buildVersion!
}
- this.productName = getProductName(this.metadata, this.devMetadata)
+ this.productName = this.config.productName || metadata.productName || metadata.name
this.productFilename = sanitizeFileName(this.productName)
}
@@ -45,13 +49,13 @@ export class AppInfo {
}
get id(): string {
- let appId = this.devMetadata.build["app-bundle-id"]
+ let appId = this.config["app-bundle-id"]
if (appId != null) {
warn("app-bundle-id is deprecated, please use appId")
}
- if (this.devMetadata.build.appId != null) {
- appId = this.devMetadata.build.appId
+ if (this.config.appId != null) {
+ appId = this.config.appId
}
const generateDefaultAppId = () => {
@@ -72,7 +76,7 @@ export class AppInfo {
}
get copyright(): string {
- const copyright = this.devMetadata.build.copyright
+ const copyright = this.config.copyright
if (copyright != null) {
return copyright
}
@@ -80,19 +84,12 @@ export class AppInfo {
}
async computePackageUrl(): Promise {
- const url = this.metadata.homepage || this.devMetadata.homepage
+ const url = this.metadata.homepage
if (url != null) {
return url
}
const info = await getRepositoryInfo(this.metadata, this.devMetadata)
- if (info != null) {
- return `https://github.com/${info.user}/${info.project}`
- }
- return null
+ return info == null ? null : `https://github.com/${info.user}/${info.project}`
}
-}
-
-function getProductName(metadata: AppMetadata, devMetadata: DevMetadata) {
- return devMetadata.build.productName || metadata.productName || metadata.name
}
\ No newline at end of file
diff --git a/src/asarUtil.ts b/src/asarUtil.ts
index 7b4ad9dd677..5d12dbfd0e2 100644
--- a/src/asarUtil.ts
+++ b/src/asarUtil.ts
@@ -1,80 +1,24 @@
import { AsarFileInfo, listPackage, statFile, AsarOptions } from "asar-electron-builder"
-import { statOrNull, debug } from "./util/util"
-import {
- lstat, readdir, readFile, Stats, createWriteStream, ensureDir, createReadStream, readJson,
- writeFile, realpath
-} from "fs-extra-p"
+import { debug } from "./util/util"
+import { readFile, Stats, createWriteStream, ensureDir, createReadStream, readJson, writeFile, realpath } from "fs-extra-p"
import BluebirdPromise from "bluebird-lst-c"
import * as path from "path"
import { log } from "./util/log"
-import { Minimatch } from "minimatch"
import { deepAssign } from "./util/deepAssign"
-import { Filter } from "./util/filter"
+import { walk, statOrNull, CONCURRENCY, MAX_FILE_REQUESTS, Filter, FileCopier } from "./util/fs"
const isBinaryFile: any = BluebirdPromise.promisify(require("isbinaryfile"))
const pickle = require ("chromium-pickle-js")
const Filesystem = require("asar-electron-builder/lib/filesystem")
const UINT64 = require("cuint").UINT64
-const MAX_FILE_REQUESTS = 8
-const concurrency = {concurrency: MAX_FILE_REQUESTS}
const NODE_MODULES_PATTERN = path.sep + "node_modules" + path.sep
-export async function walk(initialDirPath: string, consumer?: (file: string, stat: Stats) => void, filter?: Filter): Promise> {
- const result: Array = []
- const queue: Array = [initialDirPath]
- let addDirToResult = false
- while (queue.length > 0) {
- const dirPath = queue.pop()!
- if (addDirToResult) {
- result.push(dirPath)
- }
- else {
- addDirToResult = true
- }
-
- const childNames = await readdir(dirPath)
- childNames.sort()
-
- const dirs: Array = []
- await BluebirdPromise.map(childNames, name => {
- const filePath = dirPath + path.sep + name
- return lstat(filePath)
- .then(stat => {
- if (filter != null && !filter(filePath, stat)) {
- return
- }
-
- if (consumer != null) {
- consumer(filePath, stat)
- }
-
- if (stat.isDirectory()) {
- dirs.push(filePath)
- }
- else {
- result.push(filePath)
- }
- })
- }, concurrency)
-
- for (let i = dirs.length - 1; i > -1; i--) {
- queue.push(dirs[i])
- }
- }
-
- return result
-}
-
export async function createAsarArchive(src: string, resourcesPath: string, options: AsarOptions, filter: Filter, unpackPattern: Filter | null): Promise {
// sort files to minimize file change (i.e. asar file is not changed dramatically on small change)
await new AsarPackager(src, resourcesPath, options, unpackPattern).pack(filter)
}
-function isUnpackDir(path: string, pattern: Minimatch, rawPattern: string): boolean {
- return path.startsWith(rawPattern) || pattern.match(path)
-}
-
function addValue(map: Map>, key: string, value: string) {
let list = map.get(key)
if (list == null) {
@@ -86,6 +30,24 @@ function addValue(map: Map>, key: string, value: string) {
}
}
+interface UnpackedFileTask {
+ stats: Stats
+ src?: string
+ data?: string
+ destination: string
+}
+
+function writeUnpackedFiles(filesToUnpack: Array, fileCopier: FileCopier): Promise {
+ return BluebirdPromise.map(filesToUnpack, it => {
+ if (it.data == null) {
+ return fileCopier.copy(it.src!, it.destination, it.stats)
+ }
+ else {
+ return writeFile(it.destination, it.data)
+ }
+ })
+}
+
class AsarPackager {
private readonly toPack: Array = []
private readonly fs = new Filesystem(this.src)
@@ -94,16 +56,13 @@ class AsarPackager {
private srcRealPath: Promise
- constructor(private readonly src: string, private readonly resourcesPath: string, private readonly options: AsarOptions, private readonly unpackPattern: Filter | null) {
- this.outFile = path.join(this.resourcesPath, "app.asar")
+ constructor(private readonly src: string, destination: string, private readonly options: AsarOptions, private readonly unpackPattern: Filter | null) {
+ this.outFile = path.join(destination, "app.asar")
}
async pack(filter: Filter) {
const metadata = new Map()
- const files = await walk(this.src, (it, stat) => {
- metadata.set(it, stat)
- }, filter)
-
+ const files = await walk(this.src, filter, (it, stat) => metadata.set(it, stat))
await this.createPackageFromFiles(this.options.ordering == null ? files : await this.order(files), metadata)
await this.writeAsarFile()
}
@@ -119,6 +78,7 @@ class AsarPackager {
const packageJsonStringLength = "package.json".length
const dirToCreate = new Map>()
+ /* tslint:disable:rule1 prefer-const */
for (let i = 0, n = files.length; i < n; i++) {
const file = files[i]
const index = file.lastIndexOf(NODE_MODULES_PATTERN)
@@ -138,7 +98,7 @@ class AsarPackager {
const nodeModuleDir = file.substring(0, nextSlashIndex)
if (file.length === (nodeModuleDir.length + 1 + packageJsonStringLength) && file.endsWith("package.json")) {
- fileIndexToModulePackageData.set(i, readJson(file).then(it => cleanupPackageJson(it)))
+ fileIndexToModulePackageData.set(i, >readJson(file).then(it => cleanupPackageJson(it)))
}
if (autoUnpackDirs.has(nodeModuleDir)) {
@@ -187,39 +147,31 @@ class AsarPackager {
const base = path.join(unpackedDest, it)
await ensureDir(base)
await BluebirdPromise.each(dirToCreate.get(it)!, it => ensureDir(path.join(base, it)))
- }, concurrency)
+ }, CONCURRENCY)
}
}
async createPackageFromFiles(files: Array, metadata: Map) {
// search auto unpacked dir
- const autoUnpackDirs = new Set()
+ const unpackedDirs = new Set()
const unpackedDest = `${this.outFile}.unpacked`
const fileIndexToModulePackageData = new Map>()
+ await ensureDir(path.dirname(this.outFile))
+
if (this.options.smartUnpack !== false) {
- await this.detectUnpackedDirs(files, metadata, autoUnpackDirs, unpackedDest, fileIndexToModulePackageData)
+ await this.detectUnpackedDirs(files, metadata, unpackedDirs, unpackedDest, fileIndexToModulePackageData)
}
- const unpackDir = this.options.unpackDir == null ? null : new Minimatch(this.options.unpackDir)
- const unpack = this.options.unpack == null ? null : new Minimatch(this.options.unpack, {
- matchBase: true
- })
-
- const createDirPromises: Array> = [ensureDir(path.dirname(this.outFile))]
- const copyPromises: Array> = []
+ const filesToUnpack: Array = []
const mainPackageJson = path.join(this.src, "package.json")
+ const fileCopier = new FileCopier()
+ /* tslint:disable:rule1 prefer-const */
for (let i = 0, n = files.length; i < n; i++) {
const file = files[i]
const stat = metadata.get(file)!
if (stat.isFile()) {
const fileParent = path.dirname(file)
const dirNode = this.fs.searchNodeFromPath(fileParent)
-
- if (dirNode.unpacked && createDirPromises.length > 0) {
- await BluebirdPromise.all(createDirPromises)
- createDirPromises.length = 0
- }
-
const packageDataPromise = fileIndexToModulePackageData.get(i)
let newData: any | null = null
if (packageDataPromise == null) {
@@ -234,26 +186,19 @@ class AsarPackager {
const fileSize = newData == null ? stat.size : Buffer.byteLength(newData)
const node = this.fs.searchNodeFromPath(file)
node.size = fileSize
- if (dirNode.unpacked || (this.unpackPattern != null && this.unpackPattern(file, stat)) || (unpack != null && unpack.match(file))) {
+ if (dirNode.unpacked || (this.unpackPattern != null && this.unpackPattern(file, stat))) {
node.unpacked = true
- if (!dirNode.unpacked) {
- const promise = ensureDir(path.join(unpackedDest, path.relative(this.src, fileParent)))
- if (createDirPromises.length === 0) {
- await createDirPromises
- }
- else {
- createDirPromises.push(promise)
- await BluebirdPromise.all(createDirPromises)
- createDirPromises.length = 0
- }
+ if (!dirNode.unpacked && !unpackedDirs.has(fileParent)) {
+ unpackedDirs.add(fileParent)
+ await ensureDir(fileParent.replace(this.src, unpackedDest))
}
- const unpackedFile = path.join(unpackedDest, path.relative(this.src, file))
- copyPromises.push(newData == null ? copyFile(file, unpackedFile, stat) : writeFile(unpackedFile, newData))
- if (copyPromises.length > MAX_FILE_REQUESTS) {
- await BluebirdPromise.all(copyPromises)
- copyPromises.length = 0
+ const unpackedFile = file.replace(this.src, unpackedDest)
+ filesToUnpack.push(newData == null ? {src: file, destination: unpackedFile, stats: stat} : {destination: unpackedFile, data: newData, stats: stat})
+ if (filesToUnpack.length > MAX_FILE_REQUESTS) {
+ await writeUnpackedFiles(filesToUnpack, fileCopier)
+ filesToUnpack.length = 0
}
}
else {
@@ -276,24 +221,18 @@ class AsarPackager {
}
else if (stat.isDirectory()) {
let unpacked = false
- if (autoUnpackDirs.has(file)) {
+ if (unpackedDirs.has(file)) {
unpacked = true
}
else {
- unpacked = unpackDir != null && isUnpackDir(path.relative(this.src, file), unpackDir, this.options.unpackDir!)
- if (unpacked) {
- createDirPromises.push(ensureDir(path.join(unpackedDest, path.relative(this.src, file))))
- }
- else {
- for (let d of autoUnpackDirs) {
- if (file.length > (d.length + 2) && file[d.length] === path.sep && file.startsWith(d)) {
- unpacked = true
- autoUnpackDirs.add(file)
- // not all dirs marked as unpacked after first iteration - because node module dir can be marked as unpacked after processing node module dir content
- // e.g. node-notifier/example/advanced.js processed, but only on process vendor/terminal-notifier.app module will be marked as unpacked
- createDirPromises.push(ensureDir(path.join(unpackedDest, path.relative(this.src, file))))
- break
- }
+ for (const dir of unpackedDirs) {
+ if (file.length > (dir.length + 2) && file[dir.length] === path.sep && file.startsWith(dir)) {
+ unpacked = true
+ unpackedDirs.add(file)
+ // not all dirs marked as unpacked after first iteration - because node module dir can be marked as unpacked after processing node module dir content
+ // e.g. node-notifier/example/advanced.js processed, but only on process vendor/terminal-notifier.app module will be marked as unpacked
+ await ensureDir(file.replace(this.src, unpackedDest))
+ break
}
}
}
@@ -304,8 +243,8 @@ class AsarPackager {
}
}
- if (copyPromises.length > 0) {
- await BluebirdPromise.all(copyPromises)
+ if (filesToUnpack.length > 0) {
+ await writeUnpackedFiles(filesToUnpack, fileCopier)
}
}
@@ -362,7 +301,7 @@ class AsarPackager {
})
}
- async order(filenames: Array) {
+ private async order(filenames: Array) {
const orderingFiles = (await readFile(this.options.ordering!, "utf8")).split("\n").map(line => {
if (line.indexOf(":") !== -1) {
line = line.split(":").pop()!
@@ -375,10 +314,10 @@ class AsarPackager {
})
const ordering: Array = []
- for (let file of orderingFiles) {
- let pathComponents = file.split(path.sep)
+ for (const file of orderingFiles) {
+ const pathComponents = file.split(path.sep)
let str = this.src
- for (let pathComponent of pathComponents) {
+ for (const pathComponent of pathComponents) {
str = path.join(str, pathComponent)
ordering.push(str)
}
@@ -387,12 +326,12 @@ class AsarPackager {
const filenamesSorted: Array = []
let missing = 0
const total = filenames.length
- for (let file of ordering) {
+ for (const file of ordering) {
if (!filenamesSorted.includes(file) && filenames.includes(file)) {
filenamesSorted.push(file)
}
}
- for (let file of filenames) {
+ for (const file of filenames) {
if (!filenamesSorted.includes(file)) {
filenamesSorted.push(file)
missing += 1
@@ -406,7 +345,7 @@ class AsarPackager {
function cleanupPackageJson(data: any): any {
try {
let changed = false
- for (let prop of Object.getOwnPropertyNames(data)) {
+ for (const prop of Object.getOwnPropertyNames(data)) {
if (prop[0] === "_" || prop === "dist" || prop === "gitHead" || prop === "keywords") {
delete data[prop]
changed = true
@@ -457,19 +396,3 @@ export async function checkFileInArchive(asarFile: string, relativeFile: string,
throw error(`is corrupted: size 0`)
}
}
-
-function copyFile(src: string, dest: string, stats: Stats) {
- return new BluebirdPromise(function (resolve, reject) {
- const readStream = createReadStream(src)
- const writeStream = createWriteStream(dest, {mode: stats.mode})
-
- readStream.on("error", reject)
- writeStream.on("error", reject)
-
- writeStream.on("open", function () {
- readStream.pipe(writeStream)
- })
-
- writeStream.once("finish", resolve)
- })
-}
\ No newline at end of file
diff --git a/src/builder.ts b/src/builder.ts
index 0f0f0c4ea17..e63c2b23938 100644
--- a/src/builder.ts
+++ b/src/builder.ts
@@ -4,12 +4,13 @@ import { PublishOptions, Publisher } from "./publish/publisher"
import { GitHubPublisher } from "./publish/gitHubPublisher"
import { executeFinally } from "./util/promise"
import BluebirdPromise from "bluebird-lst-c"
-import { isEmptyOrSpaces, isCi, debug } from "./util/util"
+import { isEmptyOrSpaces, debug } from "./util/util"
import { log } from "./util/log"
import { Platform, Arch, archFromString } from "./metadata"
import { DIR_TARGET } from "./targets/targetFactory"
import { BintrayPublisher } from "./publish/BintrayPublisher"
import { PublishConfiguration, GithubOptions, BintrayOptions } from "./options/publishOptions"
+import isCi from "is-ci"
export interface BuildOptions extends PackagerOptions, PublishOptions {
}
@@ -82,14 +83,14 @@ export function normalizeOptions(args: CliOptions): BuildOptions {
archToType.set(Arch.x64, defaultTargetValue)
}
else {
- for (let arch of commonArch()) {
+ for (const arch of commonArch()) {
archToType.set(arch, defaultTargetValue)
}
}
return
}
- for (let type of types) {
+ for (const type of types) {
let arch: string
if (platform === Platform.MAC) {
arch = "x64"
@@ -101,7 +102,7 @@ export function normalizeOptions(args: CliOptions): BuildOptions {
addValue(archToType, archFromString(type.substring(suffixPos + 1)), type.substring(0, suffixPos))
}
else {
- for (let arch of commonArch()) {
+ for (const arch of commonArch()) {
addValue(archToType, arch, type)
}
}
@@ -162,12 +163,12 @@ export function normalizeOptions(args: CliOptions): BuildOptions {
export function createTargets(platforms: Array, type?: string | null, arch?: string | null): Map>> {
const targets = new Map>>()
- for (let platform of platforms) {
+ for (const platform of platforms) {
const archs = platform === Platform.MAC ? [Arch.x64] : (arch === "all" ? [Arch.x64, Arch.ia32] : [archFromString(arch == null ? process.arch : arch)])
const archToType = new Map>()
targets.set(platform, archToType)
- for (let arch of archs) {
+ for (const arch of archs) {
archToType.set(arch, type == null ? [] : [type])
}
}
@@ -209,7 +210,7 @@ export async function build(rawOptions?: CliOptions): Promise> {
options.publish = "onTag"
isPublishOptionGuessed = true
}
- else if (isCi()) {
+ else if (isCi) {
log("CI detected, so artifacts will be published if draft release exists")
options.publish = "onTagOrDraft"
isPublishOptionGuessed = true
@@ -225,7 +226,7 @@ export async function build(rawOptions?: CliOptions): Promise> {
if (isAuthTokenSet()) {
publishManager(packager, publishTasks, options, isPublishOptionGuessed)
}
- else if (isCi()) {
+ else if (isCi) {
log(`CI detected, publish is set to ${options.publish}, but neither GH_TOKEN nor BT_TOKEN is not set, so artifacts will be not published`)
}
}
@@ -239,7 +240,7 @@ export async function build(rawOptions?: CliOptions): Promise> {
return await executeFinally(packager.build().then(() => artifactPaths), errorOccurred => {
if (errorOccurred) {
- for (let task of publishTasks) {
+ for (const task of publishTasks) {
task!.cancel()
}
return BluebirdPromise.resolve(null)
@@ -274,7 +275,7 @@ function publishManager(packager: Packager, publishTasks: Array {
const notifier = updateNotifier({pkg: it})
diff --git a/src/cli/create-self-signed-cert.ts b/src/cli/create-self-signed-cert.ts
index cc263358828..4cf33fc69fe 100644
--- a/src/cli/create-self-signed-cert.ts
+++ b/src/cli/create-self-signed-cert.ts
@@ -1,11 +1,12 @@
import yargs from "yargs"
import { printErrorAndExit } from "../util/promise"
-import { exec, spawn, unlinkIfExists } from "../util/util"
+import { exec, spawn } from "../util/util"
import { getSignVendorPath } from "../windowsCodeSign"
import * as path from "path"
import sanitizeFileName from "sanitize-filename"
import { log } from "../util/log"
import { TmpDir } from "../util/tmp"
+import { unlinkIfExists } from "../util/fs"
async function main() {
const args: any = yargs
@@ -15,7 +16,7 @@ async function main() {
const tmpDir = new TmpDir()
const targetDir = process.cwd()
- const tempPrefix = path.join(await tmpDir.getTempFile(null), sanitizeFileName(args.publisher))
+ const tempPrefix = path.join(await tmpDir.getTempFile(""), sanitizeFileName(args.publisher))
const cer = `${tempPrefix}.cer`
const pvk = `${tempPrefix}.pvk`
@@ -31,7 +32,7 @@ async function main() {
log(`${pfx} created. Please see https://github.com/electron-userland/electron-builder/wiki/Code-Signing how do use it to sign.`)
const certLocation = "Cert:\\LocalMachine\\TrustedPeople"
- log(`${pfx} will be imported into ${certLocation} Operation will be succeded only if runned from root. Otherwise import file manually.`)
+ log(`${pfx} will be imported into ${certLocation} Operation will be succeed only if runned from root. Otherwise import file manually.`)
await spawn("powershell.exe", ["Import-PfxCertificate", "-FilePath", `"${pfx}"`, "-CertStoreLocation", ""])
tmpDir.cleanup()
}
diff --git a/src/cli/install-app-deps.ts b/src/cli/install-app-deps.ts
index 9e8c08d0c8c..79353635a76 100644
--- a/src/cli/install-app-deps.ts
+++ b/src/cli/install-app-deps.ts
@@ -1,5 +1,5 @@
#! /usr/bin/env node
-import { computeDefaultAppDirectory, getElectronVersion, use } from "../util/util"
+import { computeDefaultAppDirectory, getElectronVersion, use, getDirectoriesConfig } from "../util/util"
import { printErrorAndExit } from "../util/promise"
import * as path from "path"
import BluebirdPromise from "bluebird-lst-c"
@@ -10,21 +10,27 @@ import { installOrRebuild } from "../yarn"
async function main() {
const args: any = yargs
+ .option("platform", {
+ choices: ["linux", "darwin", "win32"],
+ default: process.platform,
+ })
.option("arch", {
choices: ["ia32", "x64", "all"],
- }).argv
+ default: process.arch,
+ })
+ .argv
const projectDir = process.cwd()
const devPackageFile = path.join(projectDir, "package.json")
const devMetadata: DevMetadata = await readPackageJson(devPackageFile)
const results: Array = await BluebirdPromise.all([
- computeDefaultAppDirectory(projectDir, use(devMetadata.directories, it => it!.app)),
+ computeDefaultAppDirectory(projectDir, use(getDirectoriesConfig(devMetadata), it => it!.app)),
getElectronVersion(devMetadata, devPackageFile)
])
// if two package.json — force full install (user wants to install/update app deps in addition to dev)
- await installOrRebuild(devMetadata.build, results[0], results[1], args.arch, process.platform, results[0] !== projectDir)
+ await installOrRebuild(devMetadata.build, results[0], results[1], args.platform, args.arch, results[0] !== projectDir)
}
main()
diff --git a/src/cli/node-gyp-rebuild.ts b/src/cli/node-gyp-rebuild.ts
index 97b85465bfc..1a91423e455 100644
--- a/src/cli/node-gyp-rebuild.ts
+++ b/src/cli/node-gyp-rebuild.ts
@@ -8,18 +8,22 @@ import { log } from "../util/log"
import { getGypEnv } from "../yarn"
const args: any = yargs
+ .option("platform", {
+ choices: ["linux", "darwin", "win32"],
+ default: process.platform,
+ })
.option("arch", {
choices: ["ia32", "x64", "armv7l"],
+ default: process.arch,
}).argv
const projectDir = process.cwd()
const devPackageFile = path.join(projectDir, "package.json")
async function main() {
- const arch = args.arch || process.arch
- log(`Execute node-gyp rebuild for arch ${arch}`)
+ log(`Execute node-gyp rebuild for ${args.platform}:${args.arch}`)
await exec(process.platform === "win32" ? "node-gyp.cmd" : "node-gyp", ["rebuild"], {
- env: getGypEnv(await getElectronVersion(await readPackageJson(devPackageFile), devPackageFile), arch, process.platform),
+ env: getGypEnv(await getElectronVersion(await readPackageJson(devPackageFile), devPackageFile), args.platform, args.arch, true),
})
}
diff --git a/src/codeSign.ts b/src/codeSign.ts
index f9577d0601f..fdebaf92fb4 100644
--- a/src/codeSign.ts
+++ b/src/codeSign.ts
@@ -1,4 +1,4 @@
-import { exec, getTempName, isEmptyOrSpaces, isCi, getCacheDirectory, statOrNull } from "./util/util"
+import { exec, getTempName, isEmptyOrSpaces, getCacheDirectory } from "./util/util"
import { deleteFile, outputFile, copy, rename } from "fs-extra-p"
import { download } from "./util/httpRequest"
import * as path from "path"
@@ -7,6 +7,8 @@ import BluebirdPromise from "bluebird-lst-c"
import { randomBytes } from "crypto"
import { TmpDir } from "./util/tmp"
import { homedir } from "os"
+import { statOrNull } from "./util/fs"
+import isCi from "is-ci"
export const appleCertificatePrefixes = ["Developer ID Application:", "Developer ID Installer:", "3rd Party Mac Developer Application:", "3rd Party Mac Developer Installer:"]
@@ -68,7 +70,7 @@ async function createCustomCertKeychain() {
const list = results[0]
.split("\n")
.map(it => {
- let r = it.trim()
+ const r = it.trim()
return r.substring(1, r.length - 1)
})
.filter(it => it.length > 0)
@@ -140,7 +142,7 @@ async function getValidIdentities(keychain?: string | null): Promise>([
exec("security", addKeychain(["find-identity", "-v"]))
.then(it => it.trim().split("\n").filter(it => {
- for (let prefix of appleCertificatePrefixes) {
+ for (const prefix of appleCertificatePrefixes) {
if (it.includes(prefix)) {
return true
}
@@ -170,7 +172,7 @@ async function _findIdentity(type: CertType, qualifier?: string | null, keychain
//noinspection SpellCheckingInspection
const lines = await getValidIdentities(keychain)
const namePrefix = `${type}:`
- for (let line of lines) {
+ for (const line of lines) {
if (qualifier != null && !line.includes(qualifier)) {
continue
}
@@ -183,7 +185,7 @@ async function _findIdentity(type: CertType, qualifier?: string | null, keychain
if (type === "Developer ID Application") {
// find non-Apple certificate
// https://github.com/electron-userland/electron-builder/issues/458
- l: for (let line of lines) {
+ l: for (const line of lines) {
if (qualifier != null && !line.includes(qualifier)) {
continue
}
@@ -192,7 +194,7 @@ async function _findIdentity(type: CertType, qualifier?: string | null, keychain
continue
}
- for (let prefix of appleCertificatePrefixes) {
+ for (const prefix of appleCertificatePrefixes) {
if (line.includes(prefix)) {
continue l
}
@@ -207,7 +209,7 @@ async function _findIdentity(type: CertType, qualifier?: string | null, keychain
export async function findIdentity(certType: CertType, qualifier?: string | null, keychain?: string | null): Promise {
let identity = process.env.CSC_NAME || qualifier
if (isEmptyOrSpaces(identity)) {
- if (keychain == null && !isCi() && (process.env.CSC_IDENTITY_AUTO_DISCOVERY === "false")) {
+ if (keychain == null && !isCi && process.env.CSC_IDENTITY_AUTO_DISCOVERY === "false") {
return null
}
else {
@@ -216,7 +218,7 @@ export async function findIdentity(certType: CertType, qualifier?: string | null
}
else {
identity = identity.trim()
- for (let prefix of appleCertificatePrefixes) {
+ for (const prefix of appleCertificatePrefixes) {
checkPrefix(identity, prefix)
}
const result = await _findIdentity(certType, identity, keychain)
diff --git a/src/fileMatcher.ts b/src/fileMatcher.ts
index 355f9c28a0d..a061e04c46d 100644
--- a/src/fileMatcher.ts
+++ b/src/fileMatcher.ts
@@ -1,7 +1,8 @@
import * as path from "path"
-import { createFilter, hasMagic, Filter } from "./util/filter"
+import { createFilter, hasMagic } from "./util/filter"
import { Minimatch } from "minimatch"
import { asArray } from "./util/util"
+import { Filter } from "./util/fs"
export interface FilePattern {
from?: string
@@ -30,10 +31,19 @@ export class FileMatcher {
this.patterns.push(pattern)
}
+ addAllPattern() {
+ // must be first, see minimatchAll implementation
+ this.patterns.unshift("**/*")
+ }
+
isEmpty() {
return this.patterns.length === 0
}
+ containsOnlyIgnore(): boolean {
+ return !this.isEmpty() && this.patterns.find(it => !it.startsWith("!")) == null
+ }
+
getParsedPatterns(fromDir?: string): Array {
// https://github.com/electron-userland/electron-builder/issues/733
const minimatchOptions = {dot: true}
@@ -41,9 +51,9 @@ export class FileMatcher {
const parsedPatterns: Array = []
const pathDifference = fromDir ? path.relative(fromDir, this.from) : null
- for (let i = 0; i < this.patterns.length; i++) {
- let expandedPattern = this.expandPattern(this.patterns[i])
- if (pathDifference) {
+ for (const p of this.patterns) {
+ let expandedPattern = this.expandPattern(p)
+ if (pathDifference != null) {
expandedPattern = path.join(pathDifference, expandedPattern)
}
@@ -72,10 +82,10 @@ export class FileMatcher {
}
}
-export function deprecatedUserIgnoreFilter(ignore: any, appDir: string) {
+export function deprecatedUserIgnoreFilter(ignore: Array | ((file: string) => boolean), appDir: string) {
let ignoreFunc: any
- if (typeof (ignore) === "function") {
- ignoreFunc = function (file: string) { return !ignore(file) }
+ if (typeof ignore === "function") {
+ ignoreFunc = function (file: string) { return !(ignore)(file) }
}
else {
if (!Array.isArray(ignore)) {
@@ -83,8 +93,8 @@ export function deprecatedUserIgnoreFilter(ignore: any, appDir: string) {
}
ignoreFunc = function (file: string) {
- for (let i = 0; i < ignore.length; i++) {
- if (file.match(ignore[i])) {
+ for (const i of >ignore) {
+ if (file.match(i)) {
return false
}
}
diff --git a/src/linuxPackager.ts b/src/linuxPackager.ts
index 96943a5955a..d9299babb7b 100755
--- a/src/linuxPackager.ts
+++ b/src/linuxPackager.ts
@@ -16,7 +16,7 @@ export class LinuxPackager extends PlatformPackager {
constructor(info: BuildInfo) {
super(info)
- let executableName = this.platformSpecificBuildOptions.executableName
+ const executableName = this.platformSpecificBuildOptions.executableName
this.executableName = sanitizeFileName(executableName == null ? this.appInfo.name : executableName).toLowerCase()
}
@@ -44,7 +44,7 @@ export class LinuxPackager extends PlatformPackager {
return helper
}
- for (let name of targets) {
+ for (const name of targets) {
if (name === DIR_TARGET) {
continue
}
diff --git a/src/macPackager.ts b/src/macPackager.ts
index b68219bd612..58e6bfdbfe2 100644
--- a/src/macPackager.ts
+++ b/src/macPackager.ts
@@ -32,11 +32,11 @@ export default class MacPackager extends PlatformPackager {
}
protected prepareAppInfo(appInfo: AppInfo): AppInfo {
- return new AppInfo(appInfo.metadata, this.devMetadata, this.platformSpecificBuildOptions.bundleVersion)
+ return new AppInfo(appInfo.metadata, this.info.devMetadata, this.platformSpecificBuildOptions.bundleVersion)
}
async getIconPath(): Promise {
- let iconPath = this.platformSpecificBuildOptions.icon || this.devMetadata.build.icon
+ let iconPath = this.platformSpecificBuildOptions.icon || this.config.icon
if (iconPath != null && !iconPath.endsWith(".icns")) {
iconPath += ".icns"
}
@@ -44,7 +44,7 @@ export default class MacPackager extends PlatformPackager {
}
createTargets(targets: Array, mapper: (name: string, factory: (outDir: string) => Target) => void, cleanupTasks: Array<() => Promise>): void {
- for (let name of targets) {
+ for (const name of targets) {
switch (name) {
case DIR_TARGET:
break
@@ -82,7 +82,7 @@ export default class MacPackager extends PlatformPackager {
if (hasMas) {
const appOutDir = path.join(outDir, "mas")
- const masBuildOptions = deepAssign({}, this.platformSpecificBuildOptions, (this.devMetadata.build).mas)
+ const masBuildOptions = deepAssign({}, this.platformSpecificBuildOptions, (this.config).mas)
await this.doPack(outDir, appOutDir, "mas", arch, masBuildOptions)
await this.sign(appOutDir, masBuildOptions)
}
@@ -112,8 +112,8 @@ export default class MacPackager extends PlatformPackager {
}
if (name == null) {
- let message = `App is not signed: cannot find valid ${isMas ? '"3rd Party Mac Developer Application" identity' : `"Developer ID Application" identity or custom non-Apple code signing certificate`}, see https://github.com/electron-userland/electron-builder/wiki/Code-Signing`
- if (isMas) {
+ const message = `App is not signed: cannot find valid ${isMas ? '"3rd Party Mac Developer Application" identity' : `"Developer ID Application" identity or custom non-Apple code signing certificate`}, see https://github.com/electron-userland/electron-builder/wiki/Code-Signing`
+ if (isMas || this.platformSpecificBuildOptions.forceCodeSigning) {
throw new Error(message)
}
else {
@@ -172,9 +172,9 @@ export default class MacPackager extends PlatformPackager {
}
async findInstallerIdentity(isMas: boolean, keychainName: string | n): Promise {
- const targetSpecificOptions: MacOptions = (this.devMetadata.build)[isMas ? "mas" : "pkg"] || this.platformSpecificBuildOptions
+ const targetSpecificOptions: MacOptions = (this.config)[isMas ? "mas" : "pkg"] || this.platformSpecificBuildOptions
const name = isMas ? "3rd Party Mac Developer Installer" : "Developer ID Installer"
- let installerName = await findIdentity(name, targetSpecificOptions.identity, keychainName)
+ const installerName = await findIdentity(name, targetSpecificOptions.identity, keychainName)
if (installerName != null) {
return installerName
}
diff --git a/src/metadata.ts b/src/metadata.ts
index 830538172b2..29ae81bf80e 100755
--- a/src/metadata.ts
+++ b/src/metadata.ts
@@ -58,17 +58,6 @@ export interface DevMetadata extends Metadata {
See [.build](#BuildMetadata).
*/
readonly build: BuildMetadata
-
- // deprecated
- readonly homepage?: string | null
-
- // deprecated
- readonly license?: string | null
-
- /*
- See [.directories](#MetadataDirectories)
- */
- readonly directories?: MetadataDirectories | null
}
export interface RepositoryInfo {
@@ -115,26 +104,24 @@ export interface BuildMetadata {
*/
readonly files?: Array | string | null
- /**
+ /*
A [glob patterns](https://www.npmjs.com/package/glob#glob-primer) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux/Windows).
Glob rules the same as for [files](#multiple-glob-patterns).
*/
readonly extraResources?: Array | string | null
- /**
+ /*
The same as [extraResources](#BuildMetadata-extraResources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux/Windows).
*/
readonly extraFiles?: Array | string | null
/*
- Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). 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/tutorial/application-packaging/#limitations-of-the-node-api).
-
- Or you can pass object of any asar options.
+ Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/). Defaults to `true`.
+ Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#BuildMetadata-asarUnpack) - please file issue if this doesn't work.
- Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set `asarUnpack` - please file issue if this doesn't work.
- */
+ Or you can pass object of asar options.
+ */
readonly asar?: AsarOptions | boolean | null
/**
@@ -239,12 +226,20 @@ export interface BuildMetadata {
// deprecated
readonly "app-bundle-id"?: string | null
- readonly dereference?: boolean
-
/*
See [.build.publish](#PublishConfiguration).
*/
readonly publish?: Publish
+
+ /*
+ Whether to fail if application will be not signed (to prevent unsigned app if code signing configuration is not correct).
+ */
+ readonly forceCodeSigning?: boolean
+
+ /*
+ See [.directories](#MetadataDirectories)
+ */
+ readonly directories?: MetadataDirectories | null
}
export interface AfterPackContext {
@@ -283,9 +278,14 @@ export interface FileAssociation {
readonly icon?: string
/*
- *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`.
+ *macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`. Corresponds to `CFBundleTypeRole`.
*/
readonly role?: string
+
+ /*
+ *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.
+ */
+ readonly isPackage?: boolean
}
/*
@@ -348,6 +348,8 @@ export interface PlatformSpecificBuildOptions {
readonly fileAssociations?: Array | FileAssociation
readonly publish?: Publish
+
+ readonly forceCodeSigning?: boolean
}
export class Platform {
@@ -372,7 +374,7 @@ export class Platform {
archs = [Arch.x64]
}
- for (let arch of (archs == null || archs.length === 0 ? [archFromString(process.arch)] : archs)) {
+ for (const arch of (archs == null || archs.length === 0 ? [archFromString(process.arch)] : archs)) {
archToType.set(arch, type == null ? [] : (Array.isArray(type) ? type : [type]))
}
return new Map([[this, archToType]])
diff --git a/src/options/winOptions.ts b/src/options/winOptions.ts
index 4fd4c688521..7ece539d905 100644
--- a/src/options/winOptions.ts
+++ b/src/options/winOptions.ts
@@ -16,7 +16,7 @@ export interface WinBuildOptions extends PlatformSpecificBuildOptions {
/*
Array of signing algorithms used. Defaults to `['sha1', 'sha256']`
- Fo AppX `sha256` is always used.
+ For AppX `sha256` is always used.
*/
readonly signingHashAlgorithms?: Array | null
@@ -51,6 +51,11 @@ export interface WinBuildOptions extends PlatformSpecificBuildOptions {
The URL of the RFC 3161 time stamp server. Defaults to `http://timestamp.comodoca.com/rfc3161`.
*/
readonly rfc3161TimeStampServer?: string
+
+ /*
+ The URL of the time stamp server. Defaults to `http://timestamp.verisign.com/scripts/timstamp.dll`.
+ */
+ readonly timeStampServer?: string
}
/*
@@ -93,6 +98,11 @@ export interface NsisOptions {
*/
readonly guid?: string | null
+ /*
+ The path to installer icon. Defaults to `build/installerIcon.ico` or application icon.
+ */
+ readonly installerIcon?: string | null
+
/*
*boring installer only.* `MUI_HEADERIMAGE`, relative to the project directory. Defaults to `build/installerHeader.bmp`
*/
@@ -180,10 +190,36 @@ export interface SquirrelWindowsOptions extends WinBuildOptions {
readonly useAppIdAsId?: boolean
}
+/*
+ ### `.build.appx`
+
+ Please see [Windows AppX docs](https://msdn.microsoft.com/en-us/library/windows/apps/br211453.aspx).
+ */
export interface AppXOptions {
- // readonly flatten?: boolean
+ /*
+ The background color of the app tile. Please see [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).
+ */
readonly backgroundColor?: string | null
+
readonly makeappxArgs?: Array | null
+ /*
+ Describes the publisher information. The Publisher attribute must match the publisher subject information of the certificate used to sign a package. For now, required.
+ */
readonly publisher?: string | null
-}
\ No newline at end of file
+
+ /*
+ A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
+ */
+ readonly displayName?: string | null
+
+ /*
+ A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
+ */
+ readonly publisherDisplayName?: string | null
+
+ /*
+ Describes the contents of the package. The Name attribute is case-sensitive. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx).
+ */
+ readonly identityName?: string | null
+}
diff --git a/src/packager.ts b/src/packager.ts
index 8edfb0d9bbe..73db795e82c 100644
--- a/src/packager.ts
+++ b/src/packager.ts
@@ -1,9 +1,9 @@
import * as path from "path"
-import { computeDefaultAppDirectory, getElectronVersion, use, exec, isEmptyOrSpaces } from "./util/util"
+import { computeDefaultAppDirectory, getElectronVersion, use, exec, isEmptyOrSpaces, getDirectoriesConfig } from "./util/util"
import { all, executeFinally } from "./util/promise"
import { EventEmitter } from "events"
import BluebirdPromise from "bluebird-lst-c"
-import { AppMetadata, DevMetadata, Platform, Arch } from "./metadata"
+import { AppMetadata, DevMetadata, Platform, Arch, BuildMetadata } from "./metadata"
import { PlatformPackager, BuildInfo, ArtifactCreated } from "./platformPackager"
import { WinPackager } from "./winPackager"
import * as errorMessages from "./errorMessages"
@@ -28,8 +28,13 @@ export class Packager implements BuildInfo {
appDir: string
metadata: AppMetadata
+
devMetadata: DevMetadata
+ get config(): BuildMetadata {
+ return this.devMetadata.build
+ }
+
isTwoPackageJsonProjectLayoutUsed = true
electronVersion: string
@@ -55,12 +60,21 @@ export class Packager implements BuildInfo {
}
async build(): Promise>> {
- const devPackageFile = this.devPackageFile
-
const extraMetadata = this.options.extraMetadata
const extraBuildMetadata = extraMetadata == null ? null : extraMetadata.build
- this.devMetadata = deepAssign(await readPackageJson(devPackageFile), this.options.devMetadata)
+ let devMetadataFromOptions = this.options.devMetadata
+ const buildConfigFromOptions = this.options.config
+ if (buildConfigFromOptions != null) {
+ if (devMetadataFromOptions != null) {
+ throw new Error("devMetadata and config cannot be used in conjunction")
+ }
+ devMetadataFromOptions = {build: buildConfigFromOptions}
+ }
+
+ const devPackageFile = this.devPackageFile
+ this.devMetadata = deepAssign(await readPackageJson(devPackageFile), devMetadataFromOptions)
+
if (extraMetadata != null) {
if (extraBuildMetadata != null) {
deepAssign(this.devMetadata, {build: extraBuildMetadata})
@@ -72,7 +86,7 @@ export class Packager implements BuildInfo {
}
}
- this.appDir = await computeDefaultAppDirectory(this.projectDir, use(this.devMetadata.directories, it => it!.app))
+ this.appDir = await computeDefaultAppDirectory(this.projectDir, use(getDirectoriesConfig(this.devMetadata), it => it!.app))
this.isTwoPackageJsonProjectLayoutUsed = this.appDir !== this.projectDir
@@ -91,7 +105,7 @@ export class Packager implements BuildInfo {
}
this.checkMetadata(appPackageFile, devPackageFile)
- checkConflictingOptions(this.devMetadata.build)
+ checkConflictingOptions(this.config)
this.electronVersion = await getElectronVersion(this.devMetadata, devPackageFile)
@@ -102,12 +116,12 @@ export class Packager implements BuildInfo {
private async doBuild(cleanupTasks: Array<() => Promise>): Promise>> {
const distTasks: Array> = []
- const outDir = path.resolve(this.projectDir, use(this.devMetadata.directories, it => it!.output) || "dist")
+ const outDir = path.resolve(this.projectDir, use(getDirectoriesConfig(this.devMetadata), it => it!.output) || "dist")
const platformToTarget: Map> = new Map()
// custom packager - don't check wine
let checkWine = this.options.platformPackagerFactory == null
- for (let [platform, archToType] of this.options.targets!) {
+ for (const [platform, archToType] of this.options.targets!) {
if (platform === Platform.MAC && process.platform === Platform.WINDOWS.nodeName) {
throw new Error("Build for macOS is supported only on macOS, please see https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build")
}
@@ -121,7 +135,7 @@ export class Packager implements BuildInfo {
const nameToTarget: Map = new Map()
platformToTarget.set(platform, nameToTarget)
- for (let [arch, targets] of archToType) {
+ for (const [arch, targets] of archToType) {
await this.installAppDependencies(platform, arch)
if (checkWine && wineCheck != null) {
@@ -132,7 +146,7 @@ export class Packager implements BuildInfo {
await helper.pack(outDir, arch, createTargets(nameToTarget, targets, outDir, helper, cleanupTasks), distTasks)
}
- for (let target of nameToTarget.values()) {
+ for (const target of nameToTarget.values()) {
distTasks.push(target.finishBuild())
}
}
@@ -193,7 +207,7 @@ export class Packager implements BuildInfo {
}
}
- const build = this.devMetadata.build
+ const build = this.config
if (build == null) {
throw new Error(util.format(errorMessages.buildIsMissed, devAppPackageFile))
}
@@ -220,10 +234,6 @@ export class Packager implements BuildInfo {
throw new Error(util.format(errorMessages.nameInBuildSpecified, appPackageFile))
}
- if (build.directories != null) {
- throw new Error(`'directories' in the 'build' is not correct. Please move 'directories' from 'build' to root`)
- }
-
if (build.prune != null) {
warn("prune is deprecated — development dependencies are never copied in any case")
}
@@ -231,11 +241,11 @@ export class Packager implements BuildInfo {
}
private async installAppDependencies(platform: Platform, arch: Arch): Promise {
- const options = this.devMetadata.build
+ const options = this.config
if (options.nodeGypRebuild === true) {
log(`Executing node-gyp rebuild for arch ${Arch[arch]}`)
await exec(process.platform === "win32" ? "node-gyp.cmd" : "node-gyp", ["rebuild"], {
- env: getGypEnv(this.electronVersion, Arch[arch], platform.name),
+ env: getGypEnv(this.electronVersion, platform.nodeName, Arch[arch], true),
})
}
@@ -248,7 +258,7 @@ export class Packager implements BuildInfo {
log("Skip app dependencies rebuild because platform is different")
}
else {
- await installOrRebuild(options, this.appDir, this.electronVersion, Arch[arch], platform.nodeName)
+ await installOrRebuild(options, this.appDir, this.electronVersion, platform.nodeName, Arch[arch])
}
}
}
@@ -276,16 +286,16 @@ export function normalizePlatforms(rawPlatforms: Array | stri
}
function checkConflictingOptions(options: any) {
- for (let name of ["all", "out", "tmpdir", "version", "platform", "dir", "arch", "name", "extra-resource"]) {
+ for (const name of ["all", "out", "tmpdir", "version", "platform", "dir", "arch", "name", "extra-resource"]) {
if (name in options) {
throw new Error(`Option ${name} is ignored, do not specify it.`)
}
}
}
-async function checkWineVersion(checkPromise: Promise) {
+export async function checkWineVersion(checkPromise: Promise) {
function wineError(prefix: string): string {
- return `${prefix}, please see https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build#${(process.platform === "linux" ? "linux" : "os-x")}`
+ return `${prefix}, please see https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build#${(process.platform === "linux" ? "linux" : "macos")}`
}
let wineVersion: string
@@ -305,6 +315,16 @@ async function checkWineVersion(checkPromise: Promise) {
wineVersion = wineVersion.substring("wine-".length)
}
+ const spaceIndex = wineVersion.indexOf(" ")
+ if (spaceIndex > 0) {
+ wineVersion = wineVersion.substring(0, spaceIndex)
+ }
+
+ const suffixIndex = wineVersion.indexOf("-")
+ if (suffixIndex > 0) {
+ wineVersion = wineVersion.substring(0, suffixIndex)
+ }
+
if (wineVersion.split(".").length === 2) {
wineVersion += ".0"
}
@@ -319,9 +339,10 @@ function checkDependencies(dependencies?: { [key: string]: string }) {
return
}
- for (let name of ["electron", "electron-prebuilt", "electron-builder"]) {
+ for (const name of ["electron", "electron-prebuilt", "electron-builder"]) {
if (name in dependencies) {
- throw new Error(`${name} must be in the devDependencies`)
+ throw new Error(`Package "${name}" is only allowed in "devDependencies". `
+ + `Please remove it from the "dependencies" section in your package.json.`)
}
}
-}
\ No newline at end of file
+}
diff --git a/src/packager/dirPackager.ts b/src/packager/dirPackager.ts
index a7e1423524b..60202e47ea3 100644
--- a/src/packager/dirPackager.ts
+++ b/src/packager/dirPackager.ts
@@ -1,10 +1,11 @@
import BluebirdPromise from "bluebird-lst-c"
-import { emptyDir, copy, chmod } from "fs-extra-p"
+import { emptyDir, chmod } from "fs-extra-p"
import { warn } from "../util/log"
import { PlatformPackager } from "../platformPackager"
import { debug7zArgs, spawn } from "../util/util"
import { path7za } from "7zip-bin"
import * as path from "path"
+import { copyDir } from "../util/fs"
const downloadElectron: (options: any) => Promise = BluebirdPromise.promisify(require("electron-download-tf"))
@@ -32,10 +33,10 @@ function subOptionWarning (properties: any, optionName: any, parameter: any, val
}
export async function unpackElectron(packager: PlatformPackager, out: string, platform: string, arch: string, electronVersion: string) {
- const electronDist = packager.devMetadata.build.electronDist
+ const electronDist = packager.config.electronDist
if (electronDist == null) {
const zipPath = (await BluebirdPromise.all([
- downloadElectron(createDownloadOpts(packager.devMetadata.build, platform, arch, electronVersion)),
+ downloadElectron(createDownloadOpts(packager.config, platform, arch, electronVersion)),
emptyDir(out)
]))[0]
@@ -43,7 +44,7 @@ export async function unpackElectron(packager: PlatformPackager, out: strin
}
else {
await emptyDir(out)
- await copy(path.resolve(packager.info.projectDir, electronDist, "Electron.app"), path.join(out, "Electron.app"))
+ await copyDir(path.resolve(packager.info.projectDir, electronDist, "Electron.app"), path.join(out, "Electron.app"))
}
if (platform === "linux") {
diff --git a/src/packager/mac.ts b/src/packager/mac.ts
index 47c5b82d40e..1168d52c999 100644
--- a/src/packager/mac.ts
+++ b/src/packager/mac.ts
@@ -1,10 +1,11 @@
-import { rename, readFile, writeFile, copy, unlink, utimes } from "fs-extra-p"
+import { rename, readFile, writeFile, unlink, utimes, copy } from "fs-extra-p"
import * as path from "path"
import { parse as parsePlist, build as buildPlist } from "plist"
import BluebirdPromise from "bluebird-lst-c"
import { use, asArray } from "../util/util"
import { normalizeExt, PlatformPackager } from "../platformPackager"
import { warn } from "../util/log"
+import { unlinkIfExists, copyFile } from "../util/fs"
function doRename (basePath: string, oldName: string, newName: string) {
return rename(path.join(basePath, oldName), path.join(basePath, newName))
@@ -36,7 +37,7 @@ export async function createApp(packager: PlatformPackager, appOutDir: stri
const helperEHPlistFilename = path.join(frameworksPath, "Electron Helper EH.app", "Contents", "Info.plist")
const helperNPPlistFilename = path.join(frameworksPath, "Electron Helper NP.app", "Contents", "Info.plist")
- const buildMetadata = packager.devMetadata.build!
+ const buildMetadata = packager.config!
const fileContents: Array = await BluebirdPromise.map([appPlistFilename, helperPlistFilename, helperEHPlistFilename, helperNPPlistFilename, (buildMetadata)["extend-info"]], it => it == null ? it : readFile(it, "utf8"))
const appPlist = parsePlist(fileContents[0])
const helperPlist = parsePlist(fileContents[1])
@@ -97,35 +98,49 @@ export async function createApp(packager: PlatformPackager, appOutDir: stri
})
}
+ const resourcesPath = path.join(contentsPath, "Resources")
+
const fileAssociations = packager.getFileAssociations()
if (fileAssociations.length > 0) {
appPlist.CFBundleDocumentTypes = await BluebirdPromise.map(fileAssociations, async fileAssociation => {
const extensions = asArray(fileAssociation.ext).map(normalizeExt)
const customIcon = await packager.getResource(fileAssociation.icon, `${extensions[0]}.icns`)
- // todo rename electron.icns
- return {
+ let iconFile = appPlist.CFBundleIconFile
+ if (customIcon != null) {
+ iconFile = path.basename(customIcon)
+ await copyFile(customIcon, path.join(resourcesPath, iconFile))
+ }
+
+ const result = {
CFBundleTypeExtensions: extensions,
CFBundleTypeName: fileAssociation.name,
CFBundleTypeRole: fileAssociation.role || "Editor",
- CFBundleTypeIconFile: customIcon || appPlist.CFBundleIconFile
+ CFBundleTypeIconFile: iconFile
+ }
+
+ if (fileAssociation.isPackage) {
+ result.LSTypeIsPackage = true
}
+ return result
})
}
use(packager.platformSpecificBuildOptions.category || (buildMetadata).category, it => appPlist.LSApplicationCategoryType = it)
appPlist.NSHumanReadableCopyright = appInfo.copyright
- const promises: Array> = [
+ const promises: Array> = [
writeFile(appPlistFilename, buildPlist(appPlist)),
writeFile(helperPlistFilename, buildPlist(helperPlist)),
writeFile(helperEHPlistFilename, buildPlist(helperEHPlist)),
writeFile(helperNPPlistFilename, buildPlist(helperNPPlist)),
- doRename(path.join(contentsPath, "MacOS"), "Electron", appPlist.CFBundleExecutable)
+ doRename(path.join(contentsPath, "MacOS"), "Electron", appPlist.CFBundleExecutable),
+ unlinkIfExists(path.join(appOutDir, "LICENSE")),
+ unlinkIfExists(path.join(appOutDir, "LICENSES.chromium.html")),
]
if (icon != null) {
- promises.push(unlink(path.join(contentsPath, "Resources", oldIcon)))
- promises.push(copy(icon, path.join(contentsPath, "Resources", appPlist.CFBundleIconFile)))
+ promises.push(unlink(path.join(resourcesPath, oldIcon)))
+ promises.push(copy(icon, path.join(resourcesPath, appPlist.CFBundleIconFile)))
}
await BluebirdPromise.all(promises)
diff --git a/src/platformPackager.ts b/src/platformPackager.ts
index 360f63109a6..d0021ab3a3e 100644
--- a/src/platformPackager.ts
+++ b/src/platformPackager.ts
@@ -1,15 +1,14 @@
-import { AppMetadata, DevMetadata, Platform, PlatformSpecificBuildOptions, Arch, FileAssociation } from "./metadata"
+import { AppMetadata, DevMetadata, Platform, PlatformSpecificBuildOptions, Arch, FileAssociation, BuildMetadata } from "./metadata"
import BluebirdPromise from "bluebird-lst-c"
import * as path from "path"
import { readdir, remove, rename } from "fs-extra-p"
-import { statOrNull, use, unlinkIfExists, isEmptyOrSpaces, asArray, debug } from "./util/util"
+import { use, isEmptyOrSpaces, asArray, debug, getDirectoriesConfig } from "./util/util"
import { Packager } from "./packager"
import { AsarOptions } from "asar-electron-builder"
import { Minimatch } from "minimatch"
import { checkFileInArchive, createAsarArchive } from "./asarUtil"
import { warn, log } from "./util/log"
import { AppInfo } from "./appInfo"
-import { copyFiltered } from "./util/filter"
import { unpackElectron } from "./packager/dirPackager"
import { TmpDir } from "./util/tmp"
import { FileMatchOptions, FileMatcher, FilePattern, deprecatedUserIgnoreFilter } from "./fileMatcher"
@@ -18,6 +17,8 @@ import { PublishConfiguration, GithubOptions, BintrayOptions, GenericServerOptio
import { getRepositoryInfo } from "./repositoryInfo"
import { dependencies } from "./yarn"
import { Target } from "./targets/targetFactory"
+import { deepAssign } from "./util/deepAssign"
+import { statOrNull, unlinkIfExists, copyDir } from "./util/fs"
import EventEmitter = NodeJS.EventEmitter
export interface PackagerOptions {
@@ -40,6 +41,11 @@ export interface PackagerOptions {
*/
readonly devMetadata?: DevMetadata
+ /*
+ See [.build](#BuildMetadata).
+ */
+ readonly config?: BuildMetadata
+
/**
* The same as [application package.json](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata).
*
@@ -59,6 +65,8 @@ export interface BuildInfo {
devMetadata: DevMetadata
+ config: BuildMetadata
+
projectDir: string
appDir: string
devPackageFile: string
@@ -81,7 +89,7 @@ export abstract class PlatformPackager
readonly projectDir: string
readonly buildResourcesDir: string
- readonly devMetadata: DevMetadata
+ readonly config: BuildMetadata
readonly platformSpecificBuildOptions: DC
@@ -91,9 +99,9 @@ export abstract class PlatformPackager
readonly appInfo: AppInfo
- constructor(public readonly info: BuildInfo) {
- this.devMetadata = info.devMetadata
- this.platformSpecificBuildOptions = this.normalizePlatformSpecificBuildOptions((info.devMetadata.build)[this.platform.buildConfigurationKey])
+ constructor(readonly info: BuildInfo) {
+ this.config = info.config
+ this.platformSpecificBuildOptions = this.normalizePlatformSpecificBuildOptions((this.config)[this.platform.buildConfigurationKey])
this.appInfo = this.prepareAppInfo(info.appInfo)
this.options = info.options
this.projectDir = info.projectDir
@@ -137,7 +145,7 @@ export abstract class PlatformPackager
}
get relativeBuildResourcesDirname() {
- return use(this.devMetadata.directories, it => it!.buildResources) || "build"
+ return use(getDirectoriesConfig(this.info.devMetadata), it => it!.buildResources) || "build"
}
protected computeAppOutDir(outDir: string, arch: Arch): string {
@@ -192,13 +200,13 @@ export abstract class PlatformPackager
if (debug.enabled) {
const nodeModulesDir = path.join(appDir, "node_modules")
- debug(`Pruned dev or extraneous dependencies: ${Array.from(ignoreFiles).slice(2).map(it => path.relative(nodeModulesDir, it)).join(", ")}`)
+ debug(`Dev or extraneous dependencies: ${Array.from(ignoreFiles).slice(2).map(it => path.relative(nodeModulesDir, it)).join(", ")}`)
}
const patterns = this.getFileMatchers("files", appDir, path.join(resourcesPath, "app"), false, fileMatchOptions, platformSpecificBuildOptions)
- let defaultMatcher = patterns == null ? new FileMatcher(appDir, path.join(resourcesPath, "app"), fileMatchOptions) : patterns[0]
- if (defaultMatcher.isEmpty()) {
- defaultMatcher.addPattern("**/*")
+ const defaultMatcher = patterns == null ? new FileMatcher(appDir, path.join(resourcesPath, "app"), fileMatchOptions) : patterns[0]
+ if (defaultMatcher.isEmpty() || defaultMatcher.containsOnlyIgnore()) {
+ defaultMatcher.addAllPattern()
}
else {
defaultMatcher.addPattern("package.json")
@@ -207,13 +215,18 @@ export abstract class PlatformPackager
defaultMatcher.addPattern("!**/node_modules/.bin")
defaultMatcher.addPattern("!**/*.{o,hprof,orig,pyc,pyo,rbc,swp}")
defaultMatcher.addPattern("!**/._*")
- defaultMatcher.addPattern("!.idea")
defaultMatcher.addPattern("!*.iml")
//noinspection SpellCheckingInspection
- defaultMatcher.addPattern("!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,__pycache__,thumbs.db,.gitignore,.gitattributes,.editorconfig,.flowconfig,.yarn-metadata.json,.idea,appveyor.yml,.travis.yml,circle.yml,npm-debug.log,.nyc_output,yarn.lock,.yarn-integrity}")
+ defaultMatcher.addPattern("!**/{.git,.hg,.svn,CVS,RCS,SCCS," +
+ "__pycache__,.DS_Store,thumbs.db,.gitignore,.gitattributes," +
+ ".editorconfig,.flowconfig,.jshintrc," +
+ ".yarn-integrity,.yarn-metadata.json,yarn-error.log,yarn.lock,npm-debug.log," +
+ ".idea," +
+ "appveyor.yml,.travis.yml,circle.yml," +
+ ".nyc_output}")
let rawFilter: any = null
- const deprecatedIgnore = (this.devMetadata.build).ignore
+ const deprecatedIgnore = (this.config).ignore
if (deprecatedIgnore != null) {
if (typeof deprecatedIgnore === "function") {
warn(`"ignore" is specified as function, may be new "files" option will be suit your needs? Please see https://github.com/electron-userland/electron-builder/wiki/Options#BuildMetadata-files`)
@@ -241,7 +254,7 @@ export abstract class PlatformPackager
const filter = defaultMatcher.createFilter(ignoreFiles, rawFilter, excludePatterns.length ? excludePatterns : null)
let promise
if (asarOptions == null) {
- promise = copyFiltered(appDir, path.join(resourcesPath, "app"), filter, this.info.devMetadata.build.dereference || this.platform === Platform.WINDOWS)
+ promise = copyDir(appDir, path.join(resourcesPath, "app"), filter)
}
else {
const unpackPattern = this.getFileMatchers("asarUnpack", appDir, path.join(resourcesPath, "app"), false, fileMatchOptions, platformSpecificBuildOptions)
@@ -252,7 +265,7 @@ export abstract class PlatformPackager
//noinspection ES6MissingAwait
const promises = [promise, unlinkIfExists(path.join(resourcesPath, "default_app.asar")), unlinkIfExists(path.join(appOutDir, "version")), this.postInitApp(appOutDir)]
if (this.platform !== Platform.MAC) {
- promises.push(rename(path.join(appOutDir, "LICENSE"), path.join(appOutDir, "LICENSE.electron.txt")) .catch(() => {/* ignore */}))
+ promises.push(rename(path.join(appOutDir, "LICENSE"), path.join(appOutDir, "LICENSE.electron.txt")).catch(() => {/* ignore */}))
}
if (this.info.electronVersion != null && this.info.electronVersion[0] === "0") {
// electron release >= 0.37.4 - the default_app/ folder is a default_app.asar file
@@ -268,11 +281,11 @@ export abstract class PlatformPackager
await this.doCopyExtraFiles(extraResourceMatchers)
await this.doCopyExtraFiles(extraFileMatchers)
- const afterPack = this.devMetadata.build.afterPack
+ const afterPack = this.config.afterPack
if (afterPack != null) {
await afterPack({
appOutDir: appOutDir,
- options: this.devMetadata.build,
+ options: this.config,
packager: this,
})
}
@@ -288,55 +301,58 @@ export abstract class PlatformPackager
}
private computeAsarOptions(customBuildOptions: DC): AsarOptions | null {
- let result = this.devMetadata.build.asar
- let platformSpecific = customBuildOptions.asar
- if (platformSpecific != null) {
- result = platformSpecific
+ function errorMessage(name: string) {
+ return `${name} is deprecated is deprecated and not supported — please use build.asarUnpack`
}
+ const buildMetadata = this.config
+ if (buildMetadata["asar-unpack"] != null) {
+ throw new Error(errorMessage("asar-unpack"))
+ }
+ if (buildMetadata["asar-unpack-dir"] != null) {
+ throw new Error(errorMessage("asar-unpack-dir"))
+ }
+
+ const platformSpecific = customBuildOptions.asar
+ const result = platformSpecific == null ? this.config.asar : platformSpecific
if (result === false) {
+ warn("Packaging using asar archive is disabled — it is strongly not recommended.\n" +
+ "Please enable asar and use asarUnpack to unpack files that must be externally available.")
return null
}
- const buildMetadata = this.devMetadata.build
- if (buildMetadata["asar-unpack"] != null) {
- warn("asar-unpack is deprecated, please set as asar.unpack")
- }
- if (buildMetadata["asar-unpack-dir"] != null) {
- warn("asar-unpack-dir is deprecated, please set as asar.unpackDir")
+ const defaultOptions = {
+ extraMetadata: this.options.extraMetadata,
}
if (result == null || result === true) {
- result = {
- unpack: buildMetadata["asar-unpack"],
- unpackDir: buildMetadata["asar-unpack-dir"]
- }
+ return defaultOptions
}
- return Object.assign(result, {
- extraMetadata: this.options.extraMetadata
- })
+ for (const name of ["unpackDir", "unpack"]) {
+ if ((result)[name] != null) {
+ throw new Error(errorMessage(`asar.${name}`))
+ }
+ }
+ return deepAssign({}, result, defaultOptions)
}
private doCopyExtraFiles(patterns: Array | null): Promise {
if (patterns == null || patterns.length === 0) {
return BluebirdPromise.resolve()
}
- else {
- const promises: Array> = []
- for (let i = 0; i < patterns.length; i++) {
- if (patterns[i].isEmpty()) {
- patterns[i].addPattern("**/*")
- }
- promises.push(copyFiltered(patterns[i].from, patterns[i].to, patterns[i].createFilter(), this.platform === Platform.WINDOWS))
+
+ return BluebirdPromise.map(patterns, pattern => {
+ if (pattern.isEmpty() || pattern.containsOnlyIgnore()) {
+ pattern.addAllPattern()
}
- return BluebirdPromise.all(promises)
- }
+ return copyDir(pattern.from, pattern.to, pattern.createFilter())
+ })
}
private getFileMatchers(name: "files" | "extraFiles" | "extraResources" | "asarUnpack", defaultSrc: string, defaultDest: string, allowAdvancedMatching: boolean, fileMatchOptions: FileMatchOptions, customBuildOptions: DC): Array | null {
- let globalPatterns: Array | string | n | FilePattern = (this.devMetadata.build)[name]
- let platformSpecificPatterns: Array | string | n = (customBuildOptions)[name]
+ const globalPatterns: Array | string | n | FilePattern = (this.config)[name]
+ const platformSpecificPatterns: Array | string | n = (customBuildOptions)[name]
const defaultMatcher = new FileMatcher(defaultSrc, defaultDest, fileMatchOptions)
const fileMatchers: Array = []
@@ -486,13 +502,13 @@ export abstract class PlatformPackager
}
getFileAssociations(): Array {
- return asArray(this.devMetadata.build.fileAssociations).concat(asArray(this.platformSpecificBuildOptions.fileAssociations))
+ return asArray(this.config.fileAssociations).concat(asArray(this.platformSpecificBuildOptions.fileAssociations))
}
async getResource(custom: string | n, ...names: Array): Promise {
if (custom === undefined) {
const resourceList = await this.resourceList
- for (let name of names) {
+ for (const name of names) {
if (resourceList.includes(name)) {
return path.join(this.buildResourcesDir, name)
}
@@ -556,7 +572,7 @@ export function getPublishConfigs(packager: PlatformPackager, platformSpeci
}
if (publishers == null) {
- publishers = packager.info.devMetadata.build.publish
+ publishers = packager.config.publish
if (publishers === null) {
return null
}
diff --git a/src/publish/BintrayPublisher.ts b/src/publish/BintrayPublisher.ts
index f93f1aba4b5..842a1587c94 100644
--- a/src/publish/BintrayPublisher.ts
+++ b/src/publish/BintrayPublisher.ts
@@ -1,14 +1,16 @@
import { Publisher, PublishOptions } from "./publisher"
import BluebirdPromise from "bluebird-lst-c"
-import { HttpError, doApiRequest } from "./restApiRequest"
import { log } from "../util/log"
import { debug, isEmptyOrSpaces } from "../util/util"
import { BintrayClient, Version } from "./bintray"
import { BintrayOptions } from "../options/publishOptions"
import { ClientRequest } from "http"
+import { NodeHttpExecutor } from "../util/nodeHttpExecutor"
+import { HttpError } from "../util/httpExecutor"
export class BintrayPublisher extends Publisher {
private _versionPromise: BluebirdPromise
+ private readonly httpExecutor: NodeHttpExecutor = new NodeHttpExecutor()
private readonly client: BintrayClient
@@ -56,7 +58,7 @@ export class BintrayPublisher extends Publisher {
let badGatewayCount = 0
for (let i = 0; i < 3; i++) {
try {
- return await doApiRequest({
+ return await this.httpExecutor.doApiRequest({
hostname: "api.bintray.com",
path: `/content/${this.client.owner}/${this.client.repo}/${this.client.packageName}/${version.name}/${fileName}`,
method: "PUT",
diff --git a/src/publish/bintray.ts b/src/publish/bintray.ts
index 4b14bec6c20..84f3fea5256 100644
--- a/src/publish/bintray.ts
+++ b/src/publish/bintray.ts
@@ -1,5 +1,10 @@
-import { bintrayRequest } from "./restApiRequest"
import { BintrayOptions } from "../options/publishOptions"
+import { request } from "../util/httpExecutor"
+export { HttpError, request } from "../util/httpExecutor"
+
+export function bintrayRequest(path: string, auth: string | null, data: {[name: string]: any; } | null = null, method: string = "GET"): Promise {
+ return request({hostname: "api.bintray.com", path: path}, auth, data, method)
+}
export interface Version {
readonly name: string
diff --git a/src/publish/gitHubPublisher.ts b/src/publish/gitHubPublisher.ts
index 6aa27d4076d..3c01fd9a152 100644
--- a/src/publish/gitHubPublisher.ts
+++ b/src/publish/gitHubPublisher.ts
@@ -3,11 +3,12 @@ import { log, warn } from "../util/log"
import { debug } from "../util/util"
import { parse as parseUrl } from "url"
import mime from "mime"
-import { githubRequest, HttpError, doApiRequest } from "./restApiRequest"
import BluebirdPromise from "bluebird-lst-c"
import { PublishPolicy, PublishOptions, Publisher } from "./publisher"
import { GithubOptions } from "../options/publishOptions"
import { ClientRequest } from "http"
+import { HttpError, githubRequest } from "../util/httpExecutor"
+import { NodeHttpExecutor } from "../util/nodeHttpExecutor"
export interface Release {
id: number
@@ -26,6 +27,7 @@ interface Asset {
export class GitHubPublisher extends Publisher {
private tag: string
private _releasePromise: Promise
+ private readonly httpExecutor: NodeHttpExecutor = new NodeHttpExecutor()
private readonly token: string
private readonly policy: PublishPolicy
@@ -60,8 +62,9 @@ export class GitHubPublisher extends Publisher {
private async init(): Promise {
const createReleaseIfNotExists = this.policy !== "onTagOrDraft"
// we don't use "Get a release by tag name" because "tag name" means existing git tag, but we draft release and don't create git tag
+
const releases = await githubRequest>(`/repos/${this.info.owner}/${this.info.repo}/releases`, this.token)
- for (let release of releases) {
+ for (const release of releases) {
if (release.tag_name === this.tag || release.tag_name === this.version) {
if (release.draft) {
return release
@@ -103,7 +106,7 @@ export class GitHubPublisher extends Publisher {
let badGatewayCount = 0
uploadAttempt: for (let i = 0; i < 3; i++) {
try {
- return await doApiRequest({
+ return await this.httpExecutor.doApiRequest({
hostname: parsedUrl.hostname,
path: parsedUrl.path,
method: "POST",
@@ -120,8 +123,9 @@ export class GitHubPublisher extends Publisher {
if (e.response.statusCode === 422 && e.description != null && e.description.errors != null && e.description.errors[0].code === "already_exists") {
// delete old artifact and re-upload
log(`Artifact ${fileName} already exists, overwrite one`)
- const assets = await githubRequest>(`/repos/${this.info.owner}/${this.info.repo}/releases/${release.id}/assets`, this.token)
- for (let asset of assets) {
+
+ const assets = await githubRequest>(`/repos/${this.info.owner}/${this.info.repo}/releases/${release.id}/assets`, this.token, null)
+ for (const asset of assets) {
if (asset!.name === fileName) {
await githubRequest(`/repos/${this.info.owner}/${this.info.repo}/releases/assets/${asset!.id}`, this.token, null, "DELETE")
continue uploadAttempt
@@ -187,7 +191,7 @@ export class GitHubPublisher extends Publisher {
// async deleteOldReleases() {
// const releases = await githubRequest>(`/repos/${this.owner}/${this.repo}/releases`, this.token)
- // for (let release of releases) {
+ // for (const release of releases) {
// await githubRequest(`/repos/${this.owner}/${this.repo}/releases/${release.id}`, this.token, null, "DELETE")
// }
// }
diff --git a/src/publish/restApiRequest.ts b/src/publish/restApiRequest.ts
deleted file mode 100644
index e3bde7dba69..00000000000
--- a/src/publish/restApiRequest.ts
+++ /dev/null
@@ -1,127 +0,0 @@
-import * as https from "https"
-import * as http from "http"
-import { RequestOptions } from "http"
-import { IncomingMessage, ClientRequest } from "http"
-import { addTimeOutHandler } from "../util/httpRequest"
-import BluebirdPromise from "bluebird-lst-c"
-import { Url } from "url"
-import { safeLoad } from "js-yaml"
-import _debug from "debug"
-import Debugger = debug.Debugger
-import { parse as parseUrl } from "url"
-
-const debug: Debugger = _debug("electron-builder")
-
-export function githubRequest(path: string, token: string | null, data: { [name: string]: any; } | null = null, method: string = "GET"): Promise {
- return request({hostname: "api.github.com", path: path}, token, data, method)
-}
-
-export function bintrayRequest(path: string, auth: string | null, data: { [name: string]: any; } | null = null, method: string = "GET"): Promise {
- return request({hostname: "api.bintray.com", path: path}, auth, data, method)
-}
-
-export function request(url: Url, token: string | null = null, data: { [name: string]: any; } | null = null, method: string = "GET"): Promise {
- const options: any = Object.assign({
- method: method,
- headers: {
- "User-Agent": "electron-builder"
- }
- }, url)
-
- if (url.hostname!!.includes("github") && !url.path!.endsWith(".yml")) {
- options.headers.Accept = "application/vnd.github.v3+json"
- }
-
- const encodedData = data == null ? null : new Buffer(JSON.stringify(data))
- if (encodedData != null) {
- options.method = "post"
- options.headers["Content-Type"] = "application/json"
- options.headers["Content-Length"] = encodedData.length
- }
- return doApiRequest(options, token, it => it.end(encodedData))
-}
-
-export function doApiRequest(options: RequestOptions, token: string | null, requestProcessor: (request: ClientRequest, reject: (error: Error) => void) => void, redirectCount: number = 0): Promise {
- debug(`HTTPS request: ${JSON.stringify(options, null, 2)}`)
-
- if (token != null) {
- (options.headers).authorization = token.startsWith("Basic") ? token : `token ${token}`
- }
-
- return new BluebirdPromise((resolve, reject, onCancel) => {
- const request = (options.protocol === "https:" ? https.request : http.request)(options, (response: IncomingMessage) => {
- try {
- if (response.statusCode === 404) {
- // error is clear, we don't need to read detailed error description
- reject(new HttpError(response, `method: ${options.method} url: ${options.protocol}://${options.hostname}${options.path}
-
-Please double check that your authentication token is correct. Due to security reasons actual status maybe not reported, but 404.
-`))
- }
- else if (response.statusCode === 204) {
- // on DELETE request
- resolve()
- return
- }
-
- const redirectUrl = response.headers.location
- if (redirectUrl != null) {
- if (redirectCount > 10) {
- reject(new Error("Too many redirects (> 10)"))
- return
- }
-
- if (options.path!.endsWith("/latest")) {
- resolve({location: redirectUrl})
- }
- else {
- doApiRequest(Object.assign({}, options, parseUrl(redirectUrl)), token, requestProcessor)
- .then(resolve)
- .catch(reject)
- }
- return
- }
-
- let data = ""
- response.setEncoding("utf8")
- response.on("data", (chunk: string) => {
- data += chunk
- })
-
- response.on("end", () => {
- try {
- const contentType = response.headers["content-type"]
- const isJson = contentType != null && contentType.includes("json")
- if (response.statusCode >= 400) {
- if (isJson) {
- reject(new HttpError(response, JSON.parse(data)))
- }
- else {
- reject(new HttpError(response))
- }
- }
- else {
- resolve(data.length === 0 ? null : (isJson || !options.path!.includes(".yml")) ? JSON.parse(data) : safeLoad(data))
- }
- }
- catch (e) {
- reject(e)
- }
- })
- }
- catch (e) {
- reject(e)
- }
- })
- addTimeOutHandler(request, reject)
- request.on("error", reject)
- requestProcessor(request, reject)
- onCancel!(() => request.abort())
- })
-}
-
-export class HttpError extends Error {
- constructor(public response: IncomingMessage, public description: any = null) {
- super(response.statusCode + " " + response.statusMessage + (description == null ? "" : ("\n" + JSON.stringify(description, null, " "))) + "\nHeaders: " + JSON.stringify(response.headers, null, " "))
- }
-}
\ No newline at end of file
diff --git a/src/repositoryInfo.ts b/src/repositoryInfo.ts
index 3d478e9c7b6..36ec8cb1e6c 100644
--- a/src/repositoryInfo.ts
+++ b/src/repositoryInfo.ts
@@ -1,6 +1,6 @@
import { fromUrl as parseRepositoryUrl, Info } from "hosted-git-info"
import { readFile } from "fs-extra-p"
-import { AppMetadata, Metadata } from "./metadata"
+import { AppMetadata, Metadata, RepositoryInfo } from "./metadata"
import * as path from "path"
export interface RepositorySlug {
@@ -12,7 +12,7 @@ let info: Promise | null
export function getRepositoryInfo(metadata?: AppMetadata, devMetadata?: Metadata): Promise {
if (info == null) {
- info = _getInfo(metadata, devMetadata)
+ info = _getInfo((devMetadata == null ? null : devMetadata.repository) || (metadata == null ? null : metadata.repository))
}
return info
}
@@ -45,8 +45,7 @@ async function getGitUrlFromGitConfig(): Promise {
return null
}
-async function _getInfo(metadata?: AppMetadata, devMetadata?: Metadata): Promise {
- const repo = metadata == null ? null : (devMetadata!.repository || metadata!.repository)
+async function _getInfo(repo?: RepositoryInfo | null): Promise {
if (repo == null) {
let url = process.env.TRAVIS_REPO_SLUG
if (url == null) {
diff --git a/src/targets/LinuxTargetHelper.ts b/src/targets/LinuxTargetHelper.ts
index ed1ae6bfbf3..aff715b0c3f 100644
--- a/src/targets/LinuxTargetHelper.ts
+++ b/src/targets/LinuxTargetHelper.ts
@@ -23,14 +23,16 @@ export class LinuxTargetHelper {
return await this.iconsFromDir(path.join(this.packager.buildResourcesDir, "icons"))
}
else {
- return await this.createFromIcns(await this.packager.getTempFile("electron-builder-linux.iconset").then(it => ensureDir(it).thenReturn(it)))
+ const iconDir = await this.packager.getTempFile("linux.iconset")
+ ensureDir(iconDir)
+ return await this.createFromIcns(iconDir)
}
}
private async iconsFromDir(iconsDir: string) {
const mappings: Array> = []
let maxSize = 0
- for (let file of (await readdir(iconsDir))) {
+ for (const file of (await readdir(iconsDir))) {
if (file.endsWith(".png") || file.endsWith(".PNG")) {
// If parseInt encounters a character that is not a numeral in the specified radix,
// it returns the integer value parsed up to that point
@@ -55,7 +57,7 @@ export class LinuxTargetHelper {
}
private async getIcns(): Promise {
- const build = this.packager.devMetadata.build
+ const build = this.packager.config
let iconPath = (build.mac || {}).icon || build.icon
if (iconPath != null && !iconPath.endsWith(".icns")) {
iconPath += ".icns"
@@ -88,7 +90,7 @@ export class LinuxTargetHelper {
}
let data = `[Desktop Entry]`
- for (let name of Object.keys(desktopMeta)) {
+ for (const name of Object.keys(desktopMeta)) {
const value = desktopMeta[name]
data += `\n${name}=${value}`
}
diff --git a/src/targets/appImage.ts b/src/targets/appImage.ts
index a2bfe255ef4..cc502539458 100644
--- a/src/targets/appImage.ts
+++ b/src/targets/appImage.ts
@@ -1,6 +1,6 @@
import { Arch } from "../metadata"
import * as path from "path"
-import { exec, unlinkIfExists } from "../util/util"
+import { exec } from "../util/util"
import { open, write, createReadStream, createWriteStream, close, chmod } from "fs-extra-p"
import { LinuxTargetHelper } from "./LinuxTargetHelper"
import { getBin } from "../util/binDownload"
@@ -9,6 +9,7 @@ import { v1 as uuid1 } from "uuid-1345"
import { LinuxPackager } from "../linuxPackager"
import { log } from "../util/log"
import { Target } from "./targetFactory"
+import { unlinkIfExists } from "../util/fs"
const appImageVersion = process.platform === "darwin" ? "AppImage-09-07-16-mac" : "AppImage-09-07-16-linux"
//noinspection SpellCheckingInspection
@@ -17,7 +18,7 @@ const appImageSha256 = process.platform === "darwin" ? "5d4a954876654403698a01ef
const appImagePathPromise = getBin("AppImage", appImageVersion, `https://dl.bintray.com/electron-userland/bin/${appImageVersion}.7z`, appImageSha256)
export default class AppImageTarget extends Target {
- private readonly options = Object.assign({}, this.packager.platformSpecificBuildOptions, (this.packager.devMetadata.build)[this.name])
+ private readonly options = Object.assign({}, this.packager.platformSpecificBuildOptions, (this.packager.config)[this.name])
private readonly desktopEntry: Promise
constructor(ignored: string, private packager: LinuxPackager, private helper: LinuxTargetHelper, private outDir: string) {
@@ -63,7 +64,7 @@ export default class AppImageTarget extends Target {
args.push("-map", this.helper.maxIconPath, "/.DirIcon")
args.push("-chown_r", "0", "/", "--")
- args.push("-zisofs", `level=${packager.devMetadata.build.compression === "store" ? "0" : "9"}:block_size=128k:by_magic=off`)
+ args.push("-zisofs", `level=${packager.config.compression === "store" ? "0" : "9"}:block_size=128k:by_magic=off`)
args.push("set_filter_r", "--zisofs", "/")
if (this.packager.options.effectiveOptionComputed != null && await this.packager.options.effectiveOptionComputed([args, desktopFile])) {
diff --git a/src/targets/appx.ts b/src/targets/appx.ts
index 1fa5b2d31a2..c22e2247771 100644
--- a/src/targets/appx.ts
+++ b/src/targets/appx.ts
@@ -9,12 +9,19 @@ import BluebirdPromise from "bluebird-lst-c"
import { Target } from "./targetFactory"
import { getSignVendorPath } from "../windowsCodeSign"
import sanitizeFileName from "sanitize-filename"
+import { release } from "os"
+import { copyDir } from "../util/fs"
export default class AppXTarget extends Target {
- private readonly options: AppXOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, this.packager.devMetadata.build.appx)
+ private readonly options: AppXOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, this.packager.config.appx)
constructor(private readonly packager: WinPackager, private readonly outDir: string) {
super("appx")
+
+ const osVersion = release()
+ if (process.platform !== "win32" || parseInt(osVersion.substring(0, osVersion.indexOf(".")), 10) < 10) {
+ throw new Error("AppX is supported only on Windows 10")
+ }
}
// no flatten - use asar or npm 3 or yarn
@@ -47,8 +54,8 @@ export default class AppXTarget extends Target {
}
return copy(path.join(templatePath, "assets", `SampleAppx.${size}.png`), target)
}),
- copy(appOutDir, path.join(preAppx, "app")),
- this.writeManifest(templatePath, preAppx, safeName)
+ copyDir(appOutDir, path.join(preAppx, "app")),
+ this.writeManifest(templatePath, preAppx, safeName, arch)
])
const destination = path.join(this.outDir, packager.generateName("appx", arch, false))
@@ -56,13 +63,13 @@ export default class AppXTarget extends Target {
use(this.options.makeappxArgs, (it: Array) => args.push(...it))
// wine supports only ia32 binary in any case makeappx crashed on wine
// await execWine(path.join(await getSignVendorPath(), "windows-10", process.platform === "win32" ? process.arch : "ia32", "makeappx.exe"), args)
- await spawn(path.join(await getSignVendorPath(), "windows-10", process.arch, "makeappx.exe"), args)
+ await spawn(path.join(await getSignVendorPath(), "windows-10", arch === Arch.ia32 ? "ia32" : "x64", "makeappx.exe"), args)
await packager.sign(destination)
packager.dispatchArtifactCreated(destination, packager.generateName("appx", arch, true))
}
- private async writeManifest(templatePath: string, preAppx: string, safeName: string) {
+ private async writeManifest(templatePath: string, preAppx: string, safeName: string, arch: Arch) {
const appInfo = this.packager.appInfo
const manifest = (await readFile(path.join(templatePath, "appxmanifest.xml"), "utf8"))
.replace(/\$\{([a-zA-Z]+)\}/g, (match, p1): string => {
@@ -70,21 +77,24 @@ export default class AppXTarget extends Target {
case "publisher":
return this.options.publisher!
- case "author":
- return appInfo.companyName
+ case "publisherDisplayName":
+ return this.options.publisherDisplayName || appInfo.companyName
case "version":
return appInfo.versionInWeirdWindowsForm
case "name":
return appInfo.name
+
+ case "identityName":
+ return this.options.identityName || appInfo.name
case "executable":
return `app\\${appInfo.productFilename}.exe`
case "displayName":
- return appInfo.productName
-
+ return this.options.displayName || appInfo.productName
+
case "description":
return appInfo.description || appInfo.productName
@@ -93,6 +103,9 @@ export default class AppXTarget extends Target {
case "safeName":
return safeName
+
+ case "arch":
+ return arch === Arch.ia32 ? "x86" : "x64"
default:
throw new Error(`Macro ${p1} is not defined`)
@@ -100,4 +113,4 @@ export default class AppXTarget extends Target {
})
await writeFile(path.join(preAppx, "appxmanifest.xml"), manifest)
}
-}
\ No newline at end of file
+}
diff --git a/src/targets/dmg.ts b/src/targets/dmg.ts
index eb9346a015c..957b24af5d6 100644
--- a/src/targets/dmg.ts
+++ b/src/targets/dmg.ts
@@ -4,12 +4,13 @@ import { log, warn } from "../util/log"
import { PlatformPackager } from "../platformPackager"
import { MacOptions, DmgOptions, DmgContent } from "../options/macOptions"
import BluebirdPromise from "bluebird-lst-c"
-import { debug, use, exec, statOrNull, isEmptyOrSpaces, spawn, exists } from "../util/util"
+import { debug, use, exec, isEmptyOrSpaces, spawn } from "../util/util"
import { copy, unlink, outputFile, remove } from "fs-extra-p"
import { executeFinally } from "../util/promise"
import sanitizeFileName from "sanitize-filename"
import { Arch } from "../metadata"
import { Target } from "./targetFactory"
+import { exists, statOrNull } from "../util/fs"
export class DmgTarget extends Target {
private helperDir = path.join(__dirname, "..", "..", "templates", "dmg")
@@ -153,7 +154,7 @@ export class DmgTarget extends Target {
const artifactPath = path.join(appOutDir, `${appInfo.productFilename}-${appInfo.version}.dmg`)
//noinspection SpellCheckingInspection
- await spawn("hdiutil", addVerboseIfNeed(["convert", tempDmg, "-format", packager.devMetadata.build.compression === "store" ? "UDRO" : "UDBZ", "-imagekey", "zlib-level=9", "-o", artifactPath]))
+ await spawn("hdiutil", addVerboseIfNeed(["convert", tempDmg, "-format", packager.config.compression === "store" ? "UDRO" : "UDBZ", "-imagekey", "zlib-level=9", "-o", artifactPath]))
await exec("hdiutil", addVerboseIfNeed(["internet-enable", "-no"]).concat(artifactPath))
this.packager.dispatchArtifactCreated(artifactPath, `${appInfo.name}-${appInfo.version}.dmg`)
@@ -179,7 +180,7 @@ export class DmgTarget extends Target {
x: 400,
y: 100,
},
- }, packager.devMetadata.build.dmg)
+ }, packager.config.dmg)
// appdmg
const oldPosition = specification.window.position
@@ -240,7 +241,7 @@ export class DmgTarget extends Target {
}
if (specification.format == null) {
- specification.format = packager.devMetadata.build.compression === "store" ? "UDRO" : "UDBZ"
+ specification.format = packager.config.compression === "store" ? "UDRO" : "UDBZ"
}
return specification
diff --git a/src/targets/fpm.ts b/src/targets/fpm.ts
index b4d0b830232..4994d13730b 100644
--- a/src/targets/fpm.ts
+++ b/src/targets/fpm.ts
@@ -30,7 +30,7 @@ function downloadFpm(): Promise {
}
export default class FpmTarget extends Target {
- private readonly options = Object.assign({}, this.packager.platformSpecificBuildOptions, (this.packager.devMetadata.build)[this.name])
+ private readonly options = Object.assign({}, this.packager.platformSpecificBuildOptions, (this.packager.config)[this.name])
private readonly scriptFiles: Promise>
private readonly desktopEntry: Promise
@@ -114,10 +114,10 @@ export default class FpmTarget extends Target {
}
if (target === "deb") {
- args.push("--deb-compression", options.compression || (packager.devMetadata.build.compression === "store" ? "gz" : "xz"))
+ args.push("--deb-compression", options.compression || (packager.config.compression === "store" ? "gz" : "xz"))
}
else if (target === "rpm") {
- // args.push("--rpm-compression", options.compression || (this.devMetadata.build.compression === "store" ? "none" : "xz"))
+ // args.push("--rpm-compression", options.compression || (this.config.compression === "store" ? "none" : "xz"))
args.push("--rpm-os", "linux")
if (synopsis != null) {
@@ -143,11 +143,11 @@ export default class FpmTarget extends Target {
}
}
- for (let dep of depends) {
+ for (const dep of depends) {
args.push("--depends", dep)
}
- use(packager.appInfo.metadata.license || packager.devMetadata.license, it => args.push("--license", it!))
+ use(packager.appInfo.metadata.license, it => args.push("--license", it!))
use(appInfo.buildNumber, it => args.push("--iteration", it!))
use(options.fpm, it => args.push(...it))
diff --git a/src/targets/nsis.ts b/src/targets/nsis.ts
index 72e7e336c02..387ad3957c2 100644
--- a/src/targets/nsis.ts
+++ b/src/targets/nsis.ts
@@ -15,9 +15,9 @@ import { safeDump } from "js-yaml"
import { createHash } from "crypto"
import { Target } from "./targetFactory"
-const NSIS_VERSION = "3.0.2"
+const NSIS_VERSION = "3.0.4"
//noinspection SpellCheckingInspection
-const NSIS_SHA2 = "012c29d62e167ff74e858eeb929641dc2c9d7bfe7465e748648814660c61b419"
+const NSIS_SHA2 = "c29883cb9a04733489590420b910ea7a91ba0f9b776fe4c647d9801f23175225"
//noinspection SpellCheckingInspection
const ELECTRON_BUILDER_NS_UUID = "50e065bc-3134-11e6-9bab-38c9862bdaf3"
@@ -25,7 +25,7 @@ const ELECTRON_BUILDER_NS_UUID = "50e065bc-3134-11e6-9bab-38c9862bdaf3"
const nsisPathPromise = getBinFromBintray("nsis", NSIS_VERSION, NSIS_SHA2)
export default class NsisTarget extends Target {
- private readonly options: NsisOptions = this.packager.info.devMetadata.build.nsis || Object.create(null)
+ private readonly options: NsisOptions = this.packager.config.nsis || Object.create(null)
private archs: Map> = new Map()
@@ -67,7 +67,7 @@ export default class NsisTarget extends Target {
const packager = this.packager
const archiveFile = path.join(this.outDir, `${packager.appInfo.name}-${packager.appInfo.version}-${Arch[arch]}.nsis.7z`)
- return await archive(packager.devMetadata.build.compression, "7z", archiveFile, appOutDir, true)
+ return await archive(packager.config.compression, "7z", archiveFile, appOutDir, true)
}
async finishBuild(): Promise {
@@ -87,7 +87,7 @@ export default class NsisTarget extends Target {
const appInfo = packager.appInfo
const version = appInfo.version
const installerFilename = `${appInfo.productFilename} Setup ${version}.exe`
- const iconPath = await packager.getIconPath()
+ const iconPath = await packager.getResource(this.options.installerIcon, "installerIcon.ico") || await packager.getIconPath()
const installerPath = path.join(this.outDir, installerFilename)
const guid = this.options.guid || await BluebirdPromise.promisify(uuid5)({namespace: ELECTRON_BUILDER_NS_UUID, name: appInfo.id})
@@ -96,13 +96,14 @@ export default class NsisTarget extends Target {
APP_GUID: guid,
PRODUCT_NAME: appInfo.productName,
PRODUCT_FILENAME: appInfo.productFilename,
+ APP_FILENAME: appInfo.name,
APP_DESCRIPTION: appInfo.description,
VERSION: version,
COMPANY_NAME: appInfo.companyName,
- PROJECT_DIR: this.packager.projectDir,
- BUILD_RESOURCES_DIR: this.packager.buildResourcesDir,
+ PROJECT_DIR: packager.projectDir,
+ BUILD_RESOURCES_DIR: packager.buildResourcesDir,
}
if (iconPath != null) {
@@ -110,7 +111,7 @@ export default class NsisTarget extends Target {
defines.MUI_UNICON = iconPath
}
- for (let [arch, file] of this.archs) {
+ for (const [arch, file] of this.archs) {
let filePath = await file
defines[arch === Arch.x64 ? "APP_64" : "APP_32"] = filePath
defines[arch === Arch.x64 ? "APP_64_FILENAME" : "APP_32_FILENAME"] = path.basename(filePath);
@@ -118,14 +119,14 @@ export default class NsisTarget extends Target {
const oneClick = this.options.oneClick !== false
- const installerHeader = oneClick ? null : await this.packager.getResource(this.options.installerHeader, "installerHeader.bmp")
+ const installerHeader = oneClick ? null : await packager.getResource(this.options.installerHeader, "installerHeader.bmp")
if (installerHeader != null) {
defines.MUI_HEADERIMAGE = null
defines.MUI_HEADERIMAGE_RIGHT = null
defines.MUI_HEADERIMAGE_BITMAP = installerHeader
}
- const installerHeaderIcon = oneClick ? await this.packager.getResource(this.options.installerHeaderIcon, "installerHeaderIcon.ico") : null
+ const installerHeaderIcon = oneClick ? await packager.getResource(this.options.installerHeaderIcon, "installerHeaderIcon.ico") : null
if (installerHeaderIcon != null) {
defines.HEADER_ICO = installerHeaderIcon
}
@@ -158,7 +159,7 @@ export default class NsisTarget extends Target {
`/LANG=${localeId} FileDescription "${appInfo.description}"`,
`/LANG=${localeId} FileVersion "${appInfo.buildVersion}"`,
]
- use(this.packager.platformSpecificBuildOptions.legalTrademarks, it => versionKey.push(`/LANG=${localeId} LegalTrademarks "${it}"`))
+ use(packager.platformSpecificBuildOptions.legalTrademarks, it => versionKey.push(`/LANG=${localeId} LegalTrademarks "${it}"`))
const commands: any = {
OutFile: `"${installerPath}"`,
@@ -167,7 +168,7 @@ export default class NsisTarget extends Target {
Unicode: true,
}
- if (packager.devMetadata.build.compression === "store") {
+ if (packager.config.compression === "store") {
commands.SetCompress = "off"
defines.COMPRESS = "off"
}
@@ -192,16 +193,16 @@ export default class NsisTarget extends Target {
debug(defines)
debug(commands)
- if (this.packager.options.effectiveOptionComputed != null && await this.packager.options.effectiveOptionComputed([defines, commands])) {
+ if (packager.options.effectiveOptionComputed != null && await packager.options.effectiveOptionComputed([defines, commands])) {
return
}
- const licenseFile = await this.packager.getResource(this.options.license, "license.rtf", "license.txt")
+ const licenseFile = await packager.getResource(this.options.license, "license.rtf", "license.txt")
if (licenseFile != null) {
defines.LICENSE_FILE = licenseFile
}
- const customScriptPath = await this.packager.getResource(this.options.script, "installer.nsi")
+ const customScriptPath = await packager.getResource(this.options.script, "installer.nsi")
const script = await readFile(customScriptPath || path.join(this.nsisTemplatesDir, "installer.nsi"), "utf8")
if (customScriptPath == null) {
@@ -228,7 +229,7 @@ export default class NsisTarget extends Target {
const githubArtifactName = `${appInfo.name}-Setup-${version}.exe`
if (publishConfigs != null) {
let sha2: string | null = null
- for (let publishConfig of publishConfigs) {
+ for (const publishConfig of publishConfigs) {
if (publishConfig.provider === "generic" || publishConfig.provider === "github") {
if (sha2 == null) {
sha2 = await sha256(installerPath)
@@ -278,7 +279,7 @@ export default class NsisTarget extends Target {
private async executeMakensis(defines: any, commands: any, isInstaller: boolean, originalScript: string) {
const args: Array = (this.options.warningsAsErrors === false) ? [] : ["-WX"]
- for (let name of Object.keys(defines)) {
+ for (const name of Object.keys(defines)) {
const value = defines[name]
if (value == null) {
args.push(`-D${name}`)
@@ -288,10 +289,10 @@ export default class NsisTarget extends Target {
}
}
- for (let name of Object.keys(commands)) {
+ for (const name of Object.keys(commands)) {
const value = commands[name]
if (Array.isArray(value)) {
- for (let c of value) {
+ for (const c of value) {
args.push(`-X${name} ${c}`)
}
}
@@ -317,9 +318,9 @@ export default class NsisTarget extends Target {
script = "!include FileAssociation.nsh\n" + script
if (isInstaller) {
let registerFileAssociationsScript = ""
- for (let item of fileAssociations) {
+ for (const item of fileAssociations) {
const extensions = asArray(item.ext).map(normalizeExt)
- for (let ext of extensions) {
+ for (const ext of extensions) {
const customIcon = await packager.getResource(item.icon, `${extensions[0]}.ico`)
let installedIconPath = "$appExe,0"
if (customIcon != null) {
@@ -338,8 +339,8 @@ export default class NsisTarget extends Target {
}
else {
let unregisterFileAssociationsScript = ""
- for (let item of fileAssociations) {
- for (let ext of asArray(item.ext)) {
+ for (const item of fileAssociations) {
+ for (const ext of asArray(item.ext)) {
unregisterFileAssociationsScript += ` !insertmacro APP_UNASSOCIATE "${normalizeExt(ext)}" "${item.name}"\n`
}
}
diff --git a/src/targets/snap.ts b/src/targets/snap.ts
index 944d155fb24..1183564b9cc 100644
--- a/src/targets/snap.ts
+++ b/src/targets/snap.ts
@@ -12,7 +12,7 @@ import { homedir } from "os"
import { Target } from "./targetFactory"
export default class SnapTarget extends Target {
- private readonly options: SnapOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, (this.packager.devMetadata.build)[this.name])
+ private readonly options: SnapOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, (this.packager.config)[this.name])
constructor(name: string, private packager: LinuxPackager, private helper: LinuxTargetHelper, private outDir: string) {
super(name)
diff --git a/src/targets/squirrelPack.ts b/src/targets/squirrelPack.ts
index 37fb75010a0..c06c8102b45 100644
--- a/src/targets/squirrelPack.ts
+++ b/src/targets/squirrelPack.ts
@@ -1,11 +1,11 @@
import * as path from "path"
import BluebirdPromise from "bluebird-lst-c"
-import { remove, copy, createWriteStream, unlink, ensureDir } from "fs-extra-p"
+import { remove, copy, createWriteStream, unlink, ensureDir, stat } from "fs-extra-p"
import { spawn, exec, prepareArgs, execWine, debug } from "../util/util"
import { WinPackager } from "../winPackager"
import { log } from "../util/log"
+import { walk, copyFile } from "../util/fs"
-const archiverUtil = require("archiver-utils")
const archiver = require("archiver")
export function convertVersion(version: string): string {
@@ -79,7 +79,7 @@ export async function buildInstaller(options: SquirrelOptions, outputDirectory:
const setupPath = path.join(outputDirectory, setupExe || `${options.name || options.productName}Setup.exe`)
await BluebirdPromise.all([
- pack(options, appOutDir, appUpdate, nupkgPath, version, options.packageCompressionLevel),
+ pack(options, appOutDir, appUpdate, nupkgPath, version, packager),
copy(path.join(options.vendorPath, "Setup.exe"), setupPath),
])
@@ -91,8 +91,7 @@ export async function buildInstaller(options: SquirrelOptions, outputDirectory:
embeddedArchive.finalize()
await embeddedArchivePromise
- const writeZipToSetup = path.join(options.vendorPath, "WriteZipToSetup.exe")
- await execWine(writeZipToSetup, [setupPath, embeddedArchiveFile])
+ await execWine(path.join(options.vendorPath, "WriteZipToSetup.exe"), [setupPath, embeddedArchiveFile])
await packager.signAndEditResources(setupPath)
if (options.msi && process.platform === "win32") {
@@ -103,8 +102,8 @@ export async function buildInstaller(options: SquirrelOptions, outputDirectory:
}
}
-async function pack(options: SquirrelOptions, directory: string, updateFile: string, outFile: string, version: string, packageCompressionLevel?: number) {
- const archive = archiver("zip", {zlib: {level: packageCompressionLevel == null ? 9 : packageCompressionLevel}})
+async function pack(options: SquirrelOptions, directory: string, updateFile: string, outFile: string, version: string, packager: WinPackager) {
+ const archive = archiver("zip", {zlib: {level: options.packageCompressionLevel == null ? 9 : options.packageCompressionLevel}})
const archiveOut = createWriteStream(outFile)
const archivePromise = new BluebirdPromise(function (resolve, reject) {
archive.on("error", reject)
@@ -169,7 +168,7 @@ async function pack(options: SquirrelOptions, directory: string, updateFile: str
`.replace(/\n/, "\r\n"), {name: "1.psmdcp", prefix: "package/services/metadata/core-properties"})
archive.file(updateFile, {name: "Update.exe", prefix: "lib/net45"})
- encodedZip(archive, directory, "lib/net45")
+ await encodedZip(archive, directory, "lib/net45", options.vendorPath, packager)
await archivePromise
}
@@ -219,27 +218,32 @@ async function msi(options: SquirrelOptions, nupkgPath: string, setupPath: strin
])
}
-function encodedZip(archive: any, dir: string, prefix: string) {
- archiverUtil.walkdir(dir, function (error: any, files: any) {
- if (error) {
- archive.emit("error", error)
+async function encodedZip(archive: any, dir: string, prefix: string, vendorPath: string, packager: WinPackager) {
+ await walk(dir, null, async (file, stats) => {
+ if (stats.isDirectory()) {
return
}
- for (let file of files) {
- if (file.stats.isDirectory()) {
- continue
- }
-
- // GBK file name encoding (or Non-English file name) caused a problem
- const entryData = {
- name: encodeURI(file.relative.replace(/\\/g, "/")).replace(/%5B/g, "[").replace(/%5D/g, "]"),
+ // GBK file name encoding (or Non-English file name) caused a problem
+ const relativeSafeFilePath = encodeURI(file.substring(dir.length + 1).replace(/\\/g, "/")).replace(/%5B/g, "[").replace(/%5D/g, "]")
+ archive._append(file, {
+ name: relativeSafeFilePath,
+ prefix: prefix,
+ stats: stats,
+ })
+
+ // createExecutableStubForExe
+ if (file.endsWith(".exe") && !file.includes("squirrel.exe")) {
+ const tempFile = await packager.getTempFile("stub.exe")
+ await copyFile(path.join(vendorPath, "StubExecutable.exe"), tempFile, null, false)
+ await execWine(path.join(vendorPath, "WriteZipToSetup.exe"), ["--copy-stub-resources", file, tempFile])
+
+ archive._append(tempFile, {
+ name: relativeSafeFilePath.substring(0, relativeSafeFilePath.length - 4) + "_ExecutionStub.exe",
prefix: prefix,
- stats: file.stats,
- }
- archive._append(file.path, entryData)
+ stats: await stat(tempFile),
+ })
}
-
- archive.finalize()
})
+ archive.finalize()
}
\ No newline at end of file
diff --git a/src/targets/squirrelWindows.ts b/src/targets/squirrelWindows.ts
index d0e2d6578fb..8a907cd4f5c 100644
--- a/src/targets/squirrelWindows.ts
+++ b/src/targets/squirrelWindows.ts
@@ -9,12 +9,12 @@ import { buildInstaller, convertVersion, SquirrelOptions } from "./squirrelPack"
import { SquirrelWindowsOptions } from "../options/winOptions"
import { Target } from "./targetFactory"
-const SW_VERSION = "1.4.4"
+const SW_VERSION = "1.5.1.3"
//noinspection SpellCheckingInspection
-const SW_SHA2 = "98e1d81c80d7afc1bcfb37f3b224dc4f761088506b9c28ccd72d1cf8752853ba"
+const SW_SHA2 = "526701c61fffed97f622b110cfd15c4a1197ce082705437e9ef938c0cb8f4172"
export default class SquirrelWindowsTarget extends Target {
- private readonly options: SquirrelWindowsOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, this.packager.devMetadata.build.squirrelWindows)
+ private readonly options: SquirrelWindowsOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, this.packager.config.squirrelWindows)
constructor(private readonly packager: WinPackager, private readonly outDir: string) {
super("squirrel")
@@ -51,9 +51,9 @@ export default class SquirrelWindowsTarget extends Target {
async computeEffectiveDistOptions(): Promise {
const packager = this.packager
- let iconUrl = this.options.iconUrl || packager.devMetadata.build.iconUrl
+ let iconUrl = this.options.iconUrl || packager.config.iconUrl
if (iconUrl == null) {
- const info = await getRepositoryInfo(packager.appInfo.metadata, packager.devMetadata)
+ const info = await getRepositoryInfo(packager.appInfo.metadata, packager.info.devMetadata)
if (info != null) {
iconUrl = `https://github.com/${info.user}/${info.project}/blob/master/${packager.relativeBuildResourcesDirname}/icon.ico?raw=true`
}
@@ -77,7 +77,7 @@ export default class SquirrelWindowsTarget extends Target {
iconUrl: iconUrl,
extraMetadataSpecs: projectUrl == null ? null : `\n ${projectUrl}`,
copyright: appInfo.copyright,
- packageCompressionLevel: packager.devMetadata.build.compression === "store" ? 0 : 9,
+ packageCompressionLevel: packager.config.compression === "store" ? 0 : 9,
vendorPath: await getBinFromBintray("Squirrel.Windows", SW_VERSION, SW_SHA2)
}, this.options)
@@ -93,7 +93,7 @@ export default class SquirrelWindowsTarget extends Target {
}
if (options.remoteReleases === true) {
- const info = await getRepositoryInfo(packager.appInfo.metadata, packager.devMetadata)
+ const info = await getRepositoryInfo(packager.appInfo.metadata, packager.info.devMetadata)
if (info == null) {
warn("remoteReleases set to true, but cannot get repository info")
}
@@ -108,7 +108,7 @@ export default class SquirrelWindowsTarget extends Target {
}
function checkConflictingOptions(options: any) {
- for (let name of ["outputDirectory", "appDirectory", "exe", "fixUpPaths", "usePackageJson", "extraFileSpecs", "extraMetadataSpecs", "skipUpdateIcon", "setupExe"]) {
+ for (const name of ["outputDirectory", "appDirectory", "exe", "fixUpPaths", "usePackageJson", "extraFileSpecs", "extraMetadataSpecs", "skipUpdateIcon", "setupExe"]) {
if (name in options) {
throw new Error(`Option ${name} is ignored, do not specify it.`)
}
diff --git a/src/targets/targetFactory.ts b/src/targets/targetFactory.ts
index b513e789c51..5e11e2a1078 100644
--- a/src/targets/targetFactory.ts
+++ b/src/targets/targetFactory.ts
@@ -102,10 +102,10 @@ class ArchiveTarget extends Target {
const dirToArchive = isMac ? path.join(appOutDir, `${packager.appInfo.productFilename}.app`) : appOutDir
if (format.startsWith("tar.")) {
- await tar(packager.devMetadata.build.compression, format, outFile, dirToArchive, isMac)
+ await tar(packager.config.compression, format, outFile, dirToArchive, isMac)
}
else {
- await archive(packager.devMetadata.build.compression, format, outFile, dirToArchive)
+ await archive(packager.config.compression, format, outFile, dirToArchive)
}
packager.dispatchArtifactCreated(outFile, isMac ? packager.generateName2(format, "mac", true) : packager.generateName(format, arch, true, packager.platform === Platform.WINDOWS ? "win" : null))
diff --git a/src/util/binDownload.ts b/src/util/binDownload.ts
index 531ad8b20b2..617f7d8ff05 100644
--- a/src/util/binDownload.ts
+++ b/src/util/binDownload.ts
@@ -1,9 +1,10 @@
-import { statOrNull, spawn, debug, debug7zArgs, getTempName, getCacheDirectory } from "./util"
+import { spawn, debug, debug7zArgs, getTempName, getCacheDirectory } from "./util"
import { rename, unlink, emptyDir } from "fs-extra-p"
import { download } from "./httpRequest"
import { path7za } from "7zip-bin"
import * as path from "path"
import BluebirdPromise from "bluebird-lst-c"
+import { statOrNull } from "./fs"
const versionToPromise = new Map>()
diff --git a/src/util/deepAssign.ts b/src/util/deepAssign.ts
index 2d0683c8689..daa52c61ff1 100644
--- a/src/util/deepAssign.ts
+++ b/src/util/deepAssign.ts
@@ -21,7 +21,7 @@ function assignKey(to: any, from: any, key: string) {
function assign(to: any, from: any) {
if (to !== from) {
- for (let key of Object.getOwnPropertyNames(from)) {
+ for (const key of Object.getOwnPropertyNames(from)) {
assignKey(to, from, key)
}
}
@@ -29,7 +29,7 @@ function assign(to: any, from: any) {
}
export function deepAssign(target: any, ...objects: Array) {
- for (let o of objects) {
+ for (const o of objects) {
if (o != null) {
assign(target, o)
}
diff --git a/src/util/filter.ts b/src/util/filter.ts
index 19f65662ddd..414edb1f90d 100644
--- a/src/util/filter.ts
+++ b/src/util/filter.ts
@@ -1,15 +1,7 @@
-import { copy, Stats } from "fs-extra-p"
+import { Stats } from "fs-extra-p"
import { Minimatch } from "minimatch"
import * as path from "path"
-
-// we use relative path to avoid canonical path issue - e.g. /tmp vs /private/tmp
-export function copyFiltered(src: string, destination: string, filter: Filter, dereference: boolean): Promise {
- return copy(src, destination, {
- dereference: dereference,
- filter: filter,
- passStats: true,
- })
-}
+import { Filter } from "./fs"
export function hasMagic(pattern: Minimatch) {
const set = pattern.set
@@ -17,7 +9,7 @@ export function hasMagic(pattern: Minimatch) {
return true
}
- for (let i of set[0]) {
+ for (const i of set[0]) {
if (typeof i !== "string") {
return true
}
@@ -26,8 +18,6 @@ export function hasMagic(pattern: Minimatch) {
return false
}
-export type Filter = (file: string, stat: Stats) => boolean
-
export function createFilter(src: string, patterns: Array, ignoreFiles?: Set, rawFilter?: (file: string) => boolean, excludePatterns?: Array | null): Filter {
return function (it, stat) {
if (src === it) {
@@ -44,7 +34,6 @@ export function createFilter(src: string, patterns: Array, ignoreFile
}
let relative = it.substring(src.length + 1)
-
if (path.sep === "\\") {
relative = relative.replace(/\\/g, "/")
}
@@ -56,7 +45,7 @@ export function createFilter(src: string, patterns: Array, ignoreFile
// https://github.com/joshwnj/minimatch-all/blob/master/index.js
function minimatchAll(path: string, patterns: Array, stat: Stats): boolean {
let match = false
- for (let pattern of patterns) {
+ for (const pattern of patterns) {
// If we've got a match, only re-test for exclusions.
// if we don't have a match, only re-test for inclusions.
if (match !== pattern.negate) {
diff --git a/src/util/fs.ts b/src/util/fs.ts
new file mode 100644
index 00000000000..571d29e963d
--- /dev/null
+++ b/src/util/fs.ts
@@ -0,0 +1,201 @@
+import { unlink, access, stat, Stats, lstat, readdir, createReadStream, createWriteStream, link, mkdirs, readlink, symlink } from "fs-extra-p"
+import BluebirdPromise from "bluebird-lst-c"
+import * as path from "path"
+import { debug } from "./util"
+import isCi from "is-ci"
+import Mode from "stat-mode"
+
+export const MAX_FILE_REQUESTS = 8
+export const CONCURRENCY = {concurrency: MAX_FILE_REQUESTS}
+
+export type Filter = (file: string, stat: Stats) => boolean
+
+export function unlinkIfExists(file: string) {
+ return unlink(file)
+ .catch(() => {/* ignore */})
+}
+
+export async function statOrNull(file: string): Promise {
+ try {
+ return await stat(file)
+ }
+ catch (e) {
+ if (e.code === "ENOENT") {
+ return null
+ }
+ else {
+ throw e
+ }
+ }
+}
+
+export async function exists(file: string): Promise {
+ try {
+ await access(file)
+ return true
+ }
+ catch (e) {
+ return false
+ }
+}
+
+export async function walk(initialDirPath: string, filter?: Filter | null, consumer?: (file: string, stat: Stats, parent: string) => any): Promise> {
+ const result: Array = []
+ const queue: Array = [initialDirPath]
+ let addDirToResult = false
+ while (queue.length > 0) {
+ const dirPath = queue.pop()!
+ if (addDirToResult) {
+ result.push(dirPath)
+ }
+ else {
+ addDirToResult = true
+ }
+
+ const childNames = await readdir(dirPath)
+ childNames.sort()
+
+ const dirs: Array = []
+ await BluebirdPromise.map(childNames, name => {
+ const filePath = dirPath + path.sep + name
+ return lstat(filePath)
+ .then(stat => {
+ if (filter != null && !filter(filePath, stat)) {
+ return
+ }
+
+ if (stat.isDirectory()) {
+ dirs.push(filePath)
+ }
+ else {
+ result.push(filePath)
+ }
+
+ return consumer == null ? null : consumer(filePath, stat, dirPath)
+ })
+ }, CONCURRENCY)
+
+ for (let i = dirs.length - 1; i > -1; i--) {
+ queue.push(dirs[i])
+ }
+ }
+
+ return result
+}
+
+const _isUseHardLink = process.platform != "win32" && process.env.USE_HARD_LINKS !== "false" && (isCi || process.env.USE_HARD_LINKS === "true")
+
+/**
+ * Hard links is used if supported and allowed.
+ * File permission is fixed — allow execute for all if owner can, allow read for all if owner can.
+ */
+export function copyFile(src: string, dest: string, stats?: Stats | null, isUseHardLink = _isUseHardLink): Promise {
+ if (stats != null) {
+ const originalModeNumber = stats.mode
+ const mode = new Mode(stats)
+ if (mode.owner.execute) {
+ mode.group.execute = true
+ mode.others.execute = true
+ }
+
+ mode.group.read = true
+ mode.others.read = true
+
+ if (originalModeNumber !== stats.mode) {
+ if (debug.enabled) {
+ const oldMode = new Mode(Object.assign({}, stats, {mode: originalModeNumber}))
+ debug(`${dest} permissions fixed from ${oldMode.toOctal()} (${oldMode.toString()}) to ${mode.toOctal()} (${mode.toString()})`)
+ }
+
+ // https://helgeklein.com/blog/2009/05/hard-links-and-permissions-acls/
+ // Permissions on all hard links to the same data on disk are always identical. The same applies to attributes.
+ // That means if you change the permissions/owner/attributes on one hard link, you will immediately see the changes on all other hard links.
+ if (isUseHardLink) {
+ isUseHardLink = false
+ debug(`${dest} will be copied, but not linked, because file permissions need to be fixed`)
+ }
+ }
+ }
+
+ if (isUseHardLink) {
+ return link(src, dest)
+ }
+
+ return new BluebirdPromise(function (resolve, reject) {
+ const readStream = createReadStream(src)
+ const writeStream = createWriteStream(dest, stats == null ? undefined : {mode: stats.mode})
+
+ readStream.on("error", reject)
+ writeStream.on("error", reject)
+
+ writeStream.on("open", function () {
+ readStream.pipe(writeStream)
+ })
+
+ writeStream.once("finish", resolve)
+ })
+}
+
+export class FileCopier {
+ constructor(private isUseHardLinkFunction?: (file: string) => boolean, private isUseHardLink = _isUseHardLink) {
+ }
+
+ async copy(src: string, dest: string, stat: Stats | undefined) {
+ try {
+ await copyFile(src, dest, stat, (!this.isUseHardLink || this.isUseHardLinkFunction == null) ? this.isUseHardLink : this.isUseHardLinkFunction(dest))
+ }
+ catch (e) {
+ // files are copied concurrently, so, we must not check here currentIsUseHardLink — our code can be executed after that other handler will set currentIsUseHardLink to false
+ if (e.code === "EXDEV") {
+ // ...but here we want to avoid excess debug log message
+ if (this.isUseHardLink) {
+ debug(`Cannot copy using hard link: ${e}`)
+ this.isUseHardLink = false
+ }
+
+ await copyFile(src, dest, stat, false)
+ }
+ else {
+ throw e
+ }
+ }
+ }
+}
+
+/**
+ * Empty directories is never created.
+ * Hard links is used if supported and allowed.
+ */
+export function copyDir(src: string, destination: string, filter?: Filter, isUseHardLink?: (file: string) => boolean): Promise {
+ if (debug.enabled) {
+ debug(`Copying ${src} to ${destination}${_isUseHardLink ? " using hard links" : ""}`)
+ }
+
+ const createdSourceDirs = new Set()
+ const fileCopier = new FileCopier(isUseHardLink)
+ const links: Array = []
+ return walk(src, filter, async(file, stat, parent) => {
+ if (!stat.isFile() && !stat.isSymbolicLink()) {
+ return
+ }
+
+ if (!createdSourceDirs.has(parent)) {
+ await mkdirs(parent.replace(src, destination))
+ createdSourceDirs.add(parent)
+ }
+
+ const destFile = file.replace(src, destination)
+ if (stat.isFile()) {
+ await fileCopier.copy(file, destFile, stat)
+ }
+ else {
+ links.push({"file": destFile, "link": await readlink(file)})
+ }
+ })
+ .then(() => BluebirdPromise.map(links, it => symlink(it.link, it.file), CONCURRENCY))
+}
+
+interface Link {
+ readonly link: string,
+ readonly file: string
+}
\ No newline at end of file
diff --git a/src/util/httpExecutor.ts b/src/util/httpExecutor.ts
new file mode 100644
index 00000000000..08a4013f207
--- /dev/null
+++ b/src/util/httpExecutor.ts
@@ -0,0 +1,63 @@
+import { Url } from "url"
+import { createHash } from "crypto"
+import { Transform } from "stream"
+
+export interface DownloadOptions {
+ skipDirCreation?: boolean
+ sha2?: string
+}
+
+export class HttpExecutorHolder {
+ private _httpExecutor: HttpExecutor
+
+ get httpExecutor(): HttpExecutor {
+ if (this._httpExecutor == null) {
+ this._httpExecutor = new (require((global).__test_app == null ? "./nodeHttpExecutor" : "out/util/nodeHttpExecutor").NodeHttpExecutor)()
+ }
+ return this._httpExecutor
+ }
+
+ set httpExecutor(value: HttpExecutor) {
+ this._httpExecutor = value
+ }
+}
+
+export interface HttpExecutor {
+ request(url: Url, token?: string | null, data?: {[name: string]: any; } | null, method?: string): Promise
+
+ download(url: string, destination: string, options?: DownloadOptions | null): Promise
+}
+
+export class HttpError extends Error {
+ constructor(public readonly response: {statusMessage?: string | undefined, statusCode?: number | undefined, headers?: { [key: string]: string[]; } | undefined}, public description: any | null = null) {
+ super(response.statusCode + " " + response.statusMessage + (description == null ? "" : ("\n" + JSON.stringify(description, null, " "))) + "\nHeaders: " + JSON.stringify(response.headers, null, " "))
+ }
+}
+
+export class DigestTransform extends Transform {
+ private readonly digester = createHash("sha256")
+
+ constructor(private expected: string) {
+ super()
+ }
+
+ _transform(chunk: any, encoding: string, callback: Function) {
+ this.digester.update(chunk)
+ callback(null, chunk)
+ }
+
+ _flush(callback: Function): void {
+ const hash = this.digester.digest("hex")
+ callback(hash === this.expected ? null : new Error(`SHA2 checksum mismatch, expected ${this.expected}, got ${hash}`))
+ }
+}
+
+export const executorHolder = new HttpExecutorHolder()
+
+export function githubRequest(path: string, token: string | null, data: {[name: string]: any; } | null = null, method: string = "GET"): Promise {
+ return request({hostname: "api.github.com", path: path}, token, data, method)
+}
+
+export function request(url: Url, token: string | null = null, data: {[name: string]: any; } | null = null, method: string = "GET"): Promise {
+ return executorHolder.httpExecutor.request(url, token, data, method)
+}
\ No newline at end of file
diff --git a/src/util/httpRequest.ts b/src/util/httpRequest.ts
index 74f03ffdfc4..c959743d894 100644
--- a/src/util/httpRequest.ts
+++ b/src/util/httpRequest.ts
@@ -1,129 +1,6 @@
-import { Socket } from "net"
-import { IncomingMessage, ClientRequest } from "http"
-import * as https from "https"
-import * as http from "http"
-import { createWriteStream, ensureDir } from "fs-extra-p"
-import { parse as parseUrl } from "url"
-import BluebirdPromise from "bluebird-lst-c"
-import * as path from "path"
-import { createHash } from "crypto"
-import { Transform } from "stream"
+import { DownloadOptions, executorHolder } from "./httpExecutor"
-const maxRedirects = 10
-
-export interface DownloadOptions {
- skipDirCreation?: boolean
- sha2?: string
-}
export function download(url: string, destination: string, options?: DownloadOptions | null): Promise {
- return new BluebirdPromise(function (resolve, reject) {
- doDownload(url, destination, 0, options || {}, error => {
- if (error == null) {
- resolve(destination)
- }
- else {
- reject(error)
- }
- })
- })
-}
-
-export function addTimeOutHandler(request: ClientRequest, callback: (error: Error) => void) {
- request.on("socket", function (socket: Socket) {
- socket.setTimeout(60 * 1000, () => {
- callback(new Error("Request timed out"))
- request.abort()
- })
- })
-}
-
-function doDownload(url: string, destination: string, redirectCount: number, options: DownloadOptions, callback: (error: Error | null) => void) {
- const ensureDirPromise = options.skipDirCreation ? BluebirdPromise.resolve() : ensureDir(path.dirname(destination))
-
- const parsedUrl = parseUrl(url)
- // user-agent must be specified, otherwise some host can return 401 unauthorised
- const request = (parsedUrl.protocol === "https:" ? https.request : http.request)({
- hostname: parsedUrl.hostname,
- port: (parsedUrl.port != null ? parseInt(parsedUrl.port) : undefined),
- path: parsedUrl.path,
- headers: {
- "User-Agent": "electron-builder"
- },
- }, (response: IncomingMessage) => {
- if (response.statusCode >= 400) {
- callback(new Error(`Cannot download "${url}", status ${response.statusCode}: ${response.statusMessage}`))
- return
- }
-
- const redirectUrl = response.headers.location
- if (redirectUrl != null) {
- if (redirectCount < maxRedirects) {
- doDownload(redirectUrl, destination, redirectCount++, options, callback)
- }
- else {
- callback(new Error("Too many redirects (> " + maxRedirects + ")"))
- }
- return
- }
-
- const sha2Header = response.headers["X-Checksum-Sha2"]
- if (sha2Header != null && options.sha2 != null) {
- // todo why bintray doesn't send this header always
- if (sha2Header == null) {
- throw new Error("checksum is required, but server response doesn't contain X-Checksum-Sha2 header")
- }
- else if (sha2Header !== options.sha2) {
- throw new Error(`checksum mismatch: expected ${options.sha2} but got ${sha2Header} (X-Checksum-Sha2 header)`)
- }
- }
-
- ensureDirPromise
- .then(() => {
- const fileOut = createWriteStream(destination)
- if (options.sha2 == null) {
- response.pipe(fileOut)
- }
- else {
- response
- .pipe(new DigestTransform(options.sha2))
- .pipe(fileOut)
- }
-
- fileOut.on("finish", () => (fileOut.close)(callback))
- })
- .catch(callback)
-
- let ended = false
- response.on("end", () => {
- ended = true
- })
-
- response.on("close", () => {
- if (!ended) {
- callback(new Error("Request aborted"))
- }
- })
- })
- addTimeOutHandler(request, callback)
- request.on("error", callback)
- request.end()
-}
-
-class DigestTransform extends Transform {
- readonly digester = createHash("sha256")
-
- constructor(private expected: string) {
- super()
- }
-
- _transform(chunk: any, encoding: string, callback: Function) {
- this.digester.update(chunk)
- callback(null, chunk)
- }
-
- _flush(callback: Function): void {
- const hash = this.digester.digest("hex")
- callback(hash === this.expected ? null : new Error(`SHA2 checksum mismatch, expected ${this.expected}, got ${hash}`))
- }
-}
+ return executorHolder.httpExecutor.download(url, destination, options)
+}
\ No newline at end of file
diff --git a/src/util/log.ts b/src/util/log.ts
index 4ff297dc991..6593b40f47f 100644
--- a/src/util/log.ts
+++ b/src/util/log.ts
@@ -101,7 +101,7 @@ class Logger {
let out = ""
let firstPendingLineIndex = 0
while (firstPendingLineIndex < prevLineCount) {
- let line = this.lines[firstPendingLineIndex]
+ const line = this.lines[firstPendingLineIndex]
if (line.promise == null || !line.promise.isPending()) {
out += line.text
firstPendingLineIndex++
@@ -122,7 +122,7 @@ class Logger {
this.lines.splice(0, firstPendingLineIndex)
}
- for (let line of this.lines) {
+ for (const line of this.lines) {
out += line.text
}
diff --git a/src/util/nodeHttpExecutor.ts b/src/util/nodeHttpExecutor.ts
new file mode 100644
index 00000000000..bd13e0f3546
--- /dev/null
+++ b/src/util/nodeHttpExecutor.ts
@@ -0,0 +1,268 @@
+import { Socket } from "net"
+import { IncomingMessage, ClientRequest, Agent } from "http"
+import * as https from "https"
+import { createWriteStream, ensureDir, readFile } from "fs-extra-p"
+import BluebirdPromise from "bluebird-lst-c"
+import * as path from "path"
+import { homedir } from "os"
+import { parse as parseIni } from "ini"
+import { HttpExecutor, DownloadOptions, HttpError, DigestTransform } from "./httpExecutor"
+import { Url } from "url"
+import { RequestOptions } from "https"
+import { safeLoad } from "js-yaml"
+import { parse as parseUrl } from "url"
+import { debug } from "./util"
+
+export class NodeHttpExecutor implements HttpExecutor {
+ private readonly maxRedirects = 10
+
+ private httpsAgent: Promise | null = null
+
+ request(url: Url, token: string | null = null, data: {[name: string]: any; } | null = null, method: string = "GET"): Promise {
+ const options: any = Object.assign({
+ method: method,
+ headers: {
+ "User-Agent": "electron-builder"
+ }
+ }, url)
+
+ if (url.hostname!!.includes("github") && !url.path!.endsWith(".yml")) {
+ options.headers.Accept = "application/vnd.github.v3+json"
+ }
+
+ const encodedData = data == null ? null : new Buffer(JSON.stringify(data))
+ if (encodedData != null) {
+ options.method = "post"
+ options.headers["Content-Type"] = "application/json"
+ options.headers["Content-Length"] = encodedData.length
+ }
+ return this.doApiRequest