Skip to content

Add support for t function #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2022
Merged

Add support for t function #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions src/rules/valid-key.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ ruleTester.run("valid-key", rule, {
code: `<Trans i18nKey="nested.valid" />`,
settings: NESTED_SETTINGS,
},
{
code: `t("valid")`,
settings: FLAT_SETTINGS,
},
{
code: `t("nested.valid")`,
settings: NESTED_SETTINGS,
},
],
invalid: [
{
Expand Down Expand Up @@ -110,5 +118,64 @@ ruleTester.run("valid-key", rule, {
},
],
},
{
code: `t(dynamicKey)`,
settings: FLAT_SETTINGS,
errors: [
{
messageId: "dynamic-key",
data: { filePath: "test/fixtures/flat/en-US.json" },
},
],
},
{
code: `t(42)`,
settings: FLAT_SETTINGS,
errors: [
{
messageId: "wrong-key-type",
data: { filePath: "test/fixtures/flat/en-US.json" },
},
],
},
{
code: `t("invalid")`,
settings: FLAT_SETTINGS,
errors: [
{
messageId: "non-existing-key",
data: {
key: "invalid",
closestKey: "valid",
},
},
],
},
{
code: `t("nested.invalid")`,
settings: NESTED_SETTINGS,
errors: [
{
messageId: "non-existing-key",
data: {
key: "nested.invalid",
closestKey: "nested.valid",
},
},
],
},
{
code: `t("onlyInEn")`,
settings: FLAT_SETTINGS,
errors: [
{
messageId: "missing-key-in-file",
data: {
key: "onlyInEn",
filePath: "test/fixtures/flat/es-ES.json",
},
},
],
},
],
});
117 changes: 71 additions & 46 deletions src/rules/valid-key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,62 @@ export default createRule<Options, keyof typeof MESSAGES>({
);
const keysArray = Array.from(keys);

const validateStaticValue = (
node: TSESTree.Node,
staticValue: {
value: unknown;
} | null
) => {
if (!staticValue) {
context.report({
messageId: "dynamic-key",
node,
});
return;
}

if (typeof staticValue.value !== "string") {
context.report({
messageId: "wrong-key-type",
node,
});
return;
}

const key = staticValue.value;

if (!keys.has(key)) {
context.report({
messageId: "non-existing-key",
node,
data: {
key,
closestKey: closest(key, keysArray),
},
});
return;
}

for (const [filePath, translation] of Object.entries(translations)) {
if (
!hasKeyInTranslation(
settings.translationFiles.format,
translation,
key
)
) {
context.report({
messageId: "missing-key-in-file",
node,
data: {
key,
filePath,
},
});
}
}
};

return {
JSXElement: (element) => {
if (isTransElement(element)) {
Expand All @@ -79,54 +135,23 @@ export default createRule<Options, keyof typeof MESSAGES>({
context.getScope()
);

if (!staticValue) {
context.report({
messageId: "dynamic-key",
node: attribute,
});
return;
}

if (typeof staticValue.value !== "string") {
context.report({
messageId: "wrong-key-type",
node: attribute,
});
return;
}

const key = staticValue.value;

if (!keys.has(key)) {
context.report({
messageId: "non-existing-key",
node: attribute,
data: {
key,
closestKey: closest(key, keysArray),
},
});
validateStaticValue(attribute, staticValue);
}
},
CallExpression: (expression) => {
if (
ASTUtils.isIdentifier(expression.callee) &&
expression.callee.name === "t"
) {
if (!expression.arguments.length) {
return;
}

for (const [filePath, translation] of Object.entries(translations)) {
if (
!hasKeyInTranslation(
settings.translationFiles.format,
translation,
key
)
) {
context.report({
messageId: "missing-key-in-file",
node: attribute,
data: {
key,
filePath,
},
});
}
}
const [firstArgument] = expression.arguments;
const staticValue = ASTUtils.getStaticValue(
firstArgument,
context.getScope()
);
validateStaticValue(firstArgument, staticValue);
}
},
};
Expand Down