Add pkg.outputPath as a configuration option. (#574)

This allows the output path to be specified in package.json, instead of needing to be manually passed as a command-line argument every time.

Author: Symbitic

README.md

@@ -61,8 +61,9 @@ are taken from current platform/Node.js. By default targets are
 During packaging process `pkg` parses your sources, detects
 calls to `require`, traverses the dependencies of your project
 and includes them into executable. In most cases you
-don't need to specify anything manually. However your code
-may have `require(variable)` calls (so called non-literal
+don't need to specify anything manually.
+
+However your code may have `require(variable)` calls (so called non-literal
 argument to `require`) or use non-javascript files (for
 example views, css, images etc).
 
@@ -78,18 +79,24 @@ your `package.json` file.
 ```json
   "pkg": {
     "scripts": "build/**/*.js",
-    "assets": "views/**/*"
+    "assets": "views/**/*",
+    "targets": [ "node4-linux-armv6" ],
+    "outputPath: "dist"
   }
 ```
 
+The above example will include everything in `assets/` and
+every .js file in `build/`, build only for `node4-linux-armv6`,
+and place the executable inside `dist/`.
+
 You may also specify arrays of globs:
 
 ```
     "assets": [ "assets/**/*", "images/**/*" ]
 ```
 
-Just be sure to call `pkg package.json` or `pkg .` to make use
-of `scripts` and `assets` entries.
+Just be sure to call `pkg package.json` or `pkg .` to make
+use of `package.json` configuration.
 
 ### Scripts
 

lib/index.js

@@ -290,7 +290,7 @@ export async function exec(argv2) {
   // output, outputPath
 
   let output = argv.o || argv.output;
-  const outputPath = argv['out-path'] || argv.outdir || argv['out-dir'];
+  let outputPath = argv['out-path'] || argv.outdir || argv['out-dir'];
   let autoOutput = false;
 
   if (output && outputPath) {
@@ -310,6 +310,15 @@ export async function exec(argv2) {
     if (!name) {
       name = path.basename(inputFin);
     }
+    if (!outputPath) {
+      if (inputJson && inputJson.pkg) {
+        outputPath = inputJson.pkg.outputPath;
+      } else
+      if (configJson && configJson.pkg) {
+        outputPath = configJson.pkg.outputPath;
+      }
+      outputPath = outputPath || '';
+    }
     autoOutput = true;
     const ext = path.extname(name);
     output = name.slice(0, -ext.length || undefined);

test/test-46-input-package-json-outputdir/main.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const assert = require('assert');
+const utils = require('../utils.js');
+
+assert(!module.parent);
+assert(__dirname === process.cwd());
+
+const input = '.';
+
+const newcomers = [
+  'out/palookaville-linux',
+  'out/palookaville-macos',
+  'out/palookaville-win.exe'
+];
+
+const before = utils.filesBefore(newcomers);
+
+utils.pkg.sync([
+  input
+], { stdio: 'inherit' });
+
+utils.filesAfter(before, newcomers);
+utils.vacuum.sync('out');

test/test-46-input-package-json-outputdir/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "palookaville",
+  "bin": "test-x-index.js",
+  "pkg": {
+    "outputPath": "out"
+  }
+}

test/test-46-input-package-json-outputdir/test-x-index.js

@@ -0,0 +1,3 @@
+'use strict';
+
+console.log(42);