mirror of
https://github.com/maputnik/editor.git
synced 2026-10-14 06:53:45 +00:00
dependabot[bot]
f0ed53c4e5
Bumps [i18next-cli](https://github.com/i18next/i18next-cli) from 1.74.7 to 1.75.2. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/i18next/i18next-cli/blob/main/CHANGELOG.md">i18next-cli's changelog</a>.</em></p> <blockquote> <h2>1.75.2</h2> <ul> <li>fix(extract): declarations with the same name in different files no longer overwrite each other. Two generated OpenAPI clients that both export <code>components</code> resolved to whichever file was read first, so <code>import { components as githubComponents } from './github-api'</code> and <code>import { components as digitalOceanComponents } from './digital-ocean-api'</code> extracted the keys of only one of them, and moving files around changed which. A name now resolves to the module the file imports it from, for renamed and plain imports, namespace imports (<code>GH.components</code>), <code>.js</code> import specifiers and tsconfig <code>paths</code> aliases. Imports that cannot be traced to a scanned file (packages, re-exporting barrels) still resolve by name as before. Fixes <a href="https://redirect.github.com/i18next/i18next-cli/issues/306">#306</a>.</li> </ul> <h2>1.75.1</h2> <ul> <li>fix(extract): types and values read through a namespace import resolve like named imports. With <code>import * as Types from './types'</code>, a qualified type (<code>(color: Types.Color) => …</code>, <code>x as Types.Color</code>, <code>FC<Types.Props></code>, <code>declare const s: Types.Status</code>) and a namespace member (<code>Types.SIZES.map(…)</code>, <code>Types.Status.Done</code>, <code>t(Types.LABELS.save)</code>, <code>Object.keys(Types.LABELS)</code>) now extract their keys, also for a namespace re-exported from a barrel (<code>export * as Shared from './types'</code>). Fixes <a href="https://redirect.github.com/i18next/i18next-cli/issues/305">#305</a>.</li> <li>fix(extract): an exported <code>as const</code> object resolves in the files that import it: <code>t(LABELS.save)</code> and <code>Object.keys(LABELS)</code> only worked in the declaring file before.</li> <li>fix(extract): a value typed <code>keyof typeof MAP</code> resolves to the map's keys, so <code>t(`label.${key}`)</code> with <code>declare const key: keyof typeof LABELS</code> extracts <code>label.save</code> and <code>label.cancel</code>. This branch never matched before.</li> </ul> <h2>1.75.0</h2> <ul> <li>feat(extract): new <code>extract.maxTypeDepth</code> option sets how many levels of nested object members are followed when a dynamic key reads a typed value (default: 5). Higher values cost time and memory on large recursive types such as OpenAPI schemas. Requested in <a href="https://redirect.github.com/i18next/i18next-cli/issues/302#issuecomment-6039348480">#302</a>.</li> <li>fix(extract): the depth now counts from the type an indexed access picks instead of from the declared wrapper type. <code>type Pet = components['schemas']['Pet']</code> gets the full depth below <code>Pet</code>, where the <code>components</code>/<code>schemas</code> wrapper used to take two of the five levels.</li> <li>fix(extract): numeric keys resolve in object types and indexed access types, so openapi-typescript response types work: <code>operations['getPet']['responses'][200]['content']['application/json']</code> and <code>op.responses[200].content['application/json'].status</code> resolved nothing before.</li> </ul> <h2>1.74.8</h2> <ul> <li>fix(extract): a commented template literal no longer extracts its placeholder as a key. <code>// t(`QUARTER.${q}`)</code> extracted <code>QUARTER.${q}</code> and <code>// t(`status.${deepObject.status}`)</code> extracted <code>status.${deepObject.status}</code>. Such a comment now keeps the existing keys it matches (<code>QUARTER.1</code>, <code>QUARTER.2</code>, …) even with <code>removeUnusedKeys</code>, the way a commented static key keeps its key, while code can still add new matching keys. A pattern without any static part (<code>`${a}.${b}`</code>) is ignored. Fixes <a href="https://redirect.github.com/i18next/i18next-cli/issues/304">#304</a>.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/i18next/i18next-cli/commit/540b3beac7737ce066af47875be7f1dd360bd12c"><code>540b3be</code></a> 1.75.2</li> <li><a href="https://github.com/i18next/i18next-cli/commit/9cc03de706dc8990dc0c801240e1cfea33f7cf37"><code>9cc03de</code></a> fix(extract): resolve same-named declarations by the module they are imported...</li> <li><a href="https://github.com/i18next/i18next-cli/commit/dd21f26554aec73b9e2d5d2670ea9ecdc0ad1562"><code>dd21f26</code></a> 1.75.1</li> <li><a href="https://github.com/i18next/i18next-cli/commit/7c637a89b5e76a29e6e8f063e9901068d10449fa"><code>7c637a8</code></a> fix(extract): resolve types and values read through a namespace import <a href="https://redirect.github.com/i18next/i18next-cli/issues/305">#305</a></li> <li><a href="https://github.com/i18next/i18next-cli/commit/ef3ebc58cb1e55d2fbe2d1d418518c8f8b539dd9"><code>ef3ebc5</code></a> 1.75.0</li> <li><a href="https://github.com/i18next/i18next-cli/commit/33d47ac8d6b8fc2429745a9f43036fea83f4b7ac"><code>33d47ac</code></a> feat(extract): add maxTypeDepth, count it from the indexed type, resolve nume...</li> <li><a href="https://github.com/i18next/i18next-cli/commit/747d5e91bc31f866f6bd2048b8efecd4ac8389b4"><code>747d5e9</code></a> 1.74.8</li> <li><a href="https://github.com/i18next/i18next-cli/commit/a8246695cf1306ff1e7cbf69f62b4941c053bd44"><code>a824669</code></a> fix(extract): keep the keys a commented template literal matches instead of e...</li> <li>See full diff in <a href="https://github.com/i18next/i18next-cli/compare/v1.74.7...v1.75.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.