ESLint: Enforce stricter translator comment placeholder matching

[USERSATOSHI]

What?

Closes #70453

This Pull Request aims to provide stricter translators comments via eslint.
Changes includes addition of placeholders in translator comments if the placeholders are being used in the below code.

Supports

Placeholders

• Unnamed: %s, %d and %f ( with and without colon )
• Positional: 1, %1, %1{s|d|f} and %1${s|d|f}
• Named: named, %named

Missing Placeholders

• Allows eslint to flag placeholders that aren't mentioned in translator comments.

Extra/Outdated Placeholders

• Allows eslint to flag placeholders that are present in comment but not in code
• Supports Unnamed and Positional Placeholder ( as of right now due to named: being false positive in some cases )

Why?

Current eslint rule only checks if translators comment is present or not which works but can be improved to force stricter checks like adding correct placeholders and removing extra placeholders.

This Pull Request aims this by checking the type of placeholder for unnamed, named and indexed and use that as inference to match with translators comments.

How?

This PR introduces 2 new helpers

extractPlaceholders: This extracts the placeholder being used in sprintf
extractTranslatorKeys: This extracts the placeholder used in translator comments

and a new Regex:
REGEXP_COMMENT_PLACEHOLDER: This regex matches the placeholders present in translators comments.

Using these 2 functions we can extract the placeholders used in sprintf and the one in comments and match against each other to find missing and extra placeholders.

Testing Instructions

• Run npm run test:unit packages/eslint-plugin/rules/__tests__/i18n-translator-comments.js
• See all checks being passed

Screenshots or screencast

Missing Placeholders in translator comments

Extra placeholder

[github-actions]

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @USERSATOSHI! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: USERSATOSHI <[email protected]>
Co-authored-by: swissspidy <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.