feat: add no-native-build option to skip native addons build

Fixes #1319

Author: robertsLando

README.md

@@ -43,8 +43,30 @@ pkg [options] <input>
     --public             speed up and disclose the sources of top-level project
     --public-packages    force specified packages to be considered public
     --no-bytecode        skip bytecode generation and include source files as plain js
+    --no-native-build    skip native addons build
     --no-dict            comma-separated list of packages names to ignore dictionaries. Use --no-dict * to disable all dictionaries
     -C, --compress       [default=None] compression algorithm = Brotli or GZip
+
+  Examples:
+
+  – Makes executables for Linux, macOS and Windows
+    $ pkg index.js
+  – Takes package.json from cwd and follows 'bin' entry
+    $ pkg .
+  – Makes executable for particular target machine
+    $ pkg -t node14-win-arm64 index.js
+  – Makes executables for target machines of your choice
+    $ pkg -t node12-linux,node14-linux,node14-win index.js
+  – Bakes '--expose-gc' and '--max-heap-size=34' into executable
+    $ pkg --options "expose-gc,max-heap-size=34" index.js
+  – Consider packageA and packageB to be public
+    $ pkg --public-packages "packageA,packageB" index.js
+  – Consider all packages to be public
+    $ pkg --public-packages "*" index.js
+  – Bakes '--expose-gc' into executable
+    $ pkg --options expose-gc index.js
+  – reduce size of the data packed inside the executable with GZip
+    $ pkg --compress GZip index.js
 ```
 
 The entrypoint of your project is a mandatory CLI argument. It may be:

lib/help.ts

@@ -19,6 +19,7 @@ export default function help() {
     --public             speed up and disclose the sources of top-level project
     --public-packages    force specified packages to be considered public
     --no-bytecode        skip bytecode generation and include source files as plain js
+    --no-native-build    skip native addons build
     --no-dict            comma-separated list of packages names to ignore dictionaries. Use --no-dict * to disable all dictionaries
     -C, --compress       [default=None] compression algorithm = Brotli or GZip
 

lib/index.ts

@@ -225,6 +225,7 @@ export async function exec(argv2: string[]) {
       'b',
       'build',
       'bytecode',
+      'native-build',
       'd',
       'debug',
       'h',
@@ -251,7 +252,7 @@ export async function exec(argv2: string[]) {
       'C',
       'compress',
     ],
-    default: { bytecode: true },
+    default: { bytecode: true, 'native-build': true },
   });
 
   if (argv.h || argv.help) {
@@ -541,6 +542,8 @@ export async function exec(argv2: string[]) {
 
   const { bytecode } = argv;
 
+  const nativeBuild = argv['native-build']
+
   for (const target of targets) {
     target.forceBuild = forceBuild;
 
@@ -677,6 +680,7 @@ export async function exec(argv2: string[]) {
       target: target as Target,
       symLinks,
       doCompress,
+      nativeBuild
     });
 
     if (target.platform !== 'win' && target.output) {

lib/producer.ts

@@ -251,6 +251,7 @@ interface ProducerOptions {
   target: Target;
   symLinks: SymLinks;
   doCompress: CompressType;
+  nativeBuild: boolean;
 }
 
 /**
@@ -314,6 +315,7 @@ export default function producer({
   target,
   symLinks,
   doCompress,
+  nativeBuild
 }: ProducerOptions) {
   return new Promise<void>((resolve, reject) => {
     if (!Buffer.alloc) {
@@ -448,7 +450,7 @@ export default function producer({
 
             assert.strictEqual(stripe.store, STORE_CONTENT); // others must be buffers from walker
 
-            if (isDotNODE(stripe.file)) {
+            if (isDotNODE(stripe.file) && nativeBuild) {
               try {
                 const platformFile = nativePrebuildInstall(target, stripe.file);