2015-07-06 02:12:30 +00:00
|
|
|
Usage: nativefier <appname> <target> --platform=<platform> --arch=<arch> --version=<version>
|
Implement multi-target options and refactor code
This adds support for --all, --platform=all, and --arch=all.
In order to accommodate outputting multiple directories for multiple
platforms and architectures, this also implements a new directory
structure under the output folder (distinguished by both platform and
arch). This structure is applied even to OS X distributions, which
formerly were output directly to an .app folder. This could be considered
a backwards-incompatible change.
One other backwards-incompatible change is the value that the packager
function passes to the callback, which is now always an array of paths,
rather than just a single path.
The behavior of the icon option has also been modified to use its
basename and apply .ico or .icns depending on platform, to make it
usable with --all and --platform=all. This attempts to maximize
backwards compatibility, by allowing a full filename to be specified,
but replacing the filename's extension with what is appropriate for
each target platform. Alternatively, the extension can now be omitted.
In the process of implementing this, it became evident that some things
were being done in 3 different places, and weren't always being done
consistently, so I've deduplicated everything I could.
This also includes a few other changes to improve stability for
multi-target runs, and other fixes:
* Avoid targeting darwin if the environment doesn't support symlinks,
to avoid the process bailing out on Windows
* Implement --overwrite centrally in index.js such that it explicitly
skips if an output directory already exists, for consistency with
all target platforms and to avoid any possible errors that would halt
operation during one target of a multi-target run
* Use ncp instead of mv to move to finalPath, which avoids flakiness
I noticed when testing on Windows 8 especially with multi-target runs
* Simplify temp directory logic by using a nested structure, so there
is only one top-level directory to clean up
* Reinstate fix from #55 which seems to have been clobbered by a later
merge
* linux.createApp now resolves to the final output directory;
it was formerly resolving to the executable path
* mac.createApp now replaces space with underscore in bundle IDs
* Only the platform modules that are needed are loaded
* The win32 module only loads rcedit if needed
This also fixes a couple of missing updates to docs (readme/usage).
This commit addresses the following issues:
* Resolves #40
* Resolves #38
* Resolves #70
* Works around #71
* Resolves #84 by reinstating #55
2015-06-20 02:36:15 +00:00
|
|
|
|
2015-05-10 20:57:42 +00:00
|
|
|
Required options
|
|
|
|
|
|
2015-07-05 07:11:49 +00:00
|
|
|
appname name for the app
|
2015-07-05 06:08:13 +00:00
|
|
|
target target url for the single page app
|
Implement multi-target options and refactor code
This adds support for --all, --platform=all, and --arch=all.
In order to accommodate outputting multiple directories for multiple
platforms and architectures, this also implements a new directory
structure under the output folder (distinguished by both platform and
arch). This structure is applied even to OS X distributions, which
formerly were output directly to an .app folder. This could be considered
a backwards-incompatible change.
One other backwards-incompatible change is the value that the packager
function passes to the callback, which is now always an array of paths,
rather than just a single path.
The behavior of the icon option has also been modified to use its
basename and apply .ico or .icns depending on platform, to make it
usable with --all and --platform=all. This attempts to maximize
backwards compatibility, by allowing a full filename to be specified,
but replacing the filename's extension with what is appropriate for
each target platform. Alternatively, the extension can now be omitted.
In the process of implementing this, it became evident that some things
were being done in 3 different places, and weren't always being done
consistently, so I've deduplicated everything I could.
This also includes a few other changes to improve stability for
multi-target runs, and other fixes:
* Avoid targeting darwin if the environment doesn't support symlinks,
to avoid the process bailing out on Windows
* Implement --overwrite centrally in index.js such that it explicitly
skips if an output directory already exists, for consistency with
all target platforms and to avoid any possible errors that would halt
operation during one target of a multi-target run
* Use ncp instead of mv to move to finalPath, which avoids flakiness
I noticed when testing on Windows 8 especially with multi-target runs
* Simplify temp directory logic by using a nested structure, so there
is only one top-level directory to clean up
* Reinstate fix from #55 which seems to have been clobbered by a later
merge
* linux.createApp now resolves to the final output directory;
it was formerly resolving to the executable path
* mac.createApp now replaces space with underscore in bundle IDs
* Only the platform modules that are needed are loaded
* The win32 module only loads rcedit if needed
This also fixes a couple of missing updates to docs (readme/usage).
This commit addresses the following issues:
* Resolves #40
* Resolves #38
* Resolves #70
* Works around #71
* Resolves #84 by reinstating #55
2015-06-20 02:36:15 +00:00
|
|
|
platform all, or one or more of: linux, win32, darwin (comma-delimited if multiple)
|
|
|
|
|
arch all, ia32, x64
|
2015-05-10 20:57:42 +00:00
|
|
|
version see https://github.com/atom/electron/releases
|
Implement multi-target options and refactor code
This adds support for --all, --platform=all, and --arch=all.
In order to accommodate outputting multiple directories for multiple
platforms and architectures, this also implements a new directory
structure under the output folder (distinguished by both platform and
arch). This structure is applied even to OS X distributions, which
formerly were output directly to an .app folder. This could be considered
a backwards-incompatible change.
One other backwards-incompatible change is the value that the packager
function passes to the callback, which is now always an array of paths,
rather than just a single path.
The behavior of the icon option has also been modified to use its
basename and apply .ico or .icns depending on platform, to make it
usable with --all and --platform=all. This attempts to maximize
backwards compatibility, by allowing a full filename to be specified,
but replacing the filename's extension with what is appropriate for
each target platform. Alternatively, the extension can now be omitted.
In the process of implementing this, it became evident that some things
were being done in 3 different places, and weren't always being done
consistently, so I've deduplicated everything I could.
This also includes a few other changes to improve stability for
multi-target runs, and other fixes:
* Avoid targeting darwin if the environment doesn't support symlinks,
to avoid the process bailing out on Windows
* Implement --overwrite centrally in index.js such that it explicitly
skips if an output directory already exists, for consistency with
all target platforms and to avoid any possible errors that would halt
operation during one target of a multi-target run
* Use ncp instead of mv to move to finalPath, which avoids flakiness
I noticed when testing on Windows 8 especially with multi-target runs
* Simplify temp directory logic by using a nested structure, so there
is only one top-level directory to clean up
* Reinstate fix from #55 which seems to have been clobbered by a later
merge
* linux.createApp now resolves to the final output directory;
it was formerly resolving to the executable path
* mac.createApp now replaces space with underscore in bundle IDs
* Only the platform modules that are needed are loaded
* The win32 module only loads rcedit if needed
This also fixes a couple of missing updates to docs (readme/usage).
This commit addresses the following issues:
* Resolves #40
* Resolves #38
* Resolves #70
* Works around #71
* Resolves #84 by reinstating #55
2015-06-20 02:36:15 +00:00
|
|
|
|
2015-07-05 07:11:49 +00:00
|
|
|
Example nativefier Messenger --target=http://messenger.com --platform=darwin --arch=x64 --version=0.28.2
|
2015-05-10 20:57:42 +00:00
|
|
|
|
|
|
|
|
Optional options
|
|
|
|
|
|
Implement multi-target options and refactor code
This adds support for --all, --platform=all, and --arch=all.
In order to accommodate outputting multiple directories for multiple
platforms and architectures, this also implements a new directory
structure under the output folder (distinguished by both platform and
arch). This structure is applied even to OS X distributions, which
formerly were output directly to an .app folder. This could be considered
a backwards-incompatible change.
One other backwards-incompatible change is the value that the packager
function passes to the callback, which is now always an array of paths,
rather than just a single path.
The behavior of the icon option has also been modified to use its
basename and apply .ico or .icns depending on platform, to make it
usable with --all and --platform=all. This attempts to maximize
backwards compatibility, by allowing a full filename to be specified,
but replacing the filename's extension with what is appropriate for
each target platform. Alternatively, the extension can now be omitted.
In the process of implementing this, it became evident that some things
were being done in 3 different places, and weren't always being done
consistently, so I've deduplicated everything I could.
This also includes a few other changes to improve stability for
multi-target runs, and other fixes:
* Avoid targeting darwin if the environment doesn't support symlinks,
to avoid the process bailing out on Windows
* Implement --overwrite centrally in index.js such that it explicitly
skips if an output directory already exists, for consistency with
all target platforms and to avoid any possible errors that would halt
operation during one target of a multi-target run
* Use ncp instead of mv to move to finalPath, which avoids flakiness
I noticed when testing on Windows 8 especially with multi-target runs
* Simplify temp directory logic by using a nested structure, so there
is only one top-level directory to clean up
* Reinstate fix from #55 which seems to have been clobbered by a later
merge
* linux.createApp now resolves to the final output directory;
it was formerly resolving to the executable path
* mac.createApp now replaces space with underscore in bundle IDs
* Only the platform modules that are needed are loaded
* The win32 module only loads rcedit if needed
This also fixes a couple of missing updates to docs (readme/usage).
This commit addresses the following issues:
* Resolves #40
* Resolves #38
* Resolves #70
* Works around #71
* Resolves #84 by reinstating #55
2015-06-20 02:36:15 +00:00
|
|
|
all equivalent to --platform=all --arch=all
|
2015-05-10 20:57:42 +00:00
|
|
|
out the dir to put the app into at the end. defaults to current working dir
|
2015-07-05 12:44:18 +00:00
|
|
|
icon the icon file to use as the icon for the app (should be a .icns file on OSX)
|
2015-05-10 20:57:42 +00:00
|
|
|
app-bundle-id bundle identifier to use in the app plist
|
|
|
|
|
app-version version to set for the app
|
|
|
|
|
helper-bundle-id bundle identifier to use in the app helper plist
|
|
|
|
|
ignore do not copy files into App whose filenames regex .match this string
|
|
|
|
|
prune runs `npm prune --production` on the app
|
Implement multi-target options and refactor code
This adds support for --all, --platform=all, and --arch=all.
In order to accommodate outputting multiple directories for multiple
platforms and architectures, this also implements a new directory
structure under the output folder (distinguished by both platform and
arch). This structure is applied even to OS X distributions, which
formerly were output directly to an .app folder. This could be considered
a backwards-incompatible change.
One other backwards-incompatible change is the value that the packager
function passes to the callback, which is now always an array of paths,
rather than just a single path.
The behavior of the icon option has also been modified to use its
basename and apply .ico or .icns depending on platform, to make it
usable with --all and --platform=all. This attempts to maximize
backwards compatibility, by allowing a full filename to be specified,
but replacing the filename's extension with what is appropriate for
each target platform. Alternatively, the extension can now be omitted.
In the process of implementing this, it became evident that some things
were being done in 3 different places, and weren't always being done
consistently, so I've deduplicated everything I could.
This also includes a few other changes to improve stability for
multi-target runs, and other fixes:
* Avoid targeting darwin if the environment doesn't support symlinks,
to avoid the process bailing out on Windows
* Implement --overwrite centrally in index.js such that it explicitly
skips if an output directory already exists, for consistency with
all target platforms and to avoid any possible errors that would halt
operation during one target of a multi-target run
* Use ncp instead of mv to move to finalPath, which avoids flakiness
I noticed when testing on Windows 8 especially with multi-target runs
* Simplify temp directory logic by using a nested structure, so there
is only one top-level directory to clean up
* Reinstate fix from #55 which seems to have been clobbered by a later
merge
* linux.createApp now resolves to the final output directory;
it was formerly resolving to the executable path
* mac.createApp now replaces space with underscore in bundle IDs
* Only the platform modules that are needed are loaded
* The win32 module only loads rcedit if needed
This also fixes a couple of missing updates to docs (readme/usage).
This commit addresses the following issues:
* Resolves #40
* Resolves #38
* Resolves #70
* Works around #71
* Resolves #84 by reinstating #55
2015-06-20 02:36:15 +00:00
|
|
|
overwrite if output directory for a platform already exists, replaces it rather than skipping it
|
|
|
|
|
asar packages the source code within your app into an archive
|
2015-07-02 00:52:43 +00:00
|
|
|
sign should contain the identity to be used when running `codesign` (OS X only)
|
|
|
|
|
version-string should contain a hash of the application metadata to be embedded into the executable (Windows only).
|
|
|
|
|
These can be specified on the command line via dot notation,
|
|
|
|
|
e.g. --version-string.CompanyName="Company Inc." --version-string.ProductName="Product"
|
|
|
|
|
Keys supported:
|
|
|
|
|
- CompanyName
|
|
|
|
|
- LegalCopyright
|
|
|
|
|
- FileDescription
|
|
|
|
|
- OriginalFilename
|
|
|
|
|
- FileVersion
|
|
|
|
|
- ProductVersion
|
|
|
|
|
- ProductName
|
2015-07-06 02:12:30 +00:00
|
|
|
- InternalName
|
2015-07-06 02:31:09 +00:00
|
|
|
badge if the target app should show badges in the OSX dock on receipt of desktop notifications
|
|
|
|
|
width window width (default=1280)
|
|
|
|
|
height window height (default=800)
|
