Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bytenode/bytenode
A minimalist bytecode compiler for Node.js
https://github.com/bytenode/bytenode
bytecode bytenode compiler nodejs source-code-protection v8
Last synced: about 11 hours ago
JSON representation
A minimalist bytecode compiler for Node.js
- Host: GitHub
- URL: https://github.com/bytenode/bytenode
- Owner: bytenode
- License: mit
- Created: 2018-10-24T10:23:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-25T13:29:49.000Z (8 months ago)
- Last Synced: 2024-11-30T09:45:24.420Z (12 days ago)
- Topics: bytecode, bytenode, compiler, nodejs, source-code-protection, v8
- Language: JavaScript
- Homepage:
- Size: 938 KB
- Stars: 2,649
- Watchers: 35
- Forks: 183
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs - bytenode - A minimalist bytecode compiler for Node.js. it truly compiles your JavaScript code into V8 bytecode, so that you can protect your source code. ![](https://img.shields.io/github/stars/bytenode/bytenode.svg?style=social&label=Star) (Repository / Source Code Obfuscator/Protect)
- awesome-repositories - bytenode/bytenode - A minimalist bytecode compiler for Node.js (JavaScript)
- awesome - bytenode/bytenode - A minimalist bytecode compiler for Node.js (JavaScript)
- awesome-electron - bytenode - A minimalist bytecode compiler for Node.js. it truly compiles your JavaScript code into V8 bytecode, so that you can protect your source code. ![](https://img.shields.io/github/stars/bytenode/bytenode.svg?style=social&label=Star) (Library / Source Code Obfuscator/Protect)
README
# Bytenode
A minimalist bytecode compiler for Node.js.
This tool truly compiles your JavaScript code into `V8` bytecode, so that you can protect your source code. It can be used with Node.js, as well as Electron and NW.js (check `examples/` directory).
---
## Install
```console
npm install --save bytenode
```Or globally:
```console
sudo npm install -g bytenode
```---
## Known Issues and Limitations
* In Node 10.x, Bytenode does not work in debug mode. See [#29](https://github.com/bytenode/bytenode/issues/29).
* Any code depends on `Function.prototype.toString` function will break, because Bytenode removes the source code from `.jsc` files and puts a dummy code instead. See [#34](https://github.com/bytenode/bytenode/issues/34). For a workaround, see [#163](https://github.com/bytenode/bytenode/issues/163)
* Async Arrow Functions (and Arrow Functions in general) cause crashes in Puppeteer and in Electron apps. See [#106](https://github.com/bytenode/bytenode/issues/106), [#47](https://github.com/bytenode/bytenode/issues/47). They also cause issues with the ndb debugger. See [#135](https://github.com/bytenode/bytenode/issues/135). It seems that whenever there is a context change (or even when called from another file or module), arrow functions break because `V8` inspects them internally using `Function.prototype.toString` in these cases. See [#157](https://github.com/bytenode/bytenode/issues/157).
---
## Resources
* [How To Compile Node.js Code Using Bytenode](https://hackernoon.com/how-to-compile-node-js-code-using-bytenode-11dcba856fa9)
* [Bytenode Webpack Plugin](https://github.com/herberttn/bytenode-webpack-plugin)
* [Creating JS Binaries For Electron](https://www.jjeff.com/blog/2021/4/27/creating-javascript-binaries-for-electron)
* [Electron Bytenode Example](https://github.com/spaceagetv/electron-bytenode-example)---
## Bytenode CLI
```console
Usage: bytenode [option] [ FILE... | - ] [arguments]Options:
-h, --help show help information.
-v, --version show bytenode version.-c, --compile [ FILE... | - ] compile stdin, a file, or a list of files
--compress compress bytecode
-n, --no-module compile without producing commonjs module
-e, --electron compile for Electron
-ep, --electron-path path to Electron executable-l, --loader [ FILE | PATTERN ] create a loader file and optionally define
loader filename or pattern using % as
filename replacer
defaults to %.loader.js
--no-loader do not create a loader file, conflicts
with -l
-t, --loader-type type create a loader file of type commonjs or
module. Defaults to CommonJSExamples:
$ bytenode -c script.js compile `script.js` to `script.jsc`.
$ bytenode -c server.js app.js
$ bytenode -c src/*.js compile all `.js` files in `src/` directory.$ bytenode -c *.js -l %.load.js create `filename.load.js` loader files along side `.jsc` files
$ bytenode script.jsc [arguments] run `script.jsc` with arguments.
$ bytenode open Node REPL with bytenode pre-loaded.
```Examples:
* Compile `express-server.js` to `express-server.jsc`.
```console
user@machine:~$ bytenode --compile express-server.js
```* Run your compiled file `express-server.jsc`.
```console
user@machine:~$ bytenode express-server.jsc
Server listening on port 3000
```* Compile all `.js` files in `./app` directory.
```console
user@machine:~$ bytenode --compile ./app/*.js
```* Compile all `.js` files in your project.
```console
user@machine:~$ bytenode --compile ./**/*.js
```Note: you may need to enable `globstar` option in bash (you should add it to `~/.bashrc`):
`shopt -s globstar`* Starting from v1.0.0, bytenode can compile from `stdin`.
```console
echo 'console.log("Hello");' | bytenode --compile - > hello.jsc
```---
## Bytenode API
```javascript
const bytenode = require('bytenode');
```---
#### bytenode.compileCode(javascriptCode) → {Buffer}
Generates v8 bytecode buffer.
* Parameters:
| Name | Type | Description |
| ---- | ---- | ----------- |
| javascriptCode | string | JavaScript source that will be compiled to bytecode. |* Returns:
{Buffer} The generated bytecode.
* Example:
```javascript
let helloWorldBytecode = bytenode.compileCode(
`console.log('Hello World!');
43; // this will be returned`
);
```This `helloWorldBytecode` bytecode can be saved to a file. However, if you want to use your code as a module (i.e. if your file has some `exports`), you have to compile it using `bytenode.compileFile({compileAsModule: true})`, or wrap your code manually, using `Module.wrap()` function.
---
#### bytenode.compileElectronCode(javascriptCode, options) → {Promise\}
Asynchronous function which generates v8 bytecode buffer for Electron.
Same as `bytenode.compileCode()`, but generates bytecode for the version of Electron currently installed in node_modules.
* Parameters:
| Name | Type | Description |
| ---- | ---- | ----------- |
| javascriptCode | string | JavaScript source that will be compiled to bytecode. |
| options | object | Options object. |
| options.electronPath | string | Path to Electron executable. |* Returns:
{Promise\} A Promise which resolves with the generated bytecode.
* Example:
```javascript
let helloWorldBytecode = await bytenode.compileElectronCode(
`console.log('Hello World!');
43; // this will be returned`
);
```This `helloWorldBytecode` bytecode can be saved to a file. However, if you want to use your code as a module (i.e. if your file has some `exports`), you have to compile it using `bytenode.compileFile({compileAsModule: true})`, or wrap your code manually, using `Module.wrap()` function.
---
#### bytenode.runBytecode(bytecodeBuffer) → {any}
Runs v8 bytecode buffer and returns the result.
* Parameters:
| Name | Type | Description |
| ---- | ---- | ----------- |
| bytecodeBuffer | Buffer | The buffer object that was created using compileCode function. |* Returns:
{any} The result of the very last statement executed in the script.
* Example:
```javascript
const result = bytenode.runBytecode(helloWorldBytecode);
// prints: Hello World!
console.log(result)
// prints: 43
```---
#### bytenode.compileFile(args, output) → {Promise\}
Asynchronous function which compiles JavaScript file to .jsc file.
* Parameters:
Name | Type | Description
---- | ---- | -----------
args | object \| string
args.filename | string | The JavaScript source file that will be compiled.
args.compileAsModule | boolean | If true, the output will be a commonjs module. Default: true.
args.electron | boolean | If true, the output will be a compiled through Electron. Default: false.
args.electronPath | string | Path to Electron executable. Default: Electron binary from node_modules.
args.output | string | The output filename. Defaults to the same path and name of the original file, but with `.jsc` extension.
args.createLoader | boolean \| string | If true, create a CommonJS loader file. As a string, select between `module` or `commonjs` loader. Default: `false`
args.loaderFilename | string | Filename or pattern for generated loader files. Defaults to originalFilename.loader.js. Use % as a substitute for originalFilename.
output | string | The output filename. (Deprecated: use args.output instead)* Returns:
{Promise\}: A Promise that resolves as the compiled filename.
* Examples:
```javascript
let compiledFilename = bytenode.compileFile({
filename: '/path/to/your/file.js',
output: '/path/to/compiled/file.jsc' // if omitted, it defaults to '/path/to/your/file.jsc'
});
```Previous code will produce a commonjs module that can be required using `require` function.
```javascript
let compiledFilename = await bytenode.compileFile({
filename: '/path/to/your/file.js',
output: '/path/to/compiled/file.jsc',
compileAsModule: false
});
```Previous code will produce a direct `.jsc` file, that can be run using `bytenode.runBytecodeFile()` function. It can NOT be required as a module. Please note that `compileAsModule` MUST be `false` in order to turn it off. Any other values (including: `null`, `""`, etc) will be treated as `true`. (It had to be done this way in order to keep the old code valid.)
---
#### bytenode.runBytecodeFile(filename) → {any}
Runs .jsc file and returns the result.
* Parameters:
| Name | Type |
| ---- | ---- |
| filename | string |* Returns:
{any} The result of the very last statement executed in the script.
* Example:
```javascript
// test.js
console.log('Hello World!');
43; // this will be returned
``````javascript
const result = bytenode.runBytecodeFile('/path/to/test.jsc');
// prints: Hello World!
console.log(result)
// prints: 43
```---
#### require(filename) → {any}
* Parameters:
| Name | Type |
| ---- | ---- |
| filename | string |* Returns:
{any} exported module content
* Example:
```javascript
let myModule = require('/path/to/your/file.jsc');
```Just like regular `.js` modules. You can also omit the extension `.jsc`.
`.jsc` file must have been compiled using `bytenode.compileFile()`, or have been wrapped inside `Module.wrap()` function. Otherwise it won't work as a module and it can NOT be required.
Please note `.jsc` files must run with the same Node.js version that was used to compile it (using same architecture of course). Also, `.jsc` files are CPU-agnostic. However, you should run your tests before and after deployment, because V8 sanity checks include some checks related to CPU supported features, so this may cause errors in some rare cases.
---
## Acknowledgements
I had the idea of this tool many years ago. However, I finally decided to implement it after seeing this [issue](https://github.com/nodejs/node/issues/11842) by @hashseed. Also, some parts were inspired by [v8-compile-cache](https://github.com/zertosh/v8-compile-cache) by @zertosh.