@abi-software/mapintegratedvuer 0.7.1-auth.6 → 0.7.1-vue3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -6
- package/dist/mapintegratedvuer.js +56166 -58146
- package/dist/mapintegratedvuer.umd.cjs +489 -906
- package/dist/style.css +1 -1
- package/package.json +14 -15
- package/src/components/MapContent.vue +53 -10
- package/src/components/viewers/MultiFlatmap.vue +3 -3
- package/vite.config.js +6 -1
- package/vuese-generator.js +65 -0
package/README.md
CHANGED
|
@@ -78,14 +78,14 @@ The following pagedemonstrates the mapintegratedapp in action: https://mapcore-d
|
|
|
78
78
|
|
|
79
79
|
|
|
80
80
|
## Testing mapintegratedvuer dependencies in [sparc-app](https://github.com/nih-sparc/sparc-app/)
|
|
81
|
-
We will cover three options for updating nested dependencies.
|
|
81
|
+
We will cover three options for updating nested dependencies.
|
|
82
82
|
|
|
83
83
|
### 1. Copy build files from `npm run build-bundle`
|
|
84
84
|
This works by directly changing files in `node-modules/`, where node will look to resolve dependencies.
|
|
85
85
|
|
|
86
86
|
```
|
|
87
87
|
cd <your-dependency>
|
|
88
|
-
npm run build-bundle
|
|
88
|
+
npm run build-bundle
|
|
89
89
|
cp /dist <mapintegratedvuer-path>/node_modules/@<your-npmhandle>/<your-dependency>/dist
|
|
90
90
|
cd <mapintegratedvuer-path>
|
|
91
91
|
npm run build-bundle
|
|
@@ -98,7 +98,7 @@ This is a variant of option 1, where we use `yarn link` to create a symbolic lin
|
|
|
98
98
|
It reduces the number of copies to 1, but still requires 3 builds
|
|
99
99
|
```
|
|
100
100
|
cd <your-dependency>
|
|
101
|
-
npm run build-bundle
|
|
101
|
+
npm run build-bundle
|
|
102
102
|
cp /dist <mapintegratedvuer-path>/node_modules/@<your-npmhandle>/<your-dependency>/dist
|
|
103
103
|
cd <mapintegratedvuer-path>
|
|
104
104
|
npm run build-bundle
|
|
@@ -110,13 +110,13 @@ yarn dev
|
|
|
110
110
|
(npm link does not work without disabling es-lint, which we won't go into)
|
|
111
111
|
|
|
112
112
|
### 3. Publish own version of mapintegratedvuer
|
|
113
|
-
This method is the most time consuming and has the downside of populating the npm package's version history with builds.
|
|
113
|
+
This method is the most time consuming and has the downside of populating the npm package's version history with builds.
|
|
114
114
|
Since it mimics the way `sparc-app` will use it, it's gauranteed to work.
|
|
115
115
|
|
|
116
116
|
```
|
|
117
117
|
cd <your-dependency>
|
|
118
118
|
npm run build-bundle
|
|
119
|
-
npm publish --tag alpha
|
|
119
|
+
npm publish --tag alpha
|
|
120
120
|
cd mapintegratedvuer
|
|
121
121
|
npm install @<your-npmhandle>/<your-dependency>@alpha
|
|
122
122
|
```
|
|
@@ -127,7 +127,7 @@ Change `@abi-software/mapintegratedvuer` to `@<your-npm-handle>/mapintegratedvue
|
|
|
127
127
|
```
|
|
128
128
|
cd mapintegratedvuer
|
|
129
129
|
npm run build-bundle
|
|
130
|
-
npm publish --tag alpha
|
|
130
|
+
npm publish --tag alpha
|
|
131
131
|
```
|
|
132
132
|
|
|
133
133
|
Edit sparc-app/pages/maps/index.vue
|
|
@@ -139,4 +139,12 @@ yarn add @<your-npm-handle>/mapintegratedvuer@alpha
|
|
|
139
139
|
yarn dev
|
|
140
140
|
```
|
|
141
141
|
|
|
142
|
+
## Documentation
|
|
143
|
+
|
|
144
|
+
The documentation is developed with `vitepress` and `vuese`. Documentation pages are in the `docs` folder.
|
|
142
145
|
|
|
146
|
+
### To run in local development mode
|
|
147
|
+
```bash
|
|
148
|
+
npm run docs:watch
|
|
149
|
+
```
|
|
150
|
+
This will start the documentation server with `vitepress` on port `:5173` and watch the `FlatmapVuer` and `MultiFlatmapVuer` components changes.
|