Skip to content

Commit 649c579

Browse files
committed
docs: describe the --force flag in the docs
1 parent 94a4344 commit 649c579

File tree

12 files changed

+12
-0
lines changed

12 files changed

+12
-0
lines changed

docs/man_pages/project/configuration/prepare.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Usage | Synopsis
3030
### Options
3131

3232
* `--hmr` - Enables the hot module replacement (HMR) feature.
33+
* `--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`.
3334

3435
<% if(isHtml) { %>
3536

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ General | `$ tns build android [--compileSdk <API Level>] [--key-store-path <Fil
3333
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
3434
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
3535
* `--aab` - Specifies that the build will produce an Android App Bundle(`.aab`) file.
36+
* `--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`.
3637

3738
<% if(isHtml) { %>
3839

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ General | `$ tns build ios [--for-device] [--release] [--copy-to <File Path>] [-
3434
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
3535
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
3636
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
37+
* `--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`.
3738

3839
<% } %>
3940

docs/man_pages/project/testing/build.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Usage | Synopsis
3939
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
4040
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
4141
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
42+
* `--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`.
4243

4344
<% if(isHtml) { %>
4445

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ 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+
* `--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`.
3233

3334
<% if(isHtml) { %>
3435

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Attach the debug tools to a running app in the iOS simulator | `$ tns debug ios
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
* `--chrome` - Deprecated - default behavior uses '--chrome' implicitly. Allows debugging in Chrome Developer Tools. If set, Safari Web Inspector is not started and debugging is attached to Chrome Developer Tools.
3838
* `--inspector` - If set, the developer tools in the Safari Web Inspector are used for debugging the application.
39+
* `--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`.
3940

4041
<% } %>
4142
<% if(isHtml) { %>

docs/man_pages/project/testing/preview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Generates a QR code that can be scanned by the NativeScript PlayGround app | `tn
2424
### Options
2525

2626
* `--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.
27+
* `--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`.
2728

2829
<% if(isHtml) { %>
2930

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Start a default emulator if none are running, or run application on all connecte
4141
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
4242
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
4343
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
44+
* `--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`.
4445

4546
<% if(isHtml) { %>
4647

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Start an emulator with specified device identifier and sdk | `$ tns run ios [--d
4444
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
4545
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
4646
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
47+
* `--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`.
4748

4849
<% } %>
4950
<% if(isHtml) { %>

docs/man_pages/project/testing/run.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Run on a selected connected device or running emulator. Will start emulator with
5252
* `--env.report` - creates a Webpack report inside a `report` folder in the root folder.
5353
* `--env.sourceMap` - creates inline source maps (useful for debbuging bundled app).
5454
* `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
55+
* `--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`.
5556

5657

5758
<% if((isConsole && isMacOS) || isHtml) { %>### Arguments

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ 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+
* `--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`.
2425

2526
<% if(isHtml) { %>
2627

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Run tests in the iOS Simulator | `$ tns test ios --emulator [--watch] [--debug-b
2727
* `--device` - Specifies the serial number or the index of the connected device on which you want to run tests. To list all connected devices, grouped by platform, run `$ tns device`. You cannot set `--device` and `--emulator` simultaneously. `<Device ID>` is the device index or identifier as listed by the `$ tns device` command.
2828
* `--emulator` - Runs tests on the iOS Simulator. You cannot set `--device` and `--emulator` simultaneously.
2929
* `--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.
30+
* `--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`.
3031

3132
<% } %>
3233

0 commit comments

Comments
 (0)