id-geo

iD-geo - geo functions from iDEditor

ALPHA: see TODO

Overview

This packages up iD Editor iD.geo helper functions as an npm package to require() in your own projects.

Usage

npm install id-geo

var geo = require('id-geo');
 
var extent = new geo.Extent();

Why

According to https://github.com/openstreetmap/iD/blob/master/ARCHITECTURE.md#core

[iD] eventually aims to be a reusable, modular library to kickstart other JavaScript-based tools for OpenStreetMap.

The OSM data model is complex and hard to implement. iD is not published on npm and importing the whole iD project is excessive for a JavaScript based tool for OpenStreetMap. At Digital Democracy we are building tools on top of OSM, and borrowing from iD gives us a head start.

How

iD does not use a commonJS module structure, so it's not as simple as requireing what is needed. We use Smash to concatenate just what is needed from d3 and iD editor to make things work. To rebuild from iD source files:

make clean && make

Tests

npm install
npm test

Uses tests directly from iD to test exported objects.

License

iD-geo is available under the WTFPL, though obviously, if you want to dual-license any contributions that's cool. It includes d3js, which BSD-licensed.