You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 7, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-17
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,16 @@ Before starting, make yourself familiar with the `nativescript-dev-webpack`'s [d
11
11
12
12
The repository contains several ingredients:
13
13
*`installer.js` - combination of postinstall scripts for adding or removing webpack configurations and necessary dependecies when installing the plugin.
14
-
*`prepublish` - [Webpack config](https://webpack.js.org/concepts/configuration/) snippets used for generating webpack configuration templates. The latter are generated with the npm's `prepublishOnly` script. **If you want to modify the distributed webpack configurations - that's the right place to do it.**
15
-
*`templates` - webpack config templates for different types of projects - NativeScript with JavaScript, NativeScript with TypeScript and NativeScript Angular projects.
16
-
*`plugins` - several [Webpack plugins](https://webpack.js.org/concepts/plugins/) necessary for bundling NativeScript applications.
17
-
*`snapshot/android` - tools used with the `NativeScriptSnapshot` plugin for generating V8 Heap Snapshots.
18
-
*`nativescript-target` - configuration of a [Webpack deployment target](https://webpack.js.org/concepts/targets/)for building NativeScript applications.
19
-
*`bin` - helper node/npm scripts for projects using the plugin.
20
-
*`bin/ns-bundle` - node script used for bundling the project with Webpack and building the native Android/iOS application with NativeScript CLI.
14
+
*`templates/` - webpack config templates for different types of projects - NativeScript with JavaScript, NativeScript with TypeScript and NativeScript Angular projects.
15
+
*`plugins/` - several [Webpack plugins](https://webpack.js.org/concepts/plugins/) necessary for bundling NativeScript applications.
16
+
*`snapshot/android/` - tools used with the `NativeScriptSnapshot` plugin for generating V8 Heap Snapshots.
17
+
*`nativescript-target/` - configuration of a [Webpack deployment target](https://webpack.js.org/concepts/targets/) for building NativeScript applications.
18
+
*`bin/` - helper node/npm scripts for projects using the plugin.
19
+
*`demo/` - resides several NativeScript applications, testing different scenarios. You can execute each app's tests by navigating to its directory and running `npm run e2e -- --runType nameOfRuntype`. For more information on runTypes, check out the[nativescript-dev-appium](https://github.com/NativeScript/nativescript-dev-appium#custom-appium-capabilities) plugin.
20
+
21
21
## Setup
22
+
23
+
> Note that you need npm 5+ for local development of the plugin.
22
24
1.[Fork](https://help.github.com/articles/fork-a-repo/) and clone the GitHub repository:
@@ -35,32 +37,30 @@ The repository contains several ingredients:
35
37
git checkout -b <my-fix-branch> master
36
38
```
37
39
38
-
4. Install devDependencies:
40
+
4. Install dependencies:
39
41
```bash
40
42
npm install
41
43
```
42
44
43
-
You are good to go! The plugin is written in plain JavaScript. You're strongly encouraged to follow the official NativeScript [Coding Conventions](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md) and to use ES features available in NodeJS v6. If unsure, check on [node.green](http://node.green/).
45
+
The last command also runs `npm prepare` which compiles the TypeScript files in the plugin.
46
+
You are good to go! You're strongly encouraged to follow the official NativeScript [Coding Conventions](https://github.com/NativeScript/NativeScript/blob/master/CodingConvention.md) and to use ES features available in NodeJS v6. If unsure, check on [node.green](http://node.green/).
44
47
45
48
## Testing locally
46
49
50
+
There are three apps in the repository, located in
47
51
1. Create a new NativeScript project with NativeScript CLI:
48
52
``` bash
49
53
tns create testapp # pass --ng/--tsc for Angular/TypeScript app
50
54
```
51
55
52
-
2. Install your local copy of the plugin using either `npm install` or `npm link`.
3. The first command will copy the files, while the second one will create a symlink to the local directory. Because of the symlink, all the changes you make in `node_modules/nativescript-dev-webpack` will be 'synced' with `/path/to/repo/nativescript-dev-webpack` and vice-versa.
58
-
59
-
4. Make sure to force-update the project's configuration files if it's already using Webpack.
61
+
3. Make sure to force-update the project's configuration files if it's already using Webpack.
0 commit comments