Skip to content
Grunt task for converting KML and GPX files to GeoJSON and TopoJSON
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
tasks
test
.eslintrc.json
.gitattributes
.gitignore
.travis.yml
Gruntfile.js
LICENSE
README.md
package.json

README.md

grunt-togeojson

Grunt task for converting KML and GPX files to GeoJSON and TopoJSON

Build Status Code Climate Dependency Status Built with Grunt Analytics

Getting Started

This Grunt task runner plugin uses Grunt, toGeoJSON, TopoJSON, Geobuf, and jsdom.

Please note that the minimum version of Node.js required is 4.2.0, starting from the release 2.0.0 of this plugin.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-togeojson --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-togeojson');

The "togeojson" task

Overview

In your project's Gruntfile, add a section named togeojson to the data object passed into grunt.initConfig().

Configure the files list as described in the multi task section of the Grunt documentation.

grunt.initConfig({
  togeojson: {
    maps: {
      files: {
        // Target-specific file lists and/or options go here.
      }
    }
  }
})

Options

Conversion will use the same basename of the source file for the destination file.

options.input

Type: String

Default value: 'auto'

Possible values: 'auto', 'kml', 'gpx'

The default value ('auto') will determine the type based on the input file extension, namely checking if it is .gpx or not.

options.output

Type: String

Default value: 'geojson'

Possible values: 'geojson', 'topojson'

Using 'topojson' will disable options.compress.

options.compress

Type: Boolean

Default value: false

Possible values: true, false

Compress the resulting GeoJSON with Geobuf. Please note that TopoJSON is not supported to be compressed via Geobuf.

Contributing

Please refer to a GitHub blog post on how to create somewhat perfect pull request.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • v2.1.0 (2016-04-05)
    • Update dependencies and remove grunt-cli from devDependencies as it is in grunt now
  • v2.0.1 (2016-02-22)
    • Grunt.js 1.0.0 is coming out soon, so its use has been tested
    • Dependencies updated
  • v2.0.0 (2015-10-28)
    • Upgraded to jsdom v7, which means to force using Node.js 4.2.0 (LTS)
  • v1.1.0 (2015-05-05)
    • Remove Geobuf/TopoJSON combination since it is not supported
  • v1.0.0 (2015-01-27)
    • Conversion to TopoJSON and Geobuf added
  • v0.1.0 (2013-09-30)
    • Initial release

License

Copyright (c) Juga Paazmaya paazmaya@yahoo.com

Licensed under the MIT license.

Something went wrong with that request. Please try again.