nw-builder 3.5.7 → 3.6.0

package/lib/index.js

@@ -55,7 +55,7 @@ function NwBuilder(options) {
         files: null,
         appName: false,
         appVersion: false,
-        platforms: ['osx64', 'win32', 'win64'],
+        platforms: [detectCurrentPlatform()],
         currentPlatform: detectCurrentPlatform(),
         version: 'latest',
         buildDir: './build',
@@ -73,7 +73,7 @@ function NwBuilder(options) {
         macPlist: false,
         winVersionString: {},
         winIco: null,
-        argv: process.argv.slice(2)
+        argv: []
     };
     // Intercept the platforms and check for the legacy platforms of 'osx' and 'win' and
     // replace with 'osx32', 'osx64', and 'win32', 'win64' respectively.
@@ -147,6 +147,10 @@ NwBuilder.prototype.build = function (callback) {
 };
 
 NwBuilder.prototype.run = function (callback) {
+    // We do not want to download nwjs for other platforms if are going to run the App
+    var platforms = this.options.platforms;
+    this.options.platforms = [this.options.currentPlatform];
+
     // Let's run this NWjs app
     var run = this.checkFiles()
         .then(this.resolveLatestVersion.bind(this))
@@ -157,9 +161,11 @@ NwBuilder.prototype.run = function (callback) {
 
     if(typeof callback === 'function'){
         run.then(function(result){
+            this.options.platforms = platforms
             callback(false, result);
         })
         .catch(function(error){
+            this.options.platforms = platforms
             callback(true, error);
         });
         return true;
@@ -439,11 +445,12 @@ NwBuilder.prototype.copyNwjs = function () {
                 var options = {};
 
                 if(['nw', 'nwjs.app', 'nw.exe'].indexOf(destFile) !== -1){
-                    // ignore nwjs.app/Contents/Resources/*.lproj, otherwise the app name will show as nwjs.app in
-                    // Finder
+                    // ignore nwjs.app/Contents/Resources/*.lproj/InfoPlist.strings,
+                    // otherwise the app name will show as nwjs.app in Finder.
+                    // *.lproj directory itself needs to be kept to support multiple locales.
                     if(destFile === 'nwjs.app'){
                         options.filter = function(filepath){
-                            return !/nwjs\.app\/Contents\/Resources\/[^.]+\.lproj(\/|$)/.test(filepath);
+                            return !/nwjs\.app\/Contents\/Resources\/[^.]+\.lproj\/InfoPlist\.strings$/.test(filepath);
                         };
                     }
                     // rename executable to app name
@@ -762,7 +769,10 @@ NwBuilder.prototype.runApp = function () {
     self.emit('log', 'Launching App');
     return new Promise(function(resolve, reject) {
         var parentDirectory = (_.isArray(self.options.files) ? self.options.files[0] : self.options.files ).replace(/\*[\/\*]*/,"");
-        var nwProcess = self._nwProcess = spawn(executable, ['--enable-logging', parentDirectory].concat(self.options.argv));
+        var nwProcess = self._nwProcess = spawn(executable, [parentDirectory].concat(self.options.argv), {
+            detached: true,
+            windowsHide: true
+        });
 
         self.emit('appstart');
 

package/package.json

@@ -1,73 +1,78 @@
 {
   "name": "nw-builder",
-  "version": "3.5.7",
-  "description": "nw-builder",
+  "version": "3.6.0",
+  "description": "Build NW.js applications for Mac, Windows and Linux.",
+  "keywords": ["NW.js", "Desktop", "Application"],
+  "author": "Steffen Müller",
+  "license": "MIT",
   "main": "index.js",
-  "scripts": {
-    "test": "tape test/*.js"
-  },
+  "homepage": "https://github.com/nwjs-community/nw-builder",
   "repository": {
     "type": "git",
-    "url": "git://github.com/mllrsohn/nw-builder.git"
-  },
-  "bin": {
-    "nwbuild": "./bin/nwbuild"
-  },
-  "author": {
-    "name": "Steffen Müller"
-  },
-  "contributors": [
-    {
-      "name": "Adam Lynch",
-      "email": "contact@adamlynch.com"
-    }
-  ],
-  "engines": {
-    "node": ">= 4.0.0"
+    "url": "https://github.com/nwjs-community/nw-builder.git"
   },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/mllrsohn/nw-builder/issues"
+  "scripts": {
+    "format": "prettier --write ./lib",
+    "lint": "eslint --ext .js ./lib",
+    "test": "tape test/*.js",
+    "demo": "node ./demo.js"
   },
-  "homepage": "https://github.com/mllrsohn/nw-builder",
-  "keywords": [
-    "NW.js",
-    "node-webkit",
-    "desktop",
-    "application"
-  ],
   "devDependencies": {
-    "decompress-zip": "0.3.1",
-    "eol": "^0.9.0",
-    "nock": "^9.0.5",
-    "redtape": "~1.0.0",
-    "tap-spec": "^4.1.1",
-    "tape": "~4.9.0"
+    "decompress-zip": "0.3.3",
+    "eol": "0.9.1",
+    "eslint": "8.15.0",
+    "nock": "9.0.5",
+    "prettier": "2.6.2",
+    "redtape": "1.0.0",
+    "tap-spec": "4.1.1",
+    "tape": "4.9.0"
   },
   "dependencies": {
-    "archiver": "^2.1.1",
-    "boxen": "^1.1.0",
-    "chalk": "^2.3.2",
-    "deprecate": "~1.0.0",
-    "extract-zip": "^1.6.5",
-    "graceful-fs-extra": "^2.0.0",
-    "graceful-ncp": "^3.0.0",
-    "inherits": "~2.0.1",
-    "lazy-req": "^2.0.0",
-    "lodash": "~4.17.4",
-    "optimist": "^0.6.1",
-    "plist": "^3.0.1",
-    "progress": "~2.0.0",
-    "rcedit": "^1.0.0",
-    "recursive-readdir-sync": "^1.0.6",
-    "request": "^2.88.0",
-    "rimraf": "^2.5.2",
-    "semver": "^5.5.0",
-    "simple-glob": "~0.2.0",
-    "tar-fs": "^1.13.0",
+    "archiver": "2.1.1",
+    "boxen": "1.1.0",
+    "chalk": "2.3.2",
+    "deprecate": "1.1.1",
+    "extract-zip": "1.6.5",
+    "graceful-fs-extra": "2.0.0",
+    "graceful-ncp": "3.0.0",
+    "inherits": "2.0.4",
+    "lazy-req": "2.0.0",
+    "lodash": "4.17.21",
+    "optimist": "0.6.1",
+    "plist": "3.0.5",
+    "progress": "2.0.3",
+    "rcedit": "1.0.0",
+    "recursive-readdir-sync": "1.0.6",
+    "request": "2.88.2",
+    "rimraf": "2.5.2",
+    "semver": "5.5.0",
+    "simple-glob": "0.2.0",
+    "tar-fs": "1.16.2",
     "temp": "github:adam-lynch/node-temp#remove_tmpdir_dep",
-    "thenify": "^3.3.0",
-    "update-notifier": "^2.4.0",
-    "winresourcer": "^0.9.0"
+    "thenify": "3.3.1",
+    "update-notifier": "2.4.0",
+    "winresourcer": "0.9.0"
+  },
+  "bin": {
+    "nwbuild": "./bin/nwbuild"
+  },
+  "prettier": {
+    "printWidth": 80,
+    "tabWidth": 2,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": false,
+    "quoteProps": "consistent",
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "bracketSameLine": false,
+    "arrowParens": "always",
+    "proseWrap": "preserve",
+    "htmlWhitespaceSensitivity": "strict",
+    "endOfLine": "lf",
+    "singleAttributePerLine": true
+  },
+  "eslintConfig": {
+    "extends": "eslint:recommended"
   }
 }

package/test/downloader.js

@@ -0,0 +1,87 @@
+var test = require('tape'),
+    nock = require('nock'),
+    temp = require('temp'),
+    path = require('path'),
+    fs = require('fs');
+
+    temp.track();
+
+var downloader = require('./../lib/downloader');
+var fixturesCache = './test/fixtures/cache/v0.8.3';
+var fixturesZip = './test/fixtures/test.zip';
+var fixturesZipStrip = './test/fixtures/test-strip.zip';
+var fixturesTar = './test/fixtures/test.tar.gz';
+var isWindows = process.platform === 'win32';
+
+test('checkCache', function (t) {
+    t.plan(2);
+    t.ok(downloader.checkCache(fixturesCache + '/osx', ['node-webkit.app']));
+    t.notOk(downloader.checkCache(fixturesCache + '/linux32', ['nwsnapshot', 'nwsnapshot2']));
+});
+
+test('downloadAndUnpack: zip', function (t) {
+    t.plan(isWindows ? 3 : 6);
+    nock('https://amazon.s3.nw.com').get('/test.zip').replyWithFile(200, fixturesZip);
+    temp.mkdir('tmpcache', function(err, dirPath) {
+        downloader.downloadAndUnpack(dirPath, 'https://amazon.s3.nw.com/test.zip').then(function (files) {
+            files.forEach(function (file) {
+                t.ok(fs.existsSync(path.join(dirPath, file.path)), file.path + ' unpacked');
+            });
+
+            if(!isWindows) {
+                t.ok(fs.statSync(path.join(dirPath, 'file1')).mode.toString(8) == 100444, '444 file permission');
+                t.ok(fs.statSync(path.join(dirPath, 'file2')).mode.toString(8) == 100666, '666 file permission');
+                t.ok(fs.statSync(path.join(dirPath, 'file3')).mode.toString(8) == 100644, '644 file permission'); // DOES NOT WORK ON WINDOWS
+            }
+        });
+    });
+});
+
+test('downloadAndUnpack: zip+strip', function (t) {
+    t.plan(isWindows ? 3 : 6);
+    nock('https://amazon.s3.nw.com').get('/test-strip.zip').replyWithFile(200, fixturesZipStrip);
+    temp.mkdir('tmpcache', function(err, dirPath) {
+        downloader.downloadAndUnpack(dirPath, 'https://amazon.s3.nw.com/test-strip.zip').then(function (files) {
+            files.forEach(function (file) {
+                t.ok(fs.existsSync(path.join(dirPath, file.path)), file.path + ' unpacked');
+            });
+
+            if(!isWindows) {
+                t.ok(fs.statSync(path.join(dirPath, 'file1')).mode.toString(8) == 100444, '444 file permission');
+                t.ok(fs.statSync(path.join(dirPath, 'file2')).mode.toString(8) == 100666, '666 file permission');
+                t.ok(fs.statSync(path.join(dirPath, 'file3')).mode.toString(8) == 100644, '644 file permission'); // DOES NOT WORK ON WINDOWS
+            }
+        });
+    });
+});
+
+test('downloadAndUnpack: tar', function (t) {
+    t.plan(isWindows ? 3 : 6);
+    nock('https://amazon.s3.nw.com').get('/test.tar.gz').replyWithFile(200, fixturesTar);
+    temp.mkdir('tmpcache', function(err, dirPath) {
+        downloader.downloadAndUnpack(dirPath, 'https://amazon.s3.nw.com/test.tar.gz').then(function (files) {
+            files.forEach(function (file) {
+                t.ok(fs.existsSync(path.join(dirPath, file.path)), file.path + ' unpacked');
+            });
+
+            if(!isWindows) {
+                t.ok(fs.statSync(path.join(dirPath, 'file1')).mode.toString(8) == 100444, '444 file permission'); // DOES NOT WORK ON WINDOWS
+                t.ok(fs.statSync(path.join(dirPath, 'file2')).mode.toString(8) == 100666, '666 file permission');
+                t.ok(fs.statSync(path.join(dirPath, 'file3')).mode.toString(8) == 100644, '644 file permission'); // DOES NOT WORK ON WINDOWS
+            }
+
+        });
+    });
+});
+
+test('Should throw an error if you try to download a file that is not available', function (t) {
+    t.plan(2);
+    nock('https://doesnot.com').get('/exist.zip').reply(404);
+    downloader.downloadAndUnpack('/', 'https://doesnot.com/exist.zip').catch(function (err) {
+        t.equal(err.statusCode, 404, err.msg);
+    });
+    nock('https://doesnot.com').get('/exist.tar').reply(404);
+    downloader.downloadAndUnpack('/', 'https://doesnot.com/exist.tar').catch(function (err) {
+        t.equal(err.statusCode, 404, err.msg);
+    });
+});

package/test/expected/README.md

@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/test/expected/merged

@@ -0,0 +1 @@
+imagefilejsfile

package/test/expected/oneOveriddenRestNot/README.md

@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/oneOveriddenRestNot/osx32.json

@@ -0,0 +1,9 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "index.html",
+    "window": {
+        "frame": true,
+        "toolbar": false
+    }
+}

package/test/expected/oneOveriddenRestNot/osx64.json

@@ -0,0 +1,9 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "index.html",
+    "window": {
+        "frame": true,
+        "toolbar": false
+    }
+}

package/test/expected/osx-plist/1.plist

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>CFBundleDevelopmentRegion</key>
+    <string>en</string>
+    <key>CFBundleDisplayName</key>
+    <string>My cool TestApp</string>
+    <key>CFBundleDocumentTypes</key>
+    <array/>
+    <key>CFBundleExecutable</key>
+    <string>nwjs</string>
+    <key>CFBundleIconFile</key>
+    <string>nw.icns</string>
+    <key>CFBundleIdentifier</key>
+    <string>com.nw-builder.testapp</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>TestApp</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>CFBundleShortVersionString</key>
+    <string>Version 1.3.3.7</string>
+    <key>CFBundleVersion</key>
+    <string>1.3.3.7</string>
+    <key>LSFileQuarantineEnabled</key>
+    <true/>
+    <key>LSMinimumSystemVersion</key>
+    <string>10.6.0</string>
+    <key>NSPrincipalClass</key>
+    <string>NSApplication</string>
+    <key>NSSupportsAutomaticGraphicsSwitching</key>
+    <true/>
+    <key>SCMRevision</key>
+    <string>222137</string>
+    <key>UTExportedTypeDeclarations</key>
+    <array/>
+    <key>NSHumanReadableCopyright</key>
+    <string>(c) by me</string>
+    <key>LSEnvironment</key>
+    <dict>
+      <key>PATH</key>
+      <string>/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin</string>
+    </dict>
+  </dict>
+</plist>

package/test/expected/osx-plist/2.plist

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>CFBundleDevelopmentRegion</key>
+    <string>en</string>
+    <key>CFBundleDisplayName</key>
+    <string>TestApp</string>
+    <key>CFBundleDocumentTypes</key>
+    <array/>
+    <key>CFBundleExecutable</key>
+    <string>nwjs</string>
+    <key>CFBundleIconFile</key>
+    <string>nw.icns</string>
+    <key>CFBundleIdentifier</key>
+    <string>com.nw-builder.testapp</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>TestApp</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>CFBundleShortVersionString</key>
+    <string>Version 1.3.3.7</string>
+    <key>CFBundleVersion</key>
+    <string>1.3.3.7</string>
+    <key>LSFileQuarantineEnabled</key>
+    <true/>
+    <key>LSMinimumSystemVersion</key>
+    <string>10.6.0</string>
+    <key>NSPrincipalClass</key>
+    <string>NSApplication</string>
+    <key>NSSupportsAutomaticGraphicsSwitching</key>
+    <true/>
+    <key>SCMRevision</key>
+    <string>222137</string>
+    <key>UTExportedTypeDeclarations</key>
+    <array/>
+  </dict>
+</plist>

package/test/expected/osx-plist/README.md

@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/platformOverrides/README.md

@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/expected/platformOverrides/linux32.json

@@ -0,0 +1,13 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "another.html",
+    "window": {
+        "frame": true,
+        "toolbar": false
+    },
+    "frame": false,
+    "x": {},
+    "abc": [],
+    "def": {}
+}

package/test/expected/platformOverrides/linux64.json

@@ -0,0 +1,9 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "index.html",
+    "window": {},
+    "x": [],
+    "abc": [],
+    "def": {}
+}

package/test/expected/platformOverrides/osx32.json

@@ -0,0 +1,12 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "other.html",
+    "window": {
+        "frame": false,
+        "toolbar": false
+    },
+    "x": ["y", "z"],
+    "abc": 2,
+    "def": {}
+}

package/test/expected/platformOverrides/osx64.json

@@ -0,0 +1,12 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "other.html",
+    "window": {
+        "frame": false,
+        "toolbar": false
+    },
+    "x": ["y", "z"],
+    "abc": 2,
+    "def": {}
+}

package/test/expected/platformOverrides/win32.json

@@ -0,0 +1,12 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "index.html",
+    "window": {
+        "frame": true,
+        "toolbar": false
+    },
+    "x": ["z"],
+    "abc": [1],
+    "def": {"x":1}
+}

package/test/expected/platformOverrides/win64.json

@@ -0,0 +1,12 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "index.html",
+    "window": {
+        "frame": true,
+        "toolbar": false
+    },
+    "x": ["z"],
+    "abc": [1],
+    "def": {"x":1}
+}

package/test/fixtures/README.md

@@ -0,0 +1,7 @@
+This directory contains all of our [test fixtures](https://en.wikipedia.org/wiki/Test_fixture).
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/test/fixtures/invalid.json

@@ -0,0 +1,3 @@
+{
+  "name": "nw-should-fail"
+}

package/test/fixtures/manifest/README.md

@@ -0,0 +1,7 @@
+This directory contains all of our manifest-related [test fixtures](https://en.wikipedia.org/wiki/Test_fixture).
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/fixtures/manifest/versions.json

@@ -0,0 +1,23 @@
+
+{
+  "latest": "v0.16.0-beta1",
+  "stable": "v0.15.2",
+  "lts": "v0.14.6",
+  "versions": [
+    {
+      "version": "v0.15.2",
+      "files": ["win-x64", "win-ia32", "linux-x64", "linux-ia32", "osx-x64"],
+      "flavors": ["normal", "sdk"]
+    },
+    {
+      "version": "v0.13.2",
+      "files": ["win-x64", "linux-ia32", "osx-x64"],
+      "flavors": ["normal", "sdk", "nacl"]
+    },
+    {
+      "version": "v0.12.3",
+      "files": ["win-x64", "win-ia32", "linux-x64", "linux-ia32", "osx-x64", "osx-ia32"],
+      "flavors": ["normal", "macappstore"]
+    }
+  ]
+}

package/test/fixtures/nwapp/README.md

@@ -0,0 +1,7 @@
+This directory contains example app related [test fixtures](https://en.wikipedia.org/wiki/Test_fixture). Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/fixtures/nwapp/images/imagefile.img

@@ -0,0 +1 @@
+imagefile

package/test/fixtures/nwapp/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hello World!</title>
+  </head>
+  <body>
+    <h1>Hello World!</h1>
+    We are using node.js <script>document.write(process.version)</script>.
+  </body>
+</html>

package/test/fixtures/nwapp/javascript/bower_packages/simple/package.json

@@ -0,0 +1 @@
+{}

package/test/fixtures/nwapp/javascript/jsfile.js

@@ -0,0 +1 @@
+jsfile

package/test/fixtures/nwapp/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "main": "index.html"
+}

package/test/fixtures/oneOveriddenRestNot/README.md

@@ -0,0 +1,7 @@
+This directory contains some [test fixtures](https://en.wikipedia.org/wiki/Test_fixture). Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/test/fixtures/oneOveriddenRestNot/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "nw-demo",
+    "version": "0.1.0",
+    "main": "index.html",
+    "window": {
+        "frame": false,
+        "toolbar": false
+    },
+    "platformOverrides": {
+        "osx32": {
+            "window": {
+                "frame": true
+            }
+        }
+    }
+}