Fix typos and improve documentation across various files by riderx · Pull Request #8230 · ionic-team/capacitor

riderx · 2025-11-11T20:19:03Z

Corrected multiple typos and enhanced clarity in documentation throughout the codebase, ensuring consistency in variable names and comments.

I used typos-cli command to fix them and double checked by hands all was done properly

- Fixed typo in CHANGELOG.md for Android and CLI regarding Typescript upgrade commit hash. - Corrected variable name from 'statememt' to 'statement' in MockCordovaWebViewImpl.java. - Updated comments and documentation in multiple files to fix spelling errors and improve clarity. - Changed 'overridenUserAgentString' to 'overriddenUserAgentString' in various iOS files for consistency. - Fixed minor typos in HttpRequestHandler.swift and WebViewDelegationHandler.swift. - Corrected test method names in BridgedTypesTests.swift and ConfigurationTests.swift for accuracy.

markemer · 2025-11-12T17:44:28Z

This is kinda neat - let me look into it. some issues.

We shouldn't point to crate-ci/typos@master
- I swore there was a workflow in here? Is that another PR I lost track of?
This checker seems to change github SHAs in markdown, which is not ok.
Also, the docs changes are no brainers, but the spelling corrections on public methods may be breaking changes. I don't actually think they are in most cases, but I need to check

android/CHANGELOG.md

cli/CHANGELOG.md

core/CHANGELOG.md

ios/CHANGELOG.md

CHANGELOG.md

markemer

SHA changes need a revert to start.

riderx · 2025-11-12T17:59:53Z

@markemer i will revert and add .typo.toml to ensure it doesn't do this

Reverts the commit hash changes in CHANGELOG files where typos CLI incorrectly modified git commit hashes (e.g., 88d0ded -> 88d0dead). All other legitimate typo fixes from the previous commit are preserved. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Add .typos.toml to prevent typos CLI from incorrectly modifying git commit hashes in CHANGELOG files while still checking for legitimate typos. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

riderx · 2025-11-12T18:24:15Z

Hey @markemer we should be all good now do you want i merge the github action check in this one as well ?

markemer · 2025-11-12T18:26:16Z

Hey @markemer we should be all good now do you want i merge the github action check in this one as well ?

That one is a bigger deal - but this one should be an easy sell.

riderx · 2025-11-12T18:32:09Z

The GitHub workflow was made only in the doc repo as PR ionic-team/capacitor-docs#481
I made it here as separate PR as well, added at lint stage #8232

eric-horodyski · 2025-11-12T18:45:48Z

.typos.toml

+  "ios/Capacitor/Capacitor.xcodeproj/xcshareddata/xcschemes/*.xcscheme",
+  "ios-pods-template/**/*.storyboard",
+  "ios-spm-template/**/*.storyboard",
+  "ios/Capacitor/TestsHostApp/**/*.storyboard",


We should exclude CHANGELOG.md so we don't modify any historical context, even if it has typos, IMO.

I went back and forth on that. Probably ok, but yeah, we should probably exempt them, also would save us the SHA headache.

i wasn't sure i will update PR

eric-horodyski · 2025-11-12T18:45:54Z

ios/Capacitor/Capacitor/WebViewAssetHandler.swift

        "tgz": "application/x-compressed",
        "thmx": "application/vnd.ms-officetheme",
-        "thn": "application/octet-stream",
+        "then": "application/octet-stream",


This should remain thn I believe.

Yep - I found that one too.

markemer · 2025-11-12T18:46:08Z

ios/Capacitor/Capacitor/WebViewAssetHandler.swift

        "tgz": "application/x-compressed",
        "thmx": "application/vnd.ms-officetheme",
-        "thn": "application/octet-stream",
+        "then": "application/octet-stream",


Caught another one.

eric-horodyski

This comment was accidentally left here, please ignore.

…files - Reverts "thn" (Thompson thumbnail format) back from incorrect "then" change - Adds "thn" to typos config to prevent future false positives - Excludes all CHANGELOG files from typos checking - Excludes Xcode project files (pbxproj, xcscheme, storyboard) that contain hex identifiers that should never be modified 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

riderx · 2025-11-14T01:09:47Z

@markemer i fixed all comment :)

riderx · 2025-11-25T04:05:09Z

hey @eric-horodyski can you review again ?

Copilot

Pull request overview

This PR applies typo fixes and minor documentation/comment clarifications across the iOS, Android, CLI, and core packages, and adds a .typos.toml configuration to standardize future typo checking.

Changes:

Fixes spelling/typos in comments, docs, and test names across multiple targets.
Renames several identifiers to corrected spellings (notably iOS User-Agent and JSValueEncoder float strategy labels).
Adds .typos.toml configuration for typos-cli.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
ios/Capacitor/CodableTests/NonconformingFloatCodableTests.swift	Updates test calls to use corrected JSValueEncoder init label.
ios/Capacitor/CodableTests/CodableTests.swift	Fixes typo in test function name.
ios/Capacitor/CapacitorTests/RouterTests.swift	Fixes typo in test function name.
ios/Capacitor/CapacitorTests/ConfigurationTests.swift	Updates tests to use corrected `overriddenUserAgentString` property.
ios/Capacitor/CapacitorTests/BridgedTypesTests.swift	Fixes typo in test comment.
ios/Capacitor/Capacitor/WebViewDelegationHandler.swift	Fixes typo in comment.
ios/Capacitor/Capacitor/UIStatusBarManager+CAPHandleTapAction.m	Fixes typo in swizzled selector/method name.
ios/Capacitor/Capacitor/Plugins/HttpRequestHandler.swift	Uses corrected `overriddenUserAgentString` property when setting header.
ios/Capacitor/Capacitor/Codable/JSValueEncoder.swift	Corrects doc + initializer argument label spelling (public API).
ios/Capacitor/Capacitor/Codable/JSValueDecoder.swift	Fixes typos in documentation/comments.
ios/Capacitor/Capacitor/CAPNotifications.swift	Fixes typo in header comment.
ios/Capacitor/Capacitor/CAPInstanceDescriptor.swift	Uses corrected `overriddenUserAgentString` property during config parsing.
ios/Capacitor/Capacitor/CAPInstanceDescriptor.h	Renames public property to corrected spelling (public API).
ios/Capacitor/Capacitor/CAPInstanceConfiguration.m	Updates ivar assignment to corrected property name.
ios/Capacitor/Capacitor/CAPInstanceConfiguration.h	Renames public property to corrected spelling (public API).
ios/Capacitor/Capacitor/CAPBridgeViewController.swift	Reads corrected `overriddenUserAgentString` property to set custom UA.
core/cordova.js	Fixes one typo in comment (but leaves another).
cli/src/util/spm.ts	Fixes typo in warning message.
cli/src/util/emoji.ts	Fixes typo in comment.
cli/src/tasks/migrate.ts	Renames local variables for clarity (typo/abbrev cleanup).
cli/src/sysconfig.ts	Fixes typo in doc comment.
cli/src/ios/doctor.ts	Fixes typo in comment.
cli/src/definitions.ts	Fixes typo in comment.
cli/src/declarations.ts	Fixes typo in comment.
cli/src/android/update.ts	Fixes typo in local variable name and its usage.
android/capacitor/src/main/java/com/getcapacitor/cordova/MockCordovaWebViewImpl.java	Fixes parameter name typo in deprecated method.
.typos.toml	Adds `typos-cli` configuration (ignore patterns/excludes/custom words).

Comments suppressed due to low confidence (1)

cli/src/sysconfig.ts:31

The doc comment is still grammatically incorrect: "Whether the user choose to signup" should be something like "Whether the user chooses to sign up" (or "chose to sign up"). Since this is documentation, it’s a good opportunity to fully correct it.

  /**
   * Whether the user choose to signup or not.
   *
   * If undefined, the prompt has not been shown.
   */
  readonly signup?: boolean;

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ios/Capacitor/Capacitor/CAPInstanceConfiguration.h

core/cordova.js

Copilot · 2026-02-10T02:12:41Z

.typos.toml

+[default.extend-words]
+# Add any custom words that should not be corrected
+# Format: incorrectword = "incorrectword"
+thn = "thn"


thn is added to the custom dictionary but doesn’t appear to exist anywhere in the repository (and looks like a typo of "then"). Consider removing it until there is a concrete false-positive to suppress, to avoid masking real typos.

Suggested change

thn = "thn"

Copilot · 2026-02-10T02:12:42Z

ios/Capacitor/Capacitor/Codable/JSValueEncoder.swift

    public init(
        optionalEncodingStrategy: OptionalEncodingStrategy = .undefined,
        dateEncodingStrategy: DateEncodingStrategy = .deferredToDate,
        dataEncodingStrategy: DataEncodingStrategy = .deferredToData,
-        nonConformingFloatEncodingStategy: NonConformingFloatEncodingStrategy = .deferred
+        nonConformingFloatEncodingStrategy: NonConformingFloatEncodingStrategy = .deferred
    ) {
        self.options = .init(
            optionalStrategy: optionalEncodingStrategy,
            dateStrategy: dateEncodingStrategy,
            dataStrategy: dataEncodingStrategy,
-            nonConformingFloatStrategy: nonConformingFloatEncodingStategy
+            nonConformingFloatStrategy: nonConformingFloatEncodingStrategy


Renaming the public initializer argument label from nonConformingFloatEncodingStategy to nonConformingFloatEncodingStrategy is a source-breaking API change for Swift callers. Consider keeping a deprecated overload with the old label (forwarding to the new init) or deferring this rename to a major version bump.

ios/Capacitor/Capacitor/CAPInstanceDescriptor.h

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

markemer reviewed Nov 12, 2025

View reviewed changes

android/CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

cli/CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

core/CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

ios/CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

markemer reviewed Nov 12, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

markemer requested changes Nov 12, 2025

View reviewed changes

riderx and others added 2 commits November 12, 2025 18:06

markemer self-requested a review November 12, 2025 18:30

riderx mentioned this pull request Nov 12, 2025

Add typo checking step to CI workflow #8232

Open

eric-horodyski reviewed Nov 12, 2025

View reviewed changes

markemer reviewed Nov 12, 2025

View reviewed changes

eric-horodyski requested changes Nov 12, 2025

View reviewed changes

riderx force-pushed the fix-typos branch from ca9eb1d to d2ef857 Compare November 13, 2025 03:16

OS-pedrogustavobilro requested review from eric-horodyski and markemer November 14, 2025 13:01

Merge branch 'main' into fix-typos

aba577e

Copilot AI review requested due to automatic review settings February 10, 2026 02:07

Copilot started reviewing on behalf of riderx February 10, 2026 02:07 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

riderx and others added 3 commits February 10, 2026 02:15

Update ios/Capacitor/Capacitor/CAPInstanceConfiguration.h

cfbab24

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update core/cordova.js

4aa3d58

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update ios/Capacitor/Capacitor/CAPInstanceDescriptor.h

74a1386

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Conversation

riderx commented Nov 11, 2025

Uh oh!

markemer commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markemer left a comment

Choose a reason for hiding this comment

Uh oh!

riderx commented Nov 12, 2025

Uh oh!

riderx commented Nov 12, 2025

Uh oh!

markemer commented Nov 12, 2025

Uh oh!

riderx commented Nov 12, 2025

Uh oh!

eric-horodyski Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

markemer Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

riderx Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

eric-horodyski Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

markemer Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

markemer Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

eric-horodyski left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

riderx commented Nov 14, 2025

Uh oh!

riderx commented Nov 25, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

markemer commented Nov 12, 2025 •

edited

Loading

eric-horodyski left a comment •

edited

Loading