docs: document leaflet_options.js config and remove dead baselayer#488
Conversation
) Add comprehensive JSDoc for the leafletOptions export and its internal functions. Remove the unused baselayer property (duplicated layer, never referenced in production code). Migrate test references to layer[0]. Add README section on customizing tile layers and overlays for self-hosters. Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Improves OSRM Frontend configurability documentation by adding detailed inline docs for src/leaflet_options.js, removing the unused baselayer export in favor of the canonical layer structure, and updating developer-facing docs/tests to match (addressing #179).
Changes:
- Added comprehensive JSDoc for
src/leaflet_options.jsconfig surface and helper functions, including runtime env var documentation. - Removed the dead
baselayerexport and migrated tests to referencelayer[0][<Display Name>]. - Expanded
README.mdwith a “Customizing Tile Layers and Overlays” section and updated backend configuration guidance.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/leaflet_options.js |
Adds extensive JSDoc, documents runtime env vars, and removes the unused baselayer export. |
test/leaflet_options.test.js |
Updates assertions to use leafletOptions.layer[0][...] after baselayer removal. |
README.md |
Documents base layers/overlays customization and clarifies backend configuration guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| function getDefaultLayer() { | ||
| return config.OSRM_DEFAULT_LAYER || 'streets'; | ||
| } |
There was a problem hiding this comment.
Fixed: Updated the JSDoc to accurately describe that this function only returns the configured value or 'streets' when unset. Key validation (and fallback for unrecognized values) happens at the call site via layerMap[getDefaultLayer()] || streets.
| * 1. `OSRM_MODES` — preferred JSON array of `{name, url, path?, profile?}` objects. | ||
| * Also accepts a plain array of URL strings (auto-named "Mode 1", "Mode 2", …). | ||
| * 2. `OSRM_BACKEND` — **deprecated** single-backend string. Emits a console warning. | ||
| * 3. Environment defaults — three public profiles (driving, bike, foot) in dev mode; | ||
| * same three profiles in Docker mode when neither env var is set. |
There was a problem hiding this comment.
Fixed: parseModes() now honors an explicit mode.profile when provided. When not specified, it falls back to positional assignment (index 0 to driving, 1 to bike, 2 to foot). The JSDoc has also been updated to document this fallback behavior.
| * | ||
| * | Variable | Default | Description | | ||
| * |------------------------|----------------------------------|-------------| | ||
| * | `OSRM_MODES` | (public OSRM services) | JSON array of `{name, url, path?, profile?}` routing backends. | |
There was a problem hiding this comment.
Fixed: The module-level table now reads 'profile defaults by position (driving → bike → foot)' and the code now honors an explicit when provided.
Honor explicit profile field in OSRM_MODES entries, falling back to positional assignment. Fix getDefaultLayer() JSDoc to not claim validation that this function does not perform.
Summary
Fixes #179 — the configuration options in
src/leaflet_options.jshave been undocumented for years, causing confusion aboutlayervsbaselayer, how to set the default tile layer, what overlays do, and how services work.Changes
src/leaflet_options.jsbaselayerproperty — it duplicatedlayerand was never referenced in production code (only in tests)mode.profileinparseModes()— falls back to positional assignment (driving → bike → foot) when not specifiedtest/leaflet_options.test.jsbaselayer.*references tolayer[0]['DisplayName']— same assertions, same coverageREADME.mdOSRM_MODESVerification
AI assistance: Claude helped draft the JSDoc, README content, and test migration. All changes were reviewed and verified by a human.