nexfpack 0.1.2 → 0.1.4

package/README-CN.md

@@ -81,6 +81,7 @@ nexfpack(config);
 | 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` |

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

@@ -4,10 +4,59 @@ import nexfpack from "./index.mjs";
 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.");
+
+  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'));
+        if (filledConfig.log) {
+            console.log('▶ Start packing...');
+            console.log('🧪 Tips: Nexfpack is very experimental. It may have some errors.');
         }
-        else {
-            config = options;
-        }
-        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 = {
@@ -209,7 +205,10 @@ async function nexfpack(options) {
         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.2",
+  "version": "0.1.4",
   "description": "A tool for building single executable files from Node.js scripts or modules.",
   "license": "MIT",
   "repository": "https://github.com/nexfteam/Nexfpack",