feat(CI/CD): Add Codespell action (#12)

Author: TheGiraffe3

.github/workflows/style.yml

@@ -0,0 +1,25 @@
+name: Style
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  spellcheck:
+    name: Spelling
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+        show-progress: false
+    - uses: codespell-project/actions-codespell@master
+      with:
+        exclude_file: site/java/testapidocs/script-dir/jquery-3.5.1.min.js,site/java/apidocs/script-dir/jquery-3.5.1.min.js

java/src/main/java/io/github/moctave/weftspace/DataNode.java

@@ -99,7 +99,7 @@ public DataNode() {
 	 * Multiple distinct nodes may have the same hash code, as
 	 * (1) the mechanics for name.hashCode() and flag.hashCode() are not controlled,
 	 * (2) parents are not taken into account in this method, and
-	 * (3) nodes which have themself as a child will not have their childen considered.
+	 * (3) nodes which have themself as a child will not have their children considered.
 	 * @return A hash code value for this node.
 	 */
 	@Override

java/src/main/java/io/github/moctave/weftspace/Logger.java

@@ -194,7 +194,7 @@ public void printPrefix(PrintStream stream) {
 
 
 		/**
-		 * Ends the message, reseting formating. If this message is a fatal error, calling
+		 * Ends the message, resetting formatting. If this message is a fatal error, calling
 		 * this method will also exit the program with an error code of 1.
 		 */
 		public void endMessage(PrintStream stream) {

python/weftspace/data_node.py

@@ -141,7 +141,7 @@ def __hash__(self):
 		Multiple distinct nodes may have the same hash code, as
 		(1) the mechanics for hash() are not controlled,
 		(2) parents are not taken into account in this method, and
-		(3) nodes which have themself as a child will not have their childen considered.
+		(3) nodes which have themself as a child will not have their children considered.
 		"""
 		prime: int = 31
 		hash_code: int = 1

python/weftspace/logger.py

@@ -163,7 +163,7 @@ def print_prefix(self, stream: TextIO):
 
 		def end_message(self, stream: TextIO):
 			"""
-			Ends the message, reseting formating. If this message is a fatal error, calling
+			Ends the message, resetting formatting. If this message is a fatal error, calling
 			this method will also exit the program with an error code of 1.
 			"""
 			stream.write(Logger.RESET)

site/java/apidocs/index-all.html

@@ -205,7 +205,7 @@ <h2 class="title" id="I:E">E</h2>
 <dl class="index">
 <dt><a href="io/github/moctave/weftspace/Logger.Message.html#endMessage(java.io.PrintStream)" class="member-name-link">endMessage(PrintStream)</a> - Method in class io.github.moctave.weftspace.<a href="io/github/moctave/weftspace/Logger.Message.html" title="class in io.github.moctave.weftspace">Logger.Message</a></dt>
 <dd>
-<div class="block">Ends the message, reseting formating.</div>
+<div class="block">Ends the message, resetting formatting.</div>
 </dd>
 <dt><a href="io/github/moctave/weftspace/DataNode.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in class io.github.moctave.weftspace.<a href="io/github/moctave/weftspace/DataNode.html" title="class in io.github.moctave.weftspace">DataNode</a></dt>
 <dd>

site/java/apidocs/io/github/moctave/weftspace/DataNode.html

@@ -310,7 +310,7 @@ <h3>hashCode</h3>
  Multiple distinct nodes may have the same hash code, as
  (1) the mechanics for name.hashCode() and flag.hashCode() are not controlled,
  (2) parents are not taken into account in this method, and
- (3) nodes which have themself as a child will not have their childen considered.</div>
+ (3) nodes which have themself as a child will not have their children considered.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>

site/java/apidocs/io/github/moctave/weftspace/Logger.Message.html

@@ -124,7 +124,7 @@ <h2>Method Summary</h2>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#endMessage(java.io.PrintStream)" class="member-name-link">endMessage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a>&nbsp;stream)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
-<div class="block">Ends the message, reseting formating.</div>
+<div class="block">Ends the message, resetting formatting.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatOn(java.io.PrintStream)" class="member-name-link">formatOn</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a>&nbsp;stream)</code></div>
@@ -212,7 +212,7 @@ <h3>printPrefix</h3>
 <section class="detail" id="endMessage(java.io.PrintStream)">
 <h3>endMessage</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">endMessage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link">PrintStream</a>&nbsp;stream)</span></div>
-<div class="block">Ends the message, reseting formating. If this message is a fatal error, calling
+<div class="block">Ends the message, resetting formatting. If this message is a fatal error, calling
  this method will also exit the program with an error code of 1.</div>
 </section>
 </li>

site/java/project-info.html

@@ -79,7 +79,7 @@ <h3><a name="Overview"></a>Overview</h3>
 <td align="left">This document lists the dependencies that are defined through dependencyManagement.</td></tr>
 <tr class="a">
 <td align="left"><a href="distribution-management.html">Distribution Management</a></td>
-<td align="left">This document provides informations on the distribution management of this project.</td></tr>
+<td align="left">This document provides information on the distribution management of this project.</td></tr>
 <tr class="b">
 <td align="left"><a href="index.html">About</a></td>
 <td align="left">Weftspace is a Java library designed to provide the maximum possible level of support for Endless Sky datafile syntax. As well as providing read/write functionality through the DataReader and DataWriter classes, it provides support for handling the data nodes themselves.</td></tr>

site/python/weftspace/data_node.html

@@ -182,7 +182,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 Multiple distinct nodes may have the same hash code, as
                 (1) the mechanics for hash() are not controlled,
                 (2) parents are not taken into account in this method, and
-                (3) nodes which have themself as a child will not have their childen considered.
+                (3) nodes which have themself as a child will not have their children considered.
                 &#34;&#34;&#34;
                 prime: int = 31
                 hash_code: int = 1