跳到主要内容
版本:Canary 🚧

string-literal-i18n-messages

强制在纯文本标签上调用 translate api。

Docusaurus 提供了Docusaurus write-translations API,它可以静态地提取标记为可翻译的文本标签。在<Translate>Translate()调用中使用的动态值将无法提取。此规则将确保所有翻译调用都是静态可提取的。

规则的细节

该规则的错误代码示例:

const text = 'Some text to be translated'

// Invalid <Translate> child
<Translate>{text}</Translate>

// Invalid message attribute
translate({message: text})

正确的代码示例:

// Valid <Translate> child
<Translate>Some text to be translated</Translate>

// Valid message attribute
translate({message: 'Some text to be translated'})

// Valid <Translate> child using values object as prop
<Translate values={{firstName: 'Sébastien'}}>
{'Welcome, {firstName}! How are you?'}
</Translate>

// Valid message attribute using values object as second argument
translate({message: 'The logo of site {siteName}'}, {siteName: 'Docusaurus'})

什么时候不要使用它

如果您不使用i18n 特性,则可以禁用此规则。

进一步的阅读