[//]: # (dependabot-start) ⚠️ **Dependabot is rebasing this PR** ⚠️ Rebasing might not happen immediately, so don't worry if this takes some time. Note: if you make any changes to this PR yourself, they will take precedence over the rebase. --- [//]: # (dependabot-end) Bumps [i18next](https://github.com/i18next/i18next) from 26.4.7 to 26.5.2. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/i18next/i18next/releases">i18next's releases</a>.</em></p> <blockquote> <h2>v26.5.2</h2> <ul> <li>fix(types): on TypeScript 7, a <code>t()</code> call with a missing, misspelled or wrongly typed option now reports that option again (<code>Property 'album' is missing</code>, <code>Type 'string' is not assignable to type 'number'</code>), as TypeScript 5 and 6 do. TypeScript 7 elaborated the error against the default-value signature instead and ended in <code>'{ count: 3; albm: "Summer"; }' is not assignable to type 'string'</code>: on a failed call TypeScript explains the last of the equally matching signatures, and TypeScript 7 sorts the 3-element <code>[key, defaultValue, options?]</code> last. It is now written as two signatures, <code>[key, defaultValue]</code> and <code>[key, defaultValue, options]</code>. This affects the default key checks with i18next <code>{{name}}</code> messages as well as <code>parseInterpolation: 'icu'</code> and <code>'mf2'</code>. Which calls compile, their return types and the error positions are unchanged on TypeScript 5.9, 6 and 7.</li> </ul> <h2>v26.5.1</h2> <ul> <li>perf(types): type-checking <code>t()</code> calls against a large namespace is no longer quadratic in the number of keys. TypeScript does not cache <code>keyof</code> of an object type, and the types rebuilt the union of all keys of a namespace once per key while building the key union, and again in every <code>t()</code> call to look up the return type. Both now use a cached key union, and a literal key is looked up directly instead of being intersected with every key. With 5,000 keys in one namespace and one call per key, the check time went from 14.8s to 1.1s (TypeScript 6); with 1,000 keys from 0.75s to 0.27s. Keys, return types and errors are unchanged.</li> <li>perf(types): the selector API (<code>enableSelector: true</code> / <code>'strict'</code>) with <code>context</code> is no longer quadratic in the size of an object. To decide which keys a context keeps, the types scanned all keys of the object once for every key, also when TypeScript checks the selector with <code>context</code> widened to <code>string</code>. With 1,000 keys plus one context variant each, a namespace took 18.7s and failed with "Type instantiation is excessively deep and possibly infinite" (TS2589); 2,500 and more ran out of memory. The context variants of an object are now collected once, in one pass over its keys: 1,000 keys check in 0.69s, 5,000 in 3.1s. Long keys (whole sentences with <code>keySeparator: false</code>) work as before. Selected values and errors are unchanged.</li> </ul> <h2>v26.5.0</h2> <ul> <li>feat(types): <code>parseInterpolation: 'icu'</code> and <code>parseInterpolation: 'mf2'</code> type <code>t()</code> options from the message's ICU MessageFormat arguments (i18next-icu) or MessageFormat 2 variables (i18next-mf2), so ICU and MF2 users no longer need <code>parseInterpolation: false</code> and lose argument checking. Missing, misspelled and wrongly typed arguments fail, and so does leaving out the options for a message with arguments (<code>t('greeting')</code>); that error names the missing arguments. Opt-in, default <code>true</code> is unchanged. <ul> <li>ICU: <code>{name}</code> takes <code>string | number</code>, <code>{n, number}</code>, <code>plural</code> and <code>selectordinal</code> take <code>number</code>, <code>{d, date}</code> and <code>{t, time}</code> take <code>Date</code>, <code>select</code> takes its case keys or any string (for <code>other</code>), and arguments nested in cases are required too. <code>#</code> and tags are not arguments, apostrophe quoting is read like intl-messageformat does.</li> <li>MF2: <code>{$name}</code> takes <code>string | number</code>, a variable annotated with <code>:number</code>, <code>:integer</code>, <code>:currency</code>, <code>:percent</code> or <code>:unit</code> (inline or through <code>.input</code> / <code>.local</code>) takes <code>number</code>, <code>:datetime</code>, <code>:date</code> and <code>:time</code> take <code>Date</code>, <code>:string</code> takes <code>string</code>, option and markup variables (<code>minimumFractionDigits=$digits</code>, <code>{#link href=$url}</code>) are required too, <code>.local</code> variables are not arguments, and <code>|quoted literals|</code> and <code>\{</code> escapes are skipped.</li> <li><code>interpolationFormatTypeMap</code> overrides a type by ICU format or MF2 function name, e.g. <code>date: Date | number</code> or a custom <code>uppercase: string</code>.</li> <li>Applies to <code>t()</code>, <code>getFixedT()</code>, <code>i18n.t</code>, key prefixes, namespaces, the selector API and react-i18next's <code>Trans</code> <code>values</code>. Messages need literal types, as the resources file from i18next-cli's <code>types</code> command has them.</li> <li>Type-check cost with 1,000 messages and one call each: 1.35s instead of 0.86s with <code>false</code> (TypeScript 6), 0.5s instead of 0.26s with TypeScript 7. Messages that no call uses cost nothing.</li> </ul> </li> <li>fix(types): with the default (non-strict) key checks, an options object with a missing or misspelled interpolation variable now reports the missing variable (<code>Property 'name' is missing</code>) instead of <code>'{ nmae: string }' is not assignable to type 'string'</code> from the default-value overload.</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/i18next/i18next/blob/master/CHANGELOG.md">i18next's changelog</a>.</em></p> <blockquote> <h2>26.5.2</h2> <ul> <li>fix(types): on TypeScript 7, a <code>t()</code> call with a missing, misspelled or wrongly typed option now reports that option again (<code>Property 'album' is missing</code>, <code>Type 'string' is not assignable to type 'number'</code>), as TypeScript 5 and 6 do. TypeScript 7 elaborated the error against the default-value signature instead and ended in <code>'{ count: 3; albm: "Summer"; }' is not assignable to type 'string'</code>: on a failed call TypeScript explains the last of the equally matching signatures, and TypeScript 7 sorts the 3-element <code>[key, defaultValue, options?]</code> last. It is now written as two signatures, <code>[key, defaultValue]</code> and <code>[key, defaultValue, options]</code>. This affects the default key checks with i18next <code>{{name}}</code> messages as well as <code>parseInterpolation: 'icu'</code> and <code>'mf2'</code>. Which calls compile, their return types and the error positions are unchanged on TypeScript 5.9, 6 and 7.</li> </ul> <h2>26.5.1</h2> <ul> <li>perf(types): type-checking <code>t()</code> calls against a large namespace is no longer quadratic in the number of keys. TypeScript does not cache <code>keyof</code> of an object type, and the types rebuilt the union of all keys of a namespace once per key while building the key union, and again in every <code>t()</code> call to look up the return type. Both now use a cached key union, and a literal key is looked up directly instead of being intersected with every key. With 5,000 keys in one namespace and one call per key, the check time went from 14.8s to 1.1s (TypeScript 6); with 1,000 keys from 0.75s to 0.27s. Keys, return types and errors are unchanged.</li> <li>perf(types): the selector API (<code>enableSelector: true</code> / <code>'strict'</code>) with <code>context</code> is no longer quadratic in the size of an object. To decide which keys a context keeps, the types scanned all keys of the object once for every key, also when TypeScript checks the selector with <code>context</code> widened to <code>string</code>. With 1,000 keys plus one context variant each, a namespace took 18.7s and failed with "Type instantiation is excessively deep and possibly infinite" (TS2589); 2,500 and more ran out of memory. The context variants of an object are now collected once, in one pass over its keys: 1,000 keys check in 0.69s, 5,000 in 3.1s. Long keys (whole sentences with <code>keySeparator: false</code>) work as before. Selected values and errors are unchanged.</li> </ul> <h2>26.5.0</h2> <ul> <li>feat(types): <code>parseInterpolation: 'icu'</code> and <code>parseInterpolation: 'mf2'</code> type <code>t()</code> options from the message's ICU MessageFormat arguments (i18next-icu) or MessageFormat 2 variables (i18next-mf2), so ICU and MF2 users no longer need <code>parseInterpolation: false</code> and lose argument checking. Missing, misspelled and wrongly typed arguments fail, and so does leaving out the options for a message with arguments (<code>t('greeting')</code>); that error names the missing arguments. Opt-in, default <code>true</code> is unchanged. <ul> <li>ICU: <code>{name}</code> takes <code>string | number</code>, <code>{n, number}</code>, <code>plural</code> and <code>selectordinal</code> take <code>number</code>, <code>{d, date}</code> and <code>{t, time}</code> take <code>Date</code>, <code>select</code> takes its case keys or any string (for <code>other</code>), and arguments nested in cases are required too. <code>#</code> and tags are not arguments, apostrophe quoting is read like intl-messageformat does.</li> <li>MF2: <code>{$name}</code> takes <code>string | number</code>, a variable annotated with <code>:number</code>, <code>:integer</code>, <code>:currency</code>, <code>:percent</code> or <code>:unit</code> (inline or through <code>.input</code> / <code>.local</code>) takes <code>number</code>, <code>:datetime</code>, <code>:date</code> and <code>:time</code> take <code>Date</code>, <code>:string</code> takes <code>string</code>, option and markup variables (<code>minimumFractionDigits=$digits</code>, <code>{#link href=$url}</code>) are required too, <code>.local</code> variables are not arguments, and <code>|quoted literals|</code> and <code>\{</code> escapes are skipped.</li> <li><code>interpolationFormatTypeMap</code> overrides a type by ICU format or MF2 function name, e.g. <code>date: Date | number</code> or a custom <code>uppercase: string</code>.</li> <li>Applies to <code>t()</code>, <code>getFixedT()</code>, <code>i18n.t</code>, key prefixes, namespaces, the selector API and react-i18next's <code>Trans</code> <code>values</code>. Messages need literal types, as the resources file from i18next-cli's <code>types</code> command has them.</li> <li>Type-check cost with 1,000 messages and one call each: 1.35s instead of 0.86s with <code>false</code> (TypeScript 6), 0.5s instead of 0.26s with TypeScript 7. Messages that no call uses cost nothing.</li> </ul> </li> <li>fix(types): with the default (non-strict) key checks, an options object with a missing or misspelled interpolation variable now reports the missing variable (<code>Property 'name' is missing</code>) instead of <code>'{ nmae: string }' is not assignable to type 'string'</code> from the default-value overload.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/i18next/i18next/commit/c46ea5c301c049d17e47412b1b64a94b54c1bb97"><code>c46ea5c</code></a> 26.5.2</li> <li><a href="https://github.com/i18next/i18next/commit/d798f0e703d49770f4016deb483945eecd3e59f3"><code>d798f0e</code></a> fix(types): report the wrong t() option on TypeScript 7</li> <li><a href="https://github.com/i18next/i18next/commit/dabd9f60d849d66936baca4adbca7e349f459069"><code>dabd9f6</code></a> 26.5.1</li> <li><a href="https://github.com/i18next/i18next/commit/01c3852d941d2dad503ff477755e0c489f3d75ee"><code>01c3852</code></a> perf(types): no quadratic type-check time for large namespaces</li> <li><a href="https://github.com/i18next/i18next/commit/64b9da8bfd6d1e2a58eef23ed885b5ab60a412f1"><code>64b9da8</code></a> 26.5.0</li> <li><a href="https://github.com/i18next/i18next/commit/2468227c924204a6fafcf78ff615d7a232e9a07a"><code>2468227</code></a> feat(types): parseInterpolation 'icu' and 'mf2' type t() options from ICU arg...</li> <li>See full diff in <a href="https://github.com/i18next/i18next/compare/v26.4.7...v26.5.2">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 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: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.
