CI: adding spell-check using typos CLI (#1370)

Author: Lucas-C

.github/workflows/continuous-integration-workflow.yml

@@ -71,6 +71,8 @@ jobs:
           guarddog pypi verify docs/requirements.txt
           guarddog pypi verify test/linters-requirements.txt
           guarddog pypi verify test/requirements.txt
+      - name: Spell Check Repo ✍️
+        uses: crate-ci/typos@v1.29.7
   test:
     strategy:
       matrix:

.typos.toml

@@ -0,0 +1,23 @@
+[default]
+extend-ignore-identifiers-re = [
+    "1fpt",         # FPDF._downscale_image()
+    ".+_2nd",
+    "BUI",
+    "decode_parms",
+    "odf",          # odf.opendocument / odf.table
+    "parameter_ot",
+    "sur", "Sur",
+    "ue", "UE",
+    "FlateDecode",
+    "VAI",
+]
+extend-ignore-re = [
+    "loca subsetting",
+    "np.arange",
+]
+
+[files]
+extend-exclude = [
+    "*.pdf",
+    "docs/Tutorial-*.md",
+]

CHANGELOG.md

@@ -88,7 +88,7 @@ This can also be enabled programmatically with `warnings.simplefilter('default',
 * [`FPDF.write_html()`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.write_html): `tag_indents` introduced in the last version - Now the indentation can be provided through the `tag_styles` parameter, using the `.l_margin` of `TextStyle` instances
 ### Changed
 * [`FPDF.local_context()`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.local_context) used to treat `font_size` as a value in points. Now this is the role of `font_size_pt`, whereas `font_size` allows to set the font size into chosen document units (specified with `FPDF(unit=)`) - MR: [#1207](https://github.com/py-pdf/fpdf2/pulls/1207)
-* [`FPDF.circle()`](https://py-pdf.github.io/fpdf2/fpdf.html#fpdf.fpdf.FPDF.circle) : the previous `r` parameter, that in fact defined the diameter, has been replaced by a new `radius` paremeter. The `x` & `y` parameters now define the circle **center**, instead of its top-left corner as it used to be - [issue #1245](https://github.com/py-pdf/fpdf2/issues/1245)
+* [`FPDF.circle()`](https://py-pdf.github.io/fpdf2/fpdf.html#fpdf.fpdf.FPDF.circle) : the previous `r` parameter, that in fact defined the diameter, has been replaced by a new `radius` parameter. The `x` & `y` parameters now define the circle **center**, instead of its top-left corner as it used to be - [issue #1245](https://github.com/py-pdf/fpdf2/issues/1245)
 * [`FPDF.table()`](https://py-pdf.github.io/fpdf2/Tables.html) now raises an error when a single row is too high to be rendered on a single page
 * [`FPDF.write_html()`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.write_html): indentation of HTML elements can now be non-integer (float), and is now independent of font size and bullet strings.
 * improved performance of font glyph selection by using functools cache
@@ -572,23 +572,23 @@ This has been fixed, and a warning is now triggered by the [`FPDF.code39`](https
 - [`FPDF.circle`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.circle): new method added, thanks to @viraj-shah18 !
 - `write_html`: support setting HTML font colors by name and short hex codes
 - [`FPDF.will_page_break`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.will_page_break)
-utility method to let users know in advance when adding an elemnt will trigger a page break.
-This can be useful to repeat table headers on each page for exemple,
+utility method to let users know in advance when adding an element will trigger a page break.
+This can be useful to repeat table headers on each page for example,
 _cf._ [documentation on Tables](https://py-pdf.github.io/fpdf2/Tables.html#repeat-table-header-on-each-page).
 - [`FPDF.set_link`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_link) now support a new optional `x` parameter to set the horizontal position after following the link
 ### Fixed
 - fixed a bug when `fpdf.Template` was used to render QRCodes, due to a forced conversion to string (#175)
 
 ## [2.4.1] - 2021-06-12
 ### Fixed
-- erroneous page breaks occured for full-width / full-height images
-- rendering issue of non-ASCII characaters with unicode fonts
+- erroneous page breaks occurred for full-width / full-height images
+- rendering issue of non-ASCII characters with unicode fonts
 
 ## [2.4.0] - 2021-06-11
 ### Changed
 - now `fpdf2` uses the newly supported `DCTDecode` image filter for JPEG images,
   instead of `FlateDecode` before, in order to improve the compression ratio without any image quality loss.
-  On test images, this reduced the size of embeded JPEG images by 90%.
+  On test images, this reduced the size of embedded JPEG images by 90%.
 - `FPDF.cell`: the `w` (width) parameter becomes optional, with a default value of `None`, meaning to generate a cell with the size of the text content provided
 - the `h` (height) parameter of the `cell`, `multi_cell` & `write` methods gets a default value change, `None`, meaning to use the current font size
 - removed the useless `w` & `h` parameters of the `FPDF.text_annotation()` method
@@ -712,7 +712,7 @@ prevented strings passed first to the text-rendering methods to be displayed.
 ## [2.0.4] - 2020-03-26
 ### Fixed
 * images centering - thanks `cgfrost`!
-* added missing import statment for `urlopen` in `image_parsing` module
+* added missing import statement for `urlopen` in `image_parsing` module
 * changed urlopen import from `six` library to maintain python2 compatibility
 
 ## [2.0.3] - 2020-01-03

README.md

@@ -82,7 +82,7 @@ pip install git+https://github.com/py-pdf/fpdf2.git@master
 Our 350+ reference PDF test files, generated by `fpdf2`, are validated using 3 different checkers:
 
 [![QPDF logo](https://py-pdf.github.io/fpdf2/qpdf-logo.svg)](https://github.com/qpdf/qpdf)
-[![PDF Checker logo](https://py-pdf.github.io/fpdf2/pdfchecker-logo.png)](https://www.datalogics.com/products/pdf-tools/pdf-checker/)
+[![PDF Checker logo](https://py-pdf.github.io/fpdf2/pdfchecker-logo.png)](https://www.datalogics.com/repair-pdf-files)
 [![VeraPDF logo](https://py-pdf.github.io/fpdf2/vera-logo.jpg)](https://verapdf.org)
 
 ## Please show the value

docs/Development.md

@@ -208,6 +208,15 @@ static code analysis with `pylint`, unit tests...
 _Pull Requests_ submitted must pass all those checks in order to be approved.
 Ask maintainers through comments if some errors in the pipeline seem obscure to you.
 
+### typos
+[typos](https://github.com/crate-ci/typos) is a handy CLI tool to detect & auto-fix [typos](https://en.wikipedia.org/wiki/Typographical_error) in source files.
+Installation is relatively straightfoward ([read the docs](https://github.com/crate-ci/typos?tab=readme-ov-file#install)).
+
+This tool is invoked in our CI pipeline.
+If it fails, you should either:
+* auto-fix the errors detected by invoking `typos --write-changes`
+* add an exclusion rule to `.typos.toml`
+
 ### Release checklist
 1. complete `CHANGELOG.md` and add the version & date of the new release
 2. bump `FPDF_VERSION` in `fpdf/fpdf.py`.
@@ -261,7 +270,6 @@ there are still many PDF features that this library does not support.
 ## Useful tools to manipulate PDFs
 
 ### qpdf
-
 [qpdf](https://qpdf.sourceforge.io/) is a very powerful tool to analyze PDF documents.
 
 One of it most useful features is the [QDF mode](https://qpdf.readthedocs.io/en/stable/qdf.html) that can convert any PDF file to a human-readable, decompressed & annotated new PDF document:
@@ -273,7 +281,6 @@ qpdf --qdf doc.pdf doc-qdf.pdf
 This is extremely useful to peek into the PDF document structure.
 
 ### pdfly
-
 `pdfly` is a very handy CLI tool to manipulate PDF files: [py-pdf/pdfly](https://github.com/py-pdf/pdfly?tab=readme-ov-file#usage).
 
 Those are some very useful commands:

docs/EmojisSymbolsDingbats.md

@@ -75,4 +75,4 @@ For reference, it was built using this script: [zapfdingbats.py](zapfdingbats.py
 
 ## Fallback fonts ##
 
-If you need to mix special characters and emojis within normal text, it is possible to specify alternative fonts for FPDF to use as fallback fonts. See an exemple of use [Here](Unicode.md#fallback-fonts)
+If you need to mix special characters and emojis within normal text, it is possible to specify alternative fonts for FPDF to use as fallback fonts. See an example of use [Here](Unicode.md#fallback-fonts)

docs/HTML.md

@@ -181,7 +181,7 @@ pdf.output("html_helvetica.pdf")
 _New in [:octicons-tag-24: 2.8.0](https://github.com/py-pdf/fpdf2/blob/master/CHANGELOG.md)_
 
 Page breaks can be triggered explicitly using the [break-before](https://developer.mozilla.org/en-US/docs/Web/CSS/break-before) or [break-after](https://developer.mozilla.org/en-US/docs/Web/CSS/break-after) CSS properties.
-For exemple you can use:
+For example you can use:
 ```html
 <br style="break-after: page">
 ```

docs/Maths.md

@@ -112,7 +112,7 @@ You can find documentation on how to convert vector images (SVG) to raster image
 
 ## Mathematical formulas ##
 `fpdf2` can only insert mathematical formula in the form of **images**.
-The following sections will explaing how to generate and embed such images.
+The following sections will explain how to generate and embed such images.
 
 ### Using Google Charts API ###
 Official documentation: [Google Charts Infographics - Mathematical Formulas](https://developers.google.com/chart/infographics/docs/formulas).

docs/Patterns.md

@@ -119,9 +119,9 @@ Both linear and radial gradients support **multiple colors**. If you pass, for e
 For **linear gradients** or **radial gradients**, passing `bounds=[0.2, 0.4, 0.7, ...]` (values between 0 and 1) fine-tunes where each color transition occurs. For instance, if you have 5 colors, you can specify 3 boundary values that partition the color progression among them.
 
 For example, taking a gradient with 5 colors and `bounds=[0.1, 0.8, 0.9]`:
-- The transition from color 1 to color 2 start at the beggining (0%) and ends at 10%
-- The transition from color 2 to color 3 start at 10% and ends at 80%
-- The transition from color 3 to color 4 start at 80% and ends at 90%
-- The transition from color 4 to color 5 start at 90% and goes to the end (100%)
+- The transition from color 1 to color 2 starts at the beginning (0%) and ends at 10%
+- The transition from color 2 to color 3 starts at 10% and ends at 80%
+- The transition from color 3 to color 4 starts at 80% and ends at 90%
+- The transition from color 4 to color 5 starts at 90% and goes to the end (100%)
 
 In other words, each boundary value dictates where the color transitions will occur along the total gradient length.

docs/README.md

@@ -1,7 +1,7 @@
 This documentation is published online at https://py-pdf.github.io/fpdf2/
 
 Docs generation & publication on GitHub Pages is performed for every new commit on the `master` branch
-throught the GitHub Actions pipeline.
+through the GitHub Actions pipeline.
 
 Please refer to the [development manual](https://py-pdf.github.io/fpdf2/Development.html#documentation)
 for more information.

docs/Tables.md

@@ -419,7 +419,7 @@ with pdf.table() as table:
             row.cell(datum)
 ```
 
-Can be shortened to the followng code,
+Can be shortened to the following code,
 by passing lists of strings as the `cells` optional argument of `.row()`:
 
 ```python

docs/Templates.md

@@ -241,7 +241,7 @@ from fpdf import Template
 elements = [
     { 'name': 'company_logo', 'type': 'I', 'x1': 20.0, 'y1': 17.0, 'x2': 78.0, 'y2': 30.0, 'font': None, 'size': 0.0, 'bold': 0, 'italic': 0, 'underline': 0, 'align': 'C', 'text': 'logo', 'priority': 2, 'multiline': False},
     { 'name': 'company_name', 'type': 'T', 'x1': 17.0, 'y1': 32.5, 'x2': 115.0, 'y2': 37.5, 'font': 'helvetica', 'size': 12.0, 'bold': 1, 'italic': 0, 'underline': 0,'align': 'C', 'text': '', 'priority': 2, 'multiline': False},
-    { 'name': 'multline_text', 'type': 'T', 'x1': 20, 'y1': 100, 'x2': 40, 'y2': 105, 'font': 'helvetica', 'size': 12, 'bold': 0, 'italic': 0, 'underline': 0, 'background': 0x88ff00, 'align': 'C', 'text': 'Lorem ipsum dolor sit amet, consectetur adipisici elit', 'priority': 2, 'multiline': True, 'wrapmode': 'WORD'},
+    { 'name': 'multiline_text', 'type': 'T', 'x1': 20, 'y1': 100, 'x2': 40, 'y2': 105, 'font': 'helvetica', 'size': 12, 'bold': 0, 'italic': 0, 'underline': 0, 'background': 0x88ff00, 'align': 'C', 'text': 'Lorem ipsum dolor sit amet, consectetur adipisici elit', 'priority': 2, 'multiline': True, 'wrapmode': 'WORD'},
     { 'name': 'box', 'type': 'B', 'x1': 15.0, 'y1': 15.0, 'x2': 185.0, 'y2': 260.0, 'font': 'helvetica', 'size': 0.0, 'bold': 0, 'italic': 0, 'underline': 0, 'align': 'C', 'text': None, 'priority': 0, 'multiline': False},
     { 'name': 'box_x', 'type': 'B', 'x1': 95.0, 'y1': 15.0, 'x2': 105.0, 'y2': 25.0, 'font': 'helvetica', 'size': 0.0, 'bold': 1, 'italic': 0, 'underline': 0, 'align': 'C', 'text': None, 'priority': 2, 'multiline': False},
     { 'name': 'line1', 'type': 'L', 'x1': 100.0, 'y1': 25.0, 'x2': 100.0, 'y2': 57.0, 'font': 'helvetica', 'size': 0, 'bold': 0, 'italic': 0, 'underline': 0, 'align': 'C', 'text': None, 'priority': 3, 'multiline': False},

docs/Text.md

@@ -30,7 +30,7 @@ With supporting Unicode fonts, `fpdf2` should handle the following text shaping
 There are a few advanced typesetting features that `fpdf2` doesn't currently support:
 
 * Contextual forms - In some writing systems (eg. Arabic, Mongolian, etc.), characters may take a different shape, depending on whether they appear at the beginning, in the middle, or at the end of a word, or isolated. Fpdf will always use the same standard shape in those cases.
-* Vertical writing - Some writing systems are meant to be written vertically. Doing so is not directly supported. In cases where this just means to stack characters on top of each other (eg. Chinese, Japanese, etc.), client software can implement this by placing each character individuall at the correct location. In cases where the characters are connected with each other (eg. Mongolian), this may be more difficult, if possible at all.
+* Vertical writing - Some writing systems are meant to be written vertically. Doing so is not directly supported. In cases where this just means to stack characters on top of each other (eg. Chinese, Japanese, etc.), client software can implement this by placing each character individually at the correct location. In cases where the characters are connected with each other (eg. Mongolian), this may be more difficult, if possible at all.
 
 ### Character or Word Based Line Wrapping
 By default, `multi_cell()` and `write()` will wrap lines based on words, using space characters and soft hyphens as separators.

docs/TextRegion.md

@@ -58,7 +58,7 @@ All types of text regions have the following constructor parameters in common:
 * `image` (str or PIL.Image.Image or io.BytesIO, optional) - An image to add to the region. This is a convenience parameter for cases when no further text or images need to be added to the paragraph. If both `text` and `image` arguments are present, the text will be inserted first. (Default: None)
 * `image_fill_width` (bool, optional) - Indicates whether to increase the size of the image to fill the width of the column. Larger images will always be reduced to column width. (Default: False)
 
-All of those values can be overriden for each individual paragraph.
+All of those values can be overridden for each individual paragraph.
 
 
 ### Common Methods ###

docs/TextShaping.md

@@ -7,7 +7,7 @@ _New in [:octicons-tag-24: 2.7.5](https://github.com/py-pdf/fpdf2/blob/master/CH
 ## What is text shaping? ##
 Text shaping is a fundamental process in typography and computer typesetting that influences the aesthetics and readability of text in various languages and scripts. It involves the transformation of Unicode text into glyphs, which are then positioned for display or print. 
 
-For texts in latin script, text shaping can improve the aesthetics by replacing characters that would colide or overlap by a single glyph specially crafted to look harmonious.
+For texts in latin script, text shaping can improve the aesthetics by replacing characters that would collide or overlap by a single glyph specially crafted to look harmonious.
 
 ![](text-shaping-ligatures.png)
 

docs/TextStyling.md

@@ -53,7 +53,7 @@ This method changes the distance between individual characters of a test string.
 
 Character spacing works best for formatting single line text created by any method, or for highlighting individual words included in a block of text with `.write()`.
 
-**Limitations**: Spacing will only be changed *within* a sequence of characters that `fpdf2` adds to the PDF in one go. This means that there will be no extra distance _eg._ between text parts that are placed successivly with `write()`. Also, if you apply different font styles using the Markdown functionality of `.cell()` and `.multi_cell()` or by using `html_write()`, then any parts given different styles will have the original distance between them. This is so because `fpdf2` has to add each styled fragment to the PDF file seperately.
+**Limitations**: Spacing will only be changed *within* a sequence of characters that `fpdf2` adds to the PDF in one go. This means that there will be no extra distance _eg._ between text parts that are placed successively with `write()`. Also, if you apply different font styles using the Markdown functionality of `.cell()` and `.multi_cell()` or by using `html_write()`, then any parts given different styles will have the original distance between them. This is so because `fpdf2` has to add each styled fragment to the PDF file separately.
 
 The example shows the same text justified to the same width, with char_spacing values of 0 and 10 (font size 8 pt).
 ```python

docs/Unicode.md

@@ -5,7 +5,7 @@ Besides the limited set of latin fonts built into the PDF format, `fpdf2` offers
 To make use of that functionality, you have to install at least one Unicode font, either in the system font folder or in some other location accessible to your program.
 For professional work, many designers prefer commercial fonts, suitable to their specific needs. There are also many sources of free TTF fonts that can be downloaded online and used free of cost (some of them may have restrictions on commercial redistribution, such as server installations or including them in a software project).
 
-  * [Font Library](https://fontlibrary.org/) - A collection of fonts for many languates with an open source type license.
+  * [Font Library](https://fontlibrary.org/) - A collection of fonts for many languages with an open source type license.
 
   * [Google Fonts](https://fonts.google.com/) - A collection of free to use fonts for many languages.
 
@@ -214,5 +214,5 @@ When a glyph cannot be rendered uing the current font,
 By default, if it does not find such matching font, the character will not be rendered using any fallback font. This behaviour can be relaxed by passing `exact_match=False` to [`set_fallback_fonts()`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.set_fallback_fonts).
 
 Moreover, for more control over font fallback election logic,
-the [`get_fallback_font()`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.get_fallback_font) can be overriden.
+the [`get_fallback_font()`](https://py-pdf.github.io/fpdf2/fpdf/fpdf.html#fpdf.fpdf.FPDF.get_fallback_font) can be overridden.
 An example of this can be found in [test/fonts/test_font_fallback.py](https://github.com/py-pdf/fpdf2/blob/master/test/fonts/test_font_fallback.py).