Match all options in API, CLI and package.json

[stevenvachon]

So that we can just write up an npm script for building instead of using Grunt/Gulp or the programmatic API.

[1j01]

Here's a bit of an overview of what is/isn't supported.

Options:

  -p, --platforms      Platforms to build, comma-sperated, can be: win,osx,linux32,linux64   [default: "osx,win"]
  -v, --version        The nw version, eg. 0.8.4                                             [default: "latest"]
  -r, --run            Runs node-webkit for the current platform                             [default: false]
  -o, --buildDir       The build folder                                                      [default: "./build"]
  -f, --forceDownload  Force download of node-webkit                                         [default: false]
  --quiet              Disables logging                                                      [default: false]

Options

• options.files Required
• options.version
• options.platforms
• options.appName
• options.appVersion
• options.buildDir
• options.cacheDir
• options.buildType (which is a bad name for this option, by the way ‡)
• options.forceDownload
• options.macCredits
• options.macIcns
• options.macZip
• options.macPlist
• options.winIco

‡ This should be called something like "namingScheme", or better yet "buildNamingScheme". It's bad form to pass options by scope. Options should be passed with an object as a parameter. It's better form and even potentially faster to type.

[1j01]

Here we go #73:

Usage: nwbuild [options] [path]

Options:
  -p, --platforms      Platforms to build, comma-sperated, can be: win,osx,linux32,linux64                [default: "osx,win"]
  -v, --version        The nw version, eg. 0.8.4                                                          [default: "latest"]
  -r, --run            Runs node-webkit for the current platform                                          [default: false]
  -o, --buildDir       The build folder                                                                   [default: "./build"]
  -f, --forceDownload  Force download of node-webkit                                                      [default: false]
  --appName            The name of your node-webkit app                                                   [default: false]
  --appVersion         The version of your node-webkit app                                                [default: false]
  --cacheDir           The directory to store cached node-webkit downloads                                [default: false]
  --buildNamingScheme  How you want to name your builds, one of "default", "versioned", or "timestamped"  [default: "default"]
  --macCredits         MAC ONLY: The path to your credits.html file                                       [default: false]
  --macIcns            MAC ONLY: The path to your ICNS icon file                                          [default: false]
  --macZip             MAC ONLY: Use a app.nw folder instead of ZIP file                                  [default: false]
  --macPlist           MAC ONLY: if you supply a path to a Plist file it will use it                      [default: false]
  --winIco             WINDOWS ONLY: The path to your ICO icon file (requires Windows/Wine)               [default: null]
  --quiet              Disables logging                                                                   [default: false]

• options.files Required
• options.version
• options.platforms
• options.appName
• options.appVersion
• options.buildDir
• options.cacheDir
• options.buildType options.buildNamingScheme
• options.forceDownload
• options.macCredits
• options.macIcns
• options.macZip
• options.macPlist
• options.winIco

💥

[stevenvachon]

"Boom!"
😄

[shenzhuxi]

Why not make all options available in package.json?

[sanderboom]

+1 for all options in package.json and/or all options available as cli arguments. Situation right now is somewhat confusing.

[sanemat]

I want this feature 😍

[adam-lynch]

I'd really appreciate it if someone could make a pull-request to add these please 😄

[stevenvachon]

Why use this over electron?