10000 chore: update dev workflow (#7819) · NativeScript/NativeScript@0b3ceb0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 0b3ceb0

Browse files
authored
chore: update dev workflow (#7819)
1 parent 3cabdde commit 0b3ceb0

File tree

1 file changed

+25
-54
lines changed

1 file changed

+25
-54
lines changed

DevelopmentWorkflow.md

Lines changed: 25 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@ Development Workflow
44
## Project Structure
55

66
The repository contains several packages and apps:
7-
- `tns-core-modules` - The core NativeScript TypeScript modules used to develop NativeScript apps.
8-
- `apps` - UI app used for manual testing and automation.
9-
- `e2e` - applications and *e2e* tests.
10-
- `tests` - Unit tests app for the `tns-core-modules`.
11-
- `tns-platform-declarations` - TypeScript definitions for Android and iOS native APIs.
7+
- `tns-core-modules` - The core NativeScript TypeScript modules used to develop NativeScript apps
8+
- `tns-core-modules-widgets` - The native widgets (Java and Objective-C) used by the core NativeScript modules
9+
- `e2e/ui-tests-app` - UI app used for manual testing and automation
10+
- `e2e` - applications and *e2e* tests
11+
- `tests` - Unit tests app for the `tns-core-modules`
12+
- `tns-platform-declarations` - TypeScript definitions for Android and iOS native APIs
1213

1314
Working with the repo is organized with npm scripts,
1415
go and read through the `scripts` section in the [package.json](./package.json).
1516

1617
Managing dependencies:
1718
- `tns-core-modules` depends on:
1819
- `tns-platform-declarations`
19-
- `apps` depends on:
20+
- `e2e/ui-tests-app` depends on:
2021
- `tns-platform-declarations`
2122
- `tns-core-modules`
2223
- `e2e` depends on:
@@ -26,71 +27,44 @@ Managing dependencies:
2627
- `tns-core-modules`
2728

2829
> NOTE: `tns-core-modules` depends on `tns-core-modules-widgets`,
29-
this dependency contains native code and is rarely modified so for now it remains outside this repo.
3030
3131
## Initial Setup
3232

3333
Clone (or fork/clone) the repo:
3434

35-
```bash
35+
``` bash
3636
git clone https://github.com/NativeScript/NativeScript.git
3737
```
3838

39-
Install devDependencies:
39+
Install dependencies:
4040

41-
```bash
41+
``` bash
4242
npm install
4343
```
4444

45-
<!---
46-
## TypeScript
47-
48-
The following commands are commonly used to compile the `tns-core-modules`:
49-
```bash
50-
# Full tsc with type checking ~22.2s.
51-
tsc
52-
53-
# Fast tsc ~11.2s.
54-
tsc --skipLibCheck
55-
56-
# Fast watcher, ~4s. on save
57-
tsc --skipLibCheck -w
58-
```
59-
60-
NOTE: transpile `tns-core-modules` only.
61-
62-
The modules have `typescript` as a devDependency so you should also be able to use the locally installed TypeScript compiler from node_modules:
63-
64-
```bash
65-
./node_modules/.bin/tsc
66-
```
67-
68-
You can compile the TypeScript files in the `tns-core-modules` and `tns-platform-declarations` at once at the root of the repo:
69-
70-
```bash
71-
npm run tsc
72-
```
73-
--->
74-
7545
## Running Unit Tests
7646

77-
```
78-
cd ./tests
79-
tns run android| ios
47+
``` bash
48+
cd tests
49+
tns run android | ios
8050
```
8151

82-
## Running the Test App
52+
## Running the UI Test App
8353

84-
The test app is an ordinary NativeScript app that logs the test results as it go.
54+
The UI test app is an ordinary NativeScript app that logs the test results on the go.
8555
After the [initial setup](#initial-setup) you can run the tests with:
8656

87-
```
88-
# Make sure TypeScript is transpiled
89-
tsc
57+
``` bash
58+
cd e2e/ui-tests-app
59+
60+
# Run the Android app
61+
tns platform add android@next # NOTE: do not commit this change to package.json
62+
tns run android
63+
64+
# Run the iOS app
65+
tns platform add ios@next # NOTE: do not commit this change to package.json
66+
tns run ios
9067

91-
# Run the app
92-
tns run ios --path apps
93-
tns run android --path apps
9468
```
9569

9670
## Running Another App
@@ -107,9 +81,6 @@ tns run ios
10781
tns run android
10882
```
10983

110-
> Note: You still have to rebuild the TypeScript if you have made changes in the code of the core-modules.
111-
112-
11384
## Platform declarations
11485
To update the platform declarations (the ios.d.ts-es) you can run:
11586

0 commit comments

Comments
 (0)
0