chore: integrate cspell and fix spelling issues (#188)

chenjiahan · web-flow · commit d9d2d7b3d34b · 2025-08-07T16:57:00.000+08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -109,6 +109,9 @@ jobs:
         if: runner.os != 'Linux'
         run: pnpm -r test
 
+      - name: Check Spell
+        run: pnpm check-spell
+
       - name: Lint
         run: pnpm run lint
 
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -36,7 +36,7 @@ var RuleNameRule = rule.Rule{
 3. **Register the rule in `internal/config/config.go`**:
 
    - Add import: `"github.com/web-infra-dev/rslint/internal/rules/rule_name"`
-   - In `RegisterAllTypeSriptEslintPluginRules()`, add:
+   - In `RegisterAllTypeScriptEslintPluginRules()`, add:
      ```go
      GlobalRuleRegistry.Register("@typescript-eslint/rule-name", rule_name.RuleNameRule)
      ```
@@ -192,7 +192,7 @@ Your changes must pass:
 
 ## Debugging Tips
 
-1. **Check rule registration**: Ensure the rule is in `RegisterAllTypeSriptEslintPluginRules()`
+1. **Check rule registration**: Ensure the rule is in `RegisterAllTypeScriptEslintPluginRules()`
 2. **Verify configuration**: Rule must be in `rslint.json` to generate diagnostics
 3. **Test CLI directly**: Use `rslint` binary to verify rule works
 4. **VSCode extension tests**: If failing with "Expected diagnostics but got 0", this is usually due to missing rule registration (not LSP issues)
diff --git a/cmd/rslint/api.go b/cmd/rslint/api.go
@@ -97,7 +97,7 @@ func (h *IPCHandler) HandleLint(req api.LintRequest) (*api.LintResponse, error)
 	}
 
 	// Initialize rule registry with all available rules
-	rslintconfig.RegisterAllTypeSriptEslintPluginRules()
+	rslintconfig.RegisterAllTypeScriptEslintPluginRules()
 
 	// Load rslint configuration and determine which tsconfig files to use
 	_, tsConfigs, configDirectory := rslintconfig.LoadConfigurationWithFallback(req.Config, currentDirectory, fs)
diff --git a/cmd/rslint/cmd.go b/cmd/rslint/cmd.go
@@ -408,7 +408,7 @@ func runCMD() int {
 	fs := bundled.WrapFS(cachedvfs.From(osvfs.FS()))
 
 	// Initialize rule registry with all available rules
-	rslintconfig.RegisterAllTypeSriptEslintPluginRules()
+	rslintconfig.RegisterAllTypeScriptEslintPluginRules()
 	var rslintConfig rslintconfig.RslintConfig
 	var tsConfigs []string
 	// Load rslint configuration and determine which rules to enable
diff --git a/cmd/rslint/lsp.go b/cmd/rslint/lsp.go
@@ -240,7 +240,7 @@ func (s *LSPServer) runDiagnostics(ctx context.Context, uri lsproto.DocumentUri,
 	}
 
 	// Initialize rule registry with all available rules (ensure it's done once)
-	config.RegisterAllTypeSriptEslintPluginRules()
+	config.RegisterAllTypeScriptEslintPluginRules()
 
 	// Convert URI to file path
 	filePath := uriToPath(uriString)
@@ -473,7 +473,7 @@ func runLintWithPrograms(uri lsproto.DocumentUri, programs []*compiler.Program,
 	}
 
 	// Initialize rule registry with all available rules
-	config.RegisterAllTypeSriptEslintPluginRules()
+	config.RegisterAllTypeScriptEslintPluginRules()
 
 	// Collect diagnostics
 	var diagnostics []rule.RuleDiagnostic
diff --git a/cspell.config.cjs b/cspell.config.cjs
@@ -0,0 +1,26 @@
+module.exports = {
+  version: '0.2',
+  language: 'en',
+  files: ['**/*.{ts,tsx,js,jsx,mjs,cjs,md,mdx,json,go,sh,yml,yaml}'],
+  enableFiletypes: ['mdx'],
+  ignorePaths: [
+    'dist',
+    'dist-*',
+    'coverage',
+    'doc_build',
+    'typescript-go',
+    'node_modules',
+    'pnpm-lock.yaml',
+    'shim',
+    'packages/vscode-extension/out',
+    'packages/rslint-test-tools/tests',
+  ],
+  dictionaries: ['dictionary'],
+  dictionaryDefinitions: [
+    {
+      name: 'dictionary',
+      path: './scripts/dictionary.txt',
+      addWords: true,
+    },
+  ],
+};
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -262,8 +262,8 @@ func (config RslintConfig) GetRulesForFile(filePath string) map[string]*RuleConf
 	return enabledRules
 }
 
-// RegisterAllTypeSriptEslintPluginRules registers all available rules in the global registry
-func RegisterAllTypeSriptEslintPluginRules() {
+// RegisterAllTypeScriptEslintPluginRules registers all available rules in the global registry
+func RegisterAllTypeScriptEslintPluginRules() {
 	GlobalRuleRegistry.Register("@typescript-eslint/adjacent-overload-signatures", adjacent_overload_signatures.AdjacentOverloadSignaturesRule)
 	GlobalRuleRegistry.Register("@typescript-eslint/array-type", array_type.ArrayTypeRule)
 	GlobalRuleRegistry.Register("@typescript-eslint/await-thenable", await_thenable.AwaitThenableRule)
diff --git a/internal/rules/no_redundant_type_constituents/no_redundant_type_constituents.go b/internal/rules/no_redundant_type_constituents/no_redundant_type_constituents.go
@@ -318,10 +318,10 @@ var NoRedundantTypeConstituentsRule = rule.CreateRule(rule.Rule{
 				checkLiteralTypeOverridesPrimitive(seenStringLiteralTypes, seenStringPrimitiveTypes, "string")
 			},
 			ast.KindUnionType: func(node *ast.Node) {
-				overridenBigIntTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
-				overridenBooleanTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
-				overridenNumberTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
-				overridenStringTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
+				overriddenBigIntTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
+				overriddenBooleanTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
+				overriddenNumberTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
+				overriddenStringTypeNodes := map[*ast.Node][]typeFlagsWithNodeOrType{}
 
 				seenPrimitiveTypeFlags := checker.TypeFlagsNone
 
@@ -364,13 +364,13 @@ var NoRedundantTypeConstituentsRule = rule.CreateRule(rule.Rule{
 						// upsert the literal text and primitive type under the backing type node
 						switch typePart.flags {
 						case checker.TypeFlagsBigIntLiteral:
-							overridenBigIntTypeNodes[typeNode] = append(overridenBigIntTypeNodes[typeNode], typePart)
+							overriddenBigIntTypeNodes[typeNode] = append(overriddenBigIntTypeNodes[typeNode], typePart)
 						case checker.TypeFlagsBooleanLiteral:
-							overridenBooleanTypeNodes[typeNode] = append(overridenBooleanTypeNodes[typeNode], typePart)
+							overriddenBooleanTypeNodes[typeNode] = append(overriddenBooleanTypeNodes[typeNode], typePart)
 						case checker.TypeFlagsNumberLiteral:
-							overridenNumberTypeNodes[typeNode] = append(overridenNumberTypeNodes[typeNode], typePart)
+							overriddenNumberTypeNodes[typeNode] = append(overriddenNumberTypeNodes[typeNode], typePart)
 						case checker.TypeFlagsStringLiteral, checker.TypeFlagsTemplateLiteral:
-							overridenStringTypeNodes[typeNode] = append(overridenStringTypeNodes[typeNode], typePart)
+							overriddenStringTypeNodes[typeNode] = append(overriddenStringTypeNodes[typeNode], typePart)
 						}
 
 						seenPrimitiveTypeFlags |= typePart.flags & (checker.TypeFlagsBigInt | checker.TypeFlagsBoolean | checker.TypeFlagsNumber | checker.TypeFlagsString)
@@ -381,23 +381,23 @@ var NoRedundantTypeConstituentsRule = rule.CreateRule(rule.Rule{
 				// group those literals by their primitive type,
 				// then report each primitive type with all its literals
 
-				checkOverridenTypes := func(primitiveFlag checker.TypeFlags, overridenNodes map[*ast.Node][]typeFlagsWithNodeOrType, primitiveName string) {
+				checkOverriddenTypes := func(primitiveFlag checker.TypeFlags, overriddenNodes map[*ast.Node][]typeFlagsWithNodeOrType, primitiveName string) {
 					if seenPrimitiveTypeFlags&primitiveFlag == 0 {
 						return
 					}
 
-					for typeNode, typeFlags := range overridenNodes {
+					for typeNode, typeFlags := range overriddenNodes {
 						ctx.ReportNode(typeNode, buildLiteralOverriddenMessage(strings.Join(utils.Map(typeFlags, func(t typeFlagsWithNodeOrType) string {
 							return t.ToString(ctx.TypeChecker)
 						}), " | "), primitiveName))
 
 					}
 				}
 
-				checkOverridenTypes(checker.TypeFlagsBigInt, overridenBigIntTypeNodes, "bigint")
-				checkOverridenTypes(checker.TypeFlagsBoolean, overridenBooleanTypeNodes, "boolean")
-				checkOverridenTypes(checker.TypeFlagsNumber, overridenNumberTypeNodes, "number")
-				checkOverridenTypes(checker.TypeFlagsString, overridenStringTypeNodes, "string")
+				checkOverriddenTypes(checker.TypeFlagsBigInt, overriddenBigIntTypeNodes, "bigint")
+				checkOverriddenTypes(checker.TypeFlagsBoolean, overriddenBooleanTypeNodes, "boolean")
+				checkOverriddenTypes(checker.TypeFlagsNumber, overriddenNumberTypeNodes, "number")
+				checkOverriddenTypes(checker.TypeFlagsString, overriddenStringTypeNodes, "string")
 			},
 		}
 	},
diff --git a/internal/rules/no_unsafe_assignment/no_unsafe_assignment.go b/internal/rules/no_unsafe_assignment/no_unsafe_assignment.go
@@ -365,7 +365,7 @@ var NoUnsafeAssignmentRule = rule.CreateRule(rule.Rule{
 		}
 
 		return rule.RuleListeners{
-			// ESTree PropertyDefintion, AccessorProperty
+			// ESTree PropertyDefinition, AccessorProperty
 			ast.KindPropertyDeclaration: func(node *ast.Node) {
 				initializer := node.Initializer()
 				if initializer == nil {
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
   "scripts": {
     "build": "pnpm -r build",
     "build:npm": "zx scripts/build-npm.mjs",
+    "check-spell": "pnpx cspell",
     "version": "zx scripts/version.mjs",
     "release": "pnpm publish -r --no-git-checks",
     "publish:vsce": "zx scripts/publish-marketplace.mjs",
diff --git a/scripts/dictionary.txt b/scripts/dictionary.txt
@@ -0,0 +1,108 @@
+# Custom Dictionary Words
+accum
+anee
+arraybindingpattern
+arrayish
+arrayliteralexpression
+assertee
+autofixers
+auvred
+bazz
+bigints
+binaryexpression
+bleh
+bmatcuk
+cachedvfs
+catchable
+clazz
+clientrc
+clippy
+cpuprof
+dirxml
+dont
+doublestar
+endline
+errchkjson
+esbuild
+execdir
+fatih
+flaggable
+fltr
+foobarbaz
+foopy
+foos
+foox
+fooz
+forinstatement
+forofstatement
+fround
+funcw
+gcflags
+gnored
+GOARCH
+GOEXPERIMENT
+golangci
+gotest
+hecker
+hoge
+hotpink
+hujson
+imul
+instane
+jsonline
+lintedfile
+lsproto
+myfunc
+nolint
+noregabi
+notcool
+objectbindingpattern
+objectliteralexpression
+osvfs
+parenless
+propertyassignment
+qwer
+readonlyness
+realpath
+recurser
+reducable
+reqs
+rsbuild
+rsdoctor
+rslib
+rslint
+rslintconfig
+rslog
+rspack
+rspeedy
+rspress
+rstack
+rstest
+scopemanager
+shouldnt
+sourcegraph
+spreadassignment
+spreadelement
+stringutil
+subclassing
+symb
+symbolname
+thenables
+tses
+tseslint
+tsgo
+tsgolint
+tsoptions
+tspath
+tsutils
+unbnound
+uncast
+undefinded
+undefinedish
+unional
+unrecognised
+unstrict
+untest
+unwinded
+variabledeclaration
+visitchildren
diff --git a/tools/gen_shims/main.go b/tools/gen_shims/main.go
@@ -283,13 +283,13 @@ func main() {
 							if ok {
 								named, ok := ptrType.Elem().(*types.Named)
 								if ok && !named.Obj().Exported() {
-									strct, ok := named.Underlying().(*types.Struct)
+									structType, ok := named.Underlying().(*types.Struct)
 									if ok {
 										n := named.Obj().Name()
 										dependencies = append(dependencies, struct {
 											string
 											*types.Struct
-										}{n, strct})
+										}{n, structType})
 										shimBuilder.WriteString("extra_")
 										shimBuilder.WriteString(n)
 										continue
@@ -309,15 +309,15 @@ func main() {
 						}
 					}
 
-					strct, ok := named.Underlying().(*types.Struct)
+					structType, ok := named.Underlying().(*types.Struct)
 					if !ok {
 						log.Fatalf("expected %v to be struct", name)
 					}
 
-					emitExtraStruct(name, strct)
+					emitExtraStruct(name, structType)
 
-					mappedFieldTypes := make(map[string]*types.Var, strct.NumFields())
-					for field := range strct.Fields() {
+					mappedFieldTypes := make(map[string]*types.Var, structType.NumFields())
+					for field := range structType.Fields() {
 						mappedFieldTypes[field.Name()] = field
 					}
 

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ func (h IPCHandler) HandleLint(req api.LintRequest) (api.LintResponse, error)`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`// Initialize rule registry with all available rules`
`100`		`- rslintconfig.RegisterAllTypeSriptEslintPluginRules()`
	`100`	`+ rslintconfig.RegisterAllTypeScriptEslintPluginRules()`
`101`	`101`
`102`	`102`	`// Load rslint configuration and determine which tsconfig files to use`
`103`	`103`	`_, tsConfigs, configDirectory := rslintconfig.LoadConfigurationWithFallback(req.Config, currentDirectory, fs)`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ func (s *LSPServer) runDiagnostics(ctx context.Context, uri lsproto.DocumentUri,`
`240`	`240`	`}`
`241`	`241`
`242`	`242`	`// Initialize rule registry with all available rules (ensure it's done once)`
`243`		`- config.RegisterAllTypeSriptEslintPluginRules()`
	`243`	`+ config.RegisterAllTypeScriptEslintPluginRules()`
`244`	`244`
`245`	`245`	`// Convert URI to file path`
`246`	`246`	`filePath := uriToPath(uriString)`
`@@ -473,7 +473,7 @@ func runLintWithPrograms(uri lsproto.DocumentUri, programs []*compiler.Program,`
`473`	`473`	`}`
`474`	`474`
`475`	`475`	`// Initialize rule registry with all available rules`
`476`		`- config.RegisterAllTypeSriptEslintPluginRules()`
	`476`	`+ config.RegisterAllTypeScriptEslintPluginRules()`
`477`	`477`
`478`	`478`	`// Collect diagnostics`
`479`	`479`	`var diagnostics []rule.RuleDiagnostic`
Original file line number	Diff line number	Diff line change
`@@ -365,7 +365,7 @@ var NoUnsafeAssignmentRule = rule.CreateRule(rule.Rule{`
`365`	`365`	`}`
`366`	`366`
`367`	`367`	`return rule.RuleListeners{`
`368`		`- // ESTree PropertyDefintion, AccessorProperty`
	`368`	`+ // ESTree PropertyDefinition, AccessorProperty`
`369`	`369`	`ast.KindPropertyDeclaration: func(node *ast.Node) {`
`370`	`370`	`initializer := node.Initializer()`
`371`	`371`	`if initializer == nil {`