chore(docs): adding msi and msi-wrapped docs to documentation site (#…

…7507)

docs/configuration/msi-wrapped.md

@@ -0,0 +1,17 @@
+<ul>
+<li><code id="MsiWrappedOptions-wrappedInstallerArgs">wrappedInstallerArgs</code> String | “undefined” - Extra arguments to provide to the wrapped installer (ie: /S for silent install)</li>
+<li><code id="MsiWrappedOptions-impersonate">impersonate</code> = <code>false</code> Boolean - Determines if the wrapped installer should be executed with impersonation</li>
+<li><code id="MsiWrappedOptions-upgradeCode">upgradeCode</code> String | “undefined” - The <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx">upgrade code</a>. Optional, by default generated using app id.</li>
+<li><code id="MsiWrappedOptions-warningsAsErrors">warningsAsErrors</code> = <code>true</code> Boolean - If <code>warningsAsErrors</code> is <code>true</code> (default): treat warnings as errors. If <code>warningsAsErrors</code> is <code>false</code>: allow warnings.</li>
+<li><code id="MsiWrappedOptions-additionalWixArgs">additionalWixArgs</code> Array&lt;String&gt; | “undefined” - Any additional arguments to be passed to the WiX installer compiler, such as <code>[&quot;-ext&quot;, &quot;WixUtilExtension&quot;]</code></li>
+<li><code id="MsiWrappedOptions-oneClick">oneClick</code> Boolean</li>
+<li><code id="MsiWrappedOptions-perMachine">perMachine</code> = <code>false</code> Boolean - Whether to install per all users (per-machine).</li>
+<li><code id="MsiWrappedOptions-runAfterFinish">runAfterFinish</code> = <code>true</code> Boolean - Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.</li>
+</ul>
+<hr>
+<ul>
+<li><code id="MsiWrappedOptions-createDesktopShortcut">createDesktopShortcut</code> = <code>true</code> Boolean | “always” - Whether to create desktop shortcut. Set to <code>always</code> if to recreate also on reinstall (even if removed by user).</li>
+<li><code id="MsiWrappedOptions-createStartMenuShortcut">createStartMenuShortcut</code> = <code>true</code> Boolean - Whether to create start menu shortcut.</li>
+<li><code id="MsiWrappedOptions-menuCategory">menuCategory</code> = <code>false</code> Boolean | String - Whether to create submenu for start menu shortcut and program files directory. If <code>true</code>, company name will be used. Or string value.</li>
+<li><code id="MsiWrappedOptions-shortcutName">shortcutName</code> String | “undefined” - The name that will be used for all shortcuts. Defaults to the application name.</li>
+</ul>

docs/configuration/msi.md

@@ -0,0 +1,15 @@
+<ul>
+<li><code id="MsiOptions-oneClick">oneClick</code> = <code>true</code> Boolean - One-click installation.</li>
+<li><code id="MsiOptions-upgradeCode">upgradeCode</code> String | “undefined” - The <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx">upgrade code</a>. Optional, by default generated using app id.</li>
+<li><code id="MsiOptions-warningsAsErrors">warningsAsErrors</code> = <code>true</code> Boolean - If <code>warningsAsErrors</code> is <code>true</code> (default): treat warnings as errors. If <code>warningsAsErrors</code> is <code>false</code>: allow warnings.</li>
+<li><code id="MsiOptions-additionalWixArgs">additionalWixArgs</code> Array&lt;String&gt; | “undefined” - Any additional arguments to be passed to the WiX installer compiler, such as <code>[&quot;-ext&quot;, &quot;WixUtilExtension&quot;]</code></li>
+<li><code id="MsiOptions-perMachine">perMachine</code> = <code>false</code> Boolean - Whether to install per all users (per-machine).</li>
+<li><code id="MsiOptions-runAfterFinish">runAfterFinish</code> = <code>true</code> Boolean - Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.</li>
+</ul>
+<hr>
+<ul>
+<li><code id="MsiOptions-createDesktopShortcut">createDesktopShortcut</code> = <code>true</code> Boolean | “always” - Whether to create desktop shortcut. Set to <code>always</code> if to recreate also on reinstall (even if removed by user).</li>
+<li><code id="MsiOptions-createStartMenuShortcut">createStartMenuShortcut</code> = <code>true</code> Boolean - Whether to create start menu shortcut.</li>
+<li><code id="MsiOptions-menuCategory">menuCategory</code> = <code>false</code> Boolean | String - Whether to create submenu for start menu shortcut and program files directory. If <code>true</code>, company name will be used. Or string value.</li>
+<li><code id="MsiOptions-shortcutName">shortcutName</code> String | “undefined” - The name that will be used for all shortcuts. Defaults to the application name.</li>
+</ul>

mkdocs.yml

@@ -60,6 +60,8 @@ nav:
           - Any Windows Target: configuration/win.md
           - NSIS: configuration/nsis.md
           - AppX: configuration/appx.md
+          - MSI: configuration/msi.md
+          - MSI Wrapped: configuration/msi-wrapped.md
           - Squirrel.Windows: configuration/squirrel-windows.md
 
       - Linux:

scripts/jsdoc2md2html.js

@@ -89,12 +89,12 @@ async function render2(files, jsdoc2MdOptions) {
       if (context.typeItem.name === "LinuxTargetSpecificOptions" && context.object.name === "DebOptions") {
         return null
       }
-      if (context.typeItem.name === "TargetSpecificOptions" && context.object.name === "NsisOptions") {
+      if (context.typeItem.name === "TargetSpecificOptions" && ["NsisOptions", "MsiOptions", "MsiWrappedOptions"].includes(context.object.name)) {
         return null
       }
 
       // looks strange when on LinuxConfiguration page "Inherited from `CommonLinuxOptions`:" - no configuration inheritance in this case
-      if (context.object.name === "LinuxConfiguration" || (context.object.name === "NsisOptions" && (context.typeItem.name === "CommonNsisOptions" || context.typeItem.name === "CommonWindowsInstallerConfiguration"))) {
+      if (context.object.name === "LinuxConfiguration" || (["NsisOptions", "MsiOptions", "MsiWrappedOptions"].includes(context.object.name) && (context.typeItem.name === "CommonNsisOptions" || context.typeItem.name === "CommonWindowsInstallerConfiguration"))) {
         return ""
       }
     }
@@ -155,6 +155,12 @@ async function render2(files, jsdoc2MdOptions) {
     if (types.some(it => it.endsWith(".NsisOptions") || it === "NsisOptions")) {
       return "[NsisOptions](nsis)"
     }
+    if (types.some(it => it.endsWith("MsiOptions"))) {
+      return "[MsisOptions](msi)"
+    }
+    if (types.some(it => it.endsWith("MsiWrappedOptions"))) {
+      return "[MsisWrappedOptions](msi-wrapped)"
+    }
     if (types.some(it => it.endsWith("AppXOptions"))) {
       return "[AppXOptions](appx)"
     }
@@ -206,6 +212,8 @@ async function render2(files, jsdoc2MdOptions) {
     new Page("configuration/pkg.md", "PkgOptions"),
 
     new Page("configuration/win.md", "WindowsConfiguration"),
+    new Page("configuration/msi-wrapped.md", "MsiWrappedOptions"),
+    new Page("configuration/msi.md", "MsiOptions"),
     new Page("configuration/appx.md", "AppXOptions"),
     new Page("configuration/squirrel-windows.md", "SquirrelWindowsOptions"),