From 9710ba8624f8e474f7387d338fbe4423e1a8a572 Mon Sep 17 00:00:00 2001 From: DimitarTachev Date: Mon, 28 Oct 2019 14:48:38 +0200 Subject: [PATCH 1/3] docs: document the --aab flag in the commands help --- docs/man_pages/project/testing/build.md | 1 + docs/man_pages/project/testing/debug-android.md | 11 ++++++----- docs/man_pages/project/testing/deploy.md | 4 +++- docs/man_pages/project/testing/run-android.md | 7 ++++--- docs/man_pages/project/testing/run.md | 1 + docs/man_pages/project/testing/test-android.md | 5 +++-- 6 files changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/man_pages/project/testing/build.md b/docs/man_pages/project/testing/build.md index eada1e13b0..10f22335e9 100644 --- a/docs/man_pages/project/testing/build.md +++ b/docs/man_pages/project/testing/build.md @@ -39,6 +39,7 @@ Usage | Synopsis * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). +* `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. <% if(isHtml) { %> diff --git a/docs/man_pages/project/testing/debug-android.md b/docs/man_pages/project/testing/debug-android.md index 5aeae09a3d..0f0556f525 100644 --- a/docs/man_pages/project/testing/debug-android.md +++ b/docs/man_pages/project/testing/debug-android.md @@ -13,11 +13,11 @@ Initiates a debugging session for your project on a connected Android device or Usage | Synopsis ---|--- -Deploy on device/emulator, run the app and generate a Chrome DevTools link for debugging | `$ tns debug android` -Deploy on device/emulator, run the app and stop at the first code statement | `$ tns debug android --debug-brk [--device ] [--timeout ]` -Deploy in the native emulator, run the app and stop at the first code statement | `$ tns debug android --debug-brk --emulator [--timeout ]` -Attach the debug tools to a running app on device/emulator | `$ tns debug android --start [--device ] [--timeout ]` -Attach the debug tools to a running app in the native emulator | `$ tns debug android --start --emulator [--timeout ]` +Deploy on device/emulator, run the app and generate a Chrome DevTools link for debugging | `$ tns debug android [--device ] [--timeout ] [--aab]` +Deploy on device/emulator, run the app and stop at the first code statement | `$ tns debug android --debug-brk [--device ] [--timeout ] [--aab]` +Deploy in the native emulator, run the app and stop at the first code statement | `$ tns debug android --debug-brk --emulator [--timeout ] [--aab]` +Attach the debug tools to a running app on device/emulator | `$ tns debug android --start [--device ] [--timeout ] [--aab]` +Attach the debug tools to a running app in the native emulator | `$ tns debug android --start --emulator [--timeout ] [--aab]` ### Options @@ -29,6 +29,7 @@ Attach the debug tools to a running app in the native emulator | `$ tns debug an * `--no-watch` - If set, changes in your code will not be reflected during the execution of this command. * `--clean` - If set, forces the complete rebuild of the native application. * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. +* `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. <% if(isHtml) { %> diff --git a/docs/man_pages/project/testing/deploy.md b/docs/man_pages/project/testing/deploy.md index 127727e56e..eaedafb537 100644 --- a/docs/man_pages/project/testing/deploy.md +++ b/docs/man_pages/project/testing/deploy.md @@ -16,7 +16,7 @@ Prepares, builds and deploys the project to a connected device or native emulato Usage | Synopsis ---|--- -Deploy on Android | `$ tns deploy android [--device ] [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release]` +Deploy on Android | `$ tns deploy android [--device ] [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--aab]` <% if(isMacOS) { %>Deploy on iOS | `$ tns deploy ios [--device ] [--release]`<% } %> ### Options for iOS @@ -33,6 +33,8 @@ Deploy on Android | `$ tns deploy android [--device ] [--key-store-pa * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias-password` - Provides the password for the alias specified with `--key-store-alias-password`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. +* `--aab` - Specifies that the command will produce and deploy an Android App Bundle. +* `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. <% if(isHtml) { %> diff --git a/docs/man_pages/project/testing/run-android.md b/docs/man_pages/project/testing/run-android.md index 7572159672..0d250c995f 100644 --- a/docs/man_pages/project/testing/run-android.md +++ b/docs/man_pages/project/testing/run-android.md @@ -17,9 +17,9 @@ When running this command without passing `--release` flag, the HMR (Hot Module Usage | Synopsis ---|--- -Run on all connected devices and running emulators | `$ tns run android [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--justlaunch] [--env.*]]` -Run on a selected connected device or running emulator. Will start emulator with specified `Device Identifier`, if not already running. | `$ tns run android --device [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--justlaunch] [--env.*]]` -Start a default emulator if none are running, or run application on all connected emulators. | `$ tns run android --emulator [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--justlaunch] [--env.*]]` +Run on all connected devices and running emulators | `$ tns run android [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--justlaunch] [--env.*]] [--aab]` +Run on a selected connected device or running emulator. Will start emulator with specified `Device Identifier`, if not already running. | `$ tns run android --device [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--justlaunch] [--env.*]] [--aab]` +Start a default emulator if none are running, or run application on all connected emulators. | `$ tns run android --emulator [--key-store-path --key-store-password --key-store-alias --key-store-alias-password ] [--release] [--justlaunch] [--env.*]] [--aab]` ### Options @@ -41,6 +41,7 @@ Start a default emulator if none are running, or run application on all connecte * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). +* `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. <% if(isHtml) { %> diff --git a/docs/man_pages/project/testing/run.md b/docs/man_pages/project/testing/run.md index 87e87ea5eb..559a2fd0ae 100644 --- a/docs/man_pages/project/testing/run.md +++ b/docs/man_pages/project/testing/run.md @@ -52,6 +52,7 @@ Run on a selected connected device or running emulator. Will start emulator with * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). +* `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/test-android.md b/docs/man_pages/project/testing/test-android.md index 2c5e984959..ace428cc3c 100644 --- a/docs/man_pages/project/testing/test-android.md +++ b/docs/man_pages/project/testing/test-android.md @@ -13,14 +13,15 @@ Runs the tests in your project on connected Android devices and Android emulator Usage | Synopsis ------|------- -Run tests on all connected devices | `$ tns test android [--watch] [--debug-brk]` -Run tests on a selected device | `$ tns test android --device [--watch] [--debug-brk]` +Run tests on all connected devices | `$ tns test android [--watch] [--debug-brk] [--aab]` +Run tests on a selected device | `$ tns test android --device [--watch] [--debug-brk] [--aab]` ### Options * `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and tests are re-run. * `--device` - Specifies the serial number or the index of the connected device on which to run the tests. To list all connected devices, grouped by platform, run `$ tns device`. `` is the device index or identifier as listed by the `$ tns device` command. * `--debug-brk` - Runs the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints. +* `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. <% if(isHtml) { %> From 38402df75e3399512831ddf67df3ac8802c049b9 Mon Sep 17 00:00:00 2001 From: DimitarTachev Date: Mon, 28 Oct 2019 16:36:41 +0200 Subject: [PATCH 2/3] docs: document --env.compileSnapshot --- docs/man_pages/project/testing/build-android.md | 5 +++-- docs/man_pages/project/testing/build-ios.md | 3 +-- docs/man_pages/project/testing/build.md | 5 +++-- docs/man_pages/project/testing/debug-android.md | 8 ++++++++ docs/man_pages/project/testing/deploy.md | 8 ++++++++ docs/man_pages/project/testing/run-android.md | 5 +++-- docs/man_pages/project/testing/run-ios.md | 3 +-- docs/man_pages/project/testing/run.md | 5 +++-- docs/man_pages/project/testing/test-android.md | 8 ++++++++ 9 files changed, 38 insertions(+), 12 deletions(-) diff --git a/docs/man_pages/project/testing/build-android.md b/docs/man_pages/project/testing/build-android.md index ad054ea51f..83ab1e695f 100644 --- a/docs/man_pages/project/testing/build-android.md +++ b/docs/man_pages/project/testing/build-android.md @@ -27,10 +27,11 @@ General | `$ tns build android [--compileSdk ] [--key-store-path ] [- * `--provision` - If used without parameter, lists all eligible provisioning profiles. If used with UUID or name of your provisioning profile, it will switch to manual signing mode and configure the .xcodeproj file of your app. In this case xcconfig should not contain any provisioning/team id flags. This provisioning profile will be further used for codesigning the app. * `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). - * `--env.snapshot`- creates [Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) (only for release builds on Mac OS & for Android). * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. - * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). + * `--env.sourceMap` - creates inline source maps. * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/build.md b/docs/man_pages/project/testing/build.md index 10f22335e9..f7f9782d8d 100644 --- a/docs/man_pages/project/testing/build.md +++ b/docs/man_pages/project/testing/build.md @@ -34,10 +34,11 @@ Usage | Synopsis * `--hmr` - Enables the hot module replacement (HMR) feature. * `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). - * `--env.snapshot`- creates [Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) (only for release builds on Mac OS & for Android). + * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. - * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). + * `--env.sourceMap` - creates inline source maps. * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/debug-android.md b/docs/man_pages/project/testing/debug-android.md index 0f0556f525..bcf2001c8b 100644 --- a/docs/man_pages/project/testing/debug-android.md +++ b/docs/man_pages/project/testing/debug-android.md @@ -29,6 +29,14 @@ Attach the debug tools to a running app in the native emulator | `$ tns debug an * `--no-watch` - If set, changes in your code will not be reflected during the execution of this command. * `--clean` - If set, forces the complete rebuild of the native application. * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. +* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: + * `--env.aot` - creates Ahead-Of-Time build (Angular only). + * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.uglify` - provides basic obfuscation and smaller app size. + * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. + * `--env.sourceMap` - creates inline source maps. + * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/deploy.md b/docs/man_pages/project/testing/deploy.md index eaedafb537..3f90cc3f86 100644 --- a/docs/man_pages/project/testing/deploy.md +++ b/docs/man_pages/project/testing/deploy.md @@ -33,6 +33,14 @@ Deploy on Android | `$ tns deploy android [--device ] [--key-store-pa * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias-password` - Provides the password for the alias specified with `--key-store-alias-password`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. +* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: + * `--env.aot` - creates Ahead-Of-Time build (Angular only). + * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.uglify` - provides basic obfuscation and smaller app size. + * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. + * `--env.sourceMap` - creates inline source maps. + * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/run-android.md b/docs/man_pages/project/testing/run-android.md index 0d250c995f..590cea7e60 100644 --- a/docs/man_pages/project/testing/run-android.md +++ b/docs/man_pages/project/testing/run-android.md @@ -36,10 +36,11 @@ Start a default emulator if none are running, or run application on all connecte * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. * `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. * `--env.aot` - creates Ahead-Of-Time build (Angular only). - * `--env.snapshot`- creates [Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) (only for release builds on Mac OS & for Android). + * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. - * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). + * `--env.sourceMap` - creates inline source maps. * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/run-ios.md b/docs/man_pages/project/testing/run-ios.md index 343c0e7395..505f2c0b2f 100644 --- a/docs/man_pages/project/testing/run-ios.md +++ b/docs/man_pages/project/testing/run-ios.md @@ -39,10 +39,9 @@ Start an emulator with specified device identifier and sdk | `$ tns run ios [--d * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. * `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. * `--env.aot` - creates Ahead-Of-Time build (Angular only). - * `--env.snapshot`- creates [Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) (only for release builds on Mac OS & for Android). * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. - * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). + * `--env.sourceMap` - creates inline source maps. * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/run.md b/docs/man_pages/project/testing/run.md index 559a2fd0ae..d4f3e79511 100644 --- a/docs/man_pages/project/testing/run.md +++ b/docs/man_pages/project/testing/run.md @@ -47,10 +47,11 @@ Run on a selected connected device or running emulator. Will start emulator with * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. * `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). - * `--env.snapshot`- creates [Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) (only for release builds on Mac OS & for Android). + * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. - * `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app). + * `--env.sourceMap` - creates inline source maps. * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. diff --git a/docs/man_pages/project/testing/test-android.md b/docs/man_pages/project/testing/test-android.md index ace428cc3c..055a83d4b1 100644 --- a/docs/man_pages/project/testing/test-android.md +++ b/docs/man_pages/project/testing/test-android.md @@ -21,6 +21,14 @@ Run tests on a selected device | `$ tns test android --device [--wat * `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and tests are re-run. * `--device` - Specifies the serial number or the index of the connected device on which to run the tests. To list all connected devices, grouped by platform, run `$ tns device`. `` is the device index or identifier as listed by the `$ tns device` command. * `--debug-brk` - Runs the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints. +* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: + * `--env.aot` - creates Ahead-Of-Time build (Angular only). + * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.uglify` - provides basic obfuscation and smaller app size. + * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. + * `--env.sourceMap` - creates inline source maps. + * `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release). * `--aab` - Specifies that the command will produce and deploy an Android App Bundle. * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `tns migrate`. From 8af706cd53e369560f2a90daa3024e273df5fd4a Mon Sep 17 00:00:00 2001 From: DimitarTachev Date: Tue, 29 Oct 2019 09:21:01 +0200 Subject: [PATCH 3/3] docs: fix PR comments --- docs/man_pages/project/testing/build-android.md | 4 ++-- docs/man_pages/project/testing/build-ios.md | 2 +- docs/man_pages/project/testing/build.md | 4 ++-- docs/man_pages/project/testing/debug-android.md | 4 ++-- docs/man_pages/project/testing/deploy.md | 4 ++-- docs/man_pages/project/testing/run-android.md | 4 ++-- docs/man_pages/project/testing/run-ios.md | 2 +- docs/man_pages/project/testing/run.md | 4 ++-- docs/man_pages/project/testing/test-android.md | 5 +---- 9 files changed, 15 insertions(+), 18 deletions(-) diff --git a/docs/man_pages/project/testing/build-android.md b/docs/man_pages/project/testing/build-android.md index 83ab1e695f..5b9660298f 100644 --- a/docs/man_pages/project/testing/build-android.md +++ b/docs/man_pages/project/testing/build-android.md @@ -25,10 +25,10 @@ General | `$ tns build android [--compileSdk ] [--key-store-path ] [- * `--copy-to` - Specifies the file path where the built `.ipa` will be copied. If it points to a non-existent directory path, it will be created. If the specified value is existing directory, the original file name will be used. * `--team-id` - If used without parameter, lists all team names and ids. If used with team name or id, it will switch to automatic signing mode and configure the .xcodeproj file of your app. In this case .xcconfig should not contain any provisioning/team id flags. This team id will be further used for codesigning the app. For Xcode 9.0+, xcodebuild will be allowed to update and modify automatically managed provisioning profiles. * `--provision` - If used without parameter, lists all eligible provisioning profiles. If used with UUID or name of your provisioning profile, it will switch to manual signing mode and configure the .xcodeproj file of your app. In this case xcconfig should not contain any provisioning/team id flags. This provisioning profile will be further used for codesigning the app. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. diff --git a/docs/man_pages/project/testing/build.md b/docs/man_pages/project/testing/build.md index f7f9782d8d..c383453994 100644 --- a/docs/man_pages/project/testing/build.md +++ b/docs/man_pages/project/testing/build.md @@ -32,10 +32,10 @@ Usage | Synopsis * `--release` -If set, produces a release build by running webpack in production mode and native build in release mode. Otherwise, produces a debug build. * `--device` - Specifies a connected device/emulator to start and run the app. `` is the index or `Device Identifier` of the target device as listed by the `$ tns device --available-devices` command. * `--hmr` - Enables the hot module replacement (HMR) feature. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). - * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. This will reduce the app size when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps. diff --git a/docs/man_pages/project/testing/debug-android.md b/docs/man_pages/project/testing/debug-android.md index bcf2001c8b..74e87a451b 100644 --- a/docs/man_pages/project/testing/debug-android.md +++ b/docs/man_pages/project/testing/debug-android.md @@ -29,10 +29,10 @@ Attach the debug tools to a running app in the native emulator | `$ tns debug an * `--no-watch` - If set, changes in your code will not be reflected during the execution of this command. * `--clean` - If set, forces the complete rebuild of the native application. * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). - * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. This will reduce the app size when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps. diff --git a/docs/man_pages/project/testing/deploy.md b/docs/man_pages/project/testing/deploy.md index 3f90cc3f86..477dc89e56 100644 --- a/docs/man_pages/project/testing/deploy.md +++ b/docs/man_pages/project/testing/deploy.md @@ -33,10 +33,10 @@ Deploy on Android | `$ tns deploy android [--device ] [--key-store-pa * `--key-store-password` - Provides the password for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias-password` - Provides the password for the alias specified with `--key-store-alias-password`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). - * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. This will reduce the app size when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps. diff --git a/docs/man_pages/project/testing/run-android.md b/docs/man_pages/project/testing/run-android.md index 590cea7e60..d2fcf975f2 100644 --- a/docs/man_pages/project/testing/run-android.md +++ b/docs/man_pages/project/testing/run-android.md @@ -34,10 +34,10 @@ Start a default emulator if none are running, or run application on all connecte * `--key-store-alias` - Provides the alias for the keystore file specified with `--key-store-path`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--key-store-alias-password` - Provides the password for the alias specified with `--key-store-alias-password`. You can use the `--key-store-*` options along with `--release` to produce a signed release build. You need to specify all `--key-store-*` options. * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). - * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. This will reduce the app size when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps. diff --git a/docs/man_pages/project/testing/run-ios.md b/docs/man_pages/project/testing/run-ios.md index 505f2c0b2f..b1ac6bc916 100644 --- a/docs/man_pages/project/testing/run-ios.md +++ b/docs/man_pages/project/testing/run-ios.md @@ -37,7 +37,7 @@ Start an emulator with specified device identifier and sdk | `$ tns run ios [--d * `--no-watch` - If set, changes in your code will not be reflected during the execution of this command. * `--release` - If set, produces a release build by running webpack in production mode and native build in release mode. Otherwise, produces a debug build. * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. diff --git a/docs/man_pages/project/testing/run.md b/docs/man_pages/project/testing/run.md index d4f3e79511..cc3b5ee173 100644 --- a/docs/man_pages/project/testing/run.md +++ b/docs/man_pages/project/testing/run.md @@ -45,10 +45,10 @@ Run on a selected connected device or running emulator. Will start emulator with * `--release` - If set, produces a release build by running webpack in production mode and native build in release mode. Otherwise, produces a debug build. * `--device` - Specifies a connected device/emulator to start and run the app. `` is the index or `Device Identifier` of the target device as listed by the `$ tns device --available-devices` command. * `--no-hmr` - Disables Hot Module Replacement (HMR). In this case, when a change in the code is applied, CLI will transfer the modified files and restart the application. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. Supported additional flags: * `--env.aot` - creates Ahead-Of-Time build (Angular only). * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). - * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. + * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. This will reduce the app size when using the `--aab` option. * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps. diff --git a/docs/man_pages/project/testing/test-android.md b/docs/man_pages/project/testing/test-android.md index 055a83d4b1..482676f942 100644 --- a/docs/man_pages/project/testing/test-android.md +++ b/docs/man_pages/project/testing/test-android.md @@ -21,10 +21,7 @@ Run tests on a selected device | `$ tns test android --device [--wat * `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and tests are re-run. * `--device` - Specifies the serial number or the index of the connected device on which to run the tests. To list all connected devices, grouped by platform, run `$ tns device`. `` is the device index or identifier as listed by the `$ tns device` command. * `--debug-brk` - Runs the tests under the debugger. The debugger will break just before your tests are executed, so you have a chance to place breakpoints. -* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags: - * `--env.aot` - creates Ahead-Of-Time build (Angular only). - * `--env.snapshot`- creates [a V8 Snapshot](https://docs.nativescript.org/performance-optimizations/bundling-with-webpack#v8-heap-snapshot) decreasing the app start time (only for release builds for Android). - * `--env.compileSnapshot`- compiles the static assets produced by `--env.snapshot` into `.so` files allowing the native build to split them per architecture. In this way, the app size will be reduced when using the `--aab` option. +* `--env.*` - Specifies additional flags that the bundler may process. Can be passed multiple times. Supported additional flags: * `--env.uglify` - provides basic obfuscation and smaller app size. * `--env.report` - creates a Webpack report inside a `report` folder in the root folder. * `--env.sourceMap` - creates inline source maps.