Skip to content

Commit 04584cd

Browse files
committed
docs: describe how different changes are synced
1 parent deffafc commit 04584cd

File tree

3 files changed

+41
-1
lines changed

3 files changed

+41
-1
lines changed

docs/man_pages/project/testing/debug.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,24 @@ position: 6
99

1010
Initiates a debugging session for your project on a connected device or native emulator. <% if(isMacOS) { %>You must specify the target platform on which you want to debug.<% } %> When necessary, the command will prepare, build, deploy and launch the app before starting the debug session. While debugging, the output from the application is printed in the console and any changes made to your code are synchronized on all connected devices or running emulators.
1111

12+
<% if(isHtml) { %>
13+
#### How file changes are handled
14+
With HMR (Hot Module Replacement):
15+
* Changes in `.js`, `.ts`, `.less`, `.sass` and other file types that are accepted will cause a refresh of the application.
16+
* Changes in `App_Resources` will cause a rebuild of the application.
17+
* Changes in `node_modules/somePlugin` if accepted will cause a refresh of the application.
18+
* Changes in `node_modules/somePlugin/platforms` will cause a rebuild of the application.
19+
* Changes that are not accepted and HMR fails will cause a restart of the native application.
20+
21+
With **no** HMR:
22+
* Changes in `.js`, `.ts`, `.less`, `.sass` and other file types will cause a restart of the native application.
23+
* Changes in `App_Resources` will cause a rebuild of the application.
24+
* Changes in `node_modules/somePlugin` will cause a restart of the native application.
25+
* Changes in `node_modules/somePlugin/platforms` will cause a rebuild of the application.
26+
27+
When running this command with `--debug-brk` any file change will cause a restart of the native application. Changes in `App_Resources` and `node_modules/somePlugin/platforms` will cause a rebuild of the application.
28+
<% } %>
29+
1230
### Commands
1331

1432
Usage | Synopsis

docs/man_pages/project/testing/run.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ Runs your project on all connected devices or in native emulators for the select
1111

1212
<% if(isHtml) { %>
1313
When running this command without passing `--release` flag, the HMR (Hot Module Replacement) is enabled by default. In case you want to disable HMR, you can pass `--no-hmr` flag. When `--release` is passed, CLI disables HMR.
14+
15+
#### How file changes are handled
16+
With HMR (Hot Module Replacement):
17+
* Changes in `.js`, `.ts`, `.less`, `.sass` and other file types that are accepted will cause a refresh of the application.
18+
* Changes in `App_Resources` will cause a rebuild of the application.
19+
* Changes in `node_modules/somePlugin` if accepted will cause a refresh of the application.
20+
* Changes in `node_modules/somePlugin/platforms` will cause a rebuild of the application.
21+
* Changes that are not accepted and HMR fails will cause a restart of the native application.
22+
23+
With **no** HMR:
24+
* Changes in `.js`, `.ts`, `.less`, `.sass` and other file types will cause a restart of the native application.
25+
* Changes in `App_Resources` will cause a rebuild of the application.
26+
* Changes in `node_modules/somePlugin` will cause a restart of the native application.
27+
* Changes in `node_modules/somePlugin/platforms` will cause a rebuild of the application.
1428
<% } %>
1529

1630
### Commands
@@ -19,7 +33,7 @@ Usage | Synopsis
1933
---|---
2034
Run on all connected devices | `$ tns run [--release] [--justlaunch]`
2135
Run on a selected connected device or running emulator. Will start emulator with specified `Device Identifier`, if not already running. | `$ tns run --device <Device ID> [--release] [--justlaunch]`
22-
<% if((isConsole && isMacOS) || isHtml) { %>Run on all connected devices of the speficied `Platform` | `$ tns run <Platform> [--release] [--justlaunch]`<% } %>
36+
<% if((isConsole && isMacOS) || isHtml) { %>Run on all connected devices of the specified `Platform` | `$ tns run <Platform> [--release] [--justlaunch]`<% } %>
2337

2438
### Options
2539

docs/man_pages/project/testing/test.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ position: 23
99

1010
Runs unit tests on the selected mobile platform.<% if(isConsole) { %> Your project must already be configured for unit testing by running `$ tns test init`.<% } %>
1111

12+
<% if(isHtml) { %>
13+
#### How file changes are handled
14+
* Changes in `.js`, `.ts`, `.less`, `.sass` and other file types will cause a restart of the native application.
15+
* Changes in `App_Resources` will cause a rebuild of the application.
16+
* Changes in `node_modules/somePlugin` will cause a restart of the native application.
17+
* Changes in `node_modules/somePlugin/platforms` will cause a rebuild of the application.
18+
<% } %>
19+
1220
### Commands
1321

1422
Usage | Synopsis

0 commit comments

Comments
 (0)