mirror of
https://github.com/maputnik/editor.git
synced 2026-10-28 05:43:45 +00:00
dependabot[bot]
2eba8b0c90
Bumps the react group with 1 update: [react-i18next](https://github.com/i18next/react-i18next). Updates `react-i18next` from 17.1.4 to 17.1.8 <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/i18next/react-i18next/blob/master/CHANGELOG.md">react-i18next's changelog</a>.</em></p> <blockquote> <h2>17.1.8</h2> <ul> <li>fix(Trans): an interpolation variable named <code>format</code> is no longer dropped. <code>Trans</code> reads <code>format</code> in an interpolation object as the formatter name (<code>{{ value, format }}</code>), so with <code>{{ format }}</code> as the only key nothing was left: <code><Trans>Export as {{ format }}</Trans></code> warned <code>TRANS_INVALID_OBJ</code> and used the default string <code>Export as </code> instead of <code>Export as {{format}}</code>. When <code>format</code> is the object's only key it is now treated as the variable. <code>{{ value, format }}</code> works as before. Without an <code>i18nKey</code>, the key derived from the children changes accordingly, from <code>Export as </code> to <code>Export as {{format}}</code>. i18next-cli serializes <code>Trans</code> children with react-i18next, so extracting with this version produces the same key. Thanks <a href="https://github.com/Pharex38"><code>@Pharex38</code></a> (<a href="https://redirect.github.com/i18next/react-i18next/pull/1944">#1944</a>).</li> </ul> <h2>17.1.7</h2> <ul> <li>fix(IcuTrans): each HTML entity in a translation is now decoded exactly once. Named, decimal and hexadecimal entities were decoded in three passes, and each pass decoded the output of the previous one, so an escaped numeric entity was decoded twice: <code>"Write &amp;[#169](https://github.com/i18next/react-i18next/issues/169); to get &[#169](https://github.com/i18next/react-i18next/issues/169);"</code> rendered <code>Write © to get ©</code> instead of <code>Write &[#169](https://github.com/i18next/react-i18next/issues/169); to get ©</code>, and <code>&amp;[#60](https://github.com/i18next/react-i18next/issues/60);</code> rendered <code><</code> instead of <code>&[#60](https://github.com/i18next/react-i18next/issues/60);</code>. This also hit interpolated values with <code>escapeValue: true</code>, where a value containing <code>&[#60](https://github.com/i18next/react-i18next/issues/60);</code> is escaped to <code>&amp;[#60](https://github.com/i18next/react-i18next/issues/60);</code>. Escaped named entities like <code>&amp;lt;</code> already stayed <code>&lt;</code>, as browsers and <code>Trans</code> decode them. Unknown named entities and entities above U+10FFFF still stay as written. Thanks <a href="https://github.com/Pharex38"><code>@Pharex38</code></a> (<a href="https://redirect.github.com/i18next/react-i18next/pull/1943">#1943</a>).</li> </ul> <h2>17.1.6</h2> <ul> <li>fix(Trans): a <code>count</code> passed in <code>tOptions</code> is now used. <code>Trans</code> spread <code>tOptions</code> and then set its own <code>count</code> prop, so a count only in <code>tOptions</code> was overwritten with <code>undefined</code>: <code><Trans i18nKey="items" tOptions={{ count: 5 }} /></code> rendered the key <code>items</code> instead of <code>5 items</code>, and with children <code>Trans</code> could pick the wrong plural form. Like <code>context</code>, <code>Trans</code> now falls back to <code>tOptions.count</code>, handled the same way as the <code>count</code> prop. A <code>count</code> prop, a count in the children or <code>values.count</code> still take precedence, and <code>tOptions</code> is not modified. Thanks <a href="https://github.com/nk-batman21"><code>@nk-batman21</code></a> (<a href="https://redirect.github.com/i18next/react-i18next/pull/1942">#1942</a>).</li> </ul> <h2>17.1.5</h2> <ul> <li>fix(Trans): with an array of keys and no children, <code>Trans</code> now falls back to the last key when none of them has a translation, as <code>t()</code> does. It used the array itself as <code>defaultValue</code>, which i18next handles as an object, so <code><Trans i18nKey={['notifications.crm_item_created', 'crm_item_created']} components={[<strong />]} /></code> rendered <code>key 'crm_item_created (en)' returned an object instead of string.</code> instead of <code>crm_item_created</code>. An array of selectors falls back to the key of the last selector. The first key that has a translation still wins, and <code>children</code>, <code>defaults</code> and <code>tOptions.defaultValue</code> are used as before. With <code>saveMissing</code>, these calls now report the missing key, like a single <code>i18nKey</code> does. Thanks <a href="https://github.com/nk-batman21"><code>@nk-batman21</code></a> (<a href="https://redirect.github.com/i18next/react-i18next/pull/1941">#1941</a>).</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/i18next/react-i18next/commit/3f0880e218f7d1235f474faf1d695d0fbde94a48"><code>3f0880e</code></a> 17.1.8</li> <li><a href="https://github.com/i18next/react-i18next/commit/9802f17e3921028ec2f582284b8dc344d4cd8f4d"><code>9802f17</code></a> build</li> <li><a href="https://github.com/i18next/react-i18next/commit/fb5fa17ea9be7b6bcc9990064f99aacb81eaa753"><code>fb5fa17</code></a> changelog for 17.1.8</li> <li><a href="https://github.com/i18next/react-i18next/commit/63f4e41dda4cb42e03edde5611f44018620bdc62"><code>63f4e41</code></a> fix(Trans): don't drop an interpolation variable named format (<a href="https://redirect.github.com/i18next/react-i18next/issues/1944">#1944</a>)</li> <li><a href="https://github.com/i18next/react-i18next/commit/8655c0f679d4ec8002a2db1c5ad4d447a973d115"><code>8655c0f</code></a> 17.1.7</li> <li><a href="https://github.com/i18next/react-i18next/commit/5e2cf4ac622c282572bce4a4cfef1324fb763365"><code>5e2cf4a</code></a> build</li> <li><a href="https://github.com/i18next/react-i18next/commit/4745dc626e14b55095e5f7ac5684859de6dfcd9b"><code>4745dc6</code></a> changelog for 17.1.7</li> <li><a href="https://github.com/i18next/react-i18next/commit/b708a76aedb44484b4fde924ad9e1630adfcbcc1"><code>b708a76</code></a> fix(IcuTrans): decode each HTML entity only once (<a href="https://redirect.github.com/i18next/react-i18next/issues/1943">#1943</a>)</li> <li><a href="https://github.com/i18next/react-i18next/commit/a8626e0470cdb627a6af420c67ac03a59ae9aff8"><code>a8626e0</code></a> 17.1.6</li> <li><a href="https://github.com/i18next/react-i18next/commit/c0cafdf3f4a8b174e05ea999de0b4fe1fb55ec91"><code>c0cafdf</code></a> build</li> <li>Additional commits viewable in <a href="https://github.com/i18next/react-i18next/compare/v17.1.4...v17.1.8">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 show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </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:8000 ghcr.io/maplibre/maputnik:main
To see the CLI options (for example file watching or style serving) run:
docker run -it --rm -p 8888:8000 ghcr.io/maplibre/maputnik:main --help
You might need to mount a volume (-v) to be able to use these options.
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
End-to-end tests
For E2E testing we use Playwright. The tests live in the e2e directory and drive the app through the MaputnikDriver page object.
The first time you run the tests, install the browser:
npx playwright install chromium
Playwright automatically starts the dev server (npm run start) for you, so you can just run:
npm run test
Some useful options:
# see the tests run in a headed browser
npm run test -- --headed
# run a single spec / filter by title
npm run test -- e2e/map.spec.ts
npm run test -- -g "zoom level"
# open the interactive UI mode
npx playwright test --ui
Running the E2E tests also produces a code-coverage report in coverage/ (collected via istanbul instrumentation of the dev server).
Unit & component tests
Unit tests and component tests run with Vitest; component tests (*.browser.test.tsx) use Vitest's browser mode with the Playwright provider.
npm run test-unit
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.