Add ObjCFormatCheck for Objective-C format strings by anshkr95 · Pull Request #18590 · WeblateOrg/weblate

anshkr95 · 2026-03-23T14:28:38Z

Adds support for Objective-C format string checks (%@ and %1$@).

Added OBJC_PRINTF_MATCH regex pattern
Added objc-format entry in FLAG_RULES
Added ObjCFormatCheck class extending BasePrintfCheck

Adds support for Objective-C format string checks (%@ and %1$@). - Added OBJC_PRINTF_MATCH regex pattern - Added objc-format entry in FLAG_RULES - Added ObjCFormatCheck class extending BasePrintfCheck Closes WeblateOrg#18339

nijel · 2026-03-23T14:31:01Z

Thanks, there are still a few bits missing:

The check needs to be registered in CHECK_LIST.
The documentation and changelog entry are missing.
The check should come with a test case verifying that it actually works as desired.

…checks/tests/test_format.py Add test cases for ObjCFormatCheck verifying %@ and %1$@ placeholders.

for more information, see https://pre-commit.ci

nijel · 2026-03-23T16:29:30Z

weblate/checks/models.py

        "weblate.checks.format.PHPFormatCheck",
        "weblate.checks.format.CFormatCheck",
-        "weblate.checks.format.PerlFormatCheck",
+        "weblate.checks.format.ObjCFormatCheckweblate.checks.format.PerlFormatCheck",


The patch is messed up here.

codecov · 2026-03-23T16:31:47Z

⚠️ JUnit XML file not found

The CLI was unable to find any JUnit XML files to upload.
For more help, visit our troubleshooting guide.

Copilot

Pull request overview

Adds a new quality check to validate Objective-C/iOS-style printf placeholders (notably %@ and positional variants like %1$@) so that Weblate can detect placeholder mismatches between source and translation.

Changes:

Introduces OBJC_PRINTF_MATCH and registers a new objc-format rule in FLAG_RULES.
Adds ObjCFormatCheck (a BasePrintfCheck specialization) to expose the new behavior as a quality check.
Updates the checks registry (CHECK_LIST) to include the new check (currently with a broken entry that needs fixing).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
`weblate/checks/models.py`	Registers the new check in the global checks list (but the new entry is currently concatenated/invalid).
`weblate/checks/format.py`	Adds the Objective-C printf regex + flag rule and defines `ObjCFormatCheck`.

Copilot · 2026-03-23T16:34:21Z

weblate/checks/models.py

        "weblate.checks.format.PHPFormatCheck",
        "weblate.checks.format.CFormatCheck",
-        "weblate.checks.format.PerlFormatCheck",
+        "weblate.checks.format.ObjCFormatCheckweblate.checks.format.PerlFormatCheck",


The CHECK_LIST entry looks accidentally concatenated: "weblate.checks.format.ObjCFormatCheckweblate.checks.format.PerlFormatCheck" is not a valid import path and will prevent checks from loading. Split this into two separate strings (ObjCFormatCheck and PerlFormatCheck), preserving the existing list order.

Suggested change

"weblate.checks.format.ObjCFormatCheckweblate.checks.format.PerlFormatCheck",

"weblate.checks.format.ObjCFormatCheck",

"weblate.checks.format.PerlFormatCheck",

Copilot · 2026-03-23T16:34:21Z

weblate/checks/format.py

+class ObjCFormatCheck(BasePrintfCheck):
+    """Check for Objective-C format string."""
+
+    check_id = "objc_format"
+    name = gettext_lazy("Objective-C format")
+    description = gettext_lazy("Objective-C format string does not match source.")


No tests are added for the new Objective-C placeholder behavior (e.g. %@ and %1$@) even though this module already has a dedicated format-check test suite. Please add unit tests covering matching, missing/extra placeholders, and positional reordering for objc-format.

Copilot · 2026-03-23T16:34:22Z

weblate/checks/format.py

+class ObjCFormatCheck(BasePrintfCheck):
+    """Check for Objective-C format string."""
+
+    check_id = "objc_format"
+    name = gettext_lazy("Objective-C format")
+    description = gettext_lazy("Objective-C format string does not match source.")


As implemented, ObjCFormatCheck will only run when the objc-format flag is present on a unit. If the intent is to resolve #18339 for iOS .strings / .stringsdict by default, wire this flag into the relevant file format(s) via their check_flags so users don’t have to set it manually.

weblate/checks/format.py

Added ObjCFormatTest class to test ObjC format strings.

for more information, see https://pre-commit.ci

Add Objective-C format check documentation

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

for more information, see https://pre-commit.ci

anshkr95 · 2026-03-23T17:46:03Z

Hi @nijel , I've resolved the merge conflicts in docs/changes.rst. The PR is now up to date and ready for the final checks. Thanks!

docs/changes.rst

nijel · 2026-03-24T07:00:10Z

docs/changes.rst

 * Improved LLM interfaces for better reliability.
 * Improved logic for adding monolingual plurals in :doc:`/formats/gettext`.
 * Improved error messages in some of the :ref:`api` endpoints.
+* Added check for Objective-C format strings.


Should use link to the check.

nijel · 2026-03-24T07:00:35Z

docs/user/checks.rst

+.. check:: objc-format
+
+Checks whether Objective-C format strings (like ``%@`` or ``%1$@``)
+match between source and translation.


The section will appear in the generated file, just extend the documentation.

nijel · 2026-03-24T07:01:35Z

weblate/checks/format.py

+
+    check_id = "objc_format"
+    name = gettext_lazy("Objective-C format")
+    description = gettext_lazy("Objective-C format string does not match source.")


version_added is missing here.

fix: add version_added to ObjCFormatCheck

fix: use ref link for objc-format in changelog

Clarify Objective-C format string check description and add version info.

anshkr95 · 2026-03-26T07:33:22Z

Hi @nijel ,

I sincerely apologize for the messy iterations and merge conflicts. I should have reviewed the structure and standards more carefully before submitting.

I've now resolved all the issues:

weblate/checks/format.py

Added version_added = "5.17" to ObjCFormatCheck class

docs/changes.rst

Updated changelog with proper ref link: :ref:check-objc-format``
Resolved merge conflicts

docs/user/checks.rst

Extended documentation with detailed examples
Added Apple's official reference link
Positioned correctly before auto-generated checks

The documentation now renders correctly and follows the proper structure (preview attached).

Thank you for your patience and guidance. Please let me know if further changes are needed.

Thanks!

anshkr95 · 2026-03-28T12:48:17Z

@nijel Could you please review when you have time? Thanks!

nijel · 2026-03-30T14:17:23Z

docs/user/checks.rst

+`Objective-C String Format Specifiers <https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Strings/Articles/formatSpecifiers.html>`_
+
+
+


This really should be in the generated file, but I've just realized that our documentation on this is outdated (see #18724). make -C docs update-docs should update it.

nijel · 2026-03-30T14:17:56Z

weblate/checks/tests/test_format_checks.py

+        self.check_fail("Hello %@", "Hello %s")
+        self.check_fail("Total: %d", "Total: %@")
+        self.check_fail("Missing %@", "Missing")
+        self.check_fail("Hello", "Hello %@")


This really should use existing attributes logic for the basic testing. Adding other tests is okay, but using existing fine-grained tests is better starting point.

Add ObjCFormatCheck for Objective-C format strings

0564fb1

Adds support for Objective-C format string checks (%@ and %1$@). - Added OBJC_PRINTF_MATCH regex pattern - Added objc-format entry in FLAG_RULES - Added ObjCFormatCheck class extending BasePrintfCheck Closes WeblateOrg#18339

anshkr95 requested a review from nijel as a code owner March 23, 2026 14:28

anshkr95 mentioned this pull request Mar 23, 2026

Support Apple/iOS-specific (ObjectiveC and Swift) placeholders format checks #18339

Open

anshkr95 and others added 5 commits March 23, 2026 20:21

Update and rename weblate/checks/models.py to weblate/checks/weblate/…

2894743

…checks/tests/test_format.py Add test cases for ObjCFormatCheck verifying %@ and %1$@ placeholders.

Add ChecksLoader and WeblateChecksConf classes

7252ae1

Add ObjCFormatCheck to format checks list

6f90839

[pre-commit.ci] auto fixes from pre-commit.com hooks

239480c

for more information, see https://pre-commit.ci

Delete weblate/checks/weblate/checks/tests/test_format.py

3e77511

nijel reviewed Mar 23, 2026

View reviewed changes

nijel added this to the 5.17 milestone Mar 23, 2026

nijel requested a review from Copilot March 23, 2026 16:30

Copilot started reviewing on behalf of nijel March 23, 2026 16:31 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

anshkr95 and others added 4 commits March 23, 2026 22:05

Add ObjCFormatTest for Objective-C format checks

1087b52

Added ObjCFormatTest class to test ObjC format strings.

[pre-commit.ci] auto fixes from pre-commit.com hooks

f4c077b

for more information, see https://pre-commit.ci

Fix formatting issue in checks/models.py

f170239

Add check for Objective-C format strings

5b5e8ec

anshkr95 requested a review from AliceVisek as a code owner March 23, 2026 16:51

anshkr95 and others added 6 commits March 23, 2026 22:27

Document Objective-C format string checks

5245314

Add Objective-C format check documentation

Fix formatting of Objective-C check description

f693f69

Apply suggestion from @Copilot

a07730a

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

Add additional format checks in ObjCFormatTest

d2f800a

Merge branch 'main' into main

939315a

[pre-commit.ci] auto fixes from pre-commit.com hooks

022f4d5

for more information, see https://pre-commit.ci

nijel reviewed Mar 24, 2026

View reviewed changes

docs/changes.rst Outdated Show resolved Hide resolved

Apply suggestion from @nijel

be7f7ff

nijel reviewed Mar 24, 2026

View reviewed changes

anshkr95 added 4 commits March 25, 2026 20:22

Update format.py

f07a9ab

fix: add version_added to ObjCFormatCheck

Update changes.rst

4ee0727

fix: use ref link for objc-format in changelog

Merge branch 'main' into main

8812956

Update Objective-C format check documentation

6d4c462

Clarify Objective-C format string check description and add version info.

nijel mentioned this pull request Mar 30, 2026

Outdated documentation on generated documentation #18724

Open

2 tasks

nijel reviewed Mar 30, 2026

View reviewed changes

	"weblate.checks.format.ObjCFormatCheckweblate.checks.format.PerlFormatCheck",
	"weblate.checks.format.ObjCFormatCheck",
	"weblate.checks.format.PerlFormatCheck",

		`Objective-C String Format Specifiers <https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Strings/Articles/formatSpecifiers.html>`_

Uh oh!

Conversation

anshkr95 commented Mar 23, 2026

Uh oh!

nijel commented Mar 23, 2026

Uh oh!

nijel Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 23, 2026

⚠️ JUnit XML file not found

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anshkr95 commented Mar 23, 2026

Uh oh!

Uh oh!

nijel Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

nijel Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

nijel Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

anshkr95 commented Mar 26, 2026

Uh oh!

anshkr95 commented Mar 28, 2026

Uh oh!

nijel Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

nijel Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants