nodejs-sea 1.0.0 → 1.0.1

package/README.md

@@ -6,10 +6,10 @@
 <p align="center">
   CLI for NodeJS single executable applications.
   <p align="center">
-    <a href="https://www.npmjs.com/package/nestjs-auditlog" target="_blank"><img alt="npm version" src="https://img.shields.io/npm/v/nestjs-auditlog" /></a>
-    <a href="https://www.npmjs.com/package/nestjs-auditlog" target="_blank"><img alt="NPM" src="https://img.shields.io/npm/l/nestjs-auditlog" /></a>
-    <a href="https://www.npmjs.com/package/nestjs-auditlog" target="_blank"><img alt="npm downloads" src="https://img.shields.io/npm/dm/nestjs-auditlog" /></a>
-     <a href="https://coveralls.io/github/thanhlcm90/nestjs-auditlog?branch=main" target="_blank"><img alt="coverage" src="https://coveralls.io/repos/github/thanhlcm90/nestjs-auditlog/badge.svg?branch=main" /></a>
+    <a href="https://www.npmjs.com/package/nodejs-sea" target="_blank"><img alt="npm version" src="https://img.shields.io/npm/v/nodejs-sea" /></a>
+    <a href="https://www.npmjs.com/package/nodejs-sea" target="_blank"><img alt="NPM" src="https://img.shields.io/npm/l/nodejs-sea" /></a>
+    <a href="https://www.npmjs.com/package/nodejs-sea" target="_blank"><img alt="npm downloads" src="https://img.shields.io/npm/dm/nodejs-sea" /></a>
+    <a href="https://coveralls.io/github/thanhlcm90/nodejs-sea?branch=main" target="_blank"><img alt="coverage" src="https://coveralls.io/repos/github/thanhlcm90/nodejs-sea/badge.svg?branch=main" /></a>
   </p>
 </p>
 
@@ -53,6 +53,23 @@ With yarn
 yarn add nodejs-sea
 ```
 
+## CLI usage
+
+Run build script with `npx`
+
+```
+npx nodejs-sea sea
+```
+
+```sh
+Options:
+      --version         Show version number             [boolean]
+  -s, --sea-config      Path of the sea config file     [string] [default: "sea/config.json"]
+  -n, --node-version    Node.js version                 [string] [default: "*"]
+  -c, --clean           Remove generated files          [boolean] [default: true]
+      --help            Show help                       [boolean]
+```
+
 ## Example
 
 To build the single executable applications from source, please create the folder `sea`, and put the `config.json` file
@@ -60,19 +77,36 @@ To build the single executable applications from source, please create the folde
 ```json
 {
   "main": "sea/dist/server-out.js",
-  "output": "sea/dist/viactapp.blob",
-  "copyFiles": [],
-  "esbuild": {}
+  "output": "sea/dist/viactapp.blob"
 }
 ```
 
-Run build script with `npx`
+If you want copy some files from your source to your build output, put them into `copyFiles`
 
-```
-npx nodejs-sea sea
+```json
+{
+  "main": "sea/dist/server-out.js",
+  "output": "sea/dist/viactapp.blob",
+  "copyFiles": ["src/config.json", ".env"]
+}
 ```
 
-## CLI usage
+If you want run <a href="https://esbuild.github.io/">esbuild</a> before, put esbuild config into `esbuild`
+
+```json
+{
+  "main": "sea/dist/server-out.js",
+  "output": "sea/dist/app.blob",
+  "esbuild": {
+    "entryPoints": ["main.js"],
+    "bundle": true,
+    "outfile": "sea/dist/server-out.js",
+    "platform": "node",
+    "external": ["@aws-sdk/client-s3", "hbs"],
+    "packages": "bundle"
+  }
+}
+```
 
 ## Contact and Feedback
 

package/lib/cli.js

@@ -213,10 +213,10 @@ class PackCommand extends clipanion.Command {
             description: `Path of the sea config file. Default is sea/config.json`,
         });
         this.nodeVersion = clipanion.Option.String(`-n,--node-version`, {
-            description: `Node.js version or semver version range. Default is 22.11.0`,
+            description: `Node.js version. Default is 22.11.0`,
         });
         this.clean = clipanion.Option.String(`-c,--clean`, {
-            description: `Node.js version or semver version range. Default is true`,
+            description: `Remove generated files. Default is true`,
         });
     }
     /**

package/lib/cli.mjs

@@ -200,10 +200,10 @@ class PackCommand extends Command {
             description: `Path of the sea config file. Default is sea/config.json`,
         });
         this.nodeVersion = Option.String(`-n,--node-version`, {
-            description: `Node.js version or semver version range. Default is 22.11.0`,
+            description: `Node.js version. Default is 22.11.0`,
         });
         this.clean = Option.String(`-c,--clean`, {
-            description: `Node.js version or semver version range. Default is true`,
+            description: `Remove generated files. Default is true`,
         });
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodejs-sea",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A powerful package for NodeJS single executable applications (SEA), support good for NestJS framework",
   "main": "lib/index.js",
   "license": "MIT",
@@ -19,7 +19,7 @@
     "prepare": "husky",
     "prepack": "rm -rf lib && rollup -c",
     "test": "sea -s test/sea/config.json",
-    "version": "standard-version",
+    "standard-version": "standard-version",
     "build": "rollup -c"
   },
   "engines": {
@@ -48,6 +48,7 @@
     "rollup-plugin-multi-input": "^1.3.1",
     "rollup-plugin-preserve-shebang": "^1.0.1",
     "rollup-plugin-terser": "^7.0.2",
+    "standard-version": "^9.5.0",
     "terser": "^5.15.0",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.2"