@yao-pkg/pkg 5.11.5 → 5.12.0

package/README.md

@@ -50,23 +50,23 @@ pkg [options] <input>
 
   Examples:
 
-  – Makes executables for Linux, macOS and Windows
+  - Makes executables for Linux, macOS and Windows
     $ pkg index.js
-  – Takes package.json from cwd and follows 'bin' entry
+  - Takes package.json from cwd and follows 'bin' entry
     $ pkg .
-  – Makes executable for particular target machine
+  - Makes executable for particular target machine
     $ pkg -t node16-win-arm64 index.js
-  – Makes executables for target machines of your choice
+  - Makes executables for target machines of your choice
     $ pkg -t node16-linux,node18-linux,node16-win index.js
-  – Bakes '--expose-gc' and '--max-heap-size=34' into executable
+  - 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
+  - Consider packageA and packageB to be public
     $ pkg --public-packages "packageA,packageB" index.js
-  – Consider all packages to be public
+  - Consider all packages to be public
     $ pkg --public-packages "*" index.js
-  – Bakes '--expose-gc' into executable
+  - Bakes '--expose-gc' into executable
     $ pkg --options expose-gc index.js
-  – reduce size of the data packed inside the executable with GZip
+  - reduce size of the data packed inside the executable with GZip
     $ pkg --compress GZip index.js
 ```
 
@@ -181,6 +181,22 @@ See also
 [Detecting assets in source code](#detecting-assets-in-source-code) and
 [Snapshot filesystem](#snapshot-filesystem).
 
+### Ignore files
+
+`ignore` is a list of globs. Files matching the paths specified as `ignore`
+will be excluded from the final executable.
+
+This is useful when you want to exclude some files from the final executable,
+like tests, documentation or build files that could have been included by a dependency.
+
+```json
+  "pkg": {
+    "ignore": [ "**/*/dependency-name/build.c" ]
+  }
+```
+
+To see if you have unwanted files in your executable, read the [Exploring virtual file system embedded in debug mode](#exploring-virtual-file-system-embedded-in-debug-mode) section.
+
 ### Options
 
 Node.js application can be called with runtime options
@@ -353,14 +369,14 @@ This way you may even avoid creating `pkg` config for your project.
 Native addons (`.node` files) use is supported. When `pkg` encounters
 a `.node` file in a `require` call, it will package this like an asset.
 In some cases (like with the `bindings` package), the module path is generated
-dynamicaly and `pkg` won't be able to detect it. In this case, you should
+dynamically and `pkg` won't be able to detect it. In this case, you should
 add the `.node` file directly in the `assets` field in `package.json`.
 
 The way Node.js requires native addon is different from a classic JS
 file. It needs to have a file on disk to load it, but `pkg` only generates
-one file. To circumvent this, `pkg` will create a temporary file on the
-disk. These files will stay on the disk after the process has exited
-and will be used again on the next process launch.
+one file. To circumvent this, `pkg` will extract native addon files to
+`$HOME/.cache/pkg/`. These files will stay on the disk after the process has
+exited and will be used again on the next process launch.
 
 When a package, that contains a native module, is being installed,
 the native module is compiled against current system-wide Node.js
@@ -413,7 +429,7 @@ printenv | grep NODE
 
 ## Advanced
 
-### exploring virtual file system embedded in debug mode
+### Exploring virtual file system embedded in debug mode
 
 When you are using the `--debug` flag when building your executable,
 `pkg` add the ability to display the content of the virtual file system

package/lib-es5/index.js

@@ -21,6 +21,7 @@ const fabricator_1 = require("./fabricator");
 const walker_1 = __importDefault(require("./walker"));
 const compress_type_1 = require("./compress_type");
 const mach_o_1 = require("./mach-o");
+const options_1 = __importDefault(require("./options"));
 const { version } = JSON.parse((0, fs_extra_1.readFileSync)(path_1.default.join(__dirname, '../package.json'), 'utf-8'));
 function isConfiguration(file) {
     return (0, common_1.isPackageJson)(file) || file.endsWith('.config.json');
@@ -439,6 +440,7 @@ async function exec(argv2) {
     // marker
     let marker;
     if (configJson) {
+        options_1.default.set(configJson === null || configJson === void 0 ? void 0 : configJson.pkg);
         marker = {
             config: configJson,
             base: path_1.default.dirname(config),
@@ -446,6 +448,7 @@ async function exec(argv2) {
         };
     }
     else {
+        options_1.default.set(inputJson === null || inputJson === void 0 ? void 0 : inputJson.pkg);
         marker = {
             config: inputJson || {},
             base: path_1.default.dirname(input),

package/lib-es5/options.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Options {
+    constructor() {
+        this.options = {
+            dictionary: {},
+        };
+    }
+    set(options) {
+        this.options = options !== null && options !== void 0 ? options : this.options;
+    }
+    get() {
+        return this.options;
+    }
+}
+const options = new Options();
+exports.default = options;
+//# sourceMappingURL=options.js.map

package/lib-es5/walker.js

@@ -33,10 +33,12 @@ const is_core_module_1 = __importDefault(require("is-core-module"));
 const globby_1 = __importDefault(require("globby"));
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
+const minimatch_1 = require("minimatch");
 const common_1 = require("./common");
 const follow_1 = require("./follow");
 const log_1 = require("./log");
 const detector = __importStar(require("./detector"));
+const options_1 = __importDefault(require("./options"));
 // Note: as a developer, you can set the PKG_STRICT_VER variable.
 //       this will turn on some assertion in the walker code below
 //       to assert that each file content/state that we appending
@@ -331,6 +333,15 @@ class Walker {
         (0, assert_1.default)(task.store === common_1.STORE_BLOB || task.store === common_1.STORE_CONTENT);
         (0, assert_1.default)(typeof task.file === 'string');
         const realFile = (0, common_1.toNormalizedRealPath)(task.file);
+        const { ignore } = options_1.default.get();
+        if (ignore) {
+            // check if the file matches one of the ignore regex patterns
+            const match = ignore.some((pattern) => (0, minimatch_1.minimatch)(realFile, pattern));
+            if (match) {
+                log_1.log.debug(`Ignoring file: ${realFile} due to top level config ignore pattern`);
+                return;
+            }
+        }
         if (realFile === task.file) {
             this.append(task);
             return;
@@ -569,7 +580,11 @@ class Walker {
         };
         const catchPackageFilter = (config, base) => {
             const newPackage = newPackages[newPackages.length - 1];
-            newPackage.marker = { config, configPath: newPackage.packageJson, base };
+            newPackage.marker = {
+                config,
+                configPath: newPackage.packageJson,
+                base,
+            };
         };
         let newFile = '';
         let failure;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yao-pkg/pkg",
-  "version": "5.11.5",
+  "version": "5.12.0",
   "description": "Package your Node.js project into an executable",
   "main": "lib-es5/index.js",
   "license": "MIT",
@@ -31,6 +31,7 @@
     "globby": "^11.1.0",
     "into-stream": "^6.0.0",
     "is-core-module": "2.9.0",
+    "minimatch": "9.0.4",
     "minimist": "^1.2.6",
     "multistream": "^4.1.0",
     "prebuild-install": "7.1.1",
@@ -43,6 +44,7 @@
     "@types/babel__generator": "7.6.5",
     "@types/fs-extra": "9.0.13",
     "@types/is-core-module": "2.2.0",
+    "@types/minimatch": "^5.1.2",
     "@types/minimist": "1.2.2",
     "@types/multistream": "4.1.0",
     "@types/node": "14.18.20",

package/prelude/bootstrap.js

@@ -24,7 +24,7 @@ const Module = require('module');
 const path = require('path');
 const { promisify, _extend } = require('util');
 const { Script } = require('vm');
-const { tmpdir } = require('os');
+const { homedir } = require('os');
 const util = require('util');
 const {
   brotliDecompress,
@@ -2210,8 +2210,8 @@ function payloadFileSync(pointer) {
       // the hash is needed to be sure we reload the module in case it changes
       const hash = createHash('sha256').update(moduleContent).digest('hex');
 
-      // Example: /tmp/pkg/<hash>
-      const tmpFolder = path.join(tmpdir(), 'pkg', hash);
+      // Example: /home/john/.cache/pkg/<hash>
+      const tmpFolder = path.join(homedir(), '.cache/pkg', hash);
 
       createDirRecursively(tmpFolder);