Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 2.91 KB

README.md

File metadata and controls

85 lines (57 loc) · 2.91 KB
Raw

gleojson

Package Version Hex Docs

gleojson is a comprehensive GeoJSON parsing and encoding library for Gleam, following the RFC 7946 specification. It provides robust types and utility functions to seamlessly encode and decode GeoJSON objects such as Points, LineStrings, Polygons, and more.

Note: This package is currently in development and has not reached version 1.0.0 yet. The API is considered unstable and may undergo breaking changes in future releases. Please use with caution in production environments and expect potential updates that might require code changes.

Features

  • Full support for all GeoJSON object types: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature, and FeatureCollection
  • Flexible encoding and decoding of GeoJSON objects
  • Custom property support for Feature and FeatureCollection objects
  • Type-safe representation of GeoJSON structures

Current Limitations

While gleojson aims to fully implement the GeoJSON specification (RFC 7946), some features are still under development. Key areas for future improvement include:

  1. Coordinate validation
  2. Antimeridian and pole handling
  3. Bounding box support
  4. Right-hand rule enforcement for polygon orientation
  5. GeometryCollection usage recommendations

Despite these limitations, gleojson is fully functional for most common GeoJSON use cases.

Installation

Add gleojson to your Gleam project:

gleam add gleojson

Usage

Here's a basic example of how to use gleojson:

import gleojson
import gleam/json
import gleam/option
import gleam/io

pub fn main() {
  // Create a Point geometry
  let point = gleojson.Point(gleojson.position_2d(lon: 125.6, lat: 10.1))

  // Create a Feature with the Point geometry
  let feature = gleojson.Feature(
    geometry: option.Some(point),
    properties: option.None,
    id: option.Some(gleojson.StringId("example-point"))
  )

  // Encode the Feature to GeoJSON
  let encoded = gleojson.encode_geojson(feature, gleojson.properties_null_encoder)

  // Print the encoded GeoJSON
  io.println(json.to_string(encoded))
}

For more advanced usage, including custom properties and decoding, see the documentation.

Development

To build and test the project:

gleam build
gleam test

Contributing

Contributions to gleojson are welcome! Please feel free to submit a Pull Request. Before contributing, please review our contribution guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Please see the NOTICE file for information about third party components and the use of AI assistance in this project.