Skip to content

Commit cc97a16

Browse files
author
Alexander Vakrilov
authored
feat: Scoped Packages (#7911)
* chore: move tns-core-modules to nativescript-core * chore: preparing compat generate script * chore: add missing definitions * chore: no need for http-request to be private * chore: packages chore * test: generate tests for tns-core-modules * chore: add anroid module for consistency * chore: add .npmignore * chore: added privateModulesWhitelist * chore(webpack): added bundle-entry-points * chore: scripts * chore: tests changed to use @ns/core * test: add scoped-packages test project * test: fix types * test: update test project * chore: build scripts * chore: update build script * chore: npm scripts cleanup * chore: make the compat pgk work with old wp config * test: generate diff friendly tests * chore: create barrel exports * chore: move files after rebase * chore: typedoc config * chore: compat mode * chore: review of barrels * chore: remove tns-core-modules import after rebase * chore: dev workflow setup * chore: update developer-workflow * docs: experiment with API extractor * chore: api-extractor and barrel exports * chore: api-extractor configs * chore: generate d.ts rollup with api-extractor * refactor: move methods inside Frame * chore: fic tests to use Frame static methods * refactor: create Builder class * refactor: use Builder class in tests * refactor: include Style in ui barrel * chore: separate compat build script * chore: fix tslint errors * chore: update NATIVESCRIPT_CORE_ARGS * chore: fix compat pack * chore: fix ui-test-app build with linked modules * chore: Application, ApplicationSettings, Connectivity and Http * chore: export Trace, Profiling and Utils * refactor: Static create methods for ImageSource * chore: fix deprecated usages of ImageSource * chore: move Span and FormattedString to ui * chore: add events-args and ImageSource to index files * chore: check for CLI >= 6.2 when building for IOS * chore: update travis build * chore: copy Pod file to compat package * chore: update error msg ui-tests-app * refactor: Apply suggestions from code review Co-Authored-By: Martin Yankov <m.i.yankov@gmail.com> * chore: typings and refs * chore: add missing d.ts files for public API * chore: adress code review FB * chore: update api-report * chore: dev-workflow for other apps * chore: api update * chore: update api-report
1 parent 6c71394 commit cc97a16

File tree

880 files changed

+9073
-2087
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

880 files changed

+9073
-2087
lines changed

‎.gitignore

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ libs
66
node_modules
77
package
88
platforms
9-
!tns-core-modules/platforms
9+
!nativescript-core/platforms
1010
reports
1111
tags
12+
temp
1213

1314
# Files
1415
package-lock.json
1516
.DS_Store
1617
.nsbuildinfo
18+
tsdoc-metadata.json
1719

1820
# IDEs and editors
1921
/.idea
@@ -23,6 +25,7 @@ package-lock.json
2325
*.launch
2426
.settings/
2527
.atom
28+
.ctags-exclude
2629

2730
# IDE - VSCode
2831
.vscode/*
@@ -51,23 +54,20 @@ tscommand*.tmp.txt
5154

5255
# Other
5356
*.js
57+
!tns-core-modules-package/**/*.js
5458
# https://github.com/NativeScript/nativescript-dev-webpack/issues/932
55-
!tns-core-modules/xml/xml.js
59+
!nativescript-core/xml/xml.js
5660
!tests/hooks/**/*.*
57-
!js-libs/**/*.*
58-
!css/**/*.*
59-
!css-value/**/*.*
60-
!fetch/**/*.*
61-
!apps/TelerikNEXT/lib/**/*.*
62-
!build/**/*.*
63-
.vs/
64-
65-
.baseDir.ts
66-
.ctags-exclude
61+
!nativescript-core/js-libs/**/*.*
62+
!nativescript-core/cli-hooks/**/*.*
63+
!nativescript-core/css/**/*.*
64+
nativescript-core/css/parser.js*
65+
nativescript-core/css/system-classes.js*
66+
!nativescript-core/css-value/**/*.*
67+
!nativescript-core/fetch/**/*.*
68+
!nativescript-core/build/**/*.*
6769

68-
TestRunResult.txt
69-
.testsapprun
70+
#generated by api-extractor
71+
nativescript-core/nativescript-core.d.ts
7072

71-
tns-core-modules.base.d.ts
72-
tns-core-modules.d.ts
73-
tns-core-modules.es6.d.ts
73+
.vs/

‎.travis.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ language: node_js
22
node_js:
33
- "node"
44
script:
5+
- npm install
6+
- npm run tslint
7+
- npm run setup
8+
- npm run unit-test
9+
510
# circular references check
611
- cd tests && npm i
712
- node_modules/.bin/webpack --env.android
813
- node_modules/.bin/webpack --env.ios
9-
# modules transpilation
10-
- cd ../tns-core-modules && npm i && cd ..
11-
- npm install
12-
- npm run tsc
13-
- npm run tslint
14+

‎DevelopmentWorkflow.md

Lines changed: 70 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,89 +4,115 @@ 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-
- `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
7+
- `nativescript-core` - The core NativeScript TypeScript modules used to develop NativeScript apps. Produces `@nativescript/core` npm package
8+
- `tns-core-modules-package` - Base for generating the `tns-core-modules` package (compatibility package for projects that still import code from `tns-core-modules`).
9+
- `tns-core-modules-widgets` - The native widgets (Java and Objective-C) used by the core NativeScript modules. Produces `tns-core-modules-widgets` npm package
10+
- `tns-platform-declarations` - TypeScript definitions for Android and iOS native APIs. Produces `tns-platform-declarations` npm package
11+
- `tests` - Unit tests app for the `@nativescript/core` package. These test are executed as nativescript application on mobile device or emulator.
12+
- `unit-test` - Node unit tests. These test validate parts of the framework that do not require the nativescript runtime and so can be executed in node environment
1013
- `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
14+
- `e2e/ui-tests-app` - UI app used for manual testing and automation
15+
- `apps` - legacy apps for testing
16+
- `build` - scripts used for building and infrastructure
17+
- `dist` - construction site for packing npm modules
1318

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

1722
Managing dependencies:
23+
- `tns-core-modules-widgets` depends on:
24+
- no deps
25+
- `@nativescript/core` depends on:
26+
- `tns-core-modules-widgets`
27+
- (devDep)`tns-platform-declarations`
1828
- `tns-core-modules` depends on:
19-
- `tns-platform-declarations`
20-
- `e2e/ui-tests-app` depends on:
21-
- `tns-platform-declarations`
22-
- `tns-core-modules`
23-
- `e2e` depends on:
24-
- `tns-core-modules`
25-
- `tests` depends on:
26-
- `tns-platform-declarations`
27-
- `tns-core-modules`
28-
29-
> NOTE: `tns-core-modules` depends on `tns-core-modules-widgets`,
29+
- `@nativescript/core`
30+
- (devDep)`tns-platform-declarations`
3031

3132
## Initial Setup
3233

33-
Clone (or fork/clone) the repo:
34+
Clone (or fork/clone) the repo and run setup script:
3435

3536
``` bash
3637
git clone https://github.com/NativeScript/NativeScript.git
38+
cd NativeScript
39+
npm run setup
3740
```
3841

39-
Install dependencies:
40-
41-
``` bash
42-
npm install
43-
```
44-
45-
## Running Unit Tests
42+
## Running Unit Tests Application
43+
After the [initial setup](#initial-setup) you can run the tests with:
4644

4745
``` bash
4846
cd tests
4947
tns run android | ios
5048
```
49+
You can do changes in the test app and `nativescript-core` and rely on HMR to re-run tests.
5150

52-
## Running the UI Test App
51+
## Running the `e2e` Test Apps
5352

54-
The UI test app is an ordinary NativeScript app that logs the test results on the go.
55-
After the [initial setup](#initial-setup) you can run the tests with:
53+
There are couple of application used for development and testing.
54+
The `ui-test-app` is the more frequently used for development and validation. It is an ordinary NativeScript app that logs the test results on the go.
55+
56+
After the [initial setup](#initial-setup) run the e2e apps with:
5657

5758
``` bash
58-
cd e2e/ui-tests-app
59+
cd e2e/<app-name>
5960

6061
# Run the Android app
61-
tns platform add android@next # NOTE: do not commit this change to package.json
62+
tns platform add android@next
6263
tns run android
6364

6465
# Run the iOS app
65-
tns platform add ios@next # NOTE: do not commit this change to package.json
66+
tns platform add ios@next
6667
tns run ios
67-
6868
```
6969

70+
>Note: NOTE: do not commit changes in the runtime versions to `e2e/<app-name>/package.json`
71+
72+
---
73+
7074
## Running Another App
7175

72-
1. Open the app, where you will use the module from the repository in the console.
73-
2. Add the `tns-core-modules` in the application via:
74-
```bash
75-
npm install --save <path to tns-core-modules>
76-
# Example: npm install --save ../NativeScript/tns-core-modules
76+
### TypeScript Applications
77+
Link both the `nativescript-core` folders and the generated compatibility package (`dist\tns-core-modules`):
78+
``` bash
79+
npm i <path-to-nativescript-repo>/nativescript-core --save
80+
npm i <path-to-nativescript-repo>/dist/tns-core-modules --save
7781
```
78-
3. Run the app
79-
```bash
80-
tns run ios
81-
tns run android
82+
83+
You can do changes in the app code and `nativescript-core` and rely on HMR to refresh the app.
84+
85+
### JavaScript Applications
86+
Use the same steps as with TS application. However, the configuration of JS application does not include loading and transpiling TS code. You need to transpile the TS code in `nativescript-core` yourself. The following npm script will run tsc in watch mode in `nativescript-core` (run it in a separate terminal so that you can do `tns run` in parallel):
87+
88+
``` bash
89+
npm run tsc-core-watch
8290
```
8391

84-
---
85-
**NOTE**
92+
### Angular Applications
93+
Linking `tns-core-modules` and `@nativescript/core` in **Angular applications** does not work at the moment. Check [#7905](https://github.com/NativeScript/NativeScript/issues/7905) for more details on the issue.
8694

87-
Linking `tns-core-modules` in Angular app does not work at the moment. Check [#7905](https://github.com/NativeScript/NativeScript/issues/7905) for more details on the issue.
8895

89-
---
96+
## Building `tns-core-modules-widgets`
97+
You can the following npm script to build and link the `tns-core-modules-widgets` package.
98+
``` bash
99+
npm run setup-widgets
100+
```
101+
102+
This script will build the `tns-core-modules-widgets` package and link it inside the `nativescript-core` so it will be used for running the tests and e2e apps.
103+
104+
>Note: NOTE: do not commit changes in the `tns-core-modules-widgets` dependency in the `nativescript-core/package.json`
105+
106+
## Running Node Unit Tests
107+
Run node unit tests with:
108+
```
109+
npm run unit-test
110+
```
111+
or run tests in watch mode:
112+
113+
```
114+
npm run unit-test-watch
115+
```
90116

91117
## Platform declarations
92118
To update the platform declarations (the ios.d.ts-es) you can run:

0 commit comments

Comments
 (0)