nexfpack 0.1.1 → 0.1.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Nexfteam
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2026 Nexfteam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README-CN.md

@@ -1,99 +1,100 @@
-# Nexfpack
-
-语言: [English](https://github.com/nexfteam/Nexfpack/blob/main/README.md) | 简体中文(当前)
-
-一个用于将Node.js脚本或模块打包为单个可执行文件的工具。
-
-## 安装
-
-```bash
-npm install -g nexfpack
-# or
-pnpm add -g nexfpack
-# or
-yarn global add nexfpack
-```
-
-## 快速开始
-
-### CLI命令
-
-创建 `nexfpack.config.json` 配置文件并运行以下CLI命令：
-
-```bash
-nexfpack nexfpack.config.json
-```
-
-### CommonJS API
-
-```javascript
-const nexfpack = require('nexfpack');
-
-const config = {
-    "name": "my-app",
-    "entry": "index.js",
-    "output": "dist",
-    "ignore": [".gitignore", "README.md"],
-    "autoRun": true
-};
-
-nexfpack(config);
-
-// 或者使用配置文件
-// nexfpack({configFile: 'nexfpack.config.json'})
-```
-
-### ESM API
-
-```javascript
-import nexfpack from 'nexfpack';
-
-const config = {
-    "name": "my-app",
-    "entry": "index.js",
-    "output": "dist",
-    "ignore": [".gitignore", "README.md"],
-    "autoRun": true
-};
-
-nexfpack(config);
-
-// 或者使用配置文件
-// nexfpack({configFile: 'nexfpack.config.json'})
-```
-
-### 配置文件示例
-
-```json
-{
-    "name": "my-app",
-    "entry": "index.js",
-    "output": "dist",
-    "ignore": [".gitignore", "README.md"],
-    "autoRun": true
-}
-```
-
-## 配置项
-
-| 名称 | 类型 | 描述 | 默认值 |
-| --- | --- | --- | --- |
-| name | string | 应用名称 | `nexfpack-app` |
-| root | string | 根目录 | 若使用配置文件，则为文件所在目录，否则为 `process.cwd()` |
-| relativeRoot | boolean | `root` 是否为相对路径 | `false` |
-| entry | string | 入口文件路径 | `index.js` |
-| output | string | 输出目录 | `dist` |
-| tempdir | string | 打包过程中的临时目录 | `.nexfpack-temp` |
-| autoDeleteTempFiles | boolean | 是否自动删除临时文件 | `true` |
-| ignorefile | string | 忽略文件路径，优先级高于 `ignore` | `.nexfpackignore` |
-| ignore | array | 忽略的文件或目录，支持 glob 语法 | `[]` |
-| enabledSign | boolean | 是否启用签名（暂不支持） | `false` |
-| autoRun | boolean | 是否自动运行打包后的可执行文件 | `false` |
-
-## 环境要求
-
-- Node.js >= 20.12.0
-
-## License
-
-MIT
+# Nexfpack
+
+语言: [English](https://github.com/nexfteam/Nexfpack/blob/main/README.md) | 简体中文(当前)
+
+一个用于将Node.js脚本或模块打包为单个可执行文件的工具。
+
+## 安装
+
+```bash
+npm install -g nexfpack
+# or
+pnpm add -g nexfpack
+# or
+yarn global add nexfpack
+```
+
+## 快速开始
+
+### CLI命令
+
+创建 `nexfpack.config.json` 配置文件并运行以下CLI命令：
+
+```bash
+nexfpack nexfpack.config.json
+```
+
+### CommonJS API
+
+```javascript
+const nexfpack = require('nexfpack');
+
+const config = {
+    "name": "my-app",
+    "entry": "index.js",
+    "output": "dist",
+    "ignore": [".gitignore", "README.md"],
+    "autoRun": true
+};
+
+nexfpack(config);
+
+// 或者使用配置文件
+// nexfpack({configFile: 'nexfpack.config.json'})
+```
+
+### ESM API
+
+```javascript
+import nexfpack from 'nexfpack';
+
+const config = {
+    "name": "my-app",
+    "entry": "index.js",
+    "output": "dist",
+    "ignore": [".gitignore", "README.md"],
+    "autoRun": true
+};
+
+nexfpack(config);
+
+// 或者使用配置文件
+// nexfpack({configFile: 'nexfpack.config.json'})
+```
+
+### 配置文件示例
+
+```json
+{
+    "name": "my-app",
+    "entry": "index.js",
+    "output": "dist",
+    "ignore": [".gitignore", "README.md"],
+    "autoRun": true
+}
+```
+
+## 配置项
+
+| 名称 | 类型 | 描述 | 默认值 |
+| --- | --- | --- | --- |
+| name | string | 应用名称 | `nexfpack-app` |
+| root | string | 根目录 | 若使用配置文件，则为文件所在目录，否则为 `process.cwd()` |
+| relativeRoot | boolean | `root` 是否为相对路径 | `false` |
+| log | boolean | 是否打印日志 | `true` |
+| entry | string | 入口文件路径 | `index.js` |
+| output | string | 输出目录 | `dist` |
+| tempdir | string | 打包过程中的临时目录 | `.nexfpack-temp` |
+| autoDeleteTempFiles | boolean | 是否自动删除临时文件 | `true` |
+| ignorefile | string | 忽略文件路径，优先级高于 `ignore` | `.nexfpackignore` |
+| ignore | array | 忽略的文件或目录，支持 glob 语法 | `[]` |
+| enabledSign | boolean | 是否启用签名（暂不支持） | `false` |
+| autoRun | boolean | 是否自动运行打包后的可执行文件 | `false` |
+
+## 环境要求
+
+- Node.js >= 20.12.0
+
+## License
+
+MIT

package/README.md

@@ -81,6 +81,7 @@ nexfpack(config);
 | name | string | Application name | `nexfpack-app` |
 | root | string | Root directory | The directory of the config file if specified, otherwise `process.cwd()` |
 | relativeRoot | boolean | Whether `root` is a relative path | `false` |
+| log | boolean | Whether to print logs | `true` |
 | entry | string | Entry file path | `index.js` |
 | output | string | Output directory | `dist` |
 | tempdir | string | Temporary directory for the build process | `.nexfpack-temp` |

package/cli.mjs

@@ -1,13 +1,65 @@
-#!/usr/bin/env node
-import nexfpack from "./index.mjs";
-
-const args = process.argv.slice(2);
-if(args.length === 0) {
-  console.log("Usage: nexfpack <config-file-path>");
-  process.exit(1);
-}
-const configFilePath = args[0];
-
-nexfpack({
-  configFile: configFilePath,
+#!/usr/bin/env node
+import nexfpack from "./index.mjs";
+import fs from "fs";
+
+const args = process.argv.slice(2);
+if(args.length === 0) {
+  console.log("Usage: nexfpack <config-file-path>");
+  console.log("Use nexfpack --help for more info.")
+  process.exit(1);
+}
+const configFilePath = args[0];
+
+if(configFilePath === "--help" || configFilePath === "-h") {
+  console.log(
+`
+    __      _       __    _
+   /  \\    / /\\_____\\ \\  / /
+  / /\\ \\  / / / ____/\\ \\/ /
+ / / /\\ \\/ / / /____\\/\\  /_____
+/_/ /  \\__/ / ____/\\  /  \\  ___\\
+\\_\\/    \\_\\/ /____\\/ / /\\ \\ \\__/
+          /_____/\\  /_/  \\_\\  __\\
+          \\_____\\/        \\ \\ \\_/
+                           \\ \\_\\
+ _______            _____   \\/_/__
+|  ___  |   /\\     |  ___| | | / /
+| |___| |  /  \\    | |     | |/ /
+|  _____| / /\\ \\   | |     |   |
+| |      / ____ \\  | |___  | |\\ \\
+|_|     /_/    \\_\\ |_____| |_| \\_\\
+
+`)
+  console.log("Nexfpack - A tool for building single executable files from Node.js scripts or modules.");
+
+  console.log("Version: " + JSON.parse(fs.readFileSync("./package.json", "utf8")).version);
+
+  const helpText = `
+Usage: nexfpack <config-file-path>
+
+Arguments:
+  configFile    Path to JSON config file (default: ./nexfpack.config.json)
+
+Options:
+  --help        Show this help message
+
+Examples:
+  nexfpack ./my-config.json    # Use custom config file
+
+Config file example (nexfpack.config.json):
+{
+  "name": "my-app",
+  "entry": "index.js",
+  "output": "dist",
+  "ignore": [".gitignore", "README.md"],
+  "autoRun": true
+}
+
+For more details, visit: https://github.com/nexfteam/Nexfpack`
+  console.log(helpText);
+  process.exit(0);
+}
+
+nexfpack({
+  configFile: configFilePath,
 });

package/index.d.mts

@@ -2,6 +2,7 @@ interface NexfpackOptions {
     name?: string;
     root?: string;
     relativeRoot?: boolean;
+    log?: boolean;
     entry?: string;
     output?: string;
     tempdir?: string;

package/index.mjs

@@ -42,6 +42,7 @@ async function fillOptions(options) {
     return {
         name: options.name ?? 'nexfpack-app',
         root: cwd,
+        log: options.log ?? true,
         entry: path.resolve(cwd, options.entry ?? 'index.js'),
         output: path.resolve(cwd, options.output ?? 'dist'),
         tempdir: path.resolve(cwd, options.tempdir ?? '.nexfpack-temp'),
@@ -67,35 +68,19 @@ function listAllFiles(dir) {
     return result;
 }
 async function nexfpack(options) {
+    let config;
+    if (options.configFile) {
+        config = JSON.parse(fs.readFileSync(options.configFile, 'utf8'));
+    }
+    else {
+        config = options;
+    }
+    const filledConfig = await fillOptions(config);
     try {
-        console.log(`
-    __      _       __    _
-   /  \\    / /\\_____\\ \\  / /
-  / /\\ \\  / / / ____/\\ \\/ /
- / / /\\ \\/ / / /____\\/\\  /_____
-/_/ /  \\__/ / ____/\\  /  \\  ___\\
-\\_\\/    \\_\\/ /____\\/ / /\\ \\ \\__/
-          /_____/\\  /_/  \\_\\  __\\
-          \\_____\\/        \\ \\ \\_/
-                           \\ \\_\\
- _______            _____   \\/_/__
-|  ___  |   /\\     |  ___| | | / /
-| |___| |  /  \\    | |     | |/ /
-|  _____| / /\\ \\   | |     |   |
-| |      / ____ \\  | |___  | |\\ \\
-|_|     /_/    \\_\\ |_____| |_| \\_\\
-
-`);
-        console.log('▶️ Start packing...');
-        console.log('🧪 Tips: Nexfpack is very experimental. It may have some errors.');
-        let config;
-        if (options.configFile) {
-            config = JSON.parse(fs.readFileSync(options.configFile, 'utf8'));
-        }
-        else {
-            config = options;
+        if (filledConfig.log) {
+            console.log('▶ Start packing...');
+            console.log('🧪 Tips: Nexfpack is very experimental. It may have some errors.');
         }
-        const filledConfig = await fillOptions(config);
         if (!fs.existsSync(filledConfig.tempdir)) {
             fs.mkdirSync(filledConfig.tempdir, { recursive: true });
         }
@@ -103,14 +88,18 @@ async function nexfpack(options) {
             fs.rmSync(filledConfig.tempdir, { recursive: true, force: true });
             fs.mkdirSync(filledConfig.tempdir, { recursive: true });
         }
-        console.log('📄 Copying files...');
+        if (filledConfig.log) {
+            console.log('📄 Copying files...');
+        }
         if (!fs.existsSync(path.join(filledConfig.tempdir, 'source-copy'))) {
             fs.mkdirSync(path.join(filledConfig.tempdir, 'source-copy'), { recursive: true });
         }
         await new Promise((resolve, reject) => {
             copyfiles([filledConfig.root, path.join(filledConfig.tempdir, 'source-copy')], { up: 1, exclude: filledConfig.ignore }, (err) => {
                 if (err) {
-                    console.error('❌ Failed to copy files:', err);
+                    if (filledConfig.log) {
+                        console.error('❌ Failed to copy files:', err);
+                    }
                     reject(err);
                 }
                 else {
@@ -118,11 +107,15 @@ async function nexfpack(options) {
                 }
             });
         });
-        console.log('📜 Packing source...');
+        if (filledConfig.log) {
+            console.log('📜 Packing source...');
+        }
         const tarStream = packTar(path.join(filledConfig.tempdir, 'source-copy'));
         const writeStream = fs.createWriteStream(path.join(filledConfig.tempdir, 'source.tar'));
         await pipeline(tarStream, writeStream);
-        console.log('📦 Packing executable...');
+        if (filledConfig.log) {
+            console.log('📦 Packing executable...');
+        }
         fs.writeFileSync(path.join(filledConfig.tempdir, 'package.json'), JSON.stringify({
             name: filledConfig.name,
             version: '1.0.0',
@@ -134,7 +127,10 @@ async function nexfpack(options) {
         }, null, 2));
         const installSpawnResult = child_process.spawnSync('npm install --omit=dev', { stdio: 'inherit', cwd: filledConfig.tempdir, shell: true });
         if (installSpawnResult.status !== 0) {
-            throw new Error('❌ Failed to install dependencies');
+            if (filledConfig.log) {
+                console.error('❌ Failed to install dependencies');
+            }
+            throw new Error('Failed to install dependencies');
         }
         const allNodeModulesFiles = listAllFiles(path.join(filledConfig.tempdir, 'node_modules'));
         const seaConfigContent = {
@@ -150,66 +146,69 @@ async function nexfpack(options) {
             seaConfigContent.assets[`node_modules/${relativePath}`] = file;
         }
         fs.writeFileSync(path.join(filledConfig.tempdir, 'sea-config.json'), JSON.stringify(seaConfigContent));
-        const launcherContent = `
-(async () => {
-  const fs = require('fs');
-  const path = require('path');
-  const os = require('os');
-  const { pathToFileURL } = require('url');
-  let sea;
-  try {
-    sea = require('node:sea');
-  } catch (e1) {
-    try {
-      sea = process.getBuiltinModule('sea');
-    } catch (e2) {
-      try {
-        sea = globalThis.process?.getBuiltinModule?.('sea');
-      } catch (e3) {
-        sea = null;
-      }
-    }
-  }
-
-  const tempDir = path.join(os.tmpdir(), 'TEMP-NEXFPACK-' + Date.now() + '-' + Math.random().toString(36).substring(2));
-  fs.mkdirSync(tempDir, { recursive: true });
-
-  try {
-    const keys = ${JSON.stringify(Object.keys(seaConfigContent.assets).filter(key => key !== 'source.tar'))};
-    for (const key of keys) {
-        const data = sea.getRawAsset(key);
-        const filePath = path.join(tempDir, 'LANCHER', key);
-        fs.mkdirSync(path.dirname(filePath), { recursive: true });
-        fs.writeFileSync(filePath, Buffer.from(data));
-    }
-
-    const tarData = sea.getRawAsset('source.tar');
-
-    const tarFile = path.join(tempDir, 'source.tar');
-    fs.writeFileSync(tarFile, Buffer.from(tarData));
-
-    const { unpackTar } = await import(pathToFileURL(path.join(tempDir, 'LANCHER', 'node_modules', 'modern-tar', 'dist', 'fs', 'index.js')));
-    const extractStream = unpackTar(tempDir);
-    const tarReadStream = fs.createReadStream(tarFile);
-    const { pipeline } = require('stream/promises');
-    await pipeline(tarReadStream, extractStream);
-
-    const entry = path.resolve(tempDir, ${JSON.stringify(filledConfig.entry)});
-    try {
-      require(entry);
-    } catch {
-      await import(pathToFileURL(entry));
-    }
-  } catch (err) {
-    console.error(err);
-  }
-  fs.rmSync(tempDir, { recursive: true, force: true });
-})();
+        const launcherContent = `
+(async () => {
+  const fs = require('fs');
+  const path = require('path');
+  const os = require('os');
+  const { pathToFileURL } = require('url');
+  let sea;
+  try {
+    sea = require('node:sea');
+  } catch (e1) {
+    try {
+      sea = process.getBuiltinModule('sea');
+    } catch (e2) {
+      try {
+        sea = globalThis.process?.getBuiltinModule?.('sea');
+      } catch (e3) {
+        sea = null;
+      }
+    }
+  }
+
+  const tempDir = path.join(os.tmpdir(), 'TEMP-NEXFPACK-' + Date.now() + '-' + Math.random().toString(36).substring(2));
+  fs.mkdirSync(tempDir, { recursive: true });
+
+  try {
+    const keys = ${JSON.stringify(Object.keys(seaConfigContent.assets).filter(key => key !== 'source.tar'))};
+    for (const key of keys) {
+        const data = sea.getRawAsset(key);
+        const filePath = path.join(tempDir, 'LANCHER', key);
+        fs.mkdirSync(path.dirname(filePath), { recursive: true });
+        fs.writeFileSync(filePath, Buffer.from(data));
+    }
+
+    const tarData = sea.getRawAsset('source.tar');
+
+    const tarFile = path.join(tempDir, 'source.tar');
+    fs.writeFileSync(tarFile, Buffer.from(tarData));
+
+    const { unpackTar } = await import(pathToFileURL(path.join(tempDir, 'LANCHER', 'node_modules', 'modern-tar', 'dist', 'fs', 'index.js')));
+    const extractStream = unpackTar(tempDir);
+    const tarReadStream = fs.createReadStream(tarFile);
+    const { pipeline } = require('stream/promises');
+    await pipeline(tarReadStream, extractStream);
+
+    const entry = path.resolve(tempDir, ${JSON.stringify(filledConfig.entry)});
+    try {
+      require(entry);
+    } catch {
+      await import(pathToFileURL(entry));
+    }
+  } catch (err) {
+    console.error(err);
+  }
+  fs.rmSync(tempDir, { recursive: true, force: true });
+})();
 `;
         fs.writeFileSync(path.join(filledConfig.tempdir, 'launcher.cjs'), launcherContent);
         const blobSpawnResult = child_process.spawnSync('node --experimental-sea-config sea-config.json', { stdio: 'inherit', cwd: filledConfig.tempdir, shell: true });
         if (blobSpawnResult.status !== 0) {
-            throw new Error('❌ Failed to generate blob');
+            if (filledConfig.log) {
+                console.error('❌ Failed to generate blob');
+            }
+            throw new Error('Failed to generate blob');
         }
         const NODE_SEA_FUSE = 'NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2';
         const blobData = fs.readFileSync(path.join(filledConfig.tempdir, 'sea-prep.blob'));
@@ -230,17 +229,26 @@ async function nexfpack(options) {
             console.log("⚠️ Sorry, we can't sign your executable file. Please sign it by yourself.");
         }
         if (filledConfig.autoDeleteTempFiles) {
-            console.log('♻️ Deleting temp files...');
+            if (filledConfig.log) {
+                console.log('♻️ Deleting temp files...');
+            }
             fs.rmSync(filledConfig.tempdir, { recursive: true, force: true });
         }
-        console.log('✅ Done!');
+        if (filledConfig.log) {
+            console.log('✅ Done!');
+        }
         if (filledConfig.autoRun) {
-            console.log('🚀 Auto-run executable...');
+            if (filledConfig.log) {
+                console.log('🚀 Auto-run executable...');
+            }
             child_process.spawnSync(exePath, { stdio: 'inherit', cwd: filledConfig.output, shell: true });
         }
     }
     catch (err) {
-        console.error('❌ Nexfpack Failed:', err);
+        if (filledConfig.log) {
+            console.error('❌ Nexfpack Failed:', err);
+        }
+        throw err;
     }
 }
 export default nexfpack;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nexfpack",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A tool for building single executable files from Node.js scripts or modules.",
   "license": "MIT",
   "repository": "https://github.com/nexfteam/Nexfpack",
@@ -10,6 +10,7 @@
   "homepage": "https://github.com/nexfteam/Nexfpack#readme",
   "author": "nexfteam",
   "type": "module",
+  "types": "index.d.mts",
   "main": "index.cjs",
   "module": "index.mjs",
   "exports": {