15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 01:33:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
docusaurus/website/docs/api/misc/eslint-plugin/no-untranslated-text.md
Elias Papavasileiou 3b1170eb44
feat: Docusaurus ESLint plugin to enforce best Docusaurus practices (#7206) 
* feat: add eslint plugin

* refactor

* add tests

* fixups!

* fix(no-dynamic-i18n-messages): make translate() recognize template literals

* refactor: rename rule no-dynamic-i18n-messages --> string-literal-i18n-messages

* feat: add ignoreStrings option and refactor

* docs: migrate docs to /docs/api/plugins

* docs: fix anchor links in README.md

* fix: add some ignored strings

* docs: update eslint-plugin docs

* fix: update README link

* docs: various updates

- Reorder sidebar entries
- Fix title size
- Use Markdown file paths
- Simplify relative links

* address reviews

* wording polish

* add npmignore

* fix all internal warnings

* doc improvements

* fix test

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-04-30 00:04:25 +08:00

1.3 KiB
Raw Blame History

slug
/api/misc/@docusaurus/eslint-plugin/no-untranslated-text

no-untranslated-text

Enforce text labels in JSX to be wrapped by translate calls.

When the i18n feature is used, this rule ensures that all labels appearing on the website are translatable, so no string accidentally slips through untranslated.

Rule Details

Examples of incorrect code for this rule:

// Hello World is not translated
<Component>Hello World</Component>

Examples of correct code for this rule:

// Hello World is translated
<Component>
  <Translate>Hello World</Translate>
</Component>

Rule Configuration

Accepted fields:

Option Type Default Description
ignoreStrings string[] [] Text labels that only contain strings in this list will not be reported.

When Not To Use It

If you're not using the i18n feature, you can disable this rule. You can also disable this rule where the text is not supposed to be translated.

Further Reading