s2-tools
## About
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
## Install
```bash
# NPM
npm install s2-tools
# PNPM
pnpm add s2-tools
# Yarn
yarn add s2-tools
# Bun
bun add s2-tools
```
## Components
> 💡 **NOTE:** The sizes are estimates and can change based on how you use them. Click the module link for documentation and more precise guides on file cost.
### Converters
| Main Modules | Size | Description |
| ------------------------ | ----------------------------- | ---------------------------------------------------------------- |
| [toJSON] | ![To JSON Badge][toJSONBadge] | Convert any Reader to JSON data. |
| [toTiles] | ![FT Badge][toTilesBadge] | Convert any Reader to vector and/or raster tiles. |
[toJSON]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/converters/toJSON.md
[toJSONBadge]: https://deno.bundlejs.com/badge?q=s2-tools&treeshake=[{+toJSON,toJSONLD,BufferReader+}]
[toTiles]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/converters/toTiles.md
[toTilesBadge]: https://deno.bundlejs.com/badge?q=s2-tools&treeshake=[{+toTiles,BufferReader+}]
### Data Stores
| Main Modules | Size | Description |
| ------------------------ | ----------------------------- | ---------------------------------------------------------------- |
| [externalSort] | ![ES Badge][esBadge] | Sort large files with uint64 keys |
| [kv] | ![KV Badge][kvBadge] | Collection of tools using the filesystem to read and write data. |
| [multiMap] | ![MM Badge][mmBadge] | Collection of tools using the filesystem to read and write data. |
| [vector] | ![Vec Badge][vecBadge] | Collection of tools using the filesystem to read and write data. |
[externalSort]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/externalSort.md
[esBadge]: /assets/badges/external-sort-gzip-cover.svg
[kv]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/kv.md
[kvBadge]: /assets/badges/kv-gzip-cover.svg
[multiMap]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/multimap.md
[mmBadge]: /assets/badges/multimap-gzip-cover.svg
[vector]: https://github.com/Open-S2/s2-tools/tree/master/docs-ts/dataStores/vector.md
[vecBadge]: /assets/badges/vector-gzip-cover.svg
---
## Development
### Requirements
You need the tool `tarpaulin` to generate the coverage report. Install it using the following command:
```bash
cargo install cargo-tarpaulin
```
The `bacon coverage` tool is used to generate the coverage report. To utilize the [pycobertura](https://pypi.org/project/pycobertura/) package for a prettier coverage report, install it using the following command:
```bash
pip install pycobertura
```
### Running Tests
To run the tests, use the following command:
```bash
# TYPESCRIPT
## basic test
bun run test
## live testing
bun run test:dev
# RUST
## basic test
cargo test
# live testing
bacon test
```
### Generating Coverage Report
To generate the coverage report, use the following command:
```bash
cargo tarpaulin
# faster
cargo tarpaulin --color always --skip-clean
# bacon
bacon coverage # or type `l` inside the tool
```