Fix typos and add codespell to nox

README.rst

@@ -112,7 +112,7 @@ Changelog
 
   * WEBP (lossy and lossless) images supported as output format
   * PNG default optimization preset changed to a 10× faster preset (old preset
-    stil available with ``--png-slow-optimization`` flag)
+    still available with ``--png-slow-optimization`` flag)
   * New model flag ``--no-fix-infacing-normals`` to disable Assimp's "fix
     infacing normals" postprocess (#32, #33)
   * Show CLI usage when no parameter given
@@ -136,7 +136,7 @@ Changelog
 
 * **0.10.1:**
 
-  * Fixes an issue that occures when output file does not already exist
+  * Fixes an issue that occurs when output file does not already exist
 
 * **0.10.0:**
 

doc/cli/image.rst

@@ -78,8 +78,8 @@ Resize Output Image
 
 YOGA allows you to resize images with the ``--resize`` option::
 
-    yoga  image  --resize=512  input.png  ouput.png
-    yoga  image  --resize=512x512  input.png  ouput.png
+    yoga  image  --resize=512  input.png  output.png
+    yoga  image  --resize=512x512  input.png  output.png
 
 .. NOTE::
 

doc/contributing.rst

@@ -108,9 +108,10 @@ Libraries:
 
 Development tools:
 
-* Black_: Code formater
+* Black_: Code formatter
 * Flake8_: Linter
 * Pytest_: Unit test
+* Codespell_: Code spell
 
 Documentation:
 
@@ -258,5 +259,6 @@ Then you can run the following command::
 .. _Flake8: https://flake8.pycqa.org/en/latest/
 .. _Black: https://black.readthedocs.io/en/stable/
 .. _pytest: https://docs.pytest.org/
+.. _Codespell: https://github.com/codespell-project/codespell
 
 .. _Sphinx: https://www.sphinx-doc.org/en/master/

noxfile.py

@@ -11,7 +11,7 @@ PYTHON_FILES = [
 
 @nox.session(reuse_venv=True)
 def lint(session):
-    session.install("flake8", "black")
+    session.install("flake8", "black", "codespell")
     session.run("flake8", *PYTHON_FILES)
     session.run(
         "black",
@@ -21,6 +21,19 @@ def lint(session):
         "--color",
         *PYTHON_FILES,
     )
+    session.run(
+        "codespell",
+        "-L",
+        "ans,alph",
+        "doc/",
+        "scripts/",
+        "test/",
+        "winbuild/",
+        "yoga/",
+        "noxfile.py",
+        "README.rst",
+        "setup.py",
+    )
 
 
 @nox.session(reuse_venv=True)

setup.py

@@ -98,8 +98,9 @@ setup(
             "flake8",
             "black",
             "pytest",
-            "Sphinx",
+            "sphinx",
             "sphinx-rtd-theme",
+            "codespell",
         ]
     },
     entry_points={

test/test_model_options.py

@@ -46,7 +46,7 @@ class Test_normalize_options(object):
 
         with pytest.raises(IOError):
             opt = options.normalize_options(
-                {"fallback_texture": "non-existant.jpg"}
+                {"fallback_texture": "non-existent.jpg"}
             )
 
     def test_no_graph_optimization(self):

yoga/image/encoders/png.py

@@ -35,7 +35,7 @@ def python_int_to_big_endian_uint32_bytes(number):
 
 def get_png_structure(data):
     if not is_png(data):
-        raise ValueError("Unvalid PNG: Not a PNG file")
+        raise ValueError("Invalid PNG: Not a PNG file")
 
     result = {
         "size": len(data),
@@ -86,7 +86,7 @@ def get_IHDR_info(data):
 def assemble_png_from_chunks(chunks):
     """Assemble a PNG file from a list of chunks
 
-    :param list chunks: The list of chunks (see bellow).
+    :param list chunks: The list of chunks (see below).
 
     Example list of chunk::
 

yoga/image/encoders/webp.py

@@ -8,7 +8,7 @@ def little_endian_unint32_bytes_to_python_int(bytes_):
 
 def get_riff_structure(data):
     if data[0:4] != b"RIFF":
-        raise ValueError("Unvalid RIFF: Not a RIFF file")
+        raise ValueError("Invalid RIFF: Not a RIFF file")
 
     result = {
         "formtype": data[8:12].decode(),
@@ -17,7 +17,7 @@ def get_riff_structure(data):
     }
 
     if result["size"] + 8 != len(data):
-        raise ValueError("Unvalid RIFF: Truncated data")
+        raise ValueError("Invalid RIFF: Truncated data")
 
     offset = 12  # RIFF header length
 
@@ -46,7 +46,7 @@ def get_vp8x_info(data):
     # fmt: on
 
     if len(data) != 10:
-        ValueError("Invaild VP8X data")
+        ValueError("Invalid VP8X data")
 
     return {
         "has_icc": bool(data[0] & VP8X_FLAG_ICC),

yoga/model/__init__.py

@@ -198,7 +198,7 @@ def optimize(
     :param str,file-like input_file: The input model file.
     :param str,file-like output_file: The output model file.
     :param dict options: Optimization options (see above).
-    :param dict textures: A dictionnary that maps textures path to bytes. When
+    :param dict textures: A dictionary that maps textures path to bytes. When
                           not ``None``, there will be no file system reads in
                           order to find referenced textures. YOGA will look
                           into that dictionary instead.
@@ -246,7 +246,7 @@ def optimize(
     )
 
     # Embed images
-    # @note We save the bytes to a dictionnary so that the garbage collector
+    # @note We save the bytes to a dictionary so that the garbage collector
     # does not occur before exporting the scene a bit later
     images_bytes = {}
     model_embed_images(

yoga/model/helpers.py

@@ -176,6 +176,6 @@ def model_embed_images(
         optimized_textures[valid_image_path] = image
         image = image.next
 
-        # @note Save the bytes to a dictionnary so that the garbage collector
+        # @note Save the bytes to a dictionary so that the garbage collector
         # does not occur before exporting the scene a bit later
         images_bytes[valid_image_path] = image_bytes_c