Skip to content

Commit cd38771

Browse files
committed
Merge remote-tracking branch 'origin/master'
# Conflicts: # docs/assets/highlight.css # docs/assets/main.js # docs/assets/search.js # docs/assets/style.css # docs/index.html # docs/modules.html
2 parents c654806 + 8905f4a commit cd38771

File tree

9 files changed

+15926
-34
lines changed

9 files changed

+15926
-34
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ yarn-error.log*
2525
.project
2626
.yarn
2727
tmp/
28-
package-lock.json
29-
yarn.lock
3028

3129
!.eslintrc.js
3230
!.prettierrc.js
@@ -54,6 +52,5 @@ packages/*.ngsummary.json
5452
packages/*.metadata.json
5553
packages/angular
5654
packages/typings
57-
pnpm-lock.yaml
5855

5956
/blueprint.md

.gitmodules

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[submodule "demo-svelte"]
22
path = demo-svelte
3-
url = git@github.com:nativescript-community/plugin-seed-demo-svelte.git
3+
url = https://github.com/nativescript-community/plugin-seed-demo-svelte.git
44
[submodule "demo-vue"]
55
path = demo-vue
6-
url = git@github.com:nativescript-community/plugin-seed-demo-vue.git
6+
url = https://github.com/nativescript-community/plugin-seed-demo-vue.git
77
[submodule "tools"]
88
path = tools
9-
url = git@github.com:nativescript-community/plugin-seed-tools.git
9+
url = https://github.com/nativescript-community/plugin-seed-tools.git

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ strict-peer-dependencies=false
88
shell-emulator=true
99
auto-install-peers=false
1010
loglevel=error
11+
engine-strict=true

.yarnrc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
nmHoistingLimits: workspaces
2+
3+
nodeLinker: node-modules
4+
5+
yarnPath: tools/.yarn/releases/yarn-3.3.1.cjs

README.md

Lines changed: 60 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,14 @@
4747
* [Usage in Vue](#usage-in-vue)
4848
* [Examples](#examples-1)
4949
* [Demos and Development](#demos-and-development)
50-
* [Setup](#setup)
50+
* [Repo Setup](#repo-setup)
5151
* [Build](#build)
5252
* [Demos](#demos)
53+
* [Contributing](#contributing)
54+
* [Update repo ](#update-repo-)
55+
* [Update readme ](#update-readme-)
56+
* [Update doc ](#update-doc-)
57+
* [Publish](#publish)
5358
* [Questions](#questions)
5459

5560

@@ -106,18 +111,18 @@ The API documentation for this plugin is available [here](https://nativescript-c
106111
## Demos and Development
107112

108113

109-
### Setup
110-
111-
To run the demos, you must clone this repo **recursively**.
114+
### Repo Setup
112115

116+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
113117
```
114-
git clone https://github.com/@nativescript-community/ui-carto.git --recursive
118+
git submodule update --init
115119
```
116120

117-
**Install Dependencies:**
118-
```bash
119-
npm i # or 'yarn install' or 'pnpm install'
120-
```
121+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
122+
123+
To develop and test:
124+
if you use `yarn` then run `yarn`
125+
if you use `pnpm` then run `pnpm i`
121126

122127
**Interactive Menu:**
123128

@@ -126,9 +131,7 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
126131
### Build
127132

128133
```bash
129-
npm run build
130-
131-
npm run build.angular # or for Angular
134+
npm run build.all
132135
```
133136

134137
### Demos
@@ -138,6 +141,51 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
138141

139142
npm run demo.svelte.ios # Example
140143
```
144+
145+
146+
[](#contributing)
147+
148+
149+
[](#contributing)
150+
151+
## Contributing
152+
153+
### Update repo
154+
155+
You can update the repo files quite easily
156+
157+
First update the submodules
158+
159+
```bash
160+
npm run update
161+
```
162+
163+
Then commit the changes
164+
Then update common files
165+
166+
```bash
167+
npm run sync
168+
```
169+
Then you can run `yarn|pnpm`, commit changed files if any
170+
171+
### Update readme
172+
```bash
173+
npm run readme
174+
```
175+
176+
### Update doc
177+
```bash
178+
npm run doc
179+
```
180+
181+
### Publish
182+
183+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
184+
Simply run
185+
```shell
186+
npm run publish
187+
```
188+
141189

142190
[](#questions)
143191

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323
"demo.vue.clean": "cd ./demo-vue && ns clean",
2424
"postinstall": "npm run setup",
2525
"publish": "npm run clean && npm run build.all && npm run readme && lerna publish --no-private --create-release=github --force-publish",
26-
"readme": "node ./tools/readme.js",
26+
"readme": "lerna run readme && node ./tools/readme.js",
2727
"setup": "npm run submodules && ts-patch install",
2828
"start": "./node_modules/.bin/ntl -A -s 15 -o",
2929
"submodules": "git submodule update --init",
3030
"sync": "node ./tools/sync.js",
3131
"update": "node ./tools/update.js",
32-
"fullclean": "npm run clean && rimraf 'packages/**/node_modules' 'demo-*/hooks' 'package-lock.json' 'pnpm-lock.yaml' 'node_modules'",
33-
"doc": "node tools/builddoc.mjs && git add docs/* && git commit -m \"chore:doc\""
32+
"fullclean": "npm run clean && rimraf 'packages/**/node_modules' 'demo-*/hooks' 'demo-*/node_modules' 'package-lock.json' 'pnpm-lock.yaml' 'node_modules'",
33+
"doc": "node tools/builddoc.mjs"
3434
},
3535
"commitlint": {
3636
"extends": [
@@ -56,7 +56,8 @@
5656
"engines": {
5757
"npm": "please use yarn or pnpm",
5858
"yarn": ">=1.19.1",
59-
"pnpm": ">=7.0.0"
59+
"pnpm": ">=7.0.0",
60+
"node": "^14.20.0 || ^16.13.0 || >=18.10.0"
6061
},
6162
"workspaces": [
6263
"packages/*",

packages/ui-carto/README.md

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,14 @@
4444
* [Usage in Vue](#usage-in-vue)
4545
* [Examples](#examples-1)
4646
* [Demos and Development](#demos-and-development)
47-
* [Setup](#setup)
47+
* [Repo Setup](#repo-setup)
4848
* [Build](#build)
4949
* [Demos](#demos)
50+
* [Contributing](#contributing)
51+
* [Update repo ](#update-repo-)
52+
* [Update readme ](#update-readme-)
53+
* [Update doc ](#update-doc-)
54+
* [Publish](#publish)
5055
* [Questions](#questions)
5156

5257

@@ -88,18 +93,18 @@ The API documentation for this plugin is available [here](https://nativescript-c
8893
## Demos and Development
8994

9095

91-
### Setup
92-
93-
To run the demos, you must clone this repo **recursively**.
96+
### Repo Setup
9497

98+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
9599
```
96-
git clone https://github.com/@nativescript-community/ui-carto.git --recursive
100+
git submodule update --init
97101
```
98102

99-
**Install Dependencies:**
100-
```bash
101-
npm i # or 'yarn install' or 'pnpm install'
102-
```
103+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
104+
105+
To develop and test:
106+
if you use `yarn` then run `yarn`
107+
if you use `pnpm` then run `pnpm i`
103108

104109
**Interactive Menu:**
105110

@@ -108,9 +113,7 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
108113
### Build
109114

110115
```bash
111-
npm run build
112-
113-
npm run build.angular # or for Angular
116+
npm run build.all
114117
```
115118

116119
### Demos
@@ -120,6 +123,48 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
120123

121124
npm run demo.svelte.ios # Example
122125
```
126+
127+
128+
[](#contributing)
129+
130+
## Contributing
131+
132+
### Update repo
133+
134+
You can update the repo files quite easily
135+
136+
First update the submodules
137+
138+
```bash
139+
npm run update
140+
```
141+
142+
Then commit the changes
143+
Then update common files
144+
145+
```bash
146+
npm run sync
147+
```
148+
Then you can run `yarn|pnpm`, commit changed files if any
149+
150+
### Update readme
151+
```bash
152+
npm run readme
153+
```
154+
155+
### Update doc
156+
```bash
157+
npm run doc
158+
```
159+
160+
### Publish
161+
162+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
163+
Simply run
164+
```shell
165+
npm run publish
166+
```
167+
123168

124169
[](#questions)
125170

svelte.config.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
const sveltePreprocess = require('svelte-preprocess');
2+
// const svelteNativePreprocessor = require('svelte-native-preprocessor');
3+
4+
module.exports = {
5+
compilerOptions: {
6+
namespace: 'foreign'
7+
},
8+
preprocess: [
9+
sveltePreprocess({
10+
typescript: {
11+
compilerOptions: {
12+
target: 'es2020'
13+
}
14+
}
15+
})
16+
// svelteNativePreprocessor()
17+
]
18+
};

0 commit comments

Comments
 (0)