https://github.com/terribledev/hydrocarbon
Making Windows Installers Great again
https://github.com/terribledev/hydrocarbon
Last synced: 10 months ago
JSON representation
Making Windows Installers Great again
- Host: GitHub
- URL: https://github.com/terribledev/hydrocarbon
- Owner: TerribleDev
- License: mit
- Created: 2016-02-11T01:47:16.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-14T12:43:00.000Z (over 10 years ago)
- Last Synced: 2025-09-07T22:14:02.806Z (10 months ago)
- Language: JavaScript
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HydroCarbon
[](https://www.npmjs.com/package/hydrocarbon)
[](https://coveralls.io/github/tparnell8/HydroCarbon?branch=master)
[](https://ci.appveyor.com/project/tparnell8/hydrocarbon/branch/master)
simple wrapper over wix. You can see a working demo [here](https://github.com/tparnell8/GulpBuildForDotNet)
## Install
```
$ npm install --save-dev hydrocarbon
```
## Usage
```js
var HydroCarbon = require('hydrocarbon');
HydroCarbon.exec({
heatFiles: ["installers/heat.rsp"],
candleFiles: ["installers/candle.rsp"],
lightFiles: ["installers/light.rsp"]
}, mycallbackFunction);
```
or
```js
var HydroCarbon = require('hydrocarbon');
HydroCarbon.exec({
heatFiles: ["installers/heat.rsp"],
candleFiles: ["installers/candle.rsp"],
lightFiles: ["installers/light.rsp"]
})
.then(()=>nextThingToDo());
```
Works great with gulp, or grunt. Build agnostic
## API
### HydroCarbon.Exec(options, callback)
#### Returns a promise object
#### options
##### heatFiles
Type: `array`
Default: `undefined`
Array of heat response file paths
##### candleFiles
Type: `array`
Default: `undefined`
Array of candle response file paths
##### lightFiles
Type: `array`
Default: `undefined`
Array of light response file paths
#### heatCommands
Type: `array`
Default: `undefined`
Array of command line args to pass to heat overrides heatFiles
#### candleCommands
Type: `array`
Default: `undefined`
Array of command line args to pass to candle overrides candleFiles
#### lightCommands
Type: `array`
Default: `undefined`
Array of command line args to pass to light overrides lightFiles
#### version
Type: `string`
Default: `undefined`
Sets the BUILD_VERSION environment variable to version before calling heat, candle, and light
#### suppressValidation
Type: `bool`
Default: `false`
If true this will supress ICE validation checks during the linking process.
## License
MIT © [Tommy Parnell](https://github.com/tparnell8)