First pass at I18N-specific ESLint rules #20555
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
swissspidy
added
[Type] Enhancement
swissspidy
requested review from
ajitbohra,
chrisvanpatten,
ellatrix,
gziolo,
jorgefilipecosta,
mkaz,
mkevins,
nerrad,
ntwb,
pinarol,
Soean,
talldan and
youknowriad
as code owners
|
Size Change: +2 B (0%) Total Size: 884 kB
ℹ️ View Unchanged
|
6 tasks
swissspidy
commented
Mar 2, 2020
swissspidy
commented
Mar 2, 2020
6 tasks
|
These rules work great! What's left here before this can be merged? |
Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>
aduth
reviewed
Apr 3, 2020
|
I raised it earlier and now it's reported by JimSchofield in #21920 (i18n ESlint rules do not correctly default text-domain). Any thoughts about how to make things easier for 3rd party projects to use the default ESLint ruleset? |
|
I missed in my review that all rules should be included in the table listing in the root README.md of https://github.com/WordPress/gutenberg/blob/master/packages/eslint-plugin/README.md#rules Fix proposed at: #22042 |
This was referenced May 5, 2020
Closed
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.
Description
This PR adds new I18N-related ESLint rules to
@wordpress/eslint-pluginand leverages them in Gutenberg. Changes in this PR:@wordpress/i18n-text-domainmakes sure the text domain is not forgotten and matches a whitelist of allowed text domains. For WordPress projects, using the default domain (
'default') can be allowed. This rule is also partially auto-fixable!@wordpress/i18n-translator-commentsmakes sure any translation functions with placeholders in them have accompanying translator comments.
@wordpress/i18n-no-variablesEnforce string literals as translation function arguments
@wordpress/i18n-no-placeholders-onlyPrevent using only placeholders in translatable strings
@wordpress/i18n-no-collapsible-whitespaceDisallow collapsible whitespace in translatable strings.
@wordpress/i18n-ellipsisDisallow using three dots in translatable strings
i18nruleset that includes all i18n-related rules and is included in therecommendedruleset.valid-sprintfrule has been moved from thecustomruleset to thei18nruleset.See #19777 for context.
I might work on more enhancements mentioned on that issue depending on usefulness and demand. Please leave a comment there with any suggestions!
How has this been tested?
Rigorous unit tests as well as application of the new rules against the Gutenberg code base.
Types of changes
New feature (non-breaking change which adds functionality)
Checklist: