You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by er...@apache.org on 2019/03/29 01:07:23 UTC
svn commit: r1856511 - in /cordova/site/public: ./
docs/en/9.x/guide/appdev/hooks/ docs/en/9.x/guide/platforms/android/
docs/en/9.x/guide/platforms/electron/ docs/en/dev/guide/appdev/hooks/
docs/en/dev/guide/platforms/android/ docs/en/dev/guide/platfor...
Author: erisu
Date: Fri Mar 29 01:07:23 2019
New Revision: 1856511
URL: http://svn.apache.org/viewvc?rev=1856511&view=rev
Log:
Updated docs
Modified:
cordova/site/public/docs/en/9.x/guide/appdev/hooks/index.html
cordova/site/public/docs/en/9.x/guide/platforms/android/index.html
cordova/site/public/docs/en/9.x/guide/platforms/electron/index.html
cordova/site/public/docs/en/dev/guide/appdev/hooks/index.html
cordova/site/public/docs/en/dev/guide/platforms/android/index.html
cordova/site/public/docs/en/dev/guide/platforms/electron/index.html
cordova/site/public/feed.xml
Modified: cordova/site/public/docs/en/9.x/guide/appdev/hooks/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/9.x/guide/appdev/hooks/index.html?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/docs/en/9.x/guide/appdev/hooks/index.html (original)
+++ cordova/site/public/docs/en/9.x/guide/appdev/hooks/index.html Fri Mar 29 01:07:23 2019
@@ -2659,14 +2659,6 @@ be specific to only one plugin.</p>
<th data-col="afterpluginls">after_plugin_ls</th>
</tr>
<tr>
- <th data-col="beforepluginsearch">before_plugin_search</th>
- <td data-col="code" rowspan="2"><code>cordova plugin search</code></td>
- <td rowspan="2" data-col="description">To be executed before and after a plugin search.</td>
- </tr>
- <tr>
- <th data-col="afterpluginsearch">after_plugin_search</th>
- </tr>
- <tr>
<th data-col="beforeplugininstall">before_plugin_install</th>
<td data-col="code" rowspan="2"><code>cordova plugin add</code></td>
<td rowspan="2" data-col="description">To be executed before and after installing a plugin (to the platforms). Plugin hooks in plugin.xml are executed for a plugin being installed only</td>
@@ -2777,11 +2769,6 @@ after_build
</code></pre></div>
<h2>Script Interface</h2>
-<h3>Windows Quirks</h3>
-
-<p>If you are working on Windows, and in case your hook (Javascript/Non-Javascript)scripts aren't bat files (which is recommended, if you want your scripts to work in non-Windows operating systems) Cordova CLI will expect a shebang line as the first line for it to know the interpreter it needs to use to launch the script. The shebang line should match the following example:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">#!/usr/bin/env [name_of_interpreter_executable]
-</code></pre></div>
<h3>Javascript</h3>
<p>If you are writing hooks using Node.js you should use the following module definition:</p>
@@ -2789,48 +2776,57 @@ after_build
<span class="p">...</span>
<span class="p">}</span>
</code></pre></div>
-<p><code>context</code> object contains hook type, executed script full path, hook options, command-line arguments passed to Cordova and top-level "cordova" object of the following format:</p>
-<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w">
- </span><span class="s2">"hook"</span><span class="p">:</span><span class="w"> </span><span class="s2">"before_plugin_install"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"scriptLocation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c:</span><span class="se">\\</span><span class="s2">script</span><span class="se">\\</span><span class="s2">full</span><span class="se">\\</span><span class="s2">path</span><span class="se">\\</span><span class="s2">appBeforePluginInstall.js"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"cmdLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The</span><span class="se">\\</span><span class="s2">exact</span><span class="se">\\</span><span class="s2">command</span><span class="se">\\</span><span class="s2">cordova</span><span class="se">\\</span><span class="s2">run</span><span class="se">\\</span><span class="s2">with arguments"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"opts"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"projectRoot"</span><span class="p">:</span><span class="s2">"C:</span><span class="se">\\</span><span class="s2">path</span><span class="se">\\</span><span class="s2">to</span><span class="se">\\</span><span class="s2">the</span><span class="se">\\</span><span class="s2">project"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"cordova"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"platforms"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"android"</span><span class="p">],</span><span class="w">
- </span><span class="s2">"plugins"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"plugin-withhooks"</span><span class="p">],</span><span class="w">
- </span><span class="s2">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.21.7-dev"</span><span class="w">
- </span><span class="p">},</span><span class="w">
- </span><span class="s2">"plugin"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"plugin-withhooks"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"pluginInfo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="err">...</span><span class="w">
- </span><span class="p">},</span><span class="w">
- </span><span class="s2">"platform"</span><span class="p">:</span><span class="w"> </span><span class="s2">"android"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"dir"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C:</span><span class="se">\\</span><span class="s2">path</span><span class="se">\\</span><span class="s2">to</span><span class="se">\\</span><span class="s2">the</span><span class="se">\\</span><span class="s2">project</span><span class="se">\\</span><span class="s2">plugins</span><span class="se">\\</span><span class="s2">plugin-withhooks"</span><span class="w">
- </span><span class="p">}</span><span class="w">
- </span><span class="p">},</span><span class="w">
- </span><span class="s2">"cordova"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">}</span><span class="w">
-</span><span class="p">}</span><span class="w">
+<p>Here is an example that showcases the contents of the <code>context</code> object:</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="p">{</span>
+ <span class="c1">// The type of hook being run</span>
+ <span class="nl">hook</span><span class="p">:</span> <span class="s1">'before_plugin_install'</span><span class="p">,</span>
+
+ <span class="c1">// Absolute path to the hook script that is currently executing</span>
+ <span class="nx">scriptLocation</span><span class="p">:</span> <span class="s1">'/foo/scripts/appBeforePluginInstall.js'</span><span class="p">,</span>
+
+ <span class="c1">// The CLI command that lead to this hook being executed</span>
+ <span class="nx">cmdLine</span><span class="p">:</span> <span class="s1">'cordova plugin add plugin-withhooks'</span><span class="p">,</span>
+
+ <span class="c1">// The options associated with the current operation.</span>
+ <span class="c1">// WARNING: The contents of this object vary among the different</span>
+ <span class="c1">// operations and are currently not documented anywhere.</span>
+ <span class="nx">opts</span><span class="p">:</span> <span class="p">{</span>
+ <span class="nl">projectRoot</span><span class="p">:</span> <span class="s1">'/foo'</span><span class="p">,</span>
+
+ <span class="nx">cordova</span><span class="p">:</span> <span class="p">{</span>
+ <span class="nl">platforms</span><span class="p">:</span> <span class="p">[</span><span class="s1">'android'</span><span class="p">],</span>
+ <span class="nx">plugins</span><span class="p">:</span> <span class="p">[</span><span class="s1">'plugin-withhooks'</span><span class="p">],</span>
+ <span class="nx">version</span><span class="p">:</span> <span class="s1">'0.21.7-dev'</span>
+ <span class="p">},</span>
+
+ <span class="c1">// Information about the plugin currently operated on.</span>
+ <span class="c1">// This object will only be passed to plugin hooks scripts.</span>
+ <span class="nx">plugin</span><span class="p">:</span> <span class="p">{</span>
+ <span class="nl">id</span><span class="p">:</span> <span class="s1">'plugin-withhooks'</span><span class="p">,</span>
+ <span class="nx">pluginInfo</span><span class="p">:</span> <span class="p">{</span> <span class="cm">/* ... */</span> <span class="p">},</span>
+ <span class="nx">platform</span><span class="p">:</span> <span class="s1">'android'</span><span class="p">,</span>
+ <span class="nx">dir</span><span class="p">:</span> <span class="s1">'/foo/plugins/plugin-withhooks'</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
-</span></code></pre></div>
-<p><code>context.opts.plugin</code> object will only be passed to plugin hooks scripts.</p>
+ <span class="c1">// A reference to Cordova's API</span>
+ <span class="nx">cordova</span><span class="p">:</span> <span class="p">{</span> <span class="cm">/* ... */</span> <span class="p">}</span>
+<span class="p">}</span>
+</code></pre></div>
<p>You can also require additional Cordova modules in your script using <code>context.requireCordovaModule</code> in the following way:</p>
-<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">var</span> <span class="nx">Q</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'q'</span><span class="p">);</span>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">cordovaCommon</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'cordova-common'</span><span class="p">);</span>
</code></pre></div>
-<p>You can make your scipts async using Q:</p>
-<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">context</span><span class="p">)</span> <span class="p">{</span>
- <span class="kd">var</span> <span class="nx">Q</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'q'</span><span class="p">);</span>
- <span class="kd">var</span> <span class="nx">deferral</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Q</span><span class="p">.</span><span class="nx">defer</span><span class="p">();</span>
-
- <span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
- <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'hook.js>> end'</span><span class="p">);</span>
- <span class="nx">deferral</span><span class="p">.</span><span class="nx">resolve</span><span class="p">();</span>
- <span class="p">},</span> <span class="mi">1000</span><span class="p">);</span>
-
- <span class="k">return</span> <span class="nx">deferral</span><span class="p">.</span><span class="nx">promise</span><span class="p">;</span>
-<span class="p">}</span>
+<p>You can make your scripts asynchronous using Promises.
+Here is an example that just waits for a second and then prints the amount of milliseconds spent waiting:</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="nx">context</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="k">return</span> <span class="k">new</span> <span class="nb">Promise</span><span class="p">(</span><span class="nx">resolve</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="kd">const</span> <span class="nx">start</span> <span class="o">=</span> <span class="nb">Date</span><span class="p">.</span><span class="nx">now</span><span class="p">();</span>
+ <span class="nx">setTimeout</span><span class="p">(()</span> <span class="o">=></span> <span class="nx">resolve</span><span class="p">(</span><span class="nb">Date</span><span class="p">.</span><span class="nx">now</span><span class="p">()</span> <span class="o">-</span> <span class="nx">start</span><span class="p">),</span> <span class="mi">1000</span><span class="p">);</span>
+ <span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="nx">msWaited</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">`</span><span class="p">${</span><span class="nx">context</span><span class="p">.</span><span class="nx">scriptLocation</span><span class="p">}</span><span class="s2"> waited </span><span class="p">${</span><span class="nx">msWaited</span><span class="p">}</span><span class="s2"> ms`</span><span class="p">);</span>
+ <span class="p">});</span>
+<span class="p">};</span>
</code></pre></div>
<blockquote>
<p><strong>Note</strong>: new module loader script interface is used for the <code>.js</code> files defined via <code>config.xml</code> or <code>plugin.xml</code> only.
@@ -2839,7 +2835,7 @@ For compatibility reasons hook files spe
<h3>Non-javascript</h3>
-<p>Non-javascript scripts are run via Node child_process spawn from the project's root directory and have the root directory passes as the first argument. All other options are passed to the script using environment variables:</p>
+<p>Non-javascript scripts are run via Node child_process spawn from the project's root directory and have the root directory passed as the first argument. All other options are passed to the script using environment variables:</p>
<table><thead>
<tr>
@@ -2875,6 +2871,11 @@ For compatibility reasons hook files spe
<p><strong>Note</strong>: we highly recommend writing your hooks using Node.js so that they are cross-platform, see <a href="#link-javascript">Javascript</a> section above.</p>
</blockquote>
+<h4>Windows Quirks</h4>
+
+<p>If you are working on Windows, and your hook scripts aren't <code>*.bat</code> files, Cordova CLI will expect a shebang line as the first line of the script. This way it knows the interpreter it needs to use to launch the script. A shebang line for a Python script could look like this:</p>
+<div class="highlight"><pre><code class="language-" data-lang=""><span class="c">#!/usr/bin/env python</span>
+</code></pre></div>
<h2>Sample Usage</h2>
<p>This sample demonstrates Cordova hooks usage to trace to the console output the
@@ -2885,30 +2886,22 @@ tell Cordova to run <code>afterBuild.js<
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><hook</span> <span class="na">type=</span><span class="s">"after_build"</span> <span class="na">src=</span><span class="s">"scripts/afterBuild.js"</span> <span class="nt">/></span>
</code></pre></div>
<p>Create <code>scripts/afterBuild.js</code> file and add the following implementation.
-We use async version of <code>fs.stat</code> method to demonstrate how async functionality
-could be done via hooks.</p>
-<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span> <span class="p">{</span>
- <span class="c1">// make sure android platform is part of build</span>
- <span class="k">if</span> <span class="p">(</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">platforms</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s1">'android'</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">return</span><span class="p">;</span>
- <span class="p">}</span>
- <span class="kd">var</span> <span class="nx">fs</span> <span class="o">=</span> <span class="nx">ctx</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'fs'</span><span class="p">),</span>
- <span class="nx">path</span> <span class="o">=</span> <span class="nx">ctx</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'path'</span><span class="p">),</span>
- <span class="nx">deferral</span> <span class="o">=</span> <span class="nx">ctx</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'q'</span><span class="p">).</span><span class="nx">defer</span><span class="p">();</span>
-
- <span class="kd">var</span> <span class="nx">platformRoot</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">projectRoot</span><span class="p">,</span> <span class="s1">'platforms/android'</span><span class="p">);</span>
- <span class="kd">var</span> <span class="nx">apkFileLocation</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">platformRoot</span><span class="p">,</span> <span class="s1">'build/outputs/apk/android-debug.apk'</span><span class="p">);</span>
-
- <span class="nx">fs</span><span class="p">.</span><span class="nx">stat</span><span class="p">(</span><span class="nx">apkFileLocation</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span><span class="nx">stats</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
- <span class="nx">deferral</span><span class="p">.</span><span class="nx">reject</span><span class="p">(</span><span class="s1">'Operation failed'</span><span class="p">);</span>
- <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
- <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Size of '</span> <span class="o">+</span> <span class="nx">apkFileLocation</span> <span class="o">+</span> <span class="s1">' is '</span> <span class="o">+</span> <span class="nx">stats</span><span class="p">.</span><span class="nx">size</span> <span class="o">+</span><span class="s1">' bytes'</span><span class="p">);</span>
- <span class="nx">deferral</span><span class="p">.</span><span class="nx">resolve</span><span class="p">();</span>
- <span class="p">}</span>
- <span class="p">});</span>
+We use async version of <code>fs.stat</code> method to demonstrate how async functions
+can be used in hooks.</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">fs</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'fs'</span><span class="p">);</span>
+<span class="kd">const</span> <span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'util'</span><span class="p">);</span>
+<span class="kd">const</span> <span class="nx">stat</span> <span class="o">=</span> <span class="nx">util</span><span class="p">.</span><span class="nx">promisify</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">stat</span><span class="p">);</span>
+
+<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// Make sure android platform is part of build</span>
+ <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">platforms</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="s1">'android'</span><span class="p">))</span> <span class="k">return</span><span class="p">;</span>
- <span class="k">return</span> <span class="nx">deferral</span><span class="p">.</span><span class="nx">promise</span><span class="p">;</span>
+ <span class="kd">const</span> <span class="nx">platformRoot</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">projectRoot</span><span class="p">,</span> <span class="s1">'platforms/android'</span><span class="p">);</span>
+ <span class="kd">const</span> <span class="nx">apkFileLocation</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">platformRoot</span><span class="p">,</span> <span class="s1">'build/outputs/apk/android-debug.apk'</span><span class="p">);</span>
+
+ <span class="k">return</span> <span class="nx">stat</span><span class="p">(</span><span class="nx">apkFileLocation</span><span class="p">).</span><span class="nx">then</span><span class="p">(</span><span class="nx">stats</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">`Size of </span><span class="p">${</span><span class="nx">apkFileLocation</span><span class="p">}</span><span class="s2"> is </span><span class="p">${</span><span class="nx">stats</span><span class="p">.</span><span class="nx">size</span><span class="p">}</span><span class="s2"> bytes`</span><span class="p">);</span>
+ <span class="p">});</span>
<span class="p">};</span>
</code></pre></div>
<p>Parameter <code>ctx</code> in example above is passed by Cordova and represents execution
Modified: cordova/site/public/docs/en/9.x/guide/platforms/android/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/9.x/guide/platforms/android/index.html?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/docs/en/9.x/guide/platforms/android/index.html (original)
+++ cordova/site/public/docs/en/9.x/guide/platforms/android/index.html Fri Mar 29 01:07:23 2019
@@ -2512,7 +2512,7 @@ the CLI, see <a href="../../../reference
<p>Cordova for Android requires the Android SDK which can be installed
on OS X, Linux or Windows. See the Android SDK's
<a href="http://developer.android.com/sdk/index.html#Requirements">System Requirements</a>.
-Cordova's latest Android package supports up to Android <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels">API Level</a> 27.
+Cordova's latest Android package supports up to Android <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels">API Level</a> 28.
The supported Android API Levels and Android Versions for the past
few cordova-android releases can be found in this table:</p>
@@ -2524,6 +2524,11 @@ few cordova-android releases can be foun
</tr>
</thead><tbody>
<tr>
+<td>8.X.X</td>
+<td>19 - 28</td>
+<td>4.4 - 9.0.0</td>
+</tr>
+<tr>
<td>7.X.X</td>
<td>19 - 27</td>
<td>4.4 - 8.1</td>
Modified: cordova/site/public/docs/en/9.x/guide/platforms/electron/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/9.x/guide/platforms/electron/index.html?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/docs/en/9.x/guide/platforms/electron/index.html (original)
+++ cordova/site/public/docs/en/9.x/guide/platforms/electron/index.html Fri Mar 29 01:07:23 2019
@@ -2544,7 +2544,7 @@
<li><p><strong>RedHat Build Support</strong></p>
<ul>
-<li><strong>Homebrew</strong>, one of the available macOS package manager, is used for installing additional tools and dependencies. Homebrew will be needed to install RPM packaging dependencies. <a href="https://brew.sh/"><strong>Brew Install Step</strong></a></li>
+<li><strong>Homebrew</strong>, one of the available macOS package managers, is used for installing additional tools and dependencies. Homebrew will be needed to install RPM packaging dependencies. <a href="https://brew.sh/"><strong>Brew Install Step</strong></a></li>
<li><strong>RPM</strong>, a standard package manager for multiple Linux distributions, is the tool used for creating the Linux RPM package. To install this tool, use the following <a href="https://brew.sh/"><strong>Homebrew</strong></a> command:</li>
</ul>
<div class="highlight"><pre><code class="language-" data-lang="">$ brew install rpm
@@ -2556,7 +2556,7 @@
<ul>
<li><p><strong>Python</strong> version 2.7.10 or higher.</p></li>
<li><p><strong>PowerShell</strong>, for Windows 7 users, must be at version 3.0 or greater for <a href="https://www.electron.build/code-signing#windows">app signing</a>.</p></li>
-<li><p><strong>Debugging Tools</strong> for Windows of Windows SDK 10.0.15063.468, if you plan on creating a full distribution.</p></li>
+<li><p><strong><a href="https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/">Debugging Tools for Windows</a></strong> is a toolkit for enhancing debug capabilities. It is recommended to install with the <strong>Windows SDK 10.0.15063.468</strong>.</p></li>
</ul>
<h2>Quick Start</h2>
@@ -2581,7 +2581,7 @@ $ cordova build electron --debug
<p><strong>Release Builds</strong></p>
<div class="highlight"><pre><code class="language-" data-lang="">$ cordova build electron --release
</code></pre></div>
-<h2>Customizing the Application's Window Process</h2>
+<h2>Customizing Application Window</h2>
<p>Electron provides many options to manipulate the <a href="https://electronjs.org/docs/api/browser-window"><code>BrowserWindow</code></a>. This section will cover how to configure a few basic options. For a full list of options, please see the <a href="https://electronjs.org/docs/api/browser-window#new-browserwindowoptions">Electron's Docs - BrowserWindow Options</a>.</p>
@@ -2599,7 +2599,7 @@ $ cordova build electron --debug
</span><span class="s2">"browserWindow"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
-<h3>How to set the window's default size?</h3>
+<h3>How to set the default window size?</h3>
<p>By default, the <code>width</code> is set to <strong>800</strong> and the <code>height</code> set to <strong>600</strong>. This can be overridden by setting the <code>width</code> and <code>height</code> property.</p>
@@ -2648,7 +2648,7 @@ $ cordova build electron --debug
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
-<h2>Customizing the Electron's Main Process</h2>
+<h2>Customizing Main Process</h2>
<p>If it is necessary to customize the Electron's main process beyond the scope of the Electron's configuration settings, chances can be added directly to the <code>cdv-electron-main.js</code> file located in <code>{PROJECT_ROOT_DIR}/platform/electron/platform_www/</code>. This is the application's main process.</p>
@@ -3003,7 +3003,7 @@ $ cordova build electron --debug
<ul>
<li><strong>[1]</strong> If the app contains native dependency, it can only be compiled on the targeted platform.</li>
<li><strong>[2]</strong> Linux and macOS are unable to build Windows Appx packages for Windows Store.</li>
-<li><strong>[3]</strong> <a href="https://www.electron.build/multi-platform-build#macos">All required system dependencies, except rpm, will be downloaded automatically on demand. RPM can be installed with brew. (macOS Sierra 10.12+)</a></li>
+<li><strong>[3]</strong> <a href="https://www.electron.build/multi-platform-build#macos">All required system dependencies, except rpm, will be downloaded automatically on demand. RPM can be installed using brew. (macOS Sierra 10.12+)</a></li>
</ul>
<p>The example below enables multi-platform build for all OS and uses the default build configurations.</p>
Modified: cordova/site/public/docs/en/dev/guide/appdev/hooks/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/appdev/hooks/index.html?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/appdev/hooks/index.html (original)
+++ cordova/site/public/docs/en/dev/guide/appdev/hooks/index.html Fri Mar 29 01:07:23 2019
@@ -2667,14 +2667,6 @@ be specific to only one plugin.</p>
<th data-col="afterpluginls">after_plugin_ls</th>
</tr>
<tr>
- <th data-col="beforepluginsearch">before_plugin_search</th>
- <td data-col="code" rowspan="2"><code>cordova plugin search</code></td>
- <td rowspan="2" data-col="description">To be executed before and after a plugin search.</td>
- </tr>
- <tr>
- <th data-col="afterpluginsearch">after_plugin_search</th>
- </tr>
- <tr>
<th data-col="beforeplugininstall">before_plugin_install</th>
<td data-col="code" rowspan="2"><code>cordova plugin add</code></td>
<td rowspan="2" data-col="description">To be executed before and after installing a plugin (to the platforms). Plugin hooks in plugin.xml are executed for a plugin being installed only</td>
@@ -2785,11 +2777,6 @@ after_build
</code></pre></div>
<h2>Script Interface</h2>
-<h3>Windows Quirks</h3>
-
-<p>If you are working on Windows, and in case your hook (Javascript/Non-Javascript)scripts aren't bat files (which is recommended, if you want your scripts to work in non-Windows operating systems) Cordova CLI will expect a shebang line as the first line for it to know the interpreter it needs to use to launch the script. The shebang line should match the following example:</p>
-<div class="highlight"><pre><code class="language-" data-lang="">#!/usr/bin/env [name_of_interpreter_executable]
-</code></pre></div>
<h3>Javascript</h3>
<p>If you are writing hooks using Node.js you should use the following module definition:</p>
@@ -2797,48 +2784,57 @@ after_build
<span class="p">...</span>
<span class="p">}</span>
</code></pre></div>
-<p><code>context</code> object contains hook type, executed script full path, hook options, command-line arguments passed to Cordova and top-level "cordova" object of the following format:</p>
-<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w">
- </span><span class="s2">"hook"</span><span class="p">:</span><span class="w"> </span><span class="s2">"before_plugin_install"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"scriptLocation"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c:</span><span class="se">\\</span><span class="s2">script</span><span class="se">\\</span><span class="s2">full</span><span class="se">\\</span><span class="s2">path</span><span class="se">\\</span><span class="s2">appBeforePluginInstall.js"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"cmdLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The</span><span class="se">\\</span><span class="s2">exact</span><span class="se">\\</span><span class="s2">command</span><span class="se">\\</span><span class="s2">cordova</span><span class="se">\\</span><span class="s2">run</span><span class="se">\\</span><span class="s2">with arguments"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"opts"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"projectRoot"</span><span class="p">:</span><span class="s2">"C:</span><span class="se">\\</span><span class="s2">path</span><span class="se">\\</span><span class="s2">to</span><span class="se">\\</span><span class="s2">the</span><span class="se">\\</span><span class="s2">project"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"cordova"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"platforms"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"android"</span><span class="p">],</span><span class="w">
- </span><span class="s2">"plugins"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"plugin-withhooks"</span><span class="p">],</span><span class="w">
- </span><span class="s2">"version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.21.7-dev"</span><span class="w">
- </span><span class="p">},</span><span class="w">
- </span><span class="s2">"plugin"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"plugin-withhooks"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"pluginInfo"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
- </span><span class="err">...</span><span class="w">
- </span><span class="p">},</span><span class="w">
- </span><span class="s2">"platform"</span><span class="p">:</span><span class="w"> </span><span class="s2">"android"</span><span class="p">,</span><span class="w">
- </span><span class="s2">"dir"</span><span class="p">:</span><span class="w"> </span><span class="s2">"C:</span><span class="se">\\</span><span class="s2">path</span><span class="se">\\</span><span class="s2">to</span><span class="se">\\</span><span class="s2">the</span><span class="se">\\</span><span class="s2">project</span><span class="se">\\</span><span class="s2">plugins</span><span class="se">\\</span><span class="s2">plugin-withhooks"</span><span class="w">
- </span><span class="p">}</span><span class="w">
- </span><span class="p">},</span><span class="w">
- </span><span class="s2">"cordova"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="err">...</span><span class="p">}</span><span class="w">
-</span><span class="p">}</span><span class="w">
+<p>Here is an example that showcases the contents of the <code>context</code> object:</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="p">{</span>
+ <span class="c1">// The type of hook being run</span>
+ <span class="nl">hook</span><span class="p">:</span> <span class="s1">'before_plugin_install'</span><span class="p">,</span>
+
+ <span class="c1">// Absolute path to the hook script that is currently executing</span>
+ <span class="nx">scriptLocation</span><span class="p">:</span> <span class="s1">'/foo/scripts/appBeforePluginInstall.js'</span><span class="p">,</span>
+
+ <span class="c1">// The CLI command that lead to this hook being executed</span>
+ <span class="nx">cmdLine</span><span class="p">:</span> <span class="s1">'cordova plugin add plugin-withhooks'</span><span class="p">,</span>
+
+ <span class="c1">// The options associated with the current operation.</span>
+ <span class="c1">// WARNING: The contents of this object vary among the different</span>
+ <span class="c1">// operations and are currently not documented anywhere.</span>
+ <span class="nx">opts</span><span class="p">:</span> <span class="p">{</span>
+ <span class="nl">projectRoot</span><span class="p">:</span> <span class="s1">'/foo'</span><span class="p">,</span>
+
+ <span class="nx">cordova</span><span class="p">:</span> <span class="p">{</span>
+ <span class="nl">platforms</span><span class="p">:</span> <span class="p">[</span><span class="s1">'android'</span><span class="p">],</span>
+ <span class="nx">plugins</span><span class="p">:</span> <span class="p">[</span><span class="s1">'plugin-withhooks'</span><span class="p">],</span>
+ <span class="nx">version</span><span class="p">:</span> <span class="s1">'0.21.7-dev'</span>
+ <span class="p">},</span>
+
+ <span class="c1">// Information about the plugin currently operated on.</span>
+ <span class="c1">// This object will only be passed to plugin hooks scripts.</span>
+ <span class="nx">plugin</span><span class="p">:</span> <span class="p">{</span>
+ <span class="nl">id</span><span class="p">:</span> <span class="s1">'plugin-withhooks'</span><span class="p">,</span>
+ <span class="nx">pluginInfo</span><span class="p">:</span> <span class="p">{</span> <span class="cm">/* ... */</span> <span class="p">},</span>
+ <span class="nx">platform</span><span class="p">:</span> <span class="s1">'android'</span><span class="p">,</span>
+ <span class="nx">dir</span><span class="p">:</span> <span class="s1">'/foo/plugins/plugin-withhooks'</span>
+ <span class="p">}</span>
+ <span class="p">},</span>
-</span></code></pre></div>
-<p><code>context.opts.plugin</code> object will only be passed to plugin hooks scripts.</p>
+ <span class="c1">// A reference to Cordova's API</span>
+ <span class="nx">cordova</span><span class="p">:</span> <span class="p">{</span> <span class="cm">/* ... */</span> <span class="p">}</span>
+<span class="p">}</span>
+</code></pre></div>
<p>You can also require additional Cordova modules in your script using <code>context.requireCordovaModule</code> in the following way:</p>
-<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">var</span> <span class="nx">Q</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'q'</span><span class="p">);</span>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">cordovaCommon</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'cordova-common'</span><span class="p">);</span>
</code></pre></div>
-<p>You can make your scipts async using Q:</p>
-<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">context</span><span class="p">)</span> <span class="p">{</span>
- <span class="kd">var</span> <span class="nx">Q</span> <span class="o">=</span> <span class="nx">context</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'q'</span><span class="p">);</span>
- <span class="kd">var</span> <span class="nx">deferral</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Q</span><span class="p">.</span><span class="nx">defer</span><span class="p">();</span>
-
- <span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
- <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'hook.js>> end'</span><span class="p">);</span>
- <span class="nx">deferral</span><span class="p">.</span><span class="nx">resolve</span><span class="p">();</span>
- <span class="p">},</span> <span class="mi">1000</span><span class="p">);</span>
-
- <span class="k">return</span> <span class="nx">deferral</span><span class="p">.</span><span class="nx">promise</span><span class="p">;</span>
-<span class="p">}</span>
+<p>You can make your scripts asynchronous using Promises.
+Here is an example that just waits for a second and then prints the amount of milliseconds spent waiting:</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="nx">context</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="k">return</span> <span class="k">new</span> <span class="nb">Promise</span><span class="p">(</span><span class="nx">resolve</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="kd">const</span> <span class="nx">start</span> <span class="o">=</span> <span class="nb">Date</span><span class="p">.</span><span class="nx">now</span><span class="p">();</span>
+ <span class="nx">setTimeout</span><span class="p">(()</span> <span class="o">=></span> <span class="nx">resolve</span><span class="p">(</span><span class="nb">Date</span><span class="p">.</span><span class="nx">now</span><span class="p">()</span> <span class="o">-</span> <span class="nx">start</span><span class="p">),</span> <span class="mi">1000</span><span class="p">);</span>
+ <span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="nx">msWaited</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">`</span><span class="p">${</span><span class="nx">context</span><span class="p">.</span><span class="nx">scriptLocation</span><span class="p">}</span><span class="s2"> waited </span><span class="p">${</span><span class="nx">msWaited</span><span class="p">}</span><span class="s2"> ms`</span><span class="p">);</span>
+ <span class="p">});</span>
+<span class="p">};</span>
</code></pre></div>
<blockquote>
<p><strong>Note</strong>: new module loader script interface is used for the <code>.js</code> files defined via <code>config.xml</code> or <code>plugin.xml</code> only.
@@ -2847,7 +2843,7 @@ For compatibility reasons hook files spe
<h3>Non-javascript</h3>
-<p>Non-javascript scripts are run via Node child_process spawn from the project's root directory and have the root directory passes as the first argument. All other options are passed to the script using environment variables:</p>
+<p>Non-javascript scripts are run via Node child_process spawn from the project's root directory and have the root directory passed as the first argument. All other options are passed to the script using environment variables:</p>
<table><thead>
<tr>
@@ -2883,6 +2879,11 @@ For compatibility reasons hook files spe
<p><strong>Note</strong>: we highly recommend writing your hooks using Node.js so that they are cross-platform, see <a href="#link-javascript">Javascript</a> section above.</p>
</blockquote>
+<h4>Windows Quirks</h4>
+
+<p>If you are working on Windows, and your hook scripts aren't <code>*.bat</code> files, Cordova CLI will expect a shebang line as the first line of the script. This way it knows the interpreter it needs to use to launch the script. A shebang line for a Python script could look like this:</p>
+<div class="highlight"><pre><code class="language-" data-lang=""><span class="c">#!/usr/bin/env python</span>
+</code></pre></div>
<h2>Sample Usage</h2>
<p>This sample demonstrates Cordova hooks usage to trace to the console output the
@@ -2893,30 +2894,22 @@ tell Cordova to run <code>afterBuild.js<
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><hook</span> <span class="na">type=</span><span class="s">"after_build"</span> <span class="na">src=</span><span class="s">"scripts/afterBuild.js"</span> <span class="nt">/></span>
</code></pre></div>
<p>Create <code>scripts/afterBuild.js</code> file and add the following implementation.
-We use async version of <code>fs.stat</code> method to demonstrate how async functionality
-could be done via hooks.</p>
-<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span> <span class="p">{</span>
- <span class="c1">// make sure android platform is part of build</span>
- <span class="k">if</span> <span class="p">(</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">platforms</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="s1">'android'</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">return</span><span class="p">;</span>
- <span class="p">}</span>
- <span class="kd">var</span> <span class="nx">fs</span> <span class="o">=</span> <span class="nx">ctx</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'fs'</span><span class="p">),</span>
- <span class="nx">path</span> <span class="o">=</span> <span class="nx">ctx</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'path'</span><span class="p">),</span>
- <span class="nx">deferral</span> <span class="o">=</span> <span class="nx">ctx</span><span class="p">.</span><span class="nx">requireCordovaModule</span><span class="p">(</span><span class="s1">'q'</span><span class="p">).</span><span class="nx">defer</span><span class="p">();</span>
-
- <span class="kd">var</span> <span class="nx">platformRoot</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">projectRoot</span><span class="p">,</span> <span class="s1">'platforms/android'</span><span class="p">);</span>
- <span class="kd">var</span> <span class="nx">apkFileLocation</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">platformRoot</span><span class="p">,</span> <span class="s1">'build/outputs/apk/android-debug.apk'</span><span class="p">);</span>
-
- <span class="nx">fs</span><span class="p">.</span><span class="nx">stat</span><span class="p">(</span><span class="nx">apkFileLocation</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span><span class="nx">stats</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">if</span> <span class="p">(</span><span class="nx">err</span><span class="p">)</span> <span class="p">{</span>
- <span class="nx">deferral</span><span class="p">.</span><span class="nx">reject</span><span class="p">(</span><span class="s1">'Operation failed'</span><span class="p">);</span>
- <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
- <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s1">'Size of '</span> <span class="o">+</span> <span class="nx">apkFileLocation</span> <span class="o">+</span> <span class="s1">' is '</span> <span class="o">+</span> <span class="nx">stats</span><span class="p">.</span><span class="nx">size</span> <span class="o">+</span><span class="s1">' bytes'</span><span class="p">);</span>
- <span class="nx">deferral</span><span class="p">.</span><span class="nx">resolve</span><span class="p">();</span>
- <span class="p">}</span>
- <span class="p">});</span>
+We use async version of <code>fs.stat</code> method to demonstrate how async functions
+can be used in hooks.</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">fs</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'fs'</span><span class="p">);</span>
+<span class="kd">const</span> <span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'util'</span><span class="p">);</span>
+<span class="kd">const</span> <span class="nx">stat</span> <span class="o">=</span> <span class="nx">util</span><span class="p">.</span><span class="nx">promisify</span><span class="p">(</span><span class="nx">fs</span><span class="p">.</span><span class="nx">stat</span><span class="p">);</span>
+
+<span class="nx">module</span><span class="p">.</span><span class="nx">exports</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// Make sure android platform is part of build</span>
+ <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">platforms</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="s1">'android'</span><span class="p">))</span> <span class="k">return</span><span class="p">;</span>
- <span class="k">return</span> <span class="nx">deferral</span><span class="p">.</span><span class="nx">promise</span><span class="p">;</span>
+ <span class="kd">const</span> <span class="nx">platformRoot</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">ctx</span><span class="p">.</span><span class="nx">opts</span><span class="p">.</span><span class="nx">projectRoot</span><span class="p">,</span> <span class="s1">'platforms/android'</span><span class="p">);</span>
+ <span class="kd">const</span> <span class="nx">apkFileLocation</span> <span class="o">=</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">platformRoot</span><span class="p">,</span> <span class="s1">'build/outputs/apk/android-debug.apk'</span><span class="p">);</span>
+
+ <span class="k">return</span> <span class="nx">stat</span><span class="p">(</span><span class="nx">apkFileLocation</span><span class="p">).</span><span class="nx">then</span><span class="p">(</span><span class="nx">stats</span> <span class="o">=></span> <span class="p">{</span>
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="s2">`Size of </span><span class="p">${</span><span class="nx">apkFileLocation</span><span class="p">}</span><span class="s2"> is </span><span class="p">${</span><span class="nx">stats</span><span class="p">.</span><span class="nx">size</span><span class="p">}</span><span class="s2"> bytes`</span><span class="p">);</span>
+ <span class="p">});</span>
<span class="p">};</span>
</code></pre></div>
<p>Parameter <code>ctx</code> in example above is passed by Cordova and represents execution
Modified: cordova/site/public/docs/en/dev/guide/platforms/android/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/android/index.html?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/android/index.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/android/index.html Fri Mar 29 01:07:23 2019
@@ -2520,7 +2520,7 @@ the CLI, see <a href="../../../reference
<p>Cordova for Android requires the Android SDK which can be installed
on OS X, Linux or Windows. See the Android SDK's
<a href="http://developer.android.com/sdk/index.html#Requirements">System Requirements</a>.
-Cordova's latest Android package supports up to Android <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels">API Level</a> 27.
+Cordova's latest Android package supports up to Android <a href="http://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels">API Level</a> 28.
The supported Android API Levels and Android Versions for the past
few cordova-android releases can be found in this table:</p>
@@ -2532,6 +2532,11 @@ few cordova-android releases can be foun
</tr>
</thead><tbody>
<tr>
+<td>8.X.X</td>
+<td>19 - 28</td>
+<td>4.4 - 9.0.0</td>
+</tr>
+<tr>
<td>7.X.X</td>
<td>19 - 27</td>
<td>4.4 - 8.1</td>
Modified: cordova/site/public/docs/en/dev/guide/platforms/electron/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/dev/guide/platforms/electron/index.html?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/docs/en/dev/guide/platforms/electron/index.html (original)
+++ cordova/site/public/docs/en/dev/guide/platforms/electron/index.html Fri Mar 29 01:07:23 2019
@@ -2552,7 +2552,7 @@
<li><p><strong>RedHat Build Support</strong></p>
<ul>
-<li><strong>Homebrew</strong>, one of the available macOS package manager, is used for installing additional tools and dependencies. Homebrew will be needed to install RPM packaging dependencies. <a href="https://brew.sh/"><strong>Brew Install Step</strong></a></li>
+<li><strong>Homebrew</strong>, one of the available macOS package managers, is used for installing additional tools and dependencies. Homebrew will be needed to install RPM packaging dependencies. <a href="https://brew.sh/"><strong>Brew Install Step</strong></a></li>
<li><strong>RPM</strong>, a standard package manager for multiple Linux distributions, is the tool used for creating the Linux RPM package. To install this tool, use the following <a href="https://brew.sh/"><strong>Homebrew</strong></a> command:</li>
</ul>
<div class="highlight"><pre><code class="language-" data-lang="">$ brew install rpm
@@ -2564,7 +2564,7 @@
<ul>
<li><p><strong>Python</strong> version 2.7.10 or higher.</p></li>
<li><p><strong>PowerShell</strong>, for Windows 7 users, must be at version 3.0 or greater for <a href="https://www.electron.build/code-signing#windows">app signing</a>.</p></li>
-<li><p><strong>Debugging Tools</strong> for Windows of Windows SDK 10.0.15063.468, if you plan on creating a full distribution.</p></li>
+<li><p><strong><a href="https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/">Debugging Tools for Windows</a></strong> is a toolkit for enhancing debug capabilities. It is recommended to install with the <strong>Windows SDK 10.0.15063.468</strong>.</p></li>
</ul>
<h2>Quick Start</h2>
@@ -2589,7 +2589,7 @@ $ cordova build electron --debug
<p><strong>Release Builds</strong></p>
<div class="highlight"><pre><code class="language-" data-lang="">$ cordova build electron --release
</code></pre></div>
-<h2>Customizing the Application's Window Process</h2>
+<h2>Customizing Application Window</h2>
<p>Electron provides many options to manipulate the <a href="https://electronjs.org/docs/api/browser-window"><code>BrowserWindow</code></a>. This section will cover how to configure a few basic options. For a full list of options, please see the <a href="https://electronjs.org/docs/api/browser-window#new-browserwindowoptions">Electron's Docs - BrowserWindow Options</a>.</p>
@@ -2607,7 +2607,7 @@ $ cordova build electron --debug
</span><span class="s2">"browserWindow"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
-<h3>How to set the window's default size?</h3>
+<h3>How to set the default window size?</h3>
<p>By default, the <code>width</code> is set to <strong>800</strong> and the <code>height</code> set to <strong>600</strong>. This can be overridden by setting the <code>width</code> and <code>height</code> property.</p>
@@ -2656,7 +2656,7 @@ $ cordova build electron --debug
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
-<h2>Customizing the Electron's Main Process</h2>
+<h2>Customizing Main Process</h2>
<p>If it is necessary to customize the Electron's main process beyond the scope of the Electron's configuration settings, chances can be added directly to the <code>cdv-electron-main.js</code> file located in <code>{PROJECT_ROOT_DIR}/platform/electron/platform_www/</code>. This is the application's main process.</p>
@@ -3011,7 +3011,7 @@ $ cordova build electron --debug
<ul>
<li><strong>[1]</strong> If the app contains native dependency, it can only be compiled on the targeted platform.</li>
<li><strong>[2]</strong> Linux and macOS are unable to build Windows Appx packages for Windows Store.</li>
-<li><strong>[3]</strong> <a href="https://www.electron.build/multi-platform-build#macos">All required system dependencies, except rpm, will be downloaded automatically on demand. RPM can be installed with brew. (macOS Sierra 10.12+)</a></li>
+<li><strong>[3]</strong> <a href="https://www.electron.build/multi-platform-build#macos">All required system dependencies, except rpm, will be downloaded automatically on demand. RPM can be installed using brew. (macOS Sierra 10.12+)</a></li>
</ul>
<p>The example below enables multi-platform build for all OS and uses the default build configurations.</p>
Modified: cordova/site/public/feed.xml
URL: http://svn.apache.org/viewvc/cordova/site/public/feed.xml?rev=1856511&r1=1856510&r2=1856511&view=diff
==============================================================================
--- cordova/site/public/feed.xml (original)
+++ cordova/site/public/feed.xml Fri Mar 29 01:07:23 2019
@@ -6,8 +6,8 @@
</description>
<link>https://cordova.apache.org/</link>
<atom:link href="https://cordova.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Mon, 25 Mar 2019 12:19:04 +0900</pubDate>
- <lastBuildDate>Mon, 25 Mar 2019 12:19:04 +0900</lastBuildDate>
+ <pubDate>Thu, 28 Mar 2019 18:02:12 +0900</pubDate>
+ <lastBuildDate>Thu, 28 Mar 2019 18:02:12 +0900</lastBuildDate>
<generator>Jekyll v2.5.3</generator>
<item>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org