forked from facebook/docusaurus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
no-untranslated-text.js
71 lines (64 loc) · 1.91 KB
/
no-untranslated-text.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
const {isTextLabelChild, report} = require('../util');
/**
* @type {import('eslint').Rule.RuleModule}
*/
module.exports = {
meta: {
type: 'suggestion',
docs: {
description:
'enforce text labels in JSX to be wrapped by translate calls',
category: 'Suggestions',
url: 'https://github.com/facebook/docusaurus/tree/main/packages/eslint-plugin/docs/rules/no-untranslated-text.md',
},
schema: [
{
type: 'object',
properties: {
ignoreStrings: {
type: 'array',
},
},
additionalProperties: false,
},
],
messages: {
translateChildren:
'All text labels in JSX should be wrapped by translate calls',
},
},
create(context) {
const stringsToIgnore = context.options[0]?.ignoreStrings ?? [];
const isParentTranslate = ({child, isParentFragment}) =>
!isParentFragment &&
child.parent.openingElement.name.name === 'Translate';
const isChildValid = ({child, isParentFragment}) => {
if (!isTextLabelChild({child, ignoreWhitespace: true, stringsToIgnore})) {
return true;
}
return isParentTranslate({child, isParentFragment});
};
const isNodeValid = ({node, isFragment = false} = {}) =>
node.children.every((child) =>
isChildValid({child, isParentFragment: isFragment}),
);
return {
'JSXElement[openingElement.selfClosing=false]': (node) => {
if (!isNodeValid({node})) {
report(context, node, 'translateChildren');
}
},
'JSXFragment[openingFragment]': (node) => {
if (!isNodeValid({node, isFragment: true})) {
report(context, node, 'translateChildren');
}
},
};
},
};