
Security News
npm ‘is’ Package Hijacked in Expanding Supply Chain Attack
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
@coder/nbin
Advanced tools
Fast and robust node.js binary compiler.
WARNING: This project was created for code-server and may provide limited support.
Why was this made? Why not use pkg
or nexe
?
nbin
does not do any kind of scanning for requiring files; it only includes
the files you tell it to. That means you should include everything (for example
by using writeFiles('/path/to/repo/*')
) or use a bundler like Webpack and
include the bundle.
When running within the binary, your application will have access to a module
named nbin
.
Two packages are provided:
@coder/nbin
- available as an API to build binaries.nbin
- ONLY available within your binary.import { Binary } from "@coder/nbin";
const bin = new Binary({
mainFile: "out/cli.js",
});
bin.writeFile("out/cli.js", Buffer.from("console.log('hi');"));
const output = bin.bundle();
To use the compiled binary as the original Node binary set the NBIN_BYPASS
environment variable. This can be especially useful when forking processes (or
spawning with the binary). You might want to simply immediately set this to any
truthy value as soon as your code loads.
If you are using webpack to bundle your main
, you'll need to externalize
modules.
// webpack.config.js
module.exports = {
...
external: {
nbin: "commonjs nbin",
// Additional modules to exclude
},
};
You can pass
NODE_OPTIONS
.
NODE_OPTIONS="--inspect-brk" ./path/to/bin
Gzip'd JavaScript files are supported to reduce bundle size.
yarn
yarn build
When publishing use npm
and not yarn
as yarn
will traverse ignored
directories anyway and re-add anything excluded by any discovered .gitignore
files.
We patch Node to make it capable of reading files within the binary.
To generate a new patch, stage all the changes you want to be included in
the patch in the Node source, then run yarn patch:generate
in this
directory.
FAQs
Fast and robust node.js binary compiler.
We found that @coder/nbin demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
Security News
A critical flaw in the popular npm form-data package could allow HTTP parameter pollution, affecting millions of projects until patched versions are adopted.
Security News
Bun 1.2.19 introduces isolated installs for smoother monorepo workflows, along with performance boosts, new tooling, and key compatibility fixes.