Merge pull request mapbox#50 from mapbox/optional-precision

[proposal] Make precision warning optional

README.md

@@ -29,7 +29,10 @@ the GeoJSON standards and returns them as an array of errors. An example of the
 }]
 ```
 
-The options argument is optional and has one option: `noDuplicateMembers`.
+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:
 
@@ -42,6 +45,36 @@ geojsonhint.hint('{"type":"invalid","type":"Feature","properties":{},"geometry":
 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](https://tools.ietf.org/html/rfc7946#section-11.2)
+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.
+
+```js
+geojsonhint.hint('{ "type": "Point", "coordinates": [100.0000000001, 5.0000000001] }', {
+ precisionWarning: false
+});
+```
+
+With this option enabled, geojsonhint will produce these warnings:
+
+```js
+[{
+ line: 1,
+ level: 'warn',
+ message: 'precision of coordinates should be reduced'
+}, {
+ line: 1,
+ level: 'warn',
+ message: 'precision of coordinates should be reduced'
+}]
+```
+
+Without this option, this input will pass without errors.
+
 ## Line Numbers
 
 Note that the GeoJSON can be given as a **string or as an object**. Here's how

index.js

@@ -8,6 +8,8 @@ var jsonlint = require('jsonlint-lines'),
  * @param {boolean} [options.noDuplicateMembers=true] forbid repeated
  * properties. This is only available for string input, becaused parsed
  * Objects cannot have duplicate properties.
+ * @param {boolean} [options.precisionWarning=true] warn if GeoJSON contains
+ * unnecessary coordinate precision.
  * @returns {Array<Object>} an array of errors
  */
 function hint(str, options) {

object.js

@@ -7,12 +7,16 @@ var rightHandRule = require('./rhr');
  * @param {boolean} [options.noDuplicateMembers=true] forbid repeated
  * properties. This is only available for string input, becaused parsed
  * Objects cannot have duplicate properties.
+ * @param {boolean} [options.precisionWarning=true] warn if GeoJSON contains
+ * unnecessary coordinate precision.
  * @returns {Array<Object>} an array of errors
  */
 function hint(gj, options) {
 
  var errors = [];
  var precisionWarningCount = 0;
+ var maxPrecisionWarnings = 10;
+ var maxPrecision = 6;
 
  function root(_) {
 
@@ -140,31 +144,30 @@ function hint(gj, options) {
  });
  }
 
- var maxPrecisionWarnings = 10;
- var maxPrecision = 6;
- if (precisionWarningCount === maxPrecisionWarnings) {
- precisionWarningCount += 1;
- return errors.push({
- message: 'truncated warnings: we\'ve encountered coordinate precision warning ' + maxPrecisionWarnings + ' times, no more warnings will be reported',
- level: 'warn',
- line: _.__line__ || line
- });
- } else if (precisionWarningCount < maxPrecisionWarnings) {
- _.forEach(function(num) {
- var precision = 0;
- var decimalStr = String(num).split('.')[1];
- if (decimalStr !== undefined)
- precision = decimalStr.length;
- if (precision > maxPrecision) {
- precisionWarningCount += 1;
- return errors.push({
- message: 'precision of coordinates should be reduced',
- level: 'warn',
- line: _.__line__ || line
- });
- }
-
- });
+ if (options && options.precisionWarning) {
+ if (precisionWarningCount === maxPrecisionWarnings) {
+ precisionWarningCount += 1;
+ return errors.push({
+ message: 'truncated warnings: we\'ve encountered coordinate precision warning ' + maxPrecisionWarnings + ' times, no more warnings will be reported',
+ level: 'warn',
+ line: _.__line__ || line
+ });
+ } else if (precisionWarningCount < maxPrecisionWarnings) {
+ _.forEach(function(num) {
+ var precision = 0;
+ var decimalStr = String(num).split('.')[1];
+ if (decimalStr !== undefined)
+ precision = decimalStr.length;
+ if (precision > maxPrecision) {
+ precisionWarningCount += 1;
+ return errors.push({
+ message: 'precision of coordinates should be reduced',
+ level: 'warn',
+ line: _.__line__ || line
+ });
+ }
+ });
+ }
  }
  }
 

test/data/bad/excessive_precision_truncated.result

@@ -1,57 +1 @@
-[
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 2
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 2
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 3
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 3
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 4
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 4
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 5
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 5
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 6
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn",
- "line": 6
- },
- {
- "message": "truncated warnings: we've encountered coordinate precision warning 10 times, no more warnings will be reported",
- "level": "warn",
- "line": 7
- }
-]
+[]

test/data/bad/excessive_precision_truncated.result-object

@@ -1,46 +1 @@
-[
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "precision of coordinates should be reduced",
- "level": "warn"
- },
- {
- "message": "truncated warnings: we've encountered coordinate precision warning 10 times, no more warnings will be reported",
- "level": "warn"
- }
-]
+[]

test/hint.test.js

@@ -83,11 +83,54 @@ test('geojsonhint', function(t) {
  t.deepEqual(geojsonhint.hint('{"type":"invalid","type":"Feature","properties":{},"geometry":null}', {
  noDuplicateMembers: true
  }), [{
- "line": 1,
- "message": "An object contained duplicate members, making parsing ambigous: type"
+ line: 1,
+ message: 'An object contained duplicate members, making parsing ambigous: type'
  }], 'sketchy object not permitted by default');
  t.end();
  });
+ test('noDuplicateMembers option=true', function(t) {
+ t.deepEqual(geojsonhint.hint('{ "type": "Point", "coordinates": [100.0000000001, 5.0000000001] }', {
+ precisionWarning: true
+ }), [{
+ line: 1,
+ level: 'warn',
+ message: 'precision of coordinates should be reduced'
+ }, {
+ line: 1,
+ level: 'warn',
+ message: 'precision of coordinates should be reduced'
+ }], 'sketchy object not permitted by default');
+ t.end();
+ });
+ test('noDuplicateMembers option=true', function(t) {
+ var excessiveFeature = {
+ type: 'Feature',
+ geometry: {
+ type: 'Point',
+ coordinates: [
+ 100.0000001,
+ 100.0000001
+ ]
+ },
+ properties: {}
+ };
+ var featureCollection = {
+ type: 'FeatureCollection',
+ features: []
+ };
+ for (var i = 0; i < 100; i++) featureCollection.features.push(excessiveFeature);
+ var truncated = geojsonhint.hint(JSON.stringify(featureCollection, null, 2), {
+ precisionWarning: true
+ })
+ t.equal(truncated.length, 11);
+ t.deepEqual(truncated[10], {
+ line: 63,
+ level: 'warn',
+ message: 'truncated warnings: we\'ve encountered coordinate precision warning 10 times, '
+ + 'no more warnings will be reported'
+ });
+ t.end();
+ });
  test('invalid roots', function(t) {
  t.deepEqual(geojsonhint.hint('null'), [{
  message: 'The root of a GeoJSON object must be an object.',