mirror of
https://github.com/maputnik/editor.git
synced 2026-01-20 12:20:03 +00:00
3dde66b6e9
Bumps [ol](https://github.com/openlayers/openlayers) from 10.3.1 to 10.4.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/openlayers/openlayers/releases">ol's releases</a>.</em></p> <blockquote> <h2>v10.4.0</h2> <p>With more than 40 pull requests, the 10.4 release brings performance improvements, bug fixes, better TypeScript generics and new features. New features include a convenience <code>Image</code> layer loader for debugging MapServer map files using the MapServer CGI API, and an experimental <code>WebGLVectorTile</code> layer.</p> <h2>Upgrade notes</h2> <h3>Deprecation of ol/layer/WebGLPoints</h3> <p>Use <code>ol/layer/WebGLVector</code> instead. Besides rendering points it will also render lines and polygons. In most cases this is a drop-in replacement. To use filtering the style and filter have to be in a nested object.</p> <pre lang="js"><code>// Before new WebGLPointsLayer({ filter: ['between', ['get', 'year'], ['var', 'minYear'], ['var', 'maxYear']], style: { 'circle-radius': 8, 'circle-fill-color': 'blue', }, source: vectorSource, }) <p>// After new WebGLVectorLayer({ style: [{ filter: ['between', ['get', 'year'], ['var', 'minYear'], ['var', 'maxYear']], style: { 'circle-radius': 8, 'circle-fill-color': 'blue', }, }], source: vectorSource, }) </code></pre></p> <h3>ol-mapbox-style compatibility</h3> <p>This version of OpenLayers is only compatible with <code>ol-mapbox-style@12.4.0</code> or higher.</p> <h3>Returning false from a one-time listener added with <code>once</code></h3> <p>Returning false from the listener function will now stop propagation, when the listener is added with <code>once</code>. Previously this only worked with the <code>on</code> method.</p> <h4>The <code>filter</code> option for <code>WebGLPointsLayer</code> has changed</h4> <p>The filter option for the <code>WebGLPointsLayer</code> must now be specified alongside other options instead of being part of the <code>style</code> object. Note that the <code>WebGLPointsLayer</code> is not part of the stable API and is subject to breaking changes between major releases.</p> <pre lang="js"><code>// Before new WebGLPointsLayer({ style: { </tr></table> </code></pre> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="85219a86c5"><code>85219a8</code></a> Updates for the 10.4.0 release</li> <li><a href="b8306d3f53"><code>b8306d3</code></a> Merge pull request <a href="https://redirect.github.com/openlayers/openlayers/issues/16591">#16591</a> from geographika/mapserver-source</li> <li><a href="2262a6a79c"><code>2262a6a</code></a> Fix typo</li> <li><a href="b79ccdf1ac"><code>b79ccdf</code></a> Update comments</li> <li><a href="7549ac61e9"><code>7549ac6</code></a> Update test/browser/spec/ol/source/mapserver.test.js</li> <li><a href="9b358c6f0a"><code>9b358c6</code></a> Update file names and title to include CGI</li> <li><a href="5590f98349"><code>5590f98</code></a> Remove map from test and test all querystring parameters are set correctly</li> <li><a href="698c82ee7e"><code>698c82e</code></a> Update tests</li> <li><a href="c7a99bfb36"><code>c7a99bf</code></a> Add mapserver.js</li> <li><a href="b8a98dfe76"><code>b8a98df</code></a> Add createLoader function for MapServer layers with example and tests</li> <li>Additional commits viewable in <a href="https://github.com/openlayers/openlayers/compare/v10.3.1...v10.4.0">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Maputnik
A free and open visual editor for the MapLibre GL styles targeted at developers and map designers.
Usage
- 🔗 Design your maps online at https://www.maplibre.org/maputnik/ (all in local storage)
- 🔗 Use the Maputnik CLI for local style development
- In a Docker, run this command and browse to http://localhost:8888, Ctrl+C to stop the server.
docker run -it --rm -p 8888:80 ghcr.io/maplibre/maputnik:main
Documentation
The documentation can be found in the Wiki. You are welcome to collaborate!
- 🔗 Study the Maputnik Wiki
- 📹 Design a map from Scratch https://youtu.be/XoDh0gEnBQo
Develop
Maputnik is written in typescript and is using React and MapLibre GL JS.
We ensure building and developing Maputnik works with the current active LTS Node.js version and above.
Check out our Internationalization guide for UI text related changes.
Getting Involved
Join the #maplibre or #maputnik slack channel at OSMUS: get an invite at https://slack.openstreetmap.us/ Read the the below guide in order to get familiar with how we do things around here.
Install the deps, start the dev server and open the web browser on http://localhost:8888/.
# install dependencies
npm install
# start dev server
npm run start
If you want Maputnik to be accessible externally use the --host option:
# start externally accessible dev server
npm run start -- --host 0.0.0.0
The build process will watch for changes to the filesystem, rebuild and autoreload the editor.
npm run build
Lint the JavaScript code.
# run linter
npm run lint
npm run lint-css
npm run sort-styles
Tests
For E2E testing we use Cypress
Cypress doesn't starts a server so you'll need to start one manually by running npm run start.
Now open a terminal and run the following using chrome:
npm run test
or firefox:
npm run test -- --browser firefox
See the following docs for more info: (Launching Browsers)[https://docs.cypress.io/guides/guides/launching-browsers]
You can also see the tests as they run or select which suites to run by executing:
npm run cy:open
Release process
- Review
CHANGELOG.md- Double-check that all changes included in the release are appropriately documented.
- To-be-released changes should be under the "main" header.
- Commit any final changes to the changelog.
- Run Create bump version PR by manual workflow dispatch and set the version number in the input. This will create a PR that changes the changelog and
package.jsonfile to review and merge. - Once merged, an automatic process will kick in and creates a GitHub release and uploads release assets.
Sponsors
Thanks to the supporters of the Kickstarter campaign. This project would not be possible without these commercial and individual sponsors. You can see this file's history for previous sponsors of the original Maputnik repo. Read more about the MapLibre Sponsorship Program at https://maplibre.org/sponsors/.
License
Maputnik is licensed under MIT and is Copyright (c) Lukas Martinelli and Maplibre contributors. As contributor please take extra care of not violating any Mapbox trademarks. Do not get inspired by other map studios and make your own decisions for a good style editor.