mapbox / mapbox/mts-data-sync

Clarify commandline usage instructions & don't double process geosonl

Open
#5 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
71
Forks
15
PR merge metrics
No merged PRs in 30d

Description

Current output
```
mtsds --configure
Run mtsds with valid options:
--config filename.geojsonl,
--convert filename.geojsonl,
--sync,
--token,
or --estimate
```

Implies that the tool is looking for geojsonl as input for both `--config` and `--convert` steps. However, if I run `mtsds --config input.geojsonl` it then re-converts it, giving me `input.geojsonll`.

As a user with (most likely) a .geojson input file this is a bit confusing, esp if I haven't read the docs lately.

In summary:
- Usage should specify `.geojson` for `--config` step (and convert also?)
- [Feature Reuest] --config runs on both, only converts to geojsonl if needed (no `.geojsonll`)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported `mtsds --config input.geojson` behavior and inspect the command-line usage plus the `--config` and `--convert` handling. Done means the usage distinguishes `.geojson` and `.geojsonl` correctly and configuring an already suitable input does not create `input.geojsonll`; clarify whether `--convert` should accept both formats.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.