Compare commits

..

9 Commits

Author SHA1 Message Date
calebboyd 4cd04d1b0c chore: bump version 2021-09-26 21:20:48 -05:00
calebboyd e539093ef4 docs: update readme 2021-09-26 17:15:06 -05:00
calebboyd 805ca35149 chore: update dependencies 2021-09-26 16:59:48 -05:00
calebboyd 37ee352408 build: add workflow for autoclose issues without response 2021-09-26 15:50:55 -05:00
Asher Oto a9811257ea docs: update readme (#861) 2021-09-26 13:43:14 -05:00
bruce-one dd3dec1f9d docs: document asset option. (#903) 2021-09-26 13:37:29 -05:00
bruce-one fe9f73d22b fix: support fs.realpath(Sync).native. (#892) 2021-09-14 10:26:26 -05:00
Caleb Boyd 0c7b942f7f fix(fs): only override time references (#883) 2021-04-05 05:55:24 -05:00
Jared Allard bd09fe59de docs(README): add discord (#870) 2021-02-25 19:54:16 -06:00
14 changed files with 1876 additions and 1564 deletions
@@ -0,0 +1,21 @@
name: No Response
# Both `issue_comment` and `scheduled` event types are required for this Action
# to work properly.
on:
issue_comment:
types: [created]
schedule:
# 9AM Central
- cron: '0 14 * * *'
jobs:
noResponse:
runs-on: ubuntu-latest
steps:
- uses: lee-dohm/no-response@v0.5.0
with:
token: ${{ github.token }}
closeComment: 'Closed awaiting response from OP, please open a new issue with the requested information and/or examples'
daysUntilClose: 21
responseRequiredLabel: more-information-needed
+51 -4
View File
@@ -1,3 +1,4 @@
<p align="center"><img src="https://cloud.githubusercontent.com/assets/2391349/23598327/a17bb68a-01ee-11e7-8f55-88a5fc96e997.png" /></p>
<p align="center">
@@ -5,9 +6,10 @@
<a href="https://www.npmjs.com/package/nexe"><img src="https://img.shields.io/npm/dt/nexe.svg" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/nexe"><img src="https://img.shields.io/npm/v/nexe.svg" alt="Version"></a>
<a href="https://www.npmjs.com/package/nexe"><img src="https://img.shields.io/npm/l/nexe.svg" alt="License"></a>
<a href="https://discord.gg/2qTH52zNcZ"><img src="https://discordapp.com/api/guilds/814334925049561168/widget.png?style=shield"></a>
</p>
<p align="center"><code>npm i nexe -g</code></p>
<p align="center">Install:&nbsp<code>npm i nexe -g</code></p>
<p align="center">Nexe is a command-line utility that compiles your Node.js application into a single executable file.</p>
<p align="center">
@@ -47,9 +49,39 @@ For more CLI options see: `nexe --help`
Additional files or resources can be added to the binary by passing `-r "glob/pattern/**/*"`. These included files can be read in the application by using `fs.readFile` or `fs.readFileSync`.
## Compiling Node
## Compiling the nexe Executable
By default `nexe` will attempt to download a pre-built executable. These are listed on the [Nexe V3 releases page](https://github.com/nexe/nexe/releases/tag/v3.3.3). The exact version you want may be unavailable or you may want to customize what is built. See `nexe --help` for a list of options available when passing the [`--build`](#build-boolean) option. You will also need to ensure your environment is setup to [build node](https://github.com/nodejs/node/blob/master/BUILDING.md). Note: the `python` binary in your path should be an acceptable version of python 2. eg. Systems that have python2 will need to create a [symlink](https://github.com/nexe/nexe/issues/354#issuecomment-319874486).
By default `nexe` will attempt to download a pre-built executable. These are listed on the [releases page](https://github.com/nexe/nexe/releases/tag/v3.3.3). The exact version you want may be unavailable or you may want to customize what is built. See `nexe --help` for a list of options available when passing the [`--build`](#build-boolean) option. You will also need to ensure your environment is setup to [build node](https://github.com/nodejs/node/blob/master/BUILDING.md). Note: the `python` binary in your path should be an acceptable version of python 2. eg. Systems that have python 2 will need to create a [symlink](https://github.com/nexe/nexe/issues/354#issuecomment-319874486).
### Linux and macOS
[Prerequisites & details](https://github.com/nodejs/node/blob/master/BUILDING.md#unix-and-macos)
### Windows
The fastest and most reliable way to get started is simply to run the commands below. If you'd rather read the details or perform a manual install of the prerequisites, [you can find that here](https://github.com/nodejs/node/blob/master/BUILDING.md#windows).
The instructions below are the fastest and most reliable method.
Run the following sets of commands with PowerShell (running as Administrator).
**Install all required build tools (and dependencies):**
```
Set-ExecutionPolicy Unrestricted -Force
iex ((New-Object System.Net.WebClient).DownloadString('https://boxstarter.org/bootstrapper.ps1'))
get-boxstarter -Force
Install-BoxstarterPackage https://raw.githubusercontent.com/nodejs/node/master/tools/bootstrap/windows_boxstarter -DisableReboots
```
**Set config:**
```
npm config set msvs_version 2019
npm config set python python2.7
```
Where `2019` is the version of Visual Studio you have (if you have it).
**Notes:**
- The above works and has been tested with node.js `14.5.4` and `15.8.0`
- Python 3 and Python 2 can coexist and `nexe` will still work, considering the `set config` area above
- Don't use `npm install windows-build-tools` unless you're having some type of issue, because the above commands configures and installs the latest/preferred too.
## Node.js API
@@ -117,8 +149,10 @@ compile({
- #### `build: boolean`
- Build node from source, passing this flag tells nexe to download and build from source. Subsequently using this flag will cause nexe to use the previously built binary. To rebuild, first add [`--clean`](#clean-boolean)
- #### `remote: string`
- Provide a custom remote location for fetching pre-built nexe binaries from. This can either be an HTTP or HTTPS URL or a file path.
- Provide a custom remote location for fetching pre-built nexe binaries from. This can either be an HTTP or HTTPS URL.
- default: `null`
- #### `asset: string`
- Provide a pre-built nexe binary asset, this is a file path is resolved relative to cwd.
- #### `python: string`
- On Linux this is the path pointing to your python2 executable
- On Windows this is the directory where `python` can be accessed
@@ -218,6 +252,19 @@ Any modifications made to `NexeFile#contents` will be maintained in the cache _w
In order to use native modules, the native binaries must be shipped alongside the binary generated by nexe.
## Troubleshooting
`Error: Entry file "" not found!` means you need to provide `nexe` with input. Either use `-i` or pipe data to it.
`Error: https://github.com/nexe/nexe/releases/download/v3.3.3/windows-x64-15.8.0 is not available, create it using the --build flag` or similar message means that it either:
- You are having networking issues such as the download being blocked
- You should specify the target so `nexe` knows what version of the executable to use.
- See the [releases page](https://github.com/nexe/nexe/releases) to find the executable's version number
- Example
- `nexe -i "app.js" -r "public/**/*.html" -o "dist/myApp.exe" -t x64-14.15.3`
- where `-i` specifies the input, `-r` specifies resources to embed, `-o` specifies the output, `-t` specifies the target.
- Alternatively you can compile the executable yourself, see that section for details
## Contributing
Building
+1754 -1520
View File
File diff suppressed because it is too large Load Diff
+16 -19
View File
@@ -2,7 +2,7 @@
"name": "nexe",
"description": "Create a single executable out of your Node.js application",
"license": "MIT",
"version": "4.0.0-beta.18",
"version": "4.0.0-beta.19",
"contributors": [
"Craig Condon <craig.j.condon@gmail.com> (http://crcn.io)",
"Jared Allard <jaredallard@outlook.com>",
@@ -41,42 +41,39 @@
},
"dependencies": {
"@calebboyd/semaphore": "^1.3.1",
"app-builder": "^6.2.2",
"app-builder": "^7.0.4",
"caw": "^2.0.1",
"chalk": "^2.4.2",
"cherow": "1.6.9",
"download": "^8.0.0",
"globby": "^11.0.2",
"got": "^11.8.1",
"got": "^11.8.2",
"minimist": "^1.2.5",
"mkdirp": "^1.0.4",
"multistream": "^4.0.1",
"multistream": "^4.1.0",
"ora": "^3.4.0",
"pify": "^5.0.0",
"resolve-dependencies": "^6.0.5",
"resolve-dependencies": "^6.0.7",
"rimraf": "^3.0.2"
},
"devDependencies": {
"@types/chai": "^4",
"@types/download": "^6",
"@types/globby": "^9",
"@types/got": "^9.6.11",
"@types/minimist": "^1.2.1",
"@types/mkdirp": "^1.0.1",
"@types/mocha": "^8.2.1",
"@types/minimist": "^1.2.2",
"@types/mkdirp": "^1.0.2",
"@types/mocha": "^9.0.0",
"@types/multistream": "^2.1.1",
"@types/ora": "^3.2.0",
"@types/pify": "5.0.0",
"@types/rimraf": "3.0.0",
"@types/semver": "^7.3.4",
"chai": "^4.3.0",
"execa": "^5.0.0",
"mocha": "^8.3.0",
"prettier": "^2.2.1",
"ts-node": "^8.9.0",
"@types/rimraf": "3.0.2",
"@types/semver": "^7.3.8",
"chai": "^4.3.4",
"execa": "^5.1.1",
"mocha": "^9.1.2",
"prettier": "^2.4.1",
"ts-node": "^10.2.1",
"tslint": "^6.1.1",
"tslint-config-prettier": "^1.18.0",
"tslint-plugin-prettier": "^2.3.0",
"typescript": "^3.8.3"
"typescript": "^4.4.3"
}
}
+2 -4
View File
@@ -111,9 +111,7 @@ export class NexeCompiler {
this.targets = options.targets as NexeTarget[]
this.target = this.targets[0]
if (!/https?\:\/\//.test(options.remote)) {
throw new NexeError(
`Invalid remote URI scheme (must be http, https, or file): ${options.remote}`
)
throw new NexeError(`Invalid remote URI scheme (must be http or https): ${options.remote}`)
}
this.remoteAsset = options.remote + this.target.toString()
this.src = join(this.options.temp, this.target.version)
@@ -205,7 +203,7 @@ export class NexeCompiler {
if (this.log.verbose) {
this.compileStep!.pause()
}
return new Promise((resolve, reject) => {
return new Promise<void>((resolve, reject) => {
spawn(command, args, {
cwd: this.src,
env: this.env,
+3
View File
@@ -35,6 +35,7 @@ async function createFile(absoluteFileName: string) {
const stats = await lstat(absoluteFileName),
file: File = {
size: stats.size,
moduleType: 'commonjs',
contents: '',
absPath: absoluteFileName,
deps: {},
@@ -77,6 +78,7 @@ export class Bundle {
if (typeof content === 'string' || Buffer.isBuffer(content)) {
this.files[absoluteFileName] = {
size: Buffer.byteLength(content),
moduleType: 'commonjs',
contents: content as any, //todo type is wrong here... should allow buffer
deps: {},
absPath: absoluteFileName,
@@ -86,6 +88,7 @@ export class Bundle {
} else {
this.files[absoluteFileName] = {
absPath: absoluteFileName,
moduleType: 'commonjs',
contents: '',
deps: {},
size: 0,
+25 -13
View File
@@ -66,22 +66,10 @@ function shimFs(binary: NexeBinary, fs: any = require('fs')) {
const statTime = function () {
return {
dev: 0,
ino: 0,
nlink: 0,
rdev: 0,
uid: 123,
gid: 500,
blksize: 4096,
blocks: 0,
atime: new Date(stat.atime),
atimeMs: stat.atime.getTime(),
mtime: new Date(stat.mtime),
mtimeMs: stat.mtime.getTime(),
ctime: new Date(stat.ctime),
ctimMs: stat.ctime.getTime(),
birthtime: new Date(stat.birthtime),
birthtimeMs: stat.birthtime.getTime(),
}
}
@@ -90,9 +78,14 @@ function shimFs(binary: NexeBinary, fs: any = require('fs')) {
BigInt = eval('BigInt')
} catch (ignored) {}
const minBlocks = Math.max(Math.ceil(stat.blksize / 512), 1)
const createStat = function (extensions: any, options: any) {
const stat = Object.assign(new fs.Stats(), binary.layout.stat, statTime(), extensions)
if (options && options.bigint && BigInt) {
if ('size' in extensions) {
//Assume non adjustable allocation size for file system
stat.blocks = Math.ceil(stat.size / stat.blksize) * minBlocks
}
if (options && options.bigint && typeof BigInt !== 'undefined') {
for (const k in stat) {
if (Object.prototype.hasOwnProperty.call(stat, k) && typeof stat[k] === 'number') {
stat[k] = BigInt(stat[k])
@@ -406,6 +399,25 @@ function shimFs(binary: NexeBinary, fs: any = require('fs')) {
}
}
if (typeof fs.realpath.native === 'function') {
nfs.realpath.native = function realpathNative(filepath: any, options: any, cb: any): void {
setupManifest()
const key = getKey(filepath)
if (isString(filepath) && (manifest[filepath] || manifest[key])) {
return process.nextTick(() => cb(null, filepath))
}
return originalFsMethods.realpath.native.call(fs, filepath, options, cb)
}
nfs.realpathSync.native = function realpathSyncNative(filepath: any, options: any) {
setupManifest()
const key = getKey(filepath)
if (manifest[key]) {
return filepath
}
return originalFsMethods.realpathSync.native.call(fs, filepath, options)
}
}
Object.assign(fs, nfs)
lazyRestoreFs = () => {
+2 -2
View File
@@ -15,7 +15,7 @@ async function compile(
compilerOptions?: Partial<NexeOptions>,
callback?: (err: Error | null) => void
) {
let error = null,
let error: Error | null = null,
options: NexeOptions | null = null,
compiler: NexeCompiler | null = null
@@ -32,7 +32,7 @@ async function compile(
options.build ? [artifacts, ...patches, ...(options.patches as NexePatch[])] : [],
options.plugins as NexePatch[]
)(compiler)
} catch (e) {
} catch (e: any) {
error = e
}
+1 -1
View File
@@ -38,7 +38,7 @@ async function fetchPrebuiltBinary(compiler: NexeCompiler, step: any) {
})
}
)
} catch (e) {
} catch (e: any) {
if (e.statusCode === 404) {
throw new NexeError(`${remoteAsset} is not available, create it using the --build flag`)
} else {
+1 -1
View File
@@ -1,6 +1,6 @@
import { NexeTarget, architectures } from '../lib/target'
import { writeFileAsync, readFileAsync } from '../lib/util'
import got = require('got')
import got from 'got'
import execa = require('execa')
import { appendFileSync } from 'fs'