Skip to content

Commit 38402df

Browse files
committed
docs: document --env.compileSnapshot
1 parent 9710ba8 commit 38402df

File tree

9 files changed

+38
-12
lines changed

9 files changed

+38
-12
lines changed

docs/man_pages/project/testing/build-android.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ General | `$ tns build android [--compileSdk <API Level>] [--key-store-path <Fil
2727
* `--copy-to` - Specifies the file path where the built `.apk` 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.
2828
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
2929
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
30-
* `--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).
30+
* `--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).
31+
* `--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.
3132
* `--env.uglify` - provides basic obfuscation and smaller app size.
3233
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
33-
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
34+
* `--env.sourceMap` - creates inline source maps.
3435
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
3536
* `--aab` - Specifies that the build will produce an Android App Bundle(`.aab`) file.
3637
* `--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`.

docs/man_pages/project/testing/build-ios.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,9 @@ General | `$ tns build ios [--for-device] [--release] [--copy-to <File Path>] [-
2929
* `--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.
3030
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
3131
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
32-
* `--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).
3332
* `--env.uglify` - provides basic obfuscation and smaller app size.
3433
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
35-
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
34+
* `--env.sourceMap` - creates inline source maps.
3635
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
3736
* `--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`.
3837

docs/man_pages/project/testing/build.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ Usage | Synopsis
3434
* `--hmr` - Enables the hot module replacement (HMR) feature.
3535
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
3636
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
37-
* `--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).
37+
* `--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).
38+
* `--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.
3839
* `--env.uglify` - provides basic obfuscation and smaller app size.
3940
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
40-
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
41+
* `--env.sourceMap` - creates inline source maps.
4142
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
4243
* `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
4344
* `--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`.

docs/man_pages/project/testing/debug-android.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ Attach the debug tools to a running app in the native emulator | `$ tns debug an
2929
* `--no-watch` - If set, changes in your code will not be reflected during the execution of this command.
3030
* `--clean` - If set, forces the complete rebuild of the native application.
3131
* `--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.
32+
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
33+
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
34+
* `--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).
35+
* `--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.
36+
* `--env.uglify` - provides basic obfuscation and smaller app size.
37+
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
38+
* `--env.sourceMap` - creates inline source maps.
39+
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
3240
* `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
3341
* `--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`.
3442

docs/man_pages/project/testing/deploy.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ Deploy on Android | `$ tns deploy android [--device <Device ID>] [--key-store-pa
3333
* `--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.
3434
* `--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.
3535
* `--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.
36+
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
37+
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
38+
* `--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).
39+
* `--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.
40+
* `--env.uglify` - provides basic obfuscation and smaller app size.
41+
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
42+
* `--env.sourceMap` - creates inline source maps.
43+
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
3644
* `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
3745
* `--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`.
3846

docs/man_pages/project/testing/run-android.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,11 @@ Start a default emulator if none are running, or run application on all connecte
3636
* `--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.
3737
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times.
3838
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
39-
* `--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).
39+
* `--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).
40+
* `--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.
4041
* `--env.uglify` - provides basic obfuscation and smaller app size.
4142
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
42-
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
43+
* `--env.sourceMap` - creates inline source maps.
4344
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
4445
* `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
4546
* `--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`.

docs/man_pages/project/testing/run-ios.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,9 @@ Start an emulator with specified device identifier and sdk | `$ tns run ios [--d
3939
* `--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.
4040
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times.
4141
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
42-
* `--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).
4342
* `--env.uglify` - provides basic obfuscation and smaller app size.
4443
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
45-
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
44+
* `--env.sourceMap` - creates inline source maps.
4645
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
4746
* `--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`.
4847

docs/man_pages/project/testing/run.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,11 @@ Run on a selected connected device or running emulator. Will start emulator with
4747
* `--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.
4848
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
4949
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
50-
* `--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).
50+
* `--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).
51+
* `--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.
5152
* `--env.uglify` - provides basic obfuscation and smaller app size.
5253
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
53-
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
54+
* `--env.sourceMap` - creates inline source maps.
5455
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
5556
* `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
5657
* `--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`.

docs/man_pages/project/testing/test-android.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ Run tests on a selected device | `$ tns test android --device <Device ID> [--wat
2121
* `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device and tests are re-run.
2222
* `--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`. `<Device ID>` is the device index or identifier as listed by the `$ tns device` command.
2323
* `--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.
24+
* `--env.*` - Specifies additional flags that the bundler may process. May be passed multiple times. Supported additional flags:
25+
* `--env.aot` - creates Ahead-Of-Time build (Angular only).
26+
* `--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).
27+
* `--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.
28+
* `--env.uglify` - provides basic obfuscation and smaller app size.
29+
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
30+
* `--env.sourceMap` - creates inline source maps.
31+
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
2432
* `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
2533
* `--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`.
2634

0 commit comments

Comments
 (0)