ci: add codespell checks for local development and CI/CD

Author: Shen7436

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = _build
+ignore-words-list = laf,OT, hart,EHEN,targetIn,dout,DOUT,oen,OEN,EMAC,emac,doubleClick,AfterAll
+write-changes = true

.github/workflows/pre-commit.yml

@@ -22,6 +22,12 @@ jobs:
     - name: Install pre-commit
       run: pip install pre-commit
 
+    - name: Install codespell
+      run: pip install codespell
+    
+    - name: Run codespell
+      run: codespell
+
     - name: Validate commit messages
       run: |
         if [ "${{ github.event_name }}" = "pull_request" ]; then

.pre-commit-config.yaml

@@ -9,4 +9,11 @@
         rev: v1.2.1
         hooks:
           - id: conventional-precommit-linter
-            stages: [commit-msg]
+            stages: [commit-msg]
+
+      - repo: https://github.com/codespell-project/codespell
+        rev: v2.4.1
+        hooks:
+          - id: codespell
+            stages: [pre-commit]
+            args: [--config=.codespellrc]

CONTRIBUTING.md

@@ -29,13 +29,13 @@ Fix: Window -> Preferences -> Plug-in Development -> API Baselines -> Missing AP
 
 ![image](https://github.com/espressif/idf-eclipse-plugin/assets/69584713/0a879d4f-99e2-4d5a-98ca-a745a6683752)
 
-Fix: in "Project Explorer" -> com.espressif.idf.tests -> com.espressif.idf.ui.test -> META-INF -> doubleclick MANIFEST.MF -> Dependencies -> Add... -> Type "slf4j.api" -> Add&Save. 
+Fix: in "Project Explorer" -> com.espressif.idf.tests -> com.espressif.idf.ui.test -> META-INF -> double-click MANIFEST.MF -> Dependencies -> Add... -> Type "slf4j.api" -> Add&Save. 
 
-* After importing project Eclipse might prompt a wizard to install `Maven Plugin Connectors` to resolve the idf-eclipse-plugins maven errors, make sure you install all of them. But, depending on the version(Eclipse / Extentions), an error may occur:
+* After importing project Eclipse might prompt a wizard to install `Maven Plugin Connectors` to resolve the idf-eclipse-plugins maven errors, make sure you install all of them. But, depending on the version(Eclipse / Extensions), an error may occur:
 
 ![image](https://github.com/espressif/idf-eclipse-plugin/assets/69584713/048196c9-8ac6-4f10-8095-596ab2ef05f2)
 
-Fix: check the error and delete one of the extention (usually Tycho) - Help -> Install New Software -> Already Installed -> select "Tycho" -> Uninstall. 
+Fix: check the error and delete one of the extension (usually Tycho) - Help -> Install New Software -> Already Installed -> select "Tycho" -> Uninstall. 
 
 * Run as -> SWTBot Test -> may lead to error: 
 
@@ -50,7 +50,7 @@ Fix: Uninstall SWTBot -> Install latest snapshot(04.04.2023): http://download.ec
 * Make changes locally on a specific local branch
 * Test with Maven Tycho using `$ mvn clean verify -Djarsigner.skip=true`
 * Submit a Pull Request(PR)
-* It is also recommended that you add or update a Functional Test if you are adding or updating a functionality in plugin. More details about adding SWTBot Funtional test can be found in the README.md in test folder in the repo.
+* It is also recommended that you add or update a Functional Test if you are adding or updating a functionality in plugin. More details about adding SWTBot Functional test can be found in the README.md in test folder in the repo.
 
 ## Coding Standards and guidelines
 * Code formatter https://github.com/espressif/idf-eclipse-plugin/blob/master/resources/espressif_eclipse_formatter.xml

bundles/com.espressif.idf.core/schema/com.espressif.idf.core.toolchain.exsd

@@ -6,7 +6,7 @@
          <meta.schema plugin="com.espressif.idf.core" id="com.espressif.idf.core.toolchain" name="esptoolchain"/>
       </appinfo>
       <documentation>
-         An extension point for registering a new esp target with the toolchain information. That includes name, id, arch, toolchain file, toolchain compiler pattern and debugger patten.
+         An extension point for registering a new esp target with the toolchain information. That includes name, id, arch, toolchain file, toolchain compiler pattern and debugger pattern.
       </documentation>
    </annotation>
 
@@ -42,7 +42,7 @@
          <attribute name="id" type="string" use="required">
             <annotation>
                <documentation>
-                  For exmaple riscv32-esp-elf is the id for esp32c2
+                  For example riscv32-esp-elf is the id for esp32c2
                </documentation>
             </annotation>
          </attribute>

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/EspIdfErrorParser.java

@@ -26,7 +26,7 @@
  * expression hint pairs. It uses regular expressions to determine if the line matches any error pattern. If a match is
  * found, the corresponding hint is associated with the error message and added to the 'allMatchesList'.
  *
- * The shutdown method is used to trigger the completion of parsing. It notifies listeners registred in the UI plugin
+ * The shutdown method is used to trigger the completion of parsing. It notifies listeners registered in the UI plugin
  * that the list of available hints has changed and providing the accumulated error hint pairs. The 'allMatchesList' is
  * then cleared to prepare for the next parsing session.
  *

bundles/com.espressif.idf.core/src/com/espressif/idf/core/build/MarkerCleanupJob.java

@@ -19,7 +19,7 @@
 /**
  * Error marker clean up job that runs to clean the error markers for the esp_idf_components folder files that are
  * actually derived ones from the esp-idf and are not user generated. This is actually done to improve the UX as CDT
- * indexer shows unwanted errros
+ * indexer shows unwanted errors
  * 
  * @author Ali Azam Rana
  *

bundles/com.espressif.idf.core/src/com/espressif/idf/core/tools/vo/ToolsVO.java

@@ -38,7 +38,7 @@ public class ToolsVO
 	private String installType;
 
 	@JsonKey(key_name = IToolsJsonKeys.LICENSE_KEY)
-	private String licesnse;
+	private String license;
 
 	@JsonKey(key_name = IToolsJsonKeys.NAME_KEY)
 	private String name;
@@ -116,12 +116,12 @@ public void setInstallType(String installType)
 
 	public String getLicesnse()
 	{
-		return licesnse;
+		return license;
 	}
 
-	public void setLicesnse(String licesnse)
+	public void setLicesnse(String license)
 	{
-		this.licesnse = licesnse;
+		this.license = license;
 	}
 
 	public String getName()
@@ -241,7 +241,7 @@ public boolean equals(Object obj)
                 && Objects.equals(exportVars, other.exportVars)
                 && Objects.equals(infoUrl, other.infoUrl)
                 && Objects.equals(installType, other.installType)
-                && Objects.equals(licesnse, other.licesnse)
+                && Objects.equals(license, other.license)
                 && Objects.equals(name, other.name)
                 && Objects.equals(supportedTargets, other.supportedTargets)
                 && Objects.equals(versionCmd, other.versionCmd)
@@ -254,6 +254,6 @@ public boolean equals(Object obj)
     @Override
     public int hashCode()
     {
-        return Objects.hash(description, exportPaths, exportVars, infoUrl, installType, licesnse, name, supportedTargets, versionCmd, versionRegex, versionVOs, version, installed);
+        return Objects.hash(description, exportPaths, exportVars, infoUrl, installType, license, name, supportedTargets, versionCmd, versionRegex, versionVOs, version, installed);
     }
 }

bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/FileUtil.java

@@ -413,9 +413,9 @@ public static void deleteDirectory(File file) throws IOException
 		}
 	}
 
-	public static File createFileWithContentsInDirectory(String fileName, String content, String direcotry) throws IOException
+	public static File createFileWithContentsInDirectory(String fileName, String content, String directory) throws IOException
 	{
-		java.nio.file.Path directoryPath = java.nio.file.Paths.get(direcotry);
+		java.nio.file.Path directoryPath = java.nio.file.Paths.get(directory);
 		java.nio.file.Path filePath = directoryPath.resolve(fileName);
 		try (FileWriter writer = new FileWriter(filePath.toFile()))
 		{

bundles/com.espressif.idf.core/src/com/espressif/idf/core/util/LspService.java

@@ -54,7 +54,7 @@ public void updateAdditionalOptions(String additionalOptions)
 			return;
 		}
 		String qualifier = configuration.qualifier();
-		InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.additionalOptions.identifer(),
+		InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.additionalOptions.identifier(),
 				additionalOptions);
 	}
 
@@ -67,19 +67,19 @@ public void updateClangdPath()
 			return;
 		}
 		String qualifier = configuration.qualifier();
-		InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.clangdPath.identifer(), clangdPath);
+		InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.clangdPath.identifier(), clangdPath);
 	}
 
 	public void updateQueryDriver()
 	{
 		String qualifier = configuration.qualifier();
-		InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.queryDriver.identifer(), "**"); //$NON-NLS-1$
+		InstanceScope.INSTANCE.getNode(qualifier).put(ClangdMetadata.Predefined.queryDriver.identifier(), "**"); //$NON-NLS-1$
 	}
 
 	public void updateCompileCommandsDir(String buildDir)
 	{
 		String qualifier = configuration.qualifier();
-		String identifier = ClangdMetadata.Predefined.additionalOptions.identifer();
+		String identifier = ClangdMetadata.Predefined.additionalOptions.identifier();
 		IEclipsePreferences preferences = InstanceScope.INSTANCE.getNode(qualifier);
 
 		String existingOptions = preferences.get(identifier, StringUtil.EMPTY);