Skip to content

Commit 69977ff

Browse files
farfromrefugfarfromrefug
committed
chore: update
1 parent e97c948 commit 69977ff

File tree

7 files changed

+229
-44
lines changed

7 files changed

+229
-44
lines changed

‎demo-snippets/package.json‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
{
22
"name": "@nativescript-community/template-snippet",
3+
"private": true,
34
"version": "4.3.7",
45
"dependencies": {
5-
"@nativescript-community/ui-image": "file:../packages/image",
6-
"@nativescript-community/ui-image-colorfilter": "file:../packages/image-colorfilter",
7-
"@nativescript-community/ui-zoomimage": "file:../packages/zoomimage"
8-
}
9-
}
6+
"@nativescript-community/ui-image": "^4.3.7",
7+
"@nativescript-community/ui-image-colorfilter": "^4.3.7",
8+
"@nativescript-community/ui-zoomimage": "^4.3.7"
9+
},
10+
"gitHead": "e97c94836db13b09c15553f71ddac95f6d8a38f3"
11+
}

‎packages/image-colorfilter/README.md‎

Lines changed: 72 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,15 @@
4545
* [setup](#setup)
4646
* [Demos](#demos)
4747
* [Demos and Development](#demos-and-development)
48-
* [Setup](#setup)
48+
* [Repo Setup](#repo-setup)
4949
* [Build](#build)
5050
* [Demos](#demos-1)
51+
* [Contributing](#contributing)
52+
* [Update repo ](#update-repo-)
53+
* [Update readme ](#update-readme-)
54+
* [Update doc ](#update-doc-)
55+
* [Publish](#publish)
56+
* [modifying submodules](#modifying-submodules)
5157
* [Questions](#questions)
5258

5359

@@ -95,18 +101,18 @@ $ ns run ios|android
95101
## Demos and Development
96102

97103

98-
### Setup
99-
100-
To run the demos, you must clone this repo **recursively**.
104+
### Repo Setup
101105

106+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
102107
```
103-
git clone https://github.com/@nativescript-community/ui-image-colorfilter.git --recursive
108+
git submodule update --init
104109
```
105110

106-
**Install Dependencies:**
107-
```bash
108-
npm i # or 'yarn install' or 'pnpm install'
109-
```
111+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
112+
113+
To develop and test:
114+
if you use `yarn` then run `yarn`
115+
if you use `pnpm` then run `pnpm i`
110116

111117
**Interactive Menu:**
112118

@@ -115,10 +121,9 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
115121
### Build
116122

117123
```bash
118-
npm run build
119-
120-
npm run build.angular # or for Angular
124+
npm run build.all
121125
```
126+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
122127

123128
### Demos
124129

@@ -127,6 +132,61 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
127132

128133
npm run demo.svelte.ios # Example
129134
```
135+
136+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
137+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
138+
You can start from the `install.ts` of each flavor to see how to register new demos
139+
140+
141+
[](#contributing)
142+
143+
## Contributing
144+
145+
### Update repo
146+
147+
You can update the repo files quite easily
148+
149+
First update the submodules
150+
151+
```bash
152+
npm run update
153+
```
154+
155+
Then commit the changes
156+
Then update common files
157+
158+
```bash
159+
npm run sync
160+
```
161+
Then you can run `yarn|pnpm`, commit changed files if any
162+
163+
### Update readme
164+
```bash
165+
npm run readme
166+
```
167+
168+
### Update doc
169+
```bash
170+
npm run doc
171+
```
172+
173+
### Publish
174+
175+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
176+
Simply run
177+
```shell
178+
npm run publish
179+
```
180+
181+
### modifying submodules
182+
183+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
184+
One easy solution is t modify `~/.gitconfig` and add
185+
```
186+
[url "ssh://[email protected]/"]
187+
pushInsteadOf = https://github.com/
188+
```
189+
130190

131191
[](#questions)
132192

‎packages/image-colorfilter/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,6 @@
4545
"@nativescript-community/ui-image": "^4.3.7"
4646
},
4747
"license": "Apache-2.0",
48-
"readmeFilename": "README.md"
48+
"readmeFilename": "README.md",
49+
"gitHead": "e97c94836db13b09c15553f71ddac95f6d8a38f3"
4950
}

‎packages/image/README.md‎

Lines changed: 72 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,15 @@
5656
* [Flavors](#flavors)
5757
* [Demos](#demos)
5858
* [Demos and Development](#demos-and-development)
59-
* [Setup](#setup)
59+
* [Repo Setup](#repo-setup)
6060
* [Build](#build)
6161
* [Demos](#demos-1)
62+
* [Contributing](#contributing)
63+
* [Update repo ](#update-repo-)
64+
* [Update readme ](#update-readme-)
65+
* [Update doc ](#update-doc-)
66+
* [Publish](#publish)
67+
* [modifying submodules](#modifying-submodules)
6268
* [Questions](#questions)
6369

6470

@@ -630,18 +636,18 @@ $ ns run ios|android
630636
## Demos and Development
631637

632638

633-
### Setup
634-
635-
To run the demos, you must clone this repo **recursively**.
639+
### Repo Setup
636640

641+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
637642
```
638-
git clone https://github.com/@nativescript-community/ui-image.git --recursive
643+
git submodule update --init
639644
```
640645

641-
**Install Dependencies:**
642-
```bash
643-
npm i # or 'yarn install' or 'pnpm install'
644-
```
646+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
647+
648+
To develop and test:
649+
if you use `yarn` then run `yarn`
650+
if you use `pnpm` then run `pnpm i`
645651

646652
**Interactive Menu:**
647653

@@ -650,10 +656,9 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
650656
### Build
651657

652658
```bash
653-
npm run build
654-
655-
npm run build.angular # or for Angular
659+
npm run build.all
656660
```
661+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
657662

658663
### Demos
659664

@@ -662,6 +667,61 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
662667

663668
npm run demo.svelte.ios # Example
664669
```
670+
671+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
672+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
673+
You can start from the `install.ts` of each flavor to see how to register new demos
674+
675+
676+
[](#contributing)
677+
678+
## Contributing
679+
680+
### Update repo
681+
682+
You can update the repo files quite easily
683+
684+
First update the submodules
685+
686+
```bash
687+
npm run update
688+
```
689+
690+
Then commit the changes
691+
Then update common files
692+
693+
```bash
694+
npm run sync
695+
```
696+
Then you can run `yarn|pnpm`, commit changed files if any
697+
698+
### Update readme
699+
```bash
700+
npm run readme
701+
```
702+
703+
### Update doc
704+
```bash
705+
npm run doc
706+
```
707+
708+
### Publish
709+
710+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
711+
Simply run
712+
```shell
713+
npm run publish
714+
```
715+
716+
### modifying submodules
717+
718+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
719+
One easy solution is t modify `~/.gitconfig` and add
720+
```
721+
[url "ssh://[email protected]/"]
722+
pushInsteadOf = https://github.com/
723+
```
724+
665725

666726
[](#questions)
667727

‎packages/image/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,6 @@
4343
"url": "https://github.com/nativescript-community/ui-image"
4444
},
4545
"license": "Apache-2.0",
46-
"readmeFilename": "README.md"
46+
"readmeFilename": "README.md",
47+
"gitHead": "e97c94836db13b09c15553f71ddac95f6d8a38f3"
4748
}

‎packages/zoomimage/README.md‎

Lines changed: 72 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,15 @@
4545
* [setup](#setup)
4646
* [Demos](#demos)
4747
* [Demos and Development](#demos-and-development)
48-
* [Setup](#setup)
48+
* [Repo Setup](#repo-setup)
4949
* [Build](#build)
5050
* [Demos](#demos-1)
51+
* [Contributing](#contributing)
52+
* [Update repo ](#update-repo-)
53+
* [Update readme ](#update-readme-)
54+
* [Update doc ](#update-doc-)
55+
* [Publish](#publish)
56+
* [modifying submodules](#modifying-submodules)
5157
* [Questions](#questions)
5258

5359

@@ -95,18 +101,18 @@ $ ns run ios|android
95101
## Demos and Development
96102

97103

98-
### Setup
99-
100-
To run the demos, you must clone this repo **recursively**.
104+
### Repo Setup
101105

106+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
102107
```
103-
git clone https://github.com/@nativescript-community/ui-zoomimage.git --recursive
108+
git submodule update --init
104109
```
105110

106-
**Install Dependencies:**
107-
```bash
108-
npm i # or 'yarn install' or 'pnpm install'
109-
```
111+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
112+
113+
To develop and test:
114+
if you use `yarn` then run `yarn`
115+
if you use `pnpm` then run `pnpm i`
110116

111117
**Interactive Menu:**
112118

@@ -115,10 +121,9 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
115121
### Build
116122

117123
```bash
118-
npm run build
119-
120-
npm run build.angular # or for Angular
124+
npm run build.all
121125
```
126+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
122127

123128
### Demos
124129

@@ -127,6 +132,61 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
127132

128133
npm run demo.svelte.ios # Example
129134
```
135+
136+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
137+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
138+
You can start from the `install.ts` of each flavor to see how to register new demos
139+
140+
141+
[](#contributing)
142+
143+
## Contributing
144+
145+
### Update repo
146+
147+
You can update the repo files quite easily
148+
149+
First update the submodules
150+
151+
```bash
152+
npm run update
153+
```
154+
155+
Then commit the changes
156+
Then update common files
157+
158+
```bash
159+
npm run sync
160+
```
161+
Then you can run `yarn|pnpm`, commit changed files if any
162+
163+
### Update readme
164+
```bash
165+
npm run readme
166+
```
167+
168+
### Update doc
169+
```bash
170+
npm run doc
171+
```
172+
173+
### Publish
174+
175+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
176+
Simply run
177+
```shell
178+
npm run publish
179+
```
180+
181+
### modifying submodules
182+
183+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
184+
One easy solution is t modify `~/.gitconfig` and add
185+
```
186+
[url "ssh://[email protected]/"]
187+
pushInsteadOf = https://github.com/
188+
```
189+
130190

131191
[](#questions)
132192

‎packages/zoomimage/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,6 @@
4646
"@nativescript-community/ui-image": "^4.3.7"
4747
},
4848
"license": "Apache-2.0",
49-
"readmeFilename": "README.md"
49+
"readmeFilename": "README.md",
50+
"gitHead": "e97c94836db13b09c15553f71ddac95f6d8a38f3"
5051
}

0 commit comments

Comments
 (0)