ESLint Plugin: Add rule valid-sprintf #13756
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aduth
added
Internationalization (i18n)
aduth
requested review from
ajitbohra,
gziolo,
jorgefilipecosta,
nerrad,
noisysocks,
notnownikki,
ntwb,
Soean,
talldan and
youknowriad
as code owners
nerrad
approved these changes
Feb 8, 2019
| @@ -38,8 +38,7 @@ const embedAttributes = { | |||
| }; | |||
|
|
|||
| export function getEmbedBlockSettings( { title, description, icon, category = 'embed', transforms, keywords = [], supports = {}, responsive = true } ) { | |||
| // translators: %s: Name of service (e.g. VideoPress, YouTube) | |||
| const blockDescription = description || sprintf( __( 'Add a block that displays content pulled from other sites, like Twitter, Instagram or YouTube.' ), title ); | |||
| const blockDescription = description || __( 'Add a block that displays content pulled from other sites, like Twitter, Instagram or YouTube.' ); | |||
There was a problem hiding this comment.
oh, so an example of something that got picked up by the new rule ;) nice.
There was a problem hiding this comment.
The pull request started as a very roundabout way of addressing this specific issue 😆
aduth
force-pushed
the
fix/embed-description-placeholder
branch
from
7abe8bb to
afe9838
Compare
This was referenced Feb 18, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
* Blocks: Embed: Avoid unneccessary sprintf * ESLint Plugin: Add rule valid-sprintf * i18n: Disable valid-sprintf for intentional error test case
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
* Blocks: Embed: Avoid unneccessary sprintf * ESLint Plugin: Add rule valid-sprintf * i18n: Disable valid-sprintf for intentional error test case
aduth
commented
Mar 27, 2019
| @@ -51,6 +51,7 @@ Rule|Description | |||
| ---|--- | |||
| [no-unused-vars-before-return](/packages/eslint-plugin/docs/rules/no-unused-vars-before-return.md)|Disallow assigning variable values if unused before a return | |||
| [dependency-group](/packages/eslint-plugin/docs/rules/dependency-group.md)|Enforce dependencies docblocks formatting | |||
| [valid-sprintf](/packages/eslint-plugin/docs/rules/valid-sprintf.md)|Disallow assigning variable values if unused before a return | |||
There was a problem hiding this comment.
This description is not correct 😅 #14666
This was referenced Apr 30, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related: #6624 (comment)
This pull request seeks to introduce a new ESLint rule to help protect against invalid use of
sprintf.Specifically, it enforces:
_nor_nx) contain an identical number of placeholders (a common error is forming a string likesprintf( _n( 'One cat', '%d cats', num ) ))It does not (yet) enforce:
sprintf( '%1$s %1$s', '1' )is valid)Testing instructions:
Verify that the description for the Embed block shows as expected:
Ensure tests pass: