s2-tools

About

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

Install

# 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		Convert any Reader to JSON data.
toTiles		Convert any Reader to vector and/or raster tiles.

Data Stores

Main Modules	Size	Description
externalSort		Sort large files with uint64 keys
kv		Collection of tools using the filesystem to read and write data.
multiMap		Collection of tools using the filesystem to read and write data.
vector		Collection of tools using the filesystem to read and write data.

---

Development

Requirements

You need the tool tarpaulin to generate the coverage report. Install it using the following command:

cargo install cargo-tarpaulin

The bacon coverage tool is used to generate the coverage report. To utilize the pycobertura package for a prettier coverage report, install it using the following command:

pip install pycobertura

Running Tests

To run the tests, use the following command:

# 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:

cargo tarpaulin
# faster
cargo tarpaulin --color always --skip-clean
# bacon
bacon coverage # or type `l` inside the tool