Skip to content

Commit 69f4ca8

Browse files
committed
docs(readme): add section explaining the overrides section in the package.json file
1 parent 4585595 commit 69f4ca8

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ Due to Grafana Labs' [plugin guidelines](https://grafana.com/legal/plugins/#plug
1818
## Features
1919
* Integration of mutliple OGC WMS 1.3.0 from different endpoints as base map layer
2020
* Opacity setting for each WMS endpoint
21-
* Collapsable legend of used WNS layers
21+
* Collapsable legend of used WMS layers
2222
* Interactive spatial filter
2323
* Minimal data links implementation
24+
* Button to reset the map view to the data extent
25+
* Support for WMTS (Web Map Tile Service)
2426

2527
## Migration from Geomap WMS Panel Plugin v1.0.1
2628
Due to the capability of using multiple WMS endpoints as base map layer a change in the plugin configuration object was required, not being backwards compatible with the configuration object used for plugins of version 1.y.z.
@@ -197,14 +199,29 @@ This repository refers to the following version of its original: https://github.
197199
<!-- - Minikube
198200
- Helm -->
199201

202+
## Dependency resolution
203+
Note that some of the `@grafana/*` packages also include `Openlayers` as part of their dependencies. Since the plugin itself also uses Openlayers as dependency it is required that the Openlayer versions of the `@grafana/*` packages and the one used in the panel plugin are compatible.
204+
This is achieved by hard-coding the `ol` version in the [`overrides` section](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides) of the `package.json`:
205+
```json
206+
...
207+
"overrides": {
208+
"ol": "7.2.2",
209+
"jspdf": "3.0.2",
210+
"uplot": "1.6.31"
211+
},
212+
...
213+
```
214+
215+
> ⚠️ When running in build errors after updating certain packages with [transitive dependencies](https://en.wikipedia.org/wiki/Transitive_dependency) listed in the `overrides` section it is recommend to check if the overriding versions conflict with the versions required by the updated packages
216+
200217
## Run the tests
201218
### Unit/integration tests
202219
```bash
203220
npm run test:all
204221
```
205222

206223
### E2E tests
207-
> Requires a Docker container of grafana running on localhost:3000 with default credentials (user: admin, password: admin).
224+
> Requires a Docker container of grafana running on `localhost:3000` with default credentials (`user: admin, password: admin`).
208225
```bash
209226
npm run e2e
210227
```

0 commit comments

Comments
 (0)