• Stars
    star
    253
  • Rank 160,776 (Top 4 %)
  • Language
    JavaScript
  • License
    ISC License
  • Created over 11 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

IMPORTANT: development of this project has been paused, see the README (Validate GeoJSON against the specification)

Build Status Coverage Status

geojsonhint: complete, fast, standards-based validation for geojson

Important: development of geojsonhint is currently paused. Until development restarts, please refrain from adding non-critical issues or PRs.

A lint tool for the GeoJSON standard. geojsonhint is written to the standard, with no missing or additional opinions about structure.

Thanks to jsonlint-lines, GeoJSON that is also not valid JSON can return informative, line-oriented parsing errors.

Specification

The basis of this tool is the published GeoJSON specification.

API

errors = geojsonhint.hint(string or object, options)

Lint a file, given as a string or object. This call detects all aberrations from the GeoJSON standards and returns them as an array of errors. An example of the output:

[{
  "message": "\"features\" property should be an array, but is an object instead",
  "line": 1
}]

The options argument is optional. It has these options:

noDuplicateMembers.

By default, geojsonhint will treat repeated properties as an error: you can set noDuplicateMembers to false to allow them. For instance:

geojsonhint.hint('{"type":"invalid","type":"Feature","properties":{},"geometry":null}', {
    noDuplicateMembers: false
});

The repeated type property in this input will be ignored with the option, and flagged without it.

precisionWarning.

GeoJSON now recommends six decimal places of accuracy for coordinates (Section 11.2). This option adds a warning message when coordinates contain over 6 decimal places of accuracy, up to 10 coordinates before the warning message is truncated for performance.

geojsonhint.hint('{ "type": "Point", "coordinates": [100.0000000001, 5.0000000001] }', {
    precisionWarning: false
});

With this option enabled, geojsonhint will produce these warnings:

[{
  line: 1,
  level: 'message',
  message: 'precision of coordinates should be reduced'
}, {
  line: 1,
  level: 'message',
  message: 'precision of coordinates should be reduced'
}]

Without this option, this input will pass without errors.

ignoreRightHandRule.

GeoJSON specification defined that linear rings must follow right-hand rule, but also says that for backward compatibility reasons parsers should not rejects polygons wiht incorrect winding order. For that kind of situations geojsonhint has an option ignoreRightHandRule which is false by default. Setting this option to true will cause geojsonhint to skip right-hand rule validation.

geojsonhint.hint(geojsonWithIncorrectWindingOrder, {
  ignoreRightHandRule: true
});

with this option enabled, geojsonhint will not validate winding order.

Line Numbers

Note that the GeoJSON can be given as a string or as an object. Here's how to choose which input to use:

  • string inputs receive line numbers for each error. These make errors easier to track down if the GeoJSON is hand-written.
  • object inputs don't have line numbers but are evaluated faster, by up to 10x. GeoJSONHint is very fast already so unless you have identified it as a bottleneck in your application, don't prematurely optimize based on this fact.

If you're really trying to save space and don't care about JSON validity errors - only GeoJSON errors - you can require('geojsonhint/lib/object') to get a version of this library that bypasses jsonlint-lines and provides only the object interface.

use it

npm (node.js, browserify, webpack, etc)

npm install --save @mapbox/geojsonhint

CDN / script tag

Hit this URL to resolve to the latest pinned version.

https://unpkg.com/@mapbox/geojsonhint@latest/geojsonhint.js

As a command-line utility

Install:

npm install -g @mapbox/geojsonhint
➟ geojsonhint
Usage: geojsonhint FILE.geojson

Options:
  --json  output json-formatted data for hints
➟ geojsonhint test.geojson
line 9, each element in a position must be a number

Development

  • Tests: npm test
  • Building the browser version: npm run build

See Also

More Repositories

1

mapbox-gl-js

Interactive, thoroughly customizable maps in the browser, powered by vector tiles and WebGL
JavaScript
10,264
star
2

pixelmatch

The smallest, simplest and fastest JavaScript pixel-level image comparison library
JavaScript
6,055
star
3

mapbox-gl-native

Interactive, thoroughly customizable maps in native Android, iOS, macOS, Node.js, and Qt applications, powered by vector tiles and OpenGL
C++
4,297
star
4

tippecanoe

Build vector tilesets from large collections of GeoJSON features.
C++
2,423
star
5

awesome-vector-tiles

Awesome implementations of the Mapbox Vector Tile specification
2,311
star
6

delaunator

An incredibly fast JavaScript library for Delaunay triangulation of 2D points
JavaScript
2,255
star
7

earcut

The fastest and smallest JavaScript polygon triangulation library for your WebGL apps
JavaScript
2,174
star
8

supercluster

A very fast geospatial point clustering library for browsers and Node.
JavaScript
2,061
star
9

robosat

Semantic segmentation on aerial and satellite imagery. Extracts features such as: buildings, parking lots, roads, water, clouds
Python
1,997
star
10

mapbox.js

Mapbox JavaScript API, a Leaflet Plugin
HTML
1,902
star
11

geojson.io

A quick, simple tool for creating, viewing, and sharing spatial data
JavaScript
1,740
star
12

geojson-vt

Slice GeoJSON into vector tiles on the fly in the browser
JavaScript
1,731
star
13

flamebearer

Blazing fast flame graph tool for V8 and Node πŸ”₯
JavaScript
1,634
star
14

maki

A POI Icon Set
JavaScript
1,475
star
15

polylabel

A fast algorithm for finding the pole of inaccessibility of a polygon (in JavaScript and C++)
C++
1,312
star
16

togeojson

convert KML and GPX to GeoJSON, without the fuss
JavaScript
1,185
star
17

mapbox-studio-classic

JavaScript
1,136
star
18

node-pre-gyp

Node.js tool for easy binary deployment of C++ addons
JavaScript
1,071
star
19

webgl-wind

Wind power visualization with WebGL particles
JavaScript
943
star
20

geobuf

A compact binary encoding for geographic data.
JavaScript
917
star
21

mapbox-navigation-ios

Turn-by-turn navigation logic and UI in Swift on iOS
Swift
861
star
22

earcut.hpp

Fast, header-only polygon triangulation
C
850
star
23

mapbox-gl-draw

Draw tools for mapbox-gl-js
JavaScript
827
star
24

Fingertips

Touch indicators on external displays for iOS applications.
Swift
809
star
25

XcodeClangFormat

Format code in Xcode 8+ with clang-format
Objective-C++
808
star
26

vector-tile-spec

Mapbox Vector Tile specification
805
star
27

pbf

A low-level, lightweight protocol buffers implementation in JavaScript.
JavaScript
746
star
28

mapbox-android-demo

Google Play demo app for the Mapbox Maps SDK for Android
Java
704
star
29

mbutil

Importer and Exporter of MBTiles
Python
694
star
30

osm-bright

A Carto template for OpenStreetMap data
CartoCSS
690
star
31

mapbox-unity-sdk

Mapbox Unity SDK - https://www.mapbox.com/unity/
C#
677
star
32

mapboxgl-jupyter

Use Mapbox GL JS to visualize data in a Python Jupyter notebook
Python
661
star
33

carto

fast CSS-like map stylesheets
JavaScript
653
star
34

mapbox-sdk-js

A JavaScript client to Mapbox services, supporting Node, browsers, and React Native
JavaScript
652
star
35

concaveman

A very fast 2D concave hull algorithm in JavaScript
JavaScript
640
star
36

leaflet-omnivore

universal format parser for Leaflet & Mapbox.js
JavaScript
625
star
37

mapbox-react-examples

Example patterns for building React apps with Mapbox GL JS
JavaScript
615
star
38

martini

A JavaScript library for real-time RTIN terrain mesh generation
JavaScript
609
star
39

polyline

polyline encoding and decoding in javascript
JavaScript
604
star
40

mapbox-navigation-android

Mapbox Navigation SDK for Android
Kotlin
572
star
41

mbtiles-spec

specification documents for the MBTiles tileset format
569
star
42

tiny-sdf

Browser-side SDF font generator
HTML
562
star
43

mapnik-vector-tile

Mapnik implemention of Mapbox Vector Tile specification
C++
546
star
44

storytelling

Storytelling with maps template
HTML
541
star
45

mapbox-gl-leaflet

binding from Mapbox GL JS to the Leaflet API
JavaScript
518
star
46

tilelive

fast interface to tiles with pluggable backends - NOT ACTIVELY MAINTAINED
JavaScript
514
star
47

cheap-ruler

Fast approximations for common geodesic measurements 🌐
JavaScript
416
star
48

mapbox-java

The Mapbox Java SDK – Java wrappers around Mapbox APIs and other location data
Java
403
star
49

jni.hpp

A modern, type-safe, header-only, C++14 wrapper for JNI
C++
388
star
50

mercantile

Spherical mercator tile and coordinate utilities
Python
381
star
51

mapbox-maps-android

Interactive, thoroughly customizable maps in native Android powered by vector tiles and OpenGL.
Kotlin
368
star
52

variant

C++11/C++14 Variant
C++
365
star
53

leaflet-image

leaflet maps to images
JavaScript
360
star
54

mapbox-gl-geocoder

Geocoder control for mapbox-gl-js using Mapbox Geocoding API
JavaScript
357
star
55

mbview

View mbtiles locally
EJS
353
star
56

csv2geojson

magically convert csv files to geojson files
JavaScript
353
star
57

mbxmapkit

DEPRECATED - Lightweight Mapbox integration with MapKit on iOS
Objective-C
336
star
58

DEPRECATED-mapbox-ios-sdk

REPLACED – use https://www.mapbox.com/ios-sdk instead
Objective-C
325
star
59

mapbox-sdk-py

Python SDK for Mapbox APIs **DEVELOPMENT IS TEMPORARILY PAUSED, SEE CONTRIBUTING.md**
Python
319
star
60

potpack

A tiny rectangle packing JavaScript library (for sprite layouts)
JavaScript
314
star
61

mapbox-maps-ios

Interactive, thoroughly customizable maps for iOS powered by vector tiles and Metal
Swift
313
star
62

vector-tile-js

Parses vector tiles with JavaScript
JavaScript
308
star
63

node-mbtiles

mbtiles utility, renderer, and storage backend for tilelive
JavaScript
285
star
64

mapbox-maps-flutter

Interactive, thoroughly customizable maps for Flutter powered by Mapbox Maps SDK
Swift
282
star
65

mapbox-ar-unity

DEPRECATED! A place to create/learn with Unity, ARKit/ARCore, and Mapbox!
C#
279
star
66

geo-googledocs

Tools to integrate Mapbox with Google Docs
JavaScript
276
star
67

delatin

A fast JavaScript terrain mesh generation tool based on Delaunay triangulation
JavaScript
273
star
68

hubdb

a github-powered database
JavaScript
272
star
69

flutter-mapbox-gl

Moved to https://github.com/tobrun/flutter-mapbox-gl
Java
271
star
70

mapbox-gl-styles

Prebuilt Mapbox GL styles for use in Mapbox GL JS or the Mapbox Mobile SDKs and as a starting point for custom maps built with Mapbox Studio
JavaScript
268
star
71

simplestyle-spec

A simple styling convention for GeoJSON data
266
star
72

postgis-vt-util

postgres helper functions for making vector tiles
PLpgSQL
265
star
73

gzip-hpp

Gzip header-only C++ library
C++
265
star
74

protozero

Minimalist protocol buffer decoder and encoder in C++
C++
261
star
75

sphericalmercator

Spherical Mercator math in Javascript
JavaScript
259
star
76

shp-write

create and write to shapefiles in pure javascript
JavaScript
254
star
77

mason

Cross platform package manager for C/C++ apps
Python
252
star
78

wellknown

GeoJSON-emitting WKT parser for browsers and node
JavaScript
249
star
79

Hecate

Fast Geospatial Feature Storage API
Rust
247
star
80

pyskel

Skeleton of a Python package
Python
243
star
81

mapbox-plugins-android

Mapbox Android Plugins are a collection of libraries that extend our other SDKs, helping you design powerful mapping features while the plugins handle most of the heavy lifting.
Java
240
star
82

mapbox-gl-directions

Directions plugin for mapbox-gl-js using Mapbox Directions API.
JavaScript
236
star
83

tilejson-spec

JSON format for describing map tilesets.
234
star
84

mapping

OpenStreetMap contributions from the data team at Mapbox
JavaScript
233
star
85

tilebelt

simple tile utilities
JavaScript
230
star
86

geojson-merge

Merge multiple GeoJSON files into one FeatureCollection.
JavaScript
229
star
87

mapbox-arkit-ios

Utilities for combining Mapbox maps and location services with ARKit in your applications.
Swift
224
star
88

mapbox-scenekit

Swift
224
star
89

react-native-mapbox-ar

Location based augmented reality components using React Native, Viro and Mapbox
Objective-C
221
star
90

mapbox-gl-native-android

Interactive, thoroughly customizable maps in native Android powered by vector tiles and OpenGL
Java
211
star
91

mapbox-gl-native-ios

Interactive, thoroughly customizable maps for iOS powered by vector tiles and OpenGL
Objective-C++
211
star
92

Simple-KML

Simple KML is a simple & lightweight parsing library for KML written in Objective-C for the iOS platform.
Objective-C
208
star
93

turf-swift

A Swift language port of Turf.js.
Swift
205
star
94

react-colorpickr

A themeable colorpicker with HSL and RGB support for React
TypeScript
205
star
95

eternal

A C++14 compile-time/constexpr map and hash map with minimal binary footprint
C++
201
star
96

node-fontnik

Fonts β‡’ protobuf-encoded SDF glyphs
JavaScript
201
star
97

ecs-watchbot

Make robots do your work for you
JavaScript
194
star
98

leaflet-pip

point in polygon intersections for leaflet
JavaScript
194
star
99

tile-cover

Generate the minimum number of tiles to cover a geojson geometry
JavaScript
183
star
100

MapboxStatic.swift

Static map snapshots with overlays in Swift or Objective-C on iOS, macOS, tvOS, and watchOS
Swift
183
star