A Node wrapper for makensis, the compiler for NSIS installers. Supports both, native and Wine.
Make sure that NSIS is properly installed with makensis in your PATH environment variable.
Download the NSIS installer from SourceForge and run setup. Once completed, you need to edit your environmental variable manually.
Alternatively, you can install NSIS using the Scoop package manager:
$ scoop install nsis/nsisInstall NSIS from your distribution's default package manager, for example:
# Debian
$ sudo apt-get install nsis
# Red Hat
$ sudo dnf install nsisInstall NSIS using Homebrew or MacPorts:
# Homebrew
$ brew install nsis
# MacPorts
$ port install nsisYou can setup NSIS in your Wine environment, but keep in mind that Wine writes standard streams while executing makensis. To disable these debug messages, set the WINEDEBUG environment variable to -all.
yarn add makensis || npm install makensis
Use ES6 imports or require() to include the module:
// ECMAScript Import
import NSIS from 'makensis';
// CommonJS Require
const NSIS = require('makensis');Example usage in script:
import NSIS from 'makensis';
const options = {
verbose: 2,
define: {
SPECIAL_BUILD: true,
},
};
// Asynchronous: async/await
(async () => {
try {
let output = await NSIS.compile('path/to/installer.nsi', options);
console.log('Compiler output:', output);
} catch (error) {
console.error(error);
}
})();
// Asynchronous: Promise API
NSIS.compile('path/to/installer.nsi', options)
.then((output) => {
console.log('Compiler output:', output);
})
.catch((error) => {
console.error(error);
});
// Synchronous
let output = NSIS.compileSync('path/to/installer.nsi', options);
console.log('Compiler output:', output);Usage: commandHelp([command], [options], [spawnOptions])
Returns usage information for a specific command, or a list all commands. Equivalent of the -CMDHELP switch.
Usage: commandHelpSync([command], [options], [spawnOptions])
Returns usage information for a specific command, or a list all commands. Equivalent of the -CMDHELP switch.
Usage: compile(script, [options], [spawnOptions])
Compiles specified script with MakeNSIS. The script can be omitted in favor of preExecute / postExecute.
Usage: compileSync(script, [options], [spawnOptions])
Compiles specified script with MakeNSIS. The script can be omitted in favor of preExecute / postExecute.
Usage: headerInfo([options], [spawnOptions])
Returns information about which options were used to compile MakeNSIS. Equivalent of the -HDRINFO switch.
Usage: headerInfoSync([options], [spawnOptions])
Returns information about which options were used to compile MakeNSIS. Equivalent of the -HDRINFO switch.
Usage: license([options], [spawnOptions])
Returns MakeNSIS software license. Equivalent of the -LICENSE switch.
Usage: licenseSync([options], [spawnOptions])
Returns MakeNSIS software license. Equivalent of the -LICENSE switch.
Usage: nsisDir([options], [spawnOptions])
Returns the path of ${NSISDIR}.
Usage: nsisDirSync([options], [spawnOptions])
Returns the path of ${NSISDIR}.
Usage: version([options], [spawnOptions])
Returns version of MakeNSIS. Equivalent of the -VERSION switch.
Usage: versionSync([options], [spawnOptions])
Returns version of MakeNSIS. Equivalent of the -VERSION switch.
Note: Some of these options are limited to NSIS v3 (see the changelog for details)
Type: integer
Verbosity where x is 4=all, 3=no script,2=no info, 1=no warnings, 0=none. Equivalent of the -V switch.
Type: boolean
Pauses after execution. Equivalent of the -PAUSE switch.
Type: boolean
Disables the current directory change to that of the .nsi file. Equivalent of the -NOCD switch.
Type: boolean
Disables inclusion of <path to makensis.exe>/nsisconf.nsh. Equivalent of the -NOCONFIG switch.
Type: integer
Sets the compiler process priority, where x is 5=realtime, 4=high, 3=above normal, 2=normal, 1=below normal, 0=idle. Equivalent of the -P switch.
Note: Only available on Windows
Type: string
allows you to specify a specific codepage for files without a BOM (ACP|OEM|CP#|UTF8|UTF16<LE|BE>). Equivalent of the -INPUTCHARSET switch.
Type: string
Allows you to specify the codepage used by stdout when the output is redirected (ACP|OEM|CP#|UTF8[SIG]|UTF16<LE|BE>[BOM]). Equivalent of the -OUTPUTCHARSET switch.
Note: Only available on Windows
Type: boolean
Treat warnings as errors. Equivalent of the -WX switch.
Type: boolean
Will only run the preprocessor and print the result to stdout. The safe version will not execute instructions like !appendfile or !system. !packhdr and !finalize are never executed. Equivalent of the -PPO / SAFEPPO switches.
Aliases: PPO / safeppo
Type: Object
Defines symbols for the script [to value]. Equivalent of the -D switch.
Example
define: {
"SPECIAL_BUILD": true,
"LANGUAGE": "English"
}Type: string | string[]
Prepends script-commands to the script, can be passed as array or multiline-script. Equivalent of the -X switch when used before passing a script.
Example
preExecute: ['SetCompressor lzma', 'SetCompressorDictSize 16'];Type: string | string[]
Appends script-commands to the script, can be passed as array or multiline-script. Equivalent of the -X switch when used after passing a script.
Example
postExecute: [`DetailPrint "That's all Folks!"`];Type: boolean
Run makensis on Wine
Type: boolean
Return output from makensis as an object
Type: string
Specifies a custom path to makensis
Type: string | string[]
Specifies raw arguments for makensis. For complex quote combinations, consider supplying the arguments as array.
Note: These will be added to the compiler arguments last and will hence overwrite any of the NSIS options above!
This module emits three types of events you can hook into using the on() and once() methods:
Gives access to an object containing the current line, and whether it contains a warning of the path of the outfile.
Gives access to an object containing the current line.
Gives access to an object containing the exit code, the full stdout and stderr, and the number of warnings.
- atom-language-nsis - NSIS package for Atom
- vscode-nsis - NSIS package for Visual Studio Code
This work is licensed under The MIT License