@angablue/exe

Node.js Windows Executable

Build a portable binary for Windows systems using Vercel's pkg. As pkg doesn't support modifying executable properties, this project serves to and aid in automating modifying the executable properties post build.

🏠 Homepage

Install

Install this package and save to devDependencies using your package manager of choice.

 npm i -D @angablue/exe

or

 yarn add -D @angablue/exe

Basic Usage

// build.js
const exe = require('@angablue/exe');

const build = exe({
    entry: './index.js',
    out: './build/My Cool App.exe',
});

build.then(() => console.log('Build completed!'));

Example Usage

Specify more arguments and completely customise the resultant executable.

// build.js
const exe = require('@angablue/exe');

const build = exe({
    entry: './index.js',
    out: './build/My Cool App.exe',
    pkg: ['-C', 'GZip'], // Specify extra pkg arguments
    version: '2.4.2',
    target: 'latest-win-x64',
    icon: './assets/icon.ico', // Application icons must be in .ico format
    properties: {
        FileDescription: 'My Cool App',
        ProductName: 'My Cool App',
        LegalCopyright: 'AngaBlue https://anga.blue',
        OriginalFilename: 'My Cool App.exe'
    }
});

build.then(() => console.log('Build completed!'));

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © AngaBlue.
This project is LGPL--3.0--or--later licensed.