@yao-pkg/pkg 6.10.1 → 6.11.0

package/README.md

@@ -302,21 +302,25 @@ The startup time of the application might be reduced slightly.
 
 All pkg-cache [environment vars](https://github.com/yao-pkg/pkg-fetch#environment), plus:
 
-| Var              | Description                                                                                                                                                          |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `CHDIR`          | Override process `chdir`                                                                                                                                             |
-| `PKG_STRICT_VER` | Turn on some assertion in the walker code to assert that each file content/state that we appending to the virtual file system applies to a real file, not a symlink. |
-| `PKG_EXECPATH`   | Used internally by `pkg`, do not override                                                                                                                            |
+| Var                     | Description                                                                                                                                                          |
+| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `CHDIR`                 | Override process `chdir`                                                                                                                                             |
+| `PKG_NATIVE_CACHE_PATH` | Override the base directory for caching extracted native addons at runtime (default: `~/.cache`)                                                                     |
+| `PKG_STRICT_VER`        | Turn on some assertion in the walker code to assert that each file content/state that we appending to the virtual file system applies to a real file, not a symlink. |
+| `PKG_EXECPATH`          | Used internally by `pkg`, do not override                                                                                                                            |
 
 Examples
 
 ```bash
-# 1 - Using export
+# 1 - Set cache path at build time (for pkg-fetch to cache Node.js binaries)
 export PKG_CACHE_PATH=/my/cache
 pkg app.js
 
-# 2 - Passing it before the script
-PKG_CACHE_PATH=/my/cache pkg app.js
+# 2 - Set cache path at runtime (for packaged app to cache extracted native addons)
+PKG_NATIVE_CACHE_PATH=/opt/myapp/cache ./myapp
+
+# 3 - Both can be used together
+PKG_CACHE_PATH=/build/cache PKG_NATIVE_CACHE_PATH=/runtime/cache pkg app.js
 ```
 
 ## Usage of packaged app
@@ -384,8 +388,17 @@ 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 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.
+`$HOME/.cache/pkg/` by default. These files will stay on the disk after the
+process has exited and will be used again on the next process launch.
+
+You can customize the cache directory by setting the `PKG_NATIVE_CACHE_PATH`
+environment variable. This is useful in enterprise environments where specific
+directories may be restricted or monitored:
+
+```bash
+# Set custom cache path for native addons
+PKG_NATIVE_CACHE_PATH=/opt/myapp/cache ./myapp
+```
 
 When a package, that contains a native module, is being installed,
 the native module is compiled against current system-wide Node.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yao-pkg/pkg",
-  "version": "6.10.1",
+  "version": "6.11.0",
   "description": "Package your Node.js project into an executable",
   "main": "lib-es5/index.js",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "@babel/generator": "^7.23.0",
     "@babel/parser": "^7.23.0",
     "@babel/types": "^7.23.0",
-    "@yao-pkg/pkg-fetch": "3.5.30",
+    "@yao-pkg/pkg-fetch": "3.5.31",
     "into-stream": "^6.0.0",
     "minimist": "^1.2.6",
     "multistream": "^4.1.0",
@@ -81,6 +81,7 @@
     "test:20": "node test/test.js node20 no-npm",
     "test:18": "node test/test.js node18 no-npm",
     "test:host": "node test/test.js host only-npm",
+    "bump:fetch": "yarn add @yao-pkg/pkg-fetch --exact",
     "release": "read -p 'GITHUB_TOKEN: ' GITHUB_TOKEN && export GITHUB_TOKEN=$GITHUB_TOKEN && release-it"
   },
   "simple-git-hooks": {

package/prelude/bootstrap.js

@@ -2187,6 +2187,15 @@ function payloadFileSync(pointer) {
     dlopen: process.dlopen,
   };
 
+  // Allow users to override the cache base directory via PKG_NATIVE_CACHE_PATH environment variable
+  // Default: path.join(homedir(), '.cache')
+  //   - Linux/macOS: /home/john/.cache or /Users/john/.cache
+  //   - Windows: C:\Users\John\.cache
+  // Custom example: /opt/myapp/cache or C:\myapp\cache
+  // Native addons will be extracted to: <PKG_NATIVE_CACHE_BASE>/pkg/<hash>
+  const PKG_NATIVE_CACHE_BASE =
+    process.env.PKG_NATIVE_CACHE_PATH || path.join(homedir(), '.cache');
+
   function revertMakingLong(f) {
     if (/^\\\\\?\\/.test(f)) return f.slice(4);
     return f;
@@ -2206,8 +2215,7 @@ 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: /home/john/.cache/pkg/<hash>
-      const tmpFolder = path.join(homedir(), '.cache/pkg', hash);
+      const tmpFolder = path.join(PKG_NATIVE_CACHE_BASE, 'pkg', hash);
 
       fs.mkdirSync(tmpFolder, { recursive: true });