chore: integrate codespell and fix existing spelling issues

This tool scans the comments of every source file and reports back
spelling errors.

Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>

.travis.yml

@@ -37,6 +37,7 @@ before_install:
 
 install:
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then
+      pip install codespell;
       gem install scss_lint;
       npm install -g bower electron-installer-debian;
       npm install -g electron-installer-debian;

appveyor.yml

@@ -34,6 +34,7 @@ install:
   - set PATH=C:\MinGW\bin;%PATH%
   - set PATH=C:\MinGW\msys\1.0\bin;%PATH%
   - gem install scss_lint
+  - pip install codespell
   - make info
   - make electron-develop
 

docs/RUNNING-LOCALLY.md

@@ -16,6 +16,7 @@ Prerequisites
 - [SCSS Lint](https://github.com/brigade/scss-lint/)
 - [jq](https://stedolan.github.io/jq/)
 - [Asar](https://github.com/electron/asar)
+- [Codespell](https://github.com/lucasdemarchi/codespell)
 
 ### Windows
 

lib/gui/components/drive-selector/templates/drive-selector-modal.tpl.html

@@ -23,7 +23,7 @@
             <!-- There can be a case where the device it not large enough, and it's also locked. -->
             <!-- Since in this case both labels will be displayed, we chose to only show the -->
             <!-- "not large enough label", since from the point of view of the user, the locked -->
-            <!-- state is irrelevent if the drive is not large enough anyway. -->
+            <!-- state is irrelevant if the drive is not large enough anyway. -->
 
             <span class="label label-danger"
               ng-hide="modal.constraints.isDriveLargeEnough(drive, modal.state.getImage())">

lib/gui/models/drives.js

@@ -69,7 +69,7 @@ Drives.service('DrivesModel', function() {
   // over a function that returns a mutable version of an
   // ImmutableJS object.
   //
-  // The problem is that everytime you call `myImmutableObject.toJS()`
+  // The problem is that every time you call `myImmutableObject.toJS()`
   // you will get a new object, whose reference is different from
   // the one you previously got, even if the data is exactly the same.
   const memoizeImmutableListReference = (func) => {

lib/gui/scss/modules/_bootstrap.scss

@@ -26,7 +26,7 @@ body {
   background-color: $palette-theme-dark-background;
 }
 
-// Fix slighly checkbox vertical alignment issue
+// Fix slight checkbox vertical alignment issue
 .checkbox input[type="checkbox"] {
   position: initial;
   margin-right: 2px;

lib/image-stream/index.js

@@ -85,7 +85,7 @@ exports.getFromFilePath = (file) => {
  * @description
  * This function is useful to determine the final size of an image
  * after decompression or any other needed transformation, as well as
- * other relevent metadata, if any.
+ * other relevant metadata, if any.
  *
  * **NOTE:** This function is known to output incorrect size results for
  * `bzip2`. For this compression format, this function will simply

package.json

@@ -15,7 +15,8 @@
     "sass": "node-sass ./lib/gui/scss/main.scss > ./lib/gui/css/main.css",
     "jslint": "eslint lib tests scripts bin versionist.conf.js",
     "scsslint": "scss-lint lib/gui/scss",
-    "lint": "npm run jslint && npm run scsslint",
+    "codespell": "codespell.py lib tests",
+    "lint": "npm run jslint && npm run scsslint && npm run codespell",
     "changelog": "versionist",
     "start": "electron lib/start.js",
     "clean-shrinkwrap": "node ./scripts/clean-shrinkwrap.js"

scripts/build/docker/Dockerfile-i686

@@ -14,6 +14,8 @@ RUN apt-get update && apt-get install -y \
   libxss1 \
   libxtst6 \
   python \
+  python-pip \
+  python-dev \
   python-software-properties \
   software-properties-common \
   upx \
@@ -28,6 +30,9 @@ RUN curl -sL https://deb.nodesource.com/setup_6.x | bash - \
 RUN npm config set spin=false
 RUN npm install -g bower asar electron-installer-debian
 
+# Python
+RUN pip install codespell
+
 # Ruby
 RUN add-apt-repository ppa:brightbox/ruby-ng
 RUN apt-get update

scripts/build/docker/Dockerfile-x86_64

@@ -14,6 +14,8 @@ RUN apt-get update && apt-get install -y \
   libxss1 \
   libxtst6 \
   python \
+  python-pip \
+  python-dev \
   python-software-properties \
   software-properties-common \
   upx \
@@ -28,6 +30,9 @@ RUN curl -sL https://deb.nodesource.com/setup_6.x | bash - \
 RUN npm config set spin=false
 RUN npm install -g bower asar electron-installer-debian
 
+# Python
+RUN pip install codespell
+
 # Ruby
 RUN add-apt-repository ppa:brightbox/ruby-ng
 RUN apt-get update

scripts/build/docker/Dockerfile.template

@@ -14,6 +14,8 @@ RUN apt-get update && apt-get install -y \
   libxss1 \
   libxtst6 \
   python \
+  python-pip \
+  python-dev \
   python-software-properties \
   software-properties-common \
   upx \
@@ -28,6 +30,9 @@ RUN curl -sL https://deb.nodesource.com/setup_6.x | bash - \
 RUN npm config set spin=false
 RUN npm install -g bower asar electron-installer-debian
 
+# Python
+RUN pip install codespell
+
 # Ruby
 RUN add-apt-repository ppa:brightbox/ruby-ng
 RUN apt-get update

tests/gui/modules/image-writer.spec.js

@@ -30,7 +30,7 @@ describe('Browser: ImageWriter', function() {
 
     describe('.flash()', function() {
 
-      describe('given a succesful write', function() {
+      describe('given a successful write', function() {
 
         beforeEach(function() {
           this.performWriteStub = m.sinon.stub(ImageWriterService, 'performWrite');
@@ -83,7 +83,7 @@ describe('Browser: ImageWriter', function() {
 
       });
 
-      describe('given an unsuccesful write', function() {
+      describe('given an unsuccessful write', function() {
 
         beforeEach(function() {
           this.performWriteStub = m.sinon.stub(ImageWriterService, 'performWrite');