diff --git a/404.html b/404.html index bc126b755..73e7650f2 100644 --- a/404.html +++ b/404.html @@ -13,7 +13,7 @@
nw-builder

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home
- + \ No newline at end of file diff --git a/api-nux.html b/api-nux.html index 82d2a0eb9..31da9de66 100644 --- a/api-nux.html +++ b/api-nux.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

Constants ​

setLinuxConfig ⇒ Promise.<void>

Generates a Desktop Entry file for Linux https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s06.html

Typedefs ​

name : object

Linux configuration options

setLinuxConfig ⇒ Promise.<void> ​

Generates a Desktop Entry file for Linux https://specifications.freedesktop.org/desktop-entry-spec/latest/ar01s06.html

Kind: global constant

ParamTypeDescription
appLinuxRcResource configuration options for Linux
outDirstringDirectory which stores build artifacts

name : object ​

Linux configuration options

Kind: global typedef
Properties

NameTypeDescription
genericNamestringGeneric name of the application
noDisplaybooleanIf true the application is not displayed
commentstringTooltip for the entry, for example "View sites on the Internet".
iconstringIcon to display in file manager, menus, etc.
hiddenbooleanTBD
onlyShowInArray.<string>A list of strings identifying the desktop environments that should (/not) display a given desktop entry
notShowInArray.<string>A list of strings identifying the desktop environments that should (/not) display a given desktop entry
dBusActivatablebooleanA boolean value specifying if D-Bus activation is supported for this application
tryExecstringPath to an executable file on disk used to determine if the program is actually installed
execstringProgram to execute, possibly with arguments.
pathstringIf entry is of type Application, the working directory to run the program in.
terminalbooleanWhether the program runs in a terminal window.
actionsArray.<string>Identifiers for application actions.
mimeTypeArray.<string>The MIME type(s) supported by this application.
categoriesArray.<string>Categories in which the entry should be shown in a menu
implementsArray.<string>A list of interfaces that this application implements.
keywordsArray.<string>A list of strings which may be used in addition to other metadata to describe this entry.
startupNotifybooleanIf true, it is KNOWN that the application will send a "remove" message when started with the DESKTOP_STARTUP_ID environment variable set. If false, it is KNOWN that the application does not work with startup notification at all.
startupWMClassstringIf specified, it is known that the application will map at least one window with the given string as its WM class or WM name hin
prefersNonDefaultGPUbooleanIf true, the application prefers to be run on a more powerful discrete GPU if available.
singleMainWindowstringIf true, the application has a single main window, and does not support having an additional one opened.
- + \ No newline at end of file diff --git a/api-osx.html b/api-osx.html index 0db985bd7..da2718214 100644 --- a/api-osx.html +++ b/api-osx.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

Functions ​

setOsxConfig(app, outDir) ⇒ Promise.<undefined>

OSX specific configuration steps https://developer.apple.com/documentation/bundleresources/information_property_list

Typedefs ​

OsxRc : object

OSX resource configuration options

setOsxConfig(app, outDir) ⇒ Promise.<undefined> ​

OSX specific configuration steps https://developer.apple.com/documentation/bundleresources/information_property_list

Kind: global function

ParamTypeDescription
appobjectResource configuration options for MacOS
outDirstringThe directory to hold build artifacts

OsxRc : object ​

OSX resource configuration options

Kind: global typedef
Properties

NameTypeDescription
namestringThe name of the application
iconstringThe path to the icon file. It should be a .icns file.
LSApplicationCategoryTypestringThe category that best describes your app for the App Store.
CFBundleIdentifierstringA unique identifier for a bundle usually in reverse DNS format.
CFBundleNamestringA user-visible short name for the bundle.
CFBundleDisplayNamestringThe user-visible name for the bundle.
CFBundleSpokenNamestringA replacement for the app name in text-to-speech operations.
CFBundleVersionstringThe version of the build that identifies an iteration of the bundle.
CFBundleShortVersionStringstringThe release or version number of the bundle.
NSHumanReadableCopyrightstringA human-readable copyright notice for the bundle.
- + \ No newline at end of file diff --git a/api-win.html b/api-win.html index 5e534f97a..21fb84cb6 100644 --- a/api-win.html +++ b/api-win.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

Functions ​

setWinConfig(app, outDir)

Windows specific configuration steps https://learn.microsoft.com/en-us/windows/win32/msi/versionhttps://learn.microsoft.com/en-gb/windows/win32/sbscs/application-manifestshttps://learn.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/deployment/trustinfo-element-clickonce-application?view=vs-2015#requestedexecutionlevelhttps://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource

Typedefs ​

WinRc : object

Windows configuration options

setWinConfig(app, outDir) ​

Windows specific configuration steps https://learn.microsoft.com/en-us/windows/win32/msi/versionhttps://learn.microsoft.com/en-gb/windows/win32/sbscs/application-manifestshttps://learn.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/deployment/trustinfo-element-clickonce-application?view=vs-2015#requestedexecutionlevelhttps://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource

Kind: global function

ParamTypeDescription
appWinRcResource configuration options for Windows
outDirstringThe directory to hold build artifacts

WinRc : object ​

Windows configuration options

Kind: global typedef
Properties

NameTypeDescription
namestringThe name of the application
versionstringThe version of the application
commentsstringAdditional information that should be displayed for diagnostic purposes.
companystringCompany that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required.
fileDescriptionstringFile description to be presented to users. This string may be displayed in a list box when the user is choosing files to install. For example, Keyboard Driver for AT-Style Keyboards. This string is required.
fileVersionstringVersion number of the file. For example, 3.10 or 5.00.RC2. This string is required.
iconstringThe path to the icon file. It should be a .ico file.
internalNamestringInternal name of the file, if one exists—for example, a module name if the file is a dynamic-link library. If the file has no internal name, this string should be the original filename, without extension. This string is required.
legalCopyrightstringCopyright notices that apply to the file. This should include the full text of all notices, legal symbols, copyright dates, and so on. This string is optional.
legalTrademarkstringTrademarks and registered trademarks that apply to the file. This should include the full text of all notices, legal symbols, trademark numbers, and so on. This string is optional.
originalFilenamestringOriginal name of the file, not including a path. This information enables an application to determine whether a file has been renamed by a user. The format of the name depends on the file system for which the file was created. This string is required.
privateBuildstringInformation about a private version of the file—for example, Built by TESTER1 on \TESTBED. This string should be present only if VS_FF_PRIVATEBUILD is specified in the fileflags parameter of the root block.
productNamestringName of the product with which the file is distributed. This string is required.
productVersionstringVersion of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. This string is required.
specialBuildstringText that specifies how this version of the file differs from the standard version—for example, Private build for TESTER1 solving mouse problems on M250 and M250E computers. This string should be present only if VS_FF_SPECIALBUILD is specified in the fileflags parameter of the root block.
- + \ No newline at end of file diff --git a/api.html b/api.html index 1320a23a7..c5ad9bf75 100644 --- a/api.html +++ b/api.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

Functions ​

nwbuild(options) ⇒ Promise.<undefined>

Automates building an NW.js application.

Typedefs ​

Options : object

Configuration options

nwbuild(options) ⇒ Promise.<undefined> ​

Automates building an NW.js application.

Kind: global function

ParamTypeDescription
optionsOptionsOptions

Options : object ​

Configuration options

Kind: global typedef
Properties

NameTypeDefaultDescription
[srcDir]"./" | string"./"String of space separated glob patterns which correspond to NW app code
[mode]"get" | "run" | "build""build"Run or build application
[version]"latest" | "stable" | string"latest"NW runtime version
[flavor]"normal" | "sdk""normal"NW runtime build flavor
platform"linux" | "osx" | "win"NW supported platforms
arch"ia32" | "x64" | "arm64"NW supported architectures
[outDir]"./out" | string"./out"Directory to store build artifacts
[cacheDir]"./cache" | string"./cache"Directory to store NW binaries
[downloadUrl]"https://dl.nwjs.io" | string"https://dl.nwjs.io"URI to download NW binaries from
[manifestUrl]"https://nwjs.io/versions&quot; | string"https://nwjs.io/versions&quot;URI to download manifest from
appobjectRefer to Linux/Windows Specific Options under Getting Started in the docs
[cache]booleantrueIf true the existing cache is used. Otherwise it removes and redownloads it.
[zip]boolean | "zip" | "tar" | "tgz"falseIf true, "zip", "tar" or "tgz" the outDir directory is compressed.
[cli]booleanfalseIf true the CLI is used to glob srcDir and parse other options
[ffmpeg]booleanfalseIf true the chromium ffmpeg is replaced by community version
[glob]booleantrueIf true globbing is enabled
[logLevel]"error" | "warn" | "info" | "debug""info"Specified log level.
- + \ No newline at end of file diff --git a/contributing.html b/contributing.html index e78f38a40..9781ed0df 100644 --- a/contributing.html +++ b/contributing.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

Contributing Guide ​

Thank you for considering to contribute!

Prerequisites ​

Install a Node Version Manager.

Install Node. Consult the version manifest before installing. nw-builder matches the Node version included in NW.js's latest release. For example, if 0.77.0 is the latest version, the Node version is 20.2.0.

Fork the repo.

Clone the fork.

Create a new branch. If you are addressing a specific issue (for example #54), then name the branch dev-54. If you encounter a problem which has not been documented (even after searching all closed issues), either open a new issue or create a branch such as fix/glob-nested-dirs.

General Tips ​

Add inline code comments if the change you make may not be obvious to others. Add tests that cover the behaviour change. We use Node's test runner for unit tests and Chromedriver for e2e tests.

Our test coverage is not great. Do not assume the package works even if all tests pass. Dependency updates are handled by dependabot unless your code change requires a version bump. If certain behaviour can be implemented using Node's standard library, that is always preferred over a third party library.

If you're unsure about any of the above, make the pull request anyway. A maintainer/community member will help you out.

- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index 5dfe4acf0..c490ddbb0 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"api-nux.md":"b31c84a4","api-osx.md":"fb85328f","mode-build.md":"52124d28","mode-get.md":"21d23444","mode-run.md":"64902f62","usage-basic.md":"c685b777","migrate-v3-v4.md":"6fd17d5b","api.md":"72398fd0","contributing.md":"12d3ea10","api-win.md":"f7fec5c5","index.md":"0c4c47f2","install.md":"0e469906"} +{"index.md":"0c4c47f2","install.md":"0e469906","api.md":"72398fd0","contributing.md":"12d3ea10","api-nux.md":"b31c84a4","migrate-v3-v4.md":"6fd17d5b","api-win.md":"f7fec5c5","mode-build.md":"52124d28","usage-basic.md":"c685b777","api-osx.md":"fb85328f","mode-get.md":"21d23444","mode-run.md":"64902f62"} diff --git a/index.html b/index.html index 550071632..acdebf084 100644 --- a/index.html +++ b/index.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

nw-builder ​

Build for Linux, MacOS, and Windows platforms.

Major Features ​

  • Get, run or build applications.
  • Integrate nwjs-ffmpeg-prebuilt
  • Configure executable fields and icons
  • Support downloading from mirrors

Consult the Installation Guide if you want to give nw-builder a try.

- + \ No newline at end of file diff --git a/install.html b/install.html index 423077850..8013926ce 100644 --- a/install.html +++ b/install.html @@ -16,7 +16,7 @@
nw-builder

Appearance

On this page

Installation Guide ​

Every NW.js release includes a modified Node.js at a specific version. It is recommended to install a version greater than or equal to NW.js's Node version. Consult the version manifest on the version to install.

With the environment set up, install nw-builder using npm:

Using npm:

shell
npm i -D nw-builder

Note: We install as a dev dependency to prevent it from being packaged with your application code.

You may use alternate package managers:

Enable corepack:

shell
corepack enable

Or install it if your version does not include it:

shell
npm i -g corepack

Prepare yarn:

corepack prepare yarn@x.y.z --activate

Using yarn:

shell
yarn add -D nw-builder

Prepare yarn:

corepack prepare pnpm@x.y.z --activate

Using pnpm:

shell
pnpm add -D nw-builder

For more information, refer to the official corepack documentation.

- + \ No newline at end of file diff --git a/migrate-v3-v4.html b/migrate-v3-v4.html index 4e91d8cbc..ed2b68d75 100644 --- a/migrate-v3-v4.html +++ b/migrate-v3-v4.html @@ -82,7 +82,7 @@ legalCopyright: "Copyright 2017", }, }); - + \ No newline at end of file diff --git a/mode-build.html b/mode-build.html index d0884c8f7..24f9a9b47 100644 --- a/mode-build.html +++ b/mode-build.html @@ -36,7 +36,7 @@ /package.json # Monorepo Node manifest

We can specify nw/package.json as the first glob pattern so that all NW.js manifest properties are taken from this file and applied to the application.

Module usage:

javascript
nwbuild({
   srcDir: "nw/package.json web/**/*",
 });

Note: If you are using the MacOS ARM unofficial builds, you will need to remove the com.apple.qurantine flag:

shell
sudo xattr -r -d com.apple.quarantine nwjs.app
- + \ No newline at end of file diff --git a/mode-get.html b/mode-get.html index 5c9bb05ed..7e7af7c1c 100644 --- a/mode-get.html +++ b/mode-get.html @@ -39,7 +39,7 @@ mode: "get", ffmpeg: true, }); - + \ No newline at end of file diff --git a/mode-run.html b/mode-run.html index 21d4f510f..98b7ee704 100644 --- a/mode-run.html +++ b/mode-run.html @@ -30,7 +30,7 @@ cache: true, ffmpeg: false, });

CLI usage:

shell
nwbuild --mode=run --glob=false

This is equivalent to:

shell
nwbuild --mode=run --version=latest --flavor=normal --platform=linux --arch=x64 --downloadUrl=https://dl.nwjs.io --manifestUrl=https://nwjs.io/versions --cacheDir=./cache --cache=true --ffmpeg=false --glob=false .

When the platform and arch are not specified, they default to the host platform and arch. For this guide, we are assumed to be using Linux x64.

This is useful if you want to run your application without building it.

- + \ No newline at end of file diff --git a/usage-basic.html b/usage-basic.html index 0874a61e0..15bbef8ec 100644 --- a/usage-basic.html +++ b/usage-basic.html @@ -26,7 +26,7 @@ })();

Execute function ​

Module usage:

javascript
nwbuild();

CLI usage:

shell
npx nwbuild

package.json usage:

json
{
   "nwbuild": {}
 }

By default, it performs a build using the latest version for the host platform and architecture. The next few guides will show you how to customize this behaviour.

- + \ No newline at end of file