camptocamp · sbrunner · May 24, 2018 · May 24, 2018 · May 24, 2018
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -3,7 +3,7 @@ To check before create a new issue:
 * I am using the latest minor version of the major version (`x.y.last`).
 * I create one issue per subject (do not put more than one thing in the same issue).
 
-For commiters:
+For committers:
 
 * I have assigned a blue and a green label.
 * I have assigned a milestone.

diff --git a/Makefile b/Makefile
@@ -110,8 +110,8 @@ help:
 	@echo "- test                        Run the test suite"
 	@echo "- test-debug                  Run the test suite in the browser"
 	@echo "- clean                       Remove generated files"
-	@echo "- cleanall                    Remove all the build artefacts"
-	@echo "- cleanallcache               Remove all the build artefacts and the extra caches (npm and pip)"
+	@echo "- cleanall                    Remove all the build artifacts"
+	@echo "- cleanallcache               Remove all the build artifacts and the extra caches (npm and pip)"
 	@echo
 	@echo "Secondary targets:"
 	@echo
@@ -124,7 +124,7 @@ help:
 apidoc: .build/apidoc
 
 .PHONY: check
-check: lint check-examples-checker check-examples test examples-hosted-apps
+check: lint spell check-examples-checker check-examples test examples-hosted-apps
 
 .PHONY: check-examples-checker
 check-example-checker: $(CHECK_EXAMPLE_CHECKER)
@@ -140,6 +140,14 @@ lint-extra:
 	if [ "`git grep @fileoverview src contribs`" != "" ]; then echo "Using @fileoverview breaks the documentation main page"; false; fi
 	if [ "`git grep @example src contribs`" != "" ]; then echo "We don't use @example to have the example in the description"; false; fi
 
+.PHONY: spell
+spell: .build/python-venv.timestamp
+	$(PY_VENV_BIN)/codespell --quiet-level=2 --ignore-words=spell-ignore-words.txt \
+		$(shell find -name 'node_modules' -prune -or -name '.build' -prune -or -name '.git' -prune \
+		-or -name '__pycache__' -prune -or -name 'build' -prune \
+		-or \( -type f -and -not -name '*.png' -and -not -name '*.mo' -and -not -name '*.po*' -and -not -name '*_translation' \
+		-and -not -name 'themescapabilities.js' -and -not -name 'themes.js'  -and -not -name 'prettify.js' \) -print)
+
 .PHONY: eslint
 eslint: .build/eslint.timestamp
 

diff --git a/buildtools/check-example.js b/buildtools/check-example.js
@@ -37,11 +37,11 @@ page.onAlert = function(msg) {
 };
 page.onResourceError = function(resourceError) {
   if (resourceError.url.includes('tile.openstreetmap.org')) {
-    console.warn('Ignoring ressource error from OpenStreetMap');
+    console.warn('Ignoring resource error from OpenStreetMap');
   } else if (resourceError.url.includes('https://maps.googleapis.com/maps/api/js')) {
-    console.warn('Ignoring ressource error from Google');
+    console.warn('Ignoring resource error from Google');
   } else if (resourceError.url.includes('https://csi.gstatic.com/')) {
-    console.warn('Ignoring ressource error from Google static');
+    console.warn('Ignoring resource error from Google static');
   } else if (resourceError.errorCode >= 300) {
     console.log('Resource error: ' + resourceError.errorCode + ', ' + resourceError.url);
     exitCode = 2;

diff --git a/contribs/gmf/examples/datepicker.html b/contribs/gmf/examples/datepicker.html
@@ -14,7 +14,7 @@
           <ngeo-date-picker time="ctrl.wmsTimeRangeMode" on-date-selected="ctrl.onDateRangeSelected(time)"></ngeo-date-picker>
       </li>
       <li style="margin-top: 50px">
-        Date formated for a WMS request (resolution set on 'day'):
+        Date formatted for a WMS request (resolution set on 'day'):
         <pre>
           {{ctrl.rangeValue}}
         </pre>
@@ -23,7 +23,7 @@
           <ngeo-date-picker time="ctrl.wmsTimeValueMode" on-date-selected="ctrl.onDateSelected(time)"></ngeo-date-picker>
       </li>
       <li style="margin-top: 50px">
-        Date formated for a WMS request (resolution set on 'month'):
+        Date formatted for a WMS request (resolution set on 'month'):
         <pre>
           {{ctrl.value}}
         </pre>

diff --git a/contribs/gmf/examples/profile.html b/contribs/gmf/examples/profile.html
@@ -13,7 +13,7 @@
     <button class="btn btn-primary" data-toggle="button" ng-click="ctrl.toggleDrawLineActive()">Draw a line</button>
 
     <p id="desc">This example shows how to use the <code>gmf-profile</code>.
-    The draw tool and hover feedback on the map are completely independant of
+    The draw tool and hover feedback on the map are completely independent of
     the gmf-profile components. This profile relies on the ngeo.profile (d3) and
     ngeo.ProfileDirective. It passes a custom css through the optional
     gmf-profile-options attribute</p>

diff --git a/contribs/gmf/examples/timeslider.html b/contribs/gmf/examples/timeslider.html
@@ -17,7 +17,7 @@
         <gmf-time-slider gmf-time-slider-time="ctrl.wmsTimeRangeMode" gmf-time-slider-on-date-selected="ctrl.onDateRangeSelected(time)"></gmf-time-slider>
       </li>
       <li style="margin-top: 50px">
-        Date formated for a WMS request (resolution set on 'day'):
+        Date formatted for a WMS request (resolution set on 'day'):
         <pre>
           {{ctrl.sliderRangeValue}}
         </pre>
@@ -29,7 +29,7 @@
         <gmf-time-slider gmf-time-slider-time="ctrl.wmsTimeValueMode" gmf-time-slider-on-date-selected="ctrl.onDateSelected(time)"></gmf-time-slider>
       </li>
       <li style="margin-top: 50px">
-        Date formated for a WMS request (resolution set on 'year'):
+        Date formatted for a WMS request (resolution set on 'year'):
         <pre>
           {{ctrl.sliderValue}}
         </pre>

diff --git a/contribs/gmf/externs/gmf-themes.js b/contribs/gmf/externs/gmf-themes.js
@@ -146,7 +146,7 @@ gmfThemes.GmfGroup.prototype.ogcServer;
 
 
 /**
- * On non mixed first level group with more then one time layer, it is the time informations.
+ * On non mixed first level group with more then one time layer, it is the time information.
  * @type {ngeox.TimeProperty|undefined}
  */
 gmfThemes.GmfGroup.prototype.time;
@@ -232,7 +232,7 @@ gmfThemes.GmfLayerWMS.prototype.ogcServer;
 
 
 /**
- * The time informations if the layer directly manage it, see
+ * The time information if the layer directly manage it, see
  * also {gmfThemes.GmfGroup.time}.
  * @type {ngeox.TimeProperty|undefined}
  */
@@ -378,7 +378,7 @@ gmfThemes.GmfFunctionalities.prototype.default_basemap;
 
 /**
  * When set, contains the name of the panel to open upon loading an application.
- * Note: altough this is a list, only one can be defined.
+ * Note: although this is a list, only one can be defined.
  * @type {Array.<!string>|undefined}
  */
 gmfThemes.GmfFunctionalities.prototype.open_panel;
@@ -387,7 +387,7 @@ gmfThemes.GmfFunctionalities.prototype.open_panel;
 /**
  * Name of the layer (data source) that should be toggled in the filter tool
  * upon loading an application.
- * Note: altough this is a list, only one can be defined.
+ * Note: although this is a list, only one can be defined.
  * @type {Array.<!string>|undefined}
  */
 gmfThemes.GmfFunctionalities.prototype.preset_layer_filter;
@@ -561,7 +561,7 @@ gmfThemes.GmfMetaData.prototype.maxResolution;
 
 
 /**
- * The URL to the informations on this layer.
+ * The URL to the information on this layer.
  * For WMS and WMTS layers.
  * @type {string|undefined}
  */

diff --git a/contribs/gmf/options/gmfx.js b/contribs/gmf/options/gmfx.js
@@ -178,7 +178,7 @@ gmfx.MousePositionProjection.prototype.code;
 
 
 /**
- * The label to diplay with this projection.
+ * The label to display with this projection.
  * @type {string}
  */
 gmfx.MousePositionProjection.prototype.label;
@@ -753,7 +753,7 @@ gmfx.datasource.OGCOptions;
 
 /**
  * A reference to the GMF layer node that was used to create the data source.
- * It may contains additionnal information, such as metadata, about the data
+ * It may contains additional information, such as metadata, about the data
  * source.
  * @type {gmfThemes.GmfLayer}
  */

diff --git a/contribs/gmf/src/filters/filterselectorComponent.js b/contribs/gmf/src/filters/filterselectorComponent.js
@@ -354,7 +354,7 @@ exports.Controller_ = class {
 
   /**
    * Called when the active property changes. Toggle data source registration.
-   * Also, when deactivated, unselect data source.
+   * Also, when deactivated, deselect data source.
    * @param {boolean} active Active.
    * @private
    */
@@ -454,7 +454,7 @@ exports.Controller_ = class {
 
   /**
    * Unregister a data source if it's filtrable. Also, if it's the one
-   * that was currently selected, unselect it.
+   * that was currently selected, deselect it.
    * @param {gmf.datasource.OGC} dataSource Data source
    * @private
    */

diff --git a/contribs/gmf/src/layertree/TreeManager.js b/contribs/gmf/src/layertree/TreeManager.js
@@ -88,7 +88,7 @@ const exports = function($timeout, $injector, gettextCatalog, ngeoLayerHelper,
 
   /**
    * The controller of the (unique) root layer tree.
-   * The array of top level layer trees is avaible through `rootCtrl.children`.
+   * The array of top level layer trees is available through `rootCtrl.children`.
    * The order doesn't match with the ordre of the displayed layertree.
    * @type {ngeo.layertree.Controller}
    * @export
@@ -576,7 +576,7 @@ exports.prototype.setNodeMetadataFromFullState_ = function(node, fullState) {
     });
   }
 
-  // Set the metadata with the fullState object informations.
+  // Set the metadata with the fullState object information.
   const metadata = node.metadata;
   metadata.isChecked = fullState.isChecked;
   metadata.isExpanded = fullState.isExpanded;

diff --git a/contribs/gmf/src/layertree/component.js b/contribs/gmf/src/layertree/component.js
@@ -98,7 +98,7 @@ function gmfLayertreeTemplate($element, $attrs, gmfLayertreeTemplate) {
  * This component creates a layertree based on the c2cgeoportal JSON themes
  * source and a {@link ngeo.layertreeComponent}. The controller used by this
  * component defines some functions for each node that are created by a default
- * template. This default template can be overrided by setting the value
+ * template. This default template can be overridden by setting the value
  * 'gmf.layertreeTemplateUrl' but you will have to adapt the
  * ngeoLayertreeTemplateUrl value too (to define the children's nodes template
  * path).
@@ -532,7 +532,7 @@ exports.Controller_.prototype.getLegendsObject = function(treeCtrl) {
     let layersNames = gmfLayerWMS.layers;
     const gmfOgcServer = this.gmfTreeManager_.getOgcServer(treeCtrl);
     const scale = this.getScale_();
-    // QGIS can handle multiple layers natively. Use Mutliple urls for other map
+    // QGIS can handle multiple layers natively. Use Multiple URLs for other map
     // servers
     if (gmfOgcServer.type === ngeoDatasourceOGC.ServerType.QGISSERVER) {
       layersNames = [layersNames];

diff --git a/contribs/gmf/src/lidarprofile/Manager.js b/contribs/gmf/src/lidarprofile/Manager.js
@@ -83,7 +83,7 @@ const exports = class {
     this.map_ = null;
 
     /**
-     * The hovered point attributes in d3 profile highlighted on the 2D map
+     * The hovered point attributes in D3 profile highlighted on the 2D map
      * @type {ol.Overlay}
      */
     this.cartoHighlight = new olOverlay({
@@ -92,7 +92,7 @@ const exports = class {
     });
 
     /**
-     * The hovered point geometry (point) in d3 profile highlighted on the 2D map
+     * The hovered point geometry (point) in D3 profile highlighted on the 2D map
      * @type {ol.layer.Vector}
      */
     this.lidarPointHighlight = new olLayerVector({
@@ -201,11 +201,11 @@ const exports = class {
 
 
   /**
-   * Load profile data (lidar points) by succesive Levels Of Details using asynchronous requests
+   * Load profile data (lidar points) by successive Levels Of Details using asynchronous requests
    * @param {Array} clippedLine an array of the clipped line coordinates
-   * @param {number} distanceOffset the left side of d3 profile domain at current zoom and pan configuration
-   * @param {boolean} resetPlot wether to reset d3 plot or not
-   * @param {number} minLOD minimum level of detail
+   * @param {number} distanceOffset the left side of D3 profile domain at current zoom and pan configuration
+   * @param {boolean} resetPlot whether to reset D3 plot or not
+   * @param {number} minLOD minimum Level Of Detail
    * @export
    */
   getProfileByLOD(clippedLine, distanceOffset, resetPlot, minLOD) {
@@ -265,14 +265,14 @@ const exports = class {
 
   /**
    * Request to Pytree service for a range of Level Of Detail (LOD)
-   * @param {number} minLOD minimum level of detail of the request
-   * @param {number} maxLOD maximum level of detail of the request
+   * @param {number} minLOD minimum Level Of Detail of the request
+   * @param {number} maxLOD maximum Level Of Detail of the request
    * @param {number} iter the iteration in profile requests cycle
    * @param {string} coordinates linestring in cPotree format
-   * @param {number} distanceOffset the left side of d3 profile domain at current zoom and pan configuration
+   * @param {number} distanceOffset the left side of D3 profile domain at current zoom and pan configuration
    * @param {boolean} lastLOD the deepest level to retrieve for this profile
    * @param {number} width the width of the profile
-   * @param {boolean} resetPlot wether to reset d3 plot or not, used for first LOD
+   * @param {boolean} resetPlot whether to reset D3 plot or not, used for first LOD
    * @private
    */
   queryPytree_(minLOD, maxLOD, iter, coordinates, distanceOffset, lastLOD, width, resetPlot) {
@@ -312,9 +312,9 @@ const exports = class {
    * Process the binary array return by Pytree (cPotree)
    * @param {ArrayBuffer} profile binary array returned by cPotree executable called by Pytree
    * @param {number} iter the iteration in profile requests cycle
-   * @param {number} distanceOffset the left side of d3 profile domain at current zoom and pan configuration
+   * @param {number} distanceOffset the left side of D3 profile domain at current zoom and pan configuration
    * @param {boolean} lastLOD the deepest level to retrieve for this profile
-   * @param {boolean} resetPlot wether to reset d3 plot or not
+   * @param {boolean} resetPlot whether to reset D3 plot or not
    * @private
    */
   processBuffer_(profile, iter, distanceOffset, lastLOD, resetPlot) {
@@ -449,7 +449,7 @@ const exports = class {
   }
 
   /**
-   * Update the profile data according to d3 chart zoom and pan level
+   * Update the profile data according to D3 chart zoom and pan level
    * The update will wait on a 200ms pause on the actions of users before to do the update.
    * @export
    */

diff --git a/contribs/gmf/src/lidarprofile/Plot.js b/contribs/gmf/src/lidarprofile/Plot.js
@@ -24,7 +24,7 @@ const exports = class {
 
   /**
    * Provides a service to create an SVG element with defined axis and a LIDAR
-   * point drawing mecanism.
+   * point drawing mechanism.
    *
    * @struct
    * @param {gmf.lidarprofile.Manager} gmfLidarprofileManagerInstance gmf lidar profile manager instance
@@ -137,7 +137,7 @@ const exports = class {
 
 
   /**
-   * Setup the SVG components of the d3 chart
+   * Setup the SVG components of the D3 chart
    * @param {Array.<number>} rangeX range of the x scale
    * @param {Array.<number>} rangeY range of the y scale
    * @export

diff --git a/contribs/gmf/src/lidarprofile/Utils.js b/contribs/gmf/src/lidarprofile/Utils.js
@@ -18,7 +18,7 @@ const d3 = {
 const exports = class {
 
   /**
-   * Clip a linstring with start and end measure givent by d3 Chart domain
+   * Clip a linstring with start and end measure given by D3 Chart domain
    * @param {gmf.lidarprofile.Config} config the LIDAR profile config instance
    * @param {number} map_resolution the current resolution of the map
    * @param {ol.geom.LineString} linestring an OpenLayer Linestring
@@ -154,11 +154,11 @@ const exports = class {
 
 
   /**
-   * Get a LOD and with for a given chart span
+   * Get a Level Of Details and with for a given chart span
    * Configuration is set up in Pytree configuration
    * @param {number} span domain extent
    * @param {lidarprofileServer.ConfigLevels} max_levels levels defined by a LIDAR server
-   * @return {{maxLOD: number, width: number}} Object with optimized LOD and width for this profile span
+   * @return {{maxLOD: number, width: number}} Object with optimized Level Of Details and width for this profile span
    */
   getNiceLOD(span, max_levels) {
     let maxLOD = 0;
@@ -227,7 +227,7 @@ const exports = class {
 
 
   /**
-   * Transforms a lidarprofile into mutliple single points sorted by distance.
+   * Transforms a lidarprofile into multiple single points sorted by distance.
    * @param {gmfx.LidarprofilePoints} profilePoints in the profile
    * @return {Array.<gmfx.LidarPoint>} An array of Lidar Points.
    */

diff --git a/contribs/gmf/src/print/component.js b/contribs/gmf/src/print/component.js
@@ -154,7 +154,7 @@ function gmfPrintTemplateUrl($element, $attrs, gmfPrintTemplateUrl) {
  *     value in each of your print panel field. The key refers to the
  *     property's name of the field.
  *     Example: {'comments': 'demo', 'legend': false}. Doesn't work for the dpi
- *     and the scale. Server's values are used in priorty.
+ *     and the scale. Server's values are used in priority.
  * @htmlAttribute {Array.<string>} gmf-print-hiddenattributes The list of attributes that should be hidden.
  * @ngdoc component
  * @ngname gmfPrint
@@ -533,7 +533,7 @@ exports.Controller_ = class {
    * @return {number} Scale of the map to print.
    */
   getScaleFn(frameState) {
-    // Don't compute an optimal scale if the user manualy choose a value not in
+    // Don't compute an optimal scale if the user manually choose a value not in
     // the pre-defined scales. (`scaleInput` in `gmfPrintOptions`).
     googAsserts.assert(this.layoutInfo.scales);
     googAsserts.assert(this.layoutInfo.scale !== undefined);
@@ -780,7 +780,7 @@ exports.Controller_ = class {
     if (this.active && originalEvent.altKey && originalEvent.shiftKey && mapCenter) {
       const center = this.map.getPixelFromCoordinate(mapCenter);
       const pixel = e.pixel;
-      // Reset previous position between two differents sessions of drags events.
+      // Reset previous position between two different sessions of drags events.
       if (this.rotationTimeoutPromise_ === null) {
         this.onDragPreviousMousePosition_ = null;
       } else {

diff --git a/contribs/gmf/src/query/gridComponent.js b/contribs/gmf/src/query/gridComponent.js
@@ -867,7 +867,7 @@ exports.Controller_.prototype.selectAll = function() {
 
 
 /**
- * Unselect all rows of the currently active grid.
+ * Deselect all rows of the currently active grid.
  * @export
  */
 exports.Controller_.prototype.unselectAll = function() {

diff --git a/contribs/gmf/test/spec/controllers/gmfprintcontroller.spec.js b/contribs/gmf/test/spec/controllers/gmfprintcontroller.spec.js
@@ -37,7 +37,7 @@ describe('GmfPrintController', () => {
     expect(gmfPrintCtrl.rotation).toBe(-180);
   });
 
-  it('Set layout and test depending layout informations changes', () => {
+  it('Set layout and test depending layout information changes', () => {
     const title = 'title';
     gmfPrintCtrl.layoutInfo.title = title;
 

diff --git a/contribs/gmf/test/spec/services/permalinkservice.spec.js b/contribs/gmf/test/spec/services/permalinkservice.spec.js
@@ -126,7 +126,7 @@ describe('Permalink service', () => {
       expect(PermalinkService.getWfsPermalinkData_()).toEqual(expectedQueryParams);
     });
 
-    it('works with multipe filter groups', () => {
+    it('works with multiple filter groups', () => {
       // ?wfs_layer=osm_scale&wfs_ngroups=2&wfs_0_ele=380&wfs_0_highway=bus_stop&
       // wfs_0_operator=TL&wfs_1_highway=bus_stop&wfs_1_name=Grand-Pont&wfs_1_operator=TL
       ngeoLocation.updateParams({