Add codespell support with configuration and fixes (#8761)

* ci(codespell): add codespell config and GitHub Actions workflow

Add .codespellrc with skip patterns for generated files, camelCase/PascalCase
ignore-regex, and project-specific word list (convertor, crypted, te, thur).
Add GitHub Actions workflow to run codespell on push to main and PRs.

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>

* fix(codespell): fix ambiguous typos requiring context review

Manual fixes for typos that needed human review to avoid breaking code:
- Comment/string typos: occured->occurred, destory->destroy, writting->writing,
  retreive->retrieve, identifer->identifier, etc.
- Struct field comments and documentation corrections
- Migration script comment fixes (preserving Go identifiers like DataConvertor)

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>

* fix(codespell): fix non-ambiguous typos with codespell -w

Automated fix via `codespell -w` for clear-cut typos across backend, config-ui,
and grafana dashboards. Examples: sucess->success, occurence->occurrence,
exeucte->execute, asynchornous->asynchronous, Grafana panel typos, etc.

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>

---------

Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
Co-authored-by: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>

Author: yarikoptic

.codespellrc

@@ -0,0 +1,28 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git,.gitignore,.gitattributes,*.svg,go.sum,*.lock,*.css,.codespellrc,.cache,.npm,.yarn,*/e2e/raw_tables/*,*/e2e/snapshot_tables/*
+check-hidden = true
+# Ignore camelCase and PascalCase identifiers (common in Go and TypeScript code)
+ignore-regex = \b[a-z]+[A-Z]\w*\b|\b[A-Z][a-z]+[A-Z]\w*\b
+# convertor,convertors - project's deliberate spelling for Go types and filenames (DataConvertor, etc.)
+# crypted - variable name in AES encrypt/decrypt functions
+# te - Tapd API field name (Te/te struct fields)
+# thur - Thursday abbreviation in Grafana dashboard SQL column alias
+ignore-words-list = convertor,convertors,crypted,te,thur

.github/actions/auto-cherry-pick/action.yml

@@ -19,7 +19,7 @@ name: "Auto Cherry Pick"
 description: "cherry pick commits from Pull Requests into Release branch"
 inputs:
   trigger_label_prefix:
-    description: "The trigger label prefic"
+    description: "The trigger label prefix"
     default: "needs-cherrypick-"
     required: false
   author_email:

.github/workflows/codespell.yml

@@ -0,0 +1,39 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

backend/core/models/domainlayer/README.md

@@ -57,7 +57,7 @@ The following rules make sure Domain Layer Entities serve its purpose
 
 - Read data from platform specific table, convert and store record into one(or multiple) domain table(s)
 - Generate its own `Id` accordingly
-- Generate foreign key accordlingly
+- Generate foreign key accordingly
 - Fields conversion
 
 Sample code:

backend/core/models/locking.go

@@ -19,7 +19,7 @@ package models
 
 import "time"
 
-// LockingHistory is desgned for preventing mutiple delake instances from sharing the same database which may cause
+// LockingHistory is desgned for preventing multiple delake instances from sharing the same database which may cause
 // problems like #3537, #3466. It works by the following step:
 //
 // 1. Each devlake insert a record to this table whie `Succeeded=false`

backend/core/plugin/plugin_blueprint.go

@@ -78,9 +78,9 @@ type DataSourcePluginBlueprintV200 interface {
 // BlueprintConnectionV200 contains the pluginName/connectionId  and related Scopes,
 
 // MetricPluginBlueprintV200 is similar to the DataSourcePluginBlueprintV200
-// but for Metric Plugin, take dora as an example, it doens't have any scope,
+// but for Metric Plugin, take dora as an example, it doesn't have any scope,
 // nor does it produce any, however, it does require other plugin to be
-// executed beforehand, like calcuating refdiff before it can connect PR to the
+// executed beforehand, like calculating refdiff before it can connect PR to the
 // right Deployment keep in mind it would be called IFF the plugin was enabled
 // for the project.
 type MetricPluginBlueprintV200 interface {

backend/core/plugin/plugin_task.go

@@ -106,7 +106,7 @@ type SubTaskMeta struct {
 	Dependencies     []*SubTaskMeta
 	DependencyTables []string
 	ProductTables    []string
-	ForceRunOnResume bool // Should a subtask be ran dispite it was finished before
+	ForceRunOnResume bool // Should a subtask be ran despite it was finished before
 }
 
 // PluginTask Implement this interface to let framework run tasks for you

backend/core/utils/network_helper_test.go

@@ -53,7 +53,7 @@ func TestResolvePort(t *testing.T) {
 	}
 	_, err = ResolvePort("", "rabbitmq")
 	if err == nil {
-		t.Errorf("Expected error %s, Got nil", "schema not fount")
+		t.Errorf("Expected error %s, Got nil", "schema not found")
 	}
 	_, err = ResolvePort("", "")
 	if err == nil {

backend/helpers/e2ehelper/data_flow_tester.go

@@ -112,7 +112,7 @@ func NewDataFlowTester(t *testing.T, pluginName string, pluginMeta plugin.Plugin
 	cfg.Set(`DB_URL`, cfg.GetString(`E2E_DB_URL`))
 	db, err := runner.NewGormDb(cfg, logruslog.Global)
 	if err != nil {
-		// if here fail with error `acces denied for user` you need to create database by your self as follow command
+		// if here fail with error `access denied for user` you need to create database by your self as follow command
 		// create databases lake_test;
 		// grant all on lake_test.* to 'merico'@'%';
 		panic(err)

backend/helpers/migrationhelper/migrationhelper.go

@@ -32,7 +32,7 @@ import (
 	helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
 )
 
-// AutoMigrateTables runs AutoMigrate for muliple tables
+// AutoMigrateTables runs AutoMigrate for multiple tables
 func AutoMigrateTables(basicRes context.BasicRes, dst ...interface{}) errors.Error {
 	db := basicRes.GetDal()
 	for _, entity := range dst {
@@ -74,14 +74,14 @@ func ChangeColumnsType[D any](
 
 	err = db.AutoMigrate(new(D), dal.From(tableName))
 	if err != nil {
-		return errors.Default.Wrap(err, "AutoMigrate for Add Colume Error")
+		return errors.Default.Wrap(err, "AutoMigrate for Add Column Error")
 	}
 
 	defer func() {
 		if err != nil {
 			err1 := db.DropColumns(tableName, columns...)
 			if err1 != nil {
-				err = errors.Default.Wrap(err, fmt.Sprintf("RollBack by DropColume failed.Relevant data needs to be repaired manually.%s", err1.Error()))
+				err = errors.Default.Wrap(err, fmt.Sprintf("RollBack by DropColumn failed.Relevant data needs to be repaired manually.%s", err1.Error()))
 			}
 		}
 	}()