diff --git a/.changes/docs-nsis-templete-url.md b/.changes/docs-nsis-templete-url.md new file mode 100644 index 00000000..975fd9c7 --- /dev/null +++ b/.changes/docs-nsis-templete-url.md @@ -0,0 +1,6 @@ +--- +"cargo-packager": "patch" +"@crabnebula/packager": "patch" +--- + +Update NSIS installer template URL. \ No newline at end of file diff --git a/bindings/packager/nodejs/schema.json b/bindings/packager/nodejs/schema.json index fe11c46f..21f89fac 100644 --- a/bindings/packager/nodejs/schema.json +++ b/bindings/packager/nodejs/schema.json @@ -740,7 +740,7 @@ ] }, "signingIdentity": { - "description": "Code signing identity.", + "description": "Code signing identity.\n\nThis is typically of the form: `\"Developer ID Application: TEAM_NAME (TEAM_ID)\"`.", "type": [ "string", "null" @@ -1138,14 +1138,14 @@ ] }, "template": { - "description": "A custom `.nsi` template to use.\n\nSee the default template here ", + "description": "A custom `.nsi` template to use.\n\nSee the default template here ", "type": [ "string", "null" ] }, "preinstallSection": { - "description": "Logic of an NSIS section that will be ran before the install section.\n\nSee the available libraries, dlls and global variables here \n\n### Example ```toml [package.metadata.packager.nsis] preinstall-section = \"\"\" ; Setup custom messages LangString webview2AbortError ${LANG_ENGLISH} \"Failed to install WebView2! The app can't run without it. Try restarting the installer.\" LangString webview2DownloadError ${LANG_ARABIC} \"خطأ: فشل تنزيل WebView2 - $0\"\n\nSection PreInstall ;
SectionEnd\n\nSection AnotherPreInstall ;
SectionEnd \"\"\" ```", + "description": "Logic of an NSIS section that will be ran before the install section.\n\nSee the available libraries, dlls and global variables here \n\n### Example ```toml [package.metadata.packager.nsis] preinstall-section = \"\"\" ; Setup custom messages LangString webview2AbortError ${LANG_ENGLISH} \"Failed to install WebView2! The app can't run without it. Try restarting the installer.\" LangString webview2DownloadError ${LANG_ARABIC} \"خطأ: فشل تنزيل WebView2 - $0\"\n\nSection PreInstall ;
SectionEnd\n\nSection AnotherPreInstall ;
SectionEnd \"\"\" ```", "type": [ "string", "null" diff --git a/bindings/packager/nodejs/src-ts/config.d.ts b/bindings/packager/nodejs/src-ts/config.d.ts index 48f78faf..9cfa89f1 100644 --- a/bindings/packager/nodejs/src-ts/config.d.ts +++ b/bindings/packager/nodejs/src-ts/config.d.ts @@ -603,13 +603,13 @@ export interface NsisConfig { /** * A custom `.nsi` template to use. * - * See the default template here + * See the default template here */ template?: string | null; /** * Logic of an NSIS section that will be ran before the install section. * - * See the available libraries, dlls and global variables here + * See the available libraries, dlls and global variables here * * ### Example ```toml [package.metadata.packager.nsis] preinstall-section = """ ; Setup custom messages LangString webview2AbortError ${LANG_ENGLISH} "Failed to install WebView2! The app can't run without it. Try restarting the installer." LangString webview2DownloadError ${LANG_ARABIC} "خطأ: فشل تنزيل WebView2 - $0" * diff --git a/crates/packager/schema.json b/crates/packager/schema.json index fe11c46f..21f89fac 100644 --- a/crates/packager/schema.json +++ b/crates/packager/schema.json @@ -740,7 +740,7 @@ ] }, "signingIdentity": { - "description": "Code signing identity.", + "description": "Code signing identity.\n\nThis is typically of the form: `\"Developer ID Application: TEAM_NAME (TEAM_ID)\"`.", "type": [ "string", "null" @@ -1138,14 +1138,14 @@ ] }, "template": { - "description": "A custom `.nsi` template to use.\n\nSee the default template here ", + "description": "A custom `.nsi` template to use.\n\nSee the default template here ", "type": [ "string", "null" ] }, "preinstallSection": { - "description": "Logic of an NSIS section that will be ran before the install section.\n\nSee the available libraries, dlls and global variables here \n\n### Example ```toml [package.metadata.packager.nsis] preinstall-section = \"\"\" ; Setup custom messages LangString webview2AbortError ${LANG_ENGLISH} \"Failed to install WebView2! The app can't run without it. Try restarting the installer.\" LangString webview2DownloadError ${LANG_ARABIC} \"خطأ: فشل تنزيل WebView2 - $0\"\n\nSection PreInstall ;
SectionEnd\n\nSection AnotherPreInstall ;
SectionEnd \"\"\" ```", + "description": "Logic of an NSIS section that will be ran before the install section.\n\nSee the available libraries, dlls and global variables here \n\n### Example ```toml [package.metadata.packager.nsis] preinstall-section = \"\"\" ; Setup custom messages LangString webview2AbortError ${LANG_ENGLISH} \"Failed to install WebView2! The app can't run without it. Try restarting the installer.\" LangString webview2DownloadError ${LANG_ARABIC} \"خطأ: فشل تنزيل WebView2 - $0\"\n\nSection PreInstall ;
SectionEnd\n\nSection AnotherPreInstall ;
SectionEnd \"\"\" ```", "type": [ "string", "null" diff --git a/crates/packager/src/config/mod.rs b/crates/packager/src/config/mod.rs index 97441be3..aea68e04 100644 --- a/crates/packager/src/config/mod.rs +++ b/crates/packager/src/config/mod.rs @@ -1115,12 +1115,12 @@ pub struct NsisConfig { /// A custom `.nsi` template to use. /// /// See the default template here - /// + /// pub template: Option, /// Logic of an NSIS section that will be ran before the install section. /// /// See the available libraries, dlls and global variables here - /// + /// /// /// ### Example /// ```toml @@ -1212,7 +1212,7 @@ impl NsisConfig { /// Set a custom `.nsi` template to use. /// /// See the default template here - /// + /// pub fn template>(mut self, template: P) -> Self { self.template.replace(template.into()); self @@ -1221,7 +1221,7 @@ impl NsisConfig { /// Set the logic of an NSIS section that will be ran before the install section. /// /// See the available libraries, dlls and global variables here - /// + /// /// /// ### Example /// ```toml