Configured eslint / cleanup

Author: brianreavis

.eslintrc

@@ -0,0 +1,7 @@
+{
+	"extends": "naturalatlas/base",
+	"rules": {
+		"no-shadow": 0,
+		"key-spacing": 0
+	}
+}

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean clean-test build rebuild release test test-concurrent format-code authors
+.PHONY: clean clean-test build rebuild release test test-concurrent test-syntax authors
 
 MOCHA_ARGS=test -R list -gc --require ./test/_common.js
 
@@ -22,15 +22,6 @@ clean-test:
 	@rm -rf ./test/**/*.tmp*
 	@rm -rf ./test/data/**/*.tmp*
 
-format-code:
-	astyle \
-		--indent=force-tab=4 \
-		--indent-namespaces \
-		--add-brackets \
-		--style=stroustrup \
-		./src/*
-	@rm -rf ./src/*.orig
-
 ./node_modules/.bin/node-pre-gyp:
 	npm install node-pre-gyp
 
@@ -54,6 +45,9 @@ test-shared: clean-test build-shared
 	./node_modules/.bin/mocha $(MOCHA_ARGS)
 	@make clean-test
 
+test-syntax:
+	npm run test-syntax
+
 test-concurrent: clean-test
 	node ./node_modules/.bin/_mocha \
 		& node ./node_modules/.bin/_mocha \

examples/gdalinfo.js

@@ -39,13 +39,13 @@ var corners = {
 	'Upper Right ' : {x: size.x, y: 0},
 	'Bottom Right' : {x: size.x, y: size.y},
 	'Bottom Left ' : {x: 0, y: size.y},
-	'Center      ' : {x: size.x/2, y: size.y/2}
+	'Center      ' : {x: size.x / 2, y: size.y / 2}
 };
 
 var wgs84 = gdal.SpatialReference.fromEPSG(4326);
 var coord_transform = new gdal.CoordinateTransformation(ds.srs, wgs84);
 
-console.log("Corner Coordinates:")
+console.log('Corner Coordinates:');
 var corner_names = Object.keys(corners);
 corner_names.forEach(function(corner_name) {
 	// convert pixel x,y to the coordinate system of the raster
@@ -54,7 +54,7 @@ corner_names.forEach(function(corner_name) {
 	var pt_orig     = {
 		x: geotransform[0] + corner.x * geotransform[1] + corner.y * geotransform[2],
 		y: geotransform[3] + corner.x * geotransform[4] + corner.y * geotransform[5]
-	}
+	};
 	var pt_wgs84    = coord_transform.transformPoint(pt_orig);
 	var description = util.format('%s (%d, %d) (%s, %s)',
 		corner_name,
@@ -67,7 +67,7 @@ corner_names.forEach(function(corner_name) {
 });
 
 // bands
-ds.bands.forEach(function(band){
+ds.bands.forEach(function(band) {
 	var description = util.format('Band %d Block=%dx%d Type=%s, ColorInterp=%s',
 		band.id,
 		band.blockSize.x,
@@ -78,21 +78,21 @@ ds.bands.forEach(function(band){
 	console.log(description);
 
 	if (band.description) {
-		console.log('  Description = '+band.description);
+		console.log('  Description = ' + band.description);
 	}
 	console.log('  Min=' + Math.floor(band.minimum * 1000) / 1000);
 	console.log('  Max=' + Math.floor(band.maximum * 1000) / 1000);
 	if (band.noDataValue !== null) {
-		console.log('  NoData Value='+band.noDataValue);
+		console.log('  NoData Value=' + band.noDataValue);
 	}
 
 	// band overviews
 	var overview_info = [];
 	band.overviews.forEach(function(overview) {
-		var overview_description = overview.size.x + "x" + overview.size.y;
+		var overview_description = overview.size.x + 'x' + overview.size.y;
 
 		var metadata = overview.getMetadata();
-		if (metadata['RESAMPLING'] == 'AVERAGE_BIT2') {
+		if (metadata['RESAMPLING'] === 'AVERAGE_BIT2') {
 			overview_description += '*';
 		}
 
@@ -128,7 +128,7 @@ ds.bands.forEach(function(band){
 	if (keys.length > 0) {
 		console.log('  Metadata:');
 		keys.forEach(function(key) {
-			console.log('    '+key+'='+metadata[key]);
+			console.log('    ' + key + '=' + metadata[key]);
 		});
 	}
 

examples/ogrinfo.js

@@ -22,23 +22,23 @@ console.log('');
 // layers
 var i = 0;
 console.log('Layers: ');
-ds.layers.forEach(function(layer){
-	console.log((i++)+': '+ layer.name);
+ds.layers.forEach(function(layer) {
+	console.log((i++) + ': ' + layer.name);
 
-	console.log('  Geometry Type = '+gdal.Geometry.getName(layer.geomType));
-	console.log('  Spatial Reference = '+(layer.srs ? layer.srs.toWKT() : 'null'));
+	console.log('  Geometry Type = ' + gdal.Geometry.getName(layer.geomType));
+	console.log('  Spatial Reference = ' + (layer.srs ? layer.srs.toWKT() : 'null'));
 
 	var extent = layer.getExtent();
 	console.log('  Extent: ');
-	console.log('    minX = '+extent.minX);
-	console.log('    minY = '+extent.minY);
-	console.log('    maxX = '+extent.maxX);
-	console.log('    maxY = '+extent.maxY);
-
-	console.log('  Fields: ')
-	layer.fields.forEach(function(field){
-		console.log('    -'+field.name+' ('+field.type+')');
+	console.log('    minX = ' + extent.minX);
+	console.log('    minY = ' + extent.minY);
+	console.log('    maxX = ' + extent.maxX);
+	console.log('    maxY = ' + extent.maxY);
+
+	console.log('  Fields: ');
+	layer.fields.forEach(function(field) {
+		console.log('    -' + field.name + ' (' + field.type + ')');
 	});
 
-	console.log('  Feature Count = '+layer.features.count());
+	console.log('  Feature Count = ' + layer.features.count());
 });

lib/envelope.js

@@ -1,5 +1,4 @@
 module.exports = function(gdal) {
-
 	/**
 	 * A 2D bounding box. For 3D envelopes, see {{#crossLink "gdal.Envelope3D"}}gdal.Envelope3D{{/crossLink}}.
 	 *
@@ -41,7 +40,7 @@ module.exports = function(gdal) {
 	 * @return {void}
 	 */
 	Envelope.prototype.merge = function(envelope) {
-	 	if (arguments.length == 1) {
+		if (arguments.length === 1) {
 			if (this.isEmpty()) {
 				this.minX = envelope.minX;
 				this.maxX = envelope.maxX;
@@ -136,5 +135,4 @@ module.exports = function(gdal) {
 	};
 
 	return Envelope;
-
-};
+};

lib/envelope_3d.js

@@ -1,5 +1,4 @@
-module.exports = function(gdal) {
-
+module.exports = function() {
 	/**
 	 * A 3D bounding box. For 2D envelopes, see {{#crossLink "gdal.Envelope"}}gdal.Envelope{{/crossLink}}.
 	 *
@@ -45,7 +44,7 @@ module.exports = function(gdal) {
 	 * @return {void}
 	 */
 	Envelope3D.prototype.merge = function(envelope) {
-	 	if (arguments.length == 1) {
+		if (arguments.length === 1) {
 			if (this.isEmpty()) {
 				this.minX = envelope.minX;
 				this.maxX = envelope.maxX;
@@ -135,5 +134,4 @@ module.exports = function(gdal) {
 	};
 
 	return Envelope3D;
-
-};
+};

lib/gdal.js

@@ -1,3 +1,4 @@
+/* eslint no-console: 0 */
 var path         = require('path');
 var fs           = require('fs');
 var pkg          = require('../package.json');
@@ -98,7 +99,7 @@ function defaultMap(callback) {
 
 function defaultToArray() {
 	var array = [];
-	this.forEach(function(geom){
+	this.forEach(function(geom) {
 		array.push(geom);
 	});
 	return array;
@@ -521,61 +522,62 @@ gdal.open = (function() {
 	var open = gdal.open;
 
 	// add 'w' mode to gdal.open() method and also GDAL2-style driver selection
-	return function(filename, mode, drivers, x_size, y_size, n_bands, datatype, options) {
+	return function(filename, mode, drivers/* , x_size, y_size, n_bands, datatype, options */) {
 		if (typeof drivers === 'string') {
 			drivers = [drivers];
 		} else if (drivers && !Array.isArray(drivers)) {
-			throw new Error('driver(s) must be a string or list of strings')
+			throw new Error('driver(s) must be a string or list of strings');
 		}
 
 		if (mode === 'w') {
 			// create file with given driver
 			if (!drivers) {
-				throw new Error("Driver must be specified");
+				throw new Error('Driver must be specified');
 			}
 			if (drivers.length !== 1) {
-				throw new Error("Only one driver can be used to create a file");
+				throw new Error('Only one driver can be used to create a file');
 			}
 			var driver = gdal.drivers.get(drivers[0]);
 			if (!driver) {
-				throw new Error("Cannot find driver: "+drivers[0]);
+				throw new Error('Cannot find driver: ' + drivers[0]);
 			}
 
 			var args = Array.prototype.slice.call(arguments, 3); // x_size, y_size, ...
 			args.unshift(filename);
-		 	return driver.create.apply(driver, args);
-		} else {
-			if (arguments.length > 2) {
-				// open file with driver list
-				// loop through given drivers trying to open file
-				var ds;
-				drivers.forEach(function(driver_name, i){
-					var driver = gdal.drivers.get(driver_name);
-					if (!driver) {
-						throw new Error("Cannot find driver: "+driver_name);
-					}
-					try {
-						ds = driver.open(filename, mode);
-						return false;
-					} catch (err) { }
-				});
-
-				if (!ds) throw new Error("Error opening dataset");
-				return ds;
-
-			} else {
-				// call gdal.open() method normally
-				return open.apply(gdal, arguments);
-			}
+			return driver.create.apply(driver, args);
 		}
-	}
+
+		if (arguments.length > 2) {
+			// open file with driver list
+			// loop through given drivers trying to open file
+			var ds;
+			drivers.forEach(function(driver_name) {
+				var driver = gdal.drivers.get(driver_name);
+				if (!driver) {
+					throw new Error('Cannot find driver: ' + driver_name);
+				}
+				try {
+					ds = driver.open(filename, mode);
+					return false;
+				} catch (err) {
+					/* skip driver */
+				}
+			});
+
+			if (!ds) throw new Error('Error opening dataset');
+			return ds;
+		}
+
+		// call gdal.open() method normally
+		return open.apply(gdal, arguments);
+	};
 })();
 
 function fieldTypeFromValue(val) {
 	var type = typeof val;
 	if (type === 'number') {
 		if (val % 1 === 0) return gdal.OFTInteger;
-		else return gdal.OFTReal;
+		return gdal.OFTReal;
 	} else if (type === 'string') {
 		return gdal.OFTString;
 	} else if (type === 'boolean') {
@@ -588,13 +590,13 @@ function fieldTypeFromValue(val) {
 			case gdal.OFTString : return gdal.OFTStringList;
 			case gdal.OFTInteger : return gdal.OFTIntegerList;
 			case gdal.OFTReal : return gdal.OFTRealList;
-			default : throw new Error("Array element cannot be converted into OGRFieldType");
+			default : throw new Error('Array element cannot be converted into OGRFieldType');
 		}
 	} else if (val instanceof Buffer) {
 		return gdal.OFTBinary;
-	} else {
-		throw new Error("Value cannot be converted into OGRFieldType");
 	}
+
+	throw new Error('Value cannot be converted into OGRFieldType');
 }
 
 /**
@@ -640,7 +642,7 @@ gdal.GeometryCollection.wkbType  = gdal.wkbGeometryCollection;
 // enable passing geometry constructors as the geometry type
 gdal.DatasetLayers.prototype.create = (function() {
 	var create = gdal.DatasetLayers.prototype.create;
-	return function(name, srs, geom_type, creation_options) {
+	return function(name, srs, geom_type/* , creation_options */) {
 		if (arguments.length > 2 && geom_type instanceof Function) {
 			if (typeof geom_type.wkbType === 'undefined') {
 				throw new Error('Function must be a geometry constructor');
@@ -661,7 +663,7 @@ function getTypedArrayType(array) {
 	if (array instanceof Float32Array) return 6; // gdal.GDT_Float32
 	if (array instanceof Float64Array) return 7; // gdal.GDT_Float64
 	return 0; // gdal.GDT_Unknown
-};
+}
 
 gdal.RasterBandPixels.prototype.read = (function() {
 	var read = gdal.RasterBandPixels.prototype.read;

package.json

@@ -37,6 +37,7 @@
   },
   "scripts": {
     "test": "mocha test -R tap --timeout 600000 --no-colors -gc --require ./test/_common.js",
+    "test-syntax": "eslint lib test --fix",
     "install": "node-pre-gyp install --fallback-to-build",
     "postpublish": "npm run publish-yuidoc",
     "yuidoc": "yuidoc --extension .js,.cpp,.hpp",
@@ -49,6 +50,8 @@
   "devDependencies": {
     "aws-sdk": "~2.0.25",
     "chai": "^3.4.1",
+    "eslint": "^1.10.1",
+    "eslint-config-naturalatlas": "latest",
     "gh-pages": "~0.2.0",
     "mocha": "^2.3.4",
     "yuidoc-lucid-theme": "~0.1.1",

scripts/publish-docs.js

@@ -11,4 +11,4 @@ ghpages.publish(path.resolve(__dirname, '../yuidocs'), {message: 'Updated docume
 		process.stdout.write('success\n');
 		process.exit(0);
 	}
-});
+});

test/.eslintrc

@@ -0,0 +1,15 @@
+{
+	"globals": {
+		"gc": true,
+		"it": true,
+		"describe": true,
+		"before": true,
+		"after": true,
+		"beforeEach": true,
+		"afterEach": true
+	},
+	"rules": {
+		"no-console": 0,
+		"no-new": 0
+	}
+}

test/_common.js

@@ -3,11 +3,15 @@ var gdal = require('../lib/gdal.js');
 // gc tracing
 try {
 	gdal.startLogging(__dirname + '/artifacts/log.txt');
-} catch (e) {}
+} catch (e) {
+	/* ignore */
+}
 
 // seg fault handler
 var SegfaultHandler;
 try {
 	SegfaultHandler = require('segfault-handler');
 	SegfaultHandler.registerHandler();
-} catch (err) {}
+} catch (err) {
+	/* ignore */
+}