mirror of
https://github.com/maputnik/editor.git
synced 2026-03-04 01:10:02 +00:00
800bc95cb7
Bumps [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) from 0.4.26 to 0.5.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/ArnaudBarre/eslint-plugin-react-refresh/releases">eslint-plugin-react-refresh's releases</a>.</em></p> <blockquote> <h2>v0.5.0</h2> <h3>Breaking changes</h3> <ul> <li>The package now ships as ESM and requires ESLint 9 + node 20. Because legacy config doesn't support ESM, this requires to use <a href="https://eslint.org/docs/latest/use/configure/migration-guide">flat config</a></li> <li>A new <code>reactRefresh</code> export is available and prefered over the default export. It's an object with two properties: <ul> <li><code>plugin</code>: The plugin object with the rules</li> <li><code>configs</code>: An object containing configuration presets, each exposed as a function. These functions accept your custom options, merge them with sensible defaults for that config, and return the final config object.</li> </ul> </li> <li><code>customHOCs</code> option was renamed to <code>extraHOCs</code></li> <li>Validation of HOCs calls is now more strict, you may need to add some HOCs to the <code>extraHOCs</code> option</li> </ul> <p>Config example:</p> <pre lang="js"><code>import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; <p>export default defineConfig( /* Main config */ reactRefresh.configs.vite({ extraHOCs: ["someLibHOC"] }), ); </code></pre></p> <p>Config example without config:</p> <pre lang="js"><code>import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; <p>export default defineConfig({ files: ["<strong>/*.ts", "</strong>/*.tsx"], plugins: { // other plugins "react-refresh": reactRefresh.plugin, }, rules: { // other rules "react-refresh/only-export-components": [ "warn", { extraHOCs: ["someLibHOC"] }, ], }, }); </code></pre></p> <h3>Why</h3> <p>This version follows a revamp of the internal logic to better make the difference between random call expressions like <code>export const Enum = Object.keys(Record)</code> and actual React HOC calls like <code>export const MemoComponent = memo(Component)</code>. (fixes <a href="https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh/issues/93">#93</a>)</p> <p>The rule now handles ternaries and patterns like <code>export default customHOC(props)(Component)</code> which makes it able to correctly support files like <a href="ddfc624ce7/ui/src/routes/__root.tsx">this one</a> given this config:</p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/main/CHANGELOG.md">eslint-plugin-react-refresh's changelog</a>.</em></p> <blockquote> <h2>0.5.0</h2> <h3>Breaking changes</h3> <ul> <li>The package now ships as ESM and requires ESLint 9 + node 20. Because legacy config doesn't support ESM, this requires to use <a href="https://eslint.org/docs/latest/use/configure/migration-guide">flat config</a></li> <li>A new <code>reactRefresh</code> export is available and prefered over the default export. It's an object with two properties: <ul> <li><code>plugin</code>: The plugin object with the rules</li> <li><code>configs</code>: An object containing configuration presets, each exposed as a function. These functions accept your custom options, merge them with sensible defaults for that config, and return the final config object.</li> </ul> </li> <li><code>customHOCs</code> option was renamed to <code>extraHOCs</code></li> <li>Validation of HOCs calls is now more strict, you may need to add some HOCs to the <code>extraHOCs</code> option</li> </ul> <p>Config example:</p> <pre lang="js"><code>import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; <p>export default defineConfig( /* Main config */ reactRefresh.configs.vite({ extraHOCs: ["someLibHOC"] }), ); </code></pre></p> <p>Config example without config:</p> <pre lang="js"><code>import { defineConfig } from "eslint/config"; import { reactRefresh } from "eslint-plugin-react-refresh"; <p>export default defineConfig({ files: ["<strong>/*.ts", "</strong>/*.tsx"], plugins: { // other plugins "react-refresh": reactRefresh.plugin, }, rules: { // other rules "react-refresh/only-export-components": [ "warn", { extraHOCs: ["someLibHOC"] }, ], }, }); </code></pre></p> <h3>Why</h3> <p>This version follows a revamp of the internal logic to better make the difference between random call expressions like <code>export const Enum = Object.keys(Record)</code> and actual React HOC calls like <code>export const MemoComponent = memo(Component)</code>. (fixes <a href="https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh/issues/93">#93</a>)</p> <p>The rule now handles ternaries and patterns like <code>export default customHOC(props)(Component)</code> which makes it able to correctly support files like <a href="ddfc624ce7/ui/src/routes/__root.tsx">this one</a> given this config:</p> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="daa2efb2a2"><code>daa2efb</code></a> Revamp logic to catch more cases [publish] (<a href="https://redirect.github.com/ArnaudBarre/eslint-plugin-react-refresh/issues/97">#97</a>)</li> <li>See full diff in <a href="https://github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.4.26...v0.5.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 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
For E2E testing we use Cypress
Cypress doesn't start 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.