Make CLI-only features optional #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nyurik
force-pushed
the
make-cli-optional
branch
from
59831e2
to
009e2e7
Compare
This greatly speeds up build for the users of the lib when CLI is not needed. Sorry forgot to include it in the previous round.
nyurik
force-pushed
the
make-cli-optional
branch
from
009e2e7
to
3bd9627
Compare
8 tasks
nyurik
added a commit
to maplibre/martin
that referenced
this pull request
Jun 16, 2023
Dynamically create image sprites for MapLibre rendering, given a directory with images. ### TODO * [x] Work with @flother to merge these PRs * [x] flother/spreet#59 (must have) * [x] flother/spreet#57 * [x] flother/spreet#56 * [ ] flother/spreet#62 (not required but nice to have, can upgrade later without any code changes) * [x] Add docs to the book * [x] Add CLI param, e.g. `--sprite <dir_path>` * [x] Don't output `.sprites` in auto-genned config when not in use ### API Per [MapLibre sprites API](https://maplibre.org/maplibre-style-spec/sprite/), we need to support the following: * `/sprite/<sprite_id>.json` metadata about the sprite file - all coming from a single directory * `/sprite/<sprite_id>.png` all images combined into a single PNG * `/sprite/<sprite_id>@2x.json` same but for high DPI devices * `/sprite/<sprite_id>@2x.png` Multiple sprite_id values can be combined into one sprite with the same pattern as for tile joining: `/sprite/<sprite_id1>,<sprite_id2>,...,<sprite_idN>[.json|.png|@2x.json|@2x.png]`. No ID renaming is done, so identical names will override one another. ### Configuration [Config file](https://maplibre.org/martin/config-file.html) and possibly CLI should have a simple option to serve sprites. The configuration may look similar to how mbtiles and pmtiles are configured: ```yaml # Publish sprite images sprites: paths: # scan this whole dir, matching all image files, and publishing it as "my_images" sprite source - /path/to/my_images sources: # named source matching source name to a directory my_sprites: /path/to/some_dir ``` Implement #705
flother
reviewed
Jun 16, 2023
There was a problem hiding this comment.
Just a small change required before this is merged (see suggestion below).
Besides that, it would be nice to add tests to check that Spreet still works with the CLI disabled. It doesn't seem like that's something Cargo supports particularly well, so my best idea is to mark existing tests as CLI-feature only, add tests to check use of Spreet as a library, and run cargo test --no-default-features during CI. I'm happy to try that out after this is merged, but if you have any better ideas let me know
Co-authored-by: Matt Riggott <flother@users.noreply.github.com>
|
Good point about the |
|
Thanks for your extra work in sorting out the tests. I've added a commit to add the docs you suggested on using the crate in I'll merge this now and flesh out the library-based tests in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This greatly speeds up build for the users of the lib when CLI is not needed. Sorry forgot to include it in the previous round.
spreet = { version = "...", default-features = false }assert_fsdependency seemed not to be needed by the primary code, only by the testsclifeature