docs: add CI spell check

jmcnamara · jmcnamara · commit 07b1ba51bc73 · 2025-09-12T20:53:06.000+01:00
diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
@@ -0,0 +1,22 @@
+name: Spelling - test spelling with Typos crate
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CLICOLOR: 1
+
+jobs:
+  spelling:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Actions Repository
+      uses: actions/checkout@v4
+    - name: Spell Check Repo
+      uses: crate-ci/typos@v1.34.0
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,10 @@
+[default.extend-words]
+Beng = "Beng"
+Caf = "Caf"
+Fo = "Fo"
+Formattings = "Formattings"
+nam = "nam"
+ODER = "ODER"
+ser = "ser"
+SOMME = "SOMME"
+ths = "ths"
diff --git a/LICENSE_Artistic_Perl b/LICENSE_Artistic_Perl
@@ -125,7 +125,7 @@ products derived from this software without specific prior written permission.
 
 10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
 				The End
 
diff --git a/examples/chart_combined.pl b/examples/chart_combined.pl
@@ -103,7 +103,7 @@
 $column_chart2->set_x_axis( name => 'Test number' );
 $column_chart2->set_y_axis( name => 'Sample length (mm)' );
 
-# Note: the y2 properites are on the secondary chart.
+# Note: the y2 properties are on the secondary chart.
 $line_chart2->set_y2_axis( name => 'Target length (mm)' );
 
 
diff --git a/examples/right_to_left.pl b/examples/right_to_left.pl
@@ -3,7 +3,7 @@
 #######################################################################
 #
 # Example of how to change the default worksheet direction from
-# left-to-right to right-to-left as required by some eastern verions
+# left-to-right to right-to-left as required by some eastern versions
 # of Excel.
 #
 # Copyright 2000-2025, John McNamara, jmcnamara@cpan.org
diff --git a/examples/sensitivity_label.pl b/examples/sensitivity_label.pl
@@ -112,7 +112,7 @@
 #
 #
 # Once you have identified the necessary metadata you can add it to a new
-# docuemnt as shown below.
+# document as shown below.
 #
 
 use strict;
diff --git a/examples/unicode_koi8r.txt b/examples/unicode_koi8r.txt
@@ -3,7 +3,7 @@
 #
 # Sample encoded text borrowed from Sean Burke's Pod::Simple distro.
 #
-# The text is some Russina in KOI8-R.
+# The text is some Russian in KOI8-R.
 #
 # See the unicode_koi8r.pl example.
 #
diff --git a/examples/unicode_shift_jis.pl b/examples/unicode_shift_jis.pl
@@ -5,7 +5,7 @@
 # A simple example of converting some Unicode text to an Excel file using
 # Excel::Writer::XLSX.
 #
-# This example generates some Japenese text from a file with Shift-JIS
+# This example generates some Japanese text from a file with Shift-JIS
 # encoded text.
 #
 # Copyright 2000-2025, John McNamara, jmcnamara@cpan.org
diff --git a/lib/Excel/Writer/XLSX/Chart.pm b/lib/Excel/Writer/XLSX/Chart.pm
@@ -9459,7 +9459,7 @@ In this case it is just necessary to add a C<y2_axis> parameter to the series an
 
     ...
 
-    # Note: the y2 properites are on the secondary chart.
+    # Note: the y2 properties are on the secondary chart.
     $line_chart2->set_y2_axis( name => 'Target length (mm)' );
 
 
diff --git a/lib/Excel/Writer/XLSX/Chart/Scatter.pm b/lib/Excel/Writer/XLSX/Chart/Scatter.pm
@@ -40,7 +40,7 @@ sub new {
     $self->{_subtype}           = $self->{_subtype} || 'marker_only';
     $self->{_cross_between}     = 'midCat';
     $self->{_horiz_val_axis}    = 0;
-    $self->{_val_axis_postion}  = 'b';
+    $self->{_val_axis_position} = 'b';
     $self->{_smooth_allowed}    = 1;
     $self->{_requires_category} = 1;
 
diff --git a/lib/Excel/Writer/XLSX/Drawing.pm b/lib/Excel/Writer/XLSX/Drawing.pm
@@ -270,7 +270,7 @@ sub _write_absolute_anchor {
 
     $self->xml_start_tag( 'xdr:absoluteAnchor' );
 
-    # Different co-ordinates for horizonatal (= 0) and vertical (= 1).
+    # Different co-ordinates for horizontal (= 0) and vertical (= 1).
     if ( $self->{_orientation} == 0 ) {
 
         # Write the xdr:pos element.
diff --git a/lib/Excel/Writer/XLSX/Examples.pm b/lib/Excel/Writer/XLSX/Examples.pm
@@ -3362,7 +3362,7 @@ SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later
     $column_chart2->set_x_axis( name => 'Test number' );
     $column_chart2->set_y_axis( name => 'Sample length (mm)' );
     
-    # Note: the y2 properites are on the secondary chart.
+    # Note: the y2 properties are on the secondary chart.
     $line_chart2->set_y2_axis( name => 'Target length (mm)' );
     
     
@@ -9189,7 +9189,7 @@ Download this example: L<http://cpansearch.perl.org/src/JMCNAMARA/Excel-Writer-X
 
 
 Example of how to change the default worksheet direction from
-left-to-right to right-to-left as required by some eastern verions
+left-to-right to right-to-left as required by some eastern versions
 of Excel.
 
 
@@ -9209,7 +9209,7 @@ Source code for this example:
     #######################################################################
     #
     # Example of how to change the default worksheet direction from
-    # left-to-right to right-to-left as required by some eastern verions
+    # left-to-right to right-to-left as required by some eastern versions
     # of Excel.
     #
     # Copyright 2000-2025, John McNamara, jmcnamara@cpan.org
@@ -12654,7 +12654,7 @@ Download this example: L<http://cpansearch.perl.org/src/JMCNAMARA/Excel-Writer-X
 A simple example of converting some Unicode text to an Excel file using
 Excel::Writer::XLSX.
 
-This example generates some Japenese text from a file with Shift-JIS
+This example generates some Japanese text from a file with Shift-JIS
 encoded text.
 
 
@@ -12676,7 +12676,7 @@ Source code for this example:
     # A simple example of converting some Unicode text to an Excel file using
     # Excel::Writer::XLSX.
     #
-    # This example generates some Japenese text from a file with Shift-JIS
+    # This example generates some Japanese text from a file with Shift-JIS
     # encoded text.
     #
     # Copyright 2000-2025, John McNamara, jmcnamara@cpan.org
diff --git a/lib/Excel/Writer/XLSX/Utility.pm b/lib/Excel/Writer/XLSX/Utility.pm
@@ -582,7 +582,7 @@ sub get_image_properties {
 
     if ( unpack( 'x A3', $data ) eq 'PNG' ) {
 
-        # Test for PNGs.
+        # Test for PNG files.
         ( $type, $width, $height, $x_dpi, $y_dpi ) =
           _process_png( $data, $filename );
 
diff --git a/lib/Excel/Writer/XLSX/Worksheet.pm b/lib/Excel/Writer/XLSX/Worksheet.pm
@@ -704,7 +704,7 @@ sub set_column {
     $level = 7 if $level > 7;
 
 
-    # Excel has a maximumn column width of 255 characters.
+    # Excel has a maximum column width of 255 characters.
     if (defined $width && $width > 255.0) {
         $width = 255.0;
     }
diff --git a/t/chart/sub_write_d_lbls.t b/t/chart/sub_write_d_lbls.t
@@ -303,7 +303,7 @@ is( $got, $expected, $caption );
 
 ###############################################################################
 #
-# Test the _write_d_lbls() method. Pie chart. Postion =
+# Test the _write_d_lbls() method. Pie chart. Position =
 #
 $caption  = " \tChart: _write_d_lbls()";
 $expected = '<c:dLbls><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>';
@@ -328,7 +328,7 @@ is( $got, $expected, $caption );
 
 ###############################################################################
 #
-# Test the _write_d_lbls() method. Pie chart. Postion = center.
+# Test the _write_d_lbls() method. Pie chart. Position = center.
 #
 $caption  = " \tChart: _write_d_lbls()";
 $expected = '<c:dLbls><c:dLblPos val="ctr"/><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>';
@@ -354,7 +354,7 @@ is( $got, $expected, $caption );
 
 ###############################################################################
 #
-# Test the _write_d_lbls() method. Pie chart. Postion = inside_end
+# Test the _write_d_lbls() method. Pie chart. Position = inside_end
 #
 $caption  = " \tChart: _write_d_lbls()";
 $expected = '<c:dLbls><c:dLblPos val="inEnd"/><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>';
@@ -378,7 +378,7 @@ is( $got, $expected, $caption );
 
 ###############################################################################
 #
-# Test the _write_d_lbls() method. Pie chart. Postion = outside_end
+# Test the _write_d_lbls() method. Pie chart. Position = outside_end
 #
 $caption  = " \tChart: _write_d_lbls()";
 $expected = '<c:dLbls><c:dLblPos val="outEnd"/><c:showVal val="1"/><c:showLeaderLines val="1"/></c:dLbls>';
diff --git a/t/regression/chart_chartarea02.t b/t/regression/chart_chartarea02.t
@@ -55,7 +55,7 @@ $chart->add_series( values => '=Sheet1!$B$1:$B$5' );
 $chart->add_series( values => '=Sheet1!$C$1:$C$5' );
 
 
-# Test the deprected Spreadsheet::WriteExcel interface.
+# Test the deprecated Spreadsheet::WriteExcel interface.
 $chart->set_chartarea(
     line_pattern => 'none',
     color        => 'red'
diff --git a/t/regression/chart_points03.t b/t/regression/chart_points03.t
@@ -38,7 +38,7 @@ my $workbook  = Excel::Writer::XLSX->new( $got_filename );
 my $worksheet = $workbook->add_worksheet();
 my $chart     = $workbook->add_chart( type => 'pie', embedded => 1 );
 
-# Replicate the cutom colors for testing.
+# Replicate the custom colors for testing.
 $workbook->set_custom_color( 40, 0xCC, 0x00, 0x00 );
 $workbook->set_custom_color( 41, 0x99, 0x00, 0x00 );
 
diff --git a/t/regression/format01.t b/t/regression/format01.t
@@ -41,7 +41,7 @@ my $worksheet3 = $workbook->add_worksheet();
 my $unused1 = $workbook->add_format( bold   => 1 );
 my $bold    = $workbook->add_format( bold   => 1 );
 my $unused2 = $workbook->add_format( bold   => 1 );
-my $unued3 = $workbook->add_format( italic => 1 );
+my $unused3 = $workbook->add_format( italic => 1 );
 
 $worksheet1->write( 'A1', 'Foo' );
 $worksheet1->write( 'A2', 123 );
diff --git a/t/regression/outline01.t b/t/regression/outline01.t
@@ -31,7 +31,7 @@ my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };
 ###############################################################################
 #
 # Test the creation of a outlines in a Excel::Writer::XLSX file. These tests
-# are based on the outline programs in the examles directory.
+# are based on the outline programs in the examples directory.
 #
 use Excel::Writer::XLSX;
 
diff --git a/t/regression/outline02.t b/t/regression/outline02.t
@@ -31,7 +31,7 @@ my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };
 ###############################################################################
 #
 # Test the creation of a outlines in a Excel::Writer::XLSX file. These tests
-# are based on the outline programs in the examles directory.
+# are based on the outline programs in the examples directory.
 #
 use Excel::Writer::XLSX;
 
diff --git a/t/regression/outline03.t b/t/regression/outline03.t
@@ -31,7 +31,7 @@ my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };
 ###############################################################################
 #
 # Test the creation of a outlines in a Excel::Writer::XLSX file. These tests
-# are based on the outline programs in the examles directory.
+# are based on the outline programs in the examples directory.
 #
 use Excel::Writer::XLSX;
 
diff --git a/t/regression/outline04.t b/t/regression/outline04.t
@@ -31,7 +31,7 @@ my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };
 ###############################################################################
 #
 # Test the creation of a outlines in a Excel::Writer::XLSX file. These tests
-# are based on the outline programs in the examles directory.
+# are based on the outline programs in the examples directory.
 #
 use Excel::Writer::XLSX;
 
diff --git a/t/regression/outline05.t b/t/regression/outline05.t
@@ -31,7 +31,7 @@ my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };
 ###############################################################################
 #
 # Test the creation of a outlines in a Excel::Writer::XLSX file. These tests
-# are based on the outline programs in the examles directory.
+# are based on the outline programs in the examples directory.
 #
 use Excel::Writer::XLSX;
 
diff --git a/t/regression/outline06.t b/t/regression/outline06.t
@@ -31,7 +31,7 @@ my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };
 ###############################################################################
 #
 # Test the creation of a outlines in a Excel::Writer::XLSX file. These tests
-# are based on the outline programs in the examles directory.
+# are based on the outline programs in the examples directory.
 #
 use Excel::Writer::XLSX;
 
diff --git a/t/regression/rich_string09.t b/t/regression/rich_string09.t
@@ -43,7 +43,7 @@ $worksheet->write( 'A1', 'Foo', $bold );
 $worksheet->write( 'A2', 'Bar', $italic );
 $worksheet->write_rich_string( 'A3', 'a', $bold, 'bc', 'defg' );
 
-# The following contains 2 consectutive formats and should be ignored.
+# The following contains 2 consecutive formats and should be ignored.
 $worksheet->write_rich_string( 'A3', 'a', $bold, $bold, 'bc', 'defg' );
 
 $workbook->close();
diff --git a/t/worksheet/sub_position_object.t b/t/worksheet/sub_position_object.t
@@ -2,7 +2,7 @@
 #
 # Tests for Excel::Writer::XLSX::Worksheet methods.
 #
-# Tests for the _position_object_emus method used to calcualte the twoCellAnchor
+# Tests for the _position_object_emus method used to calculate the twoCellAnchor
 # positions for drawing and chart objects.
 #
 # Copyright 2000-2025, John McNamara, jmcnamara@cpan.org
diff --git a/t/worksheet/sub_write_data_validations_02.t b/t/worksheet/sub_write_data_validations_02.t
@@ -300,7 +300,7 @@ _is_deep_diff( $got, $expected, $caption );
 
 ###############################################################################
 #
-# Test 19 Integer between 1 and 10 (same as test 1) + Error style == infor..
+# Test 19 Integer between 1 and 10 (same as test 1) + Error style == information.
 #
 
 $worksheet = _new_worksheet( \$got );

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`#######################################################################`
`4`	`4`	`#`
`5`	`5`	`# Example of how to change the default worksheet direction from`
`6`		`-# left-to-right to right-to-left as required by some eastern verions`
	`6`	`+# left-to-right to right-to-left as required by some eastern versions`
`7`	`7`	`# of Excel.`
`8`	`8`	`#`
`9`	`9`	`# Copyright 2000-2025, John McNamara, jmcnamara@cpan.org`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@`
`112`	`112`	`#`
`113`	`113`	`#`
`114`	`114`	`# Once you have identified the necessary metadata you can add it to a new`
`115`		`-# docuemnt as shown below.`
	`115`	`+# document as shown below.`
`116`	`116`	`#`
`117`	`117`
`118`	`118`	`use strict;`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`#`
`4`	`4`	`# Sample encoded text borrowed from Sean Burke's Pod::Simple distro.`
`5`	`5`	`#`
`6`		`-# The text is some Russina in KOI8-R.`
	`6`	`+# The text is some Russian in KOI8-R.`
`7`	`7`	`#`
`8`	`8`	`# See the unicode_koi8r.pl example.`
`9`	`9`	`#`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`# A simple example of converting some Unicode text to an Excel file using`
`6`	`6`	`# Excel::Writer::XLSX.`
`7`	`7`	`#`
`8`		`-# This example generates some Japenese text from a file with Shift-JIS`
	`8`	`+# This example generates some Japanese text from a file with Shift-JIS`
`9`	`9`	`# encoded text.`
`10`	`10`	`#`
`11`	`11`	`# Copyright 2000-2025, John McNamara, jmcnamara@cpan.org`